increase 1.340.0 → 1.342.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (348) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -6
  4. data/lib/increase/internal/type/converter.rb +13 -12
  5. data/lib/increase/models/account.rb +40 -19
  6. data/lib/increase/models/account_create_params.rb +14 -11
  7. data/lib/increase/models/account_list_params.rb +25 -17
  8. data/lib/increase/models/account_number.rb +22 -14
  9. data/lib/increase/models/account_number_create_params.rb +12 -13
  10. data/lib/increase/models/account_number_list_params.rb +26 -20
  11. data/lib/increase/models/account_number_update_params.rb +12 -11
  12. data/lib/increase/models/account_statement.rb +15 -11
  13. data/lib/increase/models/account_statement_list_params.rb +15 -12
  14. data/lib/increase/models/account_transfer.rb +58 -29
  15. data/lib/increase/models/account_transfer_create_params.rb +12 -7
  16. data/lib/increase/models/account_transfer_list_params.rb +20 -12
  17. data/lib/increase/models/ach_prenotification.rb +49 -28
  18. data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
  19. data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
  20. data/lib/increase/models/ach_transfer.rb +220 -105
  21. data/lib/increase/models/ach_transfer_create_params.rb +110 -61
  22. data/lib/increase/models/ach_transfer_list_params.rb +23 -16
  23. data/lib/increase/models/balance_lookup.rb +14 -11
  24. data/lib/increase/models/beneficial_owner_create_params.rb +60 -46
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +56 -40
  27. data/lib/increase/models/card.rb +69 -47
  28. data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
  29. data/lib/increase/models/card_create_params.rb +65 -56
  30. data/lib/increase/models/card_details.rb +7 -5
  31. data/lib/increase/models/card_dispute.rb +530 -306
  32. data/lib/increase/models/card_dispute_create_params.rb +271 -175
  33. data/lib/increase/models/card_dispute_list_params.rb +24 -16
  34. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
  35. data/lib/increase/models/card_iframe_url.rb +3 -4
  36. data/lib/increase/models/card_list_params.rb +23 -16
  37. data/lib/increase/models/card_payment.rb +1941 -1200
  38. data/lib/increase/models/card_payment_list_params.rb +15 -11
  39. data/lib/increase/models/card_purchase_supplement.rb +37 -25
  40. data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
  41. data/lib/increase/models/card_push_transfer.rb +121 -65
  42. data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
  43. data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
  44. data/lib/increase/models/card_token.rb +9 -6
  45. data/lib/increase/models/card_token_capabilities.rb +11 -8
  46. data/lib/increase/models/card_token_list_params.rb +15 -11
  47. data/lib/increase/models/card_update_params.rb +65 -57
  48. data/lib/increase/models/card_validation.rb +76 -43
  49. data/lib/increase/models/card_validation_create_params.rb +11 -7
  50. data/lib/increase/models/card_validation_list_params.rb +23 -16
  51. data/lib/increase/models/check_deposit.rb +103 -52
  52. data/lib/increase/models/check_deposit_create_params.rb +2 -4
  53. data/lib/increase/models/check_deposit_list_params.rb +20 -12
  54. data/lib/increase/models/check_transfer.rb +127 -76
  55. data/lib/increase/models/check_transfer_create_params.rb +91 -51
  56. data/lib/increase/models/check_transfer_list_params.rb +24 -16
  57. data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
  58. data/lib/increase/models/declined_transaction.rb +339 -206
  59. data/lib/increase/models/declined_transaction_list_params.rb +18 -15
  60. data/lib/increase/models/digital_card_profile.rb +16 -9
  61. data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
  62. data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
  63. data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
  64. data/lib/increase/models/digital_wallet_token.rb +26 -17
  65. data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
  66. data/lib/increase/models/entity.rb +175 -135
  67. data/lib/increase/models/entity_archive_params.rb +3 -4
  68. data/lib/increase/models/entity_beneficial_owner.rb +24 -19
  69. data/lib/increase/models/entity_create_params.rb +395 -290
  70. data/lib/increase/models/entity_list_params.rb +67 -16
  71. data/lib/increase/models/entity_onboarding_session.rb +25 -11
  72. data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
  73. data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
  74. data/lib/increase/models/entity_supplemental_document.rb +10 -6
  75. data/lib/increase/models/entity_update_params.rb +136 -104
  76. data/lib/increase/models/event.rb +14 -5
  77. data/lib/increase/models/event_list_params.rb +31 -17
  78. data/lib/increase/models/event_subscription.rb +25 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +22 -8
  80. data/lib/increase/models/event_subscription_list_params.rb +8 -5
  81. data/lib/increase/models/event_subscription_update_params.rb +2 -1
  82. data/lib/increase/models/export.rb +69 -30
  83. data/lib/increase/models/export_create_params.rb +76 -46
  84. data/lib/increase/models/export_list_params.rb +26 -17
  85. data/lib/increase/models/external_account.rb +14 -8
  86. data/lib/increase/models/external_account_create_params.rb +7 -6
  87. data/lib/increase/models/external_account_list_params.rb +12 -9
  88. data/lib/increase/models/external_account_update_params.rb +6 -3
  89. data/lib/increase/models/fednow_transfer.rb +62 -32
  90. data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
  91. data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
  92. data/lib/increase/models/file.rb +13 -7
  93. data/lib/increase/models/file_create_params.rb +6 -5
  94. data/lib/increase/models/file_link.rb +17 -8
  95. data/lib/increase/models/file_link_create_params.rb +3 -4
  96. data/lib/increase/models/file_list_params.rb +23 -16
  97. data/lib/increase/models/group.rb +6 -5
  98. data/lib/increase/models/inbound_ach_transfer.rb +115 -51
  99. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
  100. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
  101. data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
  102. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
  103. data/lib/increase/models/inbound_check_deposit.rb +46 -19
  104. data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
  105. data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
  106. data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
  107. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
  108. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
  109. data/lib/increase/models/inbound_mail_item.rb +13 -8
  110. data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
  111. data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
  112. data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
  113. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
  114. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
  115. data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
  116. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
  117. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
  118. data/lib/increase/models/inbound_wire_transfer.rb +51 -22
  119. data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
  120. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
  121. data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
  122. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
  123. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
  124. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
  125. data/lib/increase/models/intrafi_balance.rb +18 -12
  126. data/lib/increase/models/intrafi_exclusion.rb +13 -7
  127. data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
  128. data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
  129. data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
  130. data/lib/increase/models/lockbox_address.rb +16 -11
  131. data/lib/increase/models/lockbox_address_list_params.rb +20 -12
  132. data/lib/increase/models/lockbox_address_update_params.rb +2 -1
  133. data/lib/increase/models/lockbox_recipient.rb +22 -10
  134. data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
  135. data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
  136. data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
  137. data/lib/increase/models/oauth_application.rb +12 -7
  138. data/lib/increase/models/oauth_application_list_params.rb +18 -15
  139. data/lib/increase/models/oauth_connection.rb +9 -6
  140. data/lib/increase/models/oauth_connection_list_params.rb +10 -9
  141. data/lib/increase/models/oauth_token.rb +6 -5
  142. data/lib/increase/models/oauth_token_create_params.rb +14 -7
  143. data/lib/increase/models/pending_transaction.rb +392 -239
  144. data/lib/increase/models/pending_transaction_create_params.rb +6 -6
  145. data/lib/increase/models/pending_transaction_list_params.rb +23 -19
  146. data/lib/increase/models/physical_card.rb +36 -24
  147. data/lib/increase/models/physical_card_create_params.rb +22 -17
  148. data/lib/increase/models/physical_card_list_params.rb +20 -12
  149. data/lib/increase/models/physical_card_profile.rb +33 -17
  150. data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
  151. data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
  152. data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
  153. data/lib/increase/models/physical_card_update_params.rb +2 -1
  154. data/lib/increase/models/program.rb +15 -8
  155. data/lib/increase/models/program_list_params.rb +3 -4
  156. data/lib/increase/models/real_time_decision.rb +561 -370
  157. data/lib/increase/models/real_time_decision_action_params.rb +86 -75
  158. data/lib/increase/models/real_time_payments_transfer.rb +90 -47
  159. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
  160. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
  161. data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
  162. data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
  163. data/lib/increase/models/routing_number_list_params.rb +3 -4
  164. data/lib/increase/models/routing_number_list_response.rb +11 -8
  165. data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
  166. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
  167. data/lib/increase/models/simulations/ach_transfer_return_params.rb +18 -6
  168. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
  169. data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
  170. data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
  171. data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
  172. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
  173. data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
  174. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
  175. data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
  176. data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
  177. data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
  178. data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
  179. data/lib/increase/models/simulations/card_settlement_create_params.rb +16 -13
  180. data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
  181. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
  182. data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
  183. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
  184. data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
  185. data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
  186. data/lib/increase/models/simulations/export_create_params.rb +5 -5
  187. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
  188. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
  189. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
  190. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
  191. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
  192. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
  193. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
  194. data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
  195. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
  196. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
  197. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
  198. data/lib/increase/models/simulations/program_create_params.rb +4 -5
  199. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
  200. data/lib/increase/models/supplemental_document_list_params.rb +8 -5
  201. data/lib/increase/models/swift_transfer.rb +60 -27
  202. data/lib/increase/models/swift_transfer_create_params.rb +40 -20
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +1016 -536
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +14 -5
  207. data/lib/increase/models/wire_drawdown_request.rb +44 -26
  208. data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
  209. data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
  210. data/lib/increase/models/wire_transfer.rb +100 -55
  211. data/lib/increase/models/wire_transfer_create_params.rb +43 -26
  212. data/lib/increase/models/wire_transfer_list_params.rb +23 -16
  213. data/lib/increase/resources/account_numbers.rb +20 -16
  214. data/lib/increase/resources/account_statements.rb +3 -4
  215. data/lib/increase/resources/account_transfers.rb +20 -12
  216. data/lib/increase/resources/accounts.rb +19 -12
  217. data/lib/increase/resources/ach_prenotifications.rb +23 -13
  218. data/lib/increase/resources/ach_transfers.rb +93 -43
  219. data/lib/increase/resources/beneficial_owners.rb +35 -19
  220. data/lib/increase/resources/card_disputes.rb +43 -22
  221. data/lib/increase/resources/card_payments.rb +3 -4
  222. data/lib/increase/resources/card_purchase_supplements.rb +6 -5
  223. data/lib/increase/resources/card_push_transfers.rb +55 -24
  224. data/lib/increase/resources/card_tokens.rb +3 -4
  225. data/lib/increase/resources/card_validations.rb +19 -12
  226. data/lib/increase/resources/cards.rb +33 -22
  227. data/lib/increase/resources/check_deposits.rb +10 -9
  228. data/lib/increase/resources/check_transfers.rb +37 -17
  229. data/lib/increase/resources/declined_transactions.rb +3 -4
  230. data/lib/increase/resources/digital_card_profiles.rb +12 -7
  231. data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
  232. data/lib/increase/resources/entities.rb +69 -33
  233. data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
  234. data/lib/increase/resources/event_subscriptions.rb +22 -13
  235. data/lib/increase/resources/events.rb +10 -9
  236. data/lib/increase/resources/exports.rb +40 -22
  237. data/lib/increase/resources/external_accounts.rb +21 -14
  238. data/lib/increase/resources/fednow_transfers.rb +21 -14
  239. data/lib/increase/resources/file_links.rb +3 -4
  240. data/lib/increase/resources/files.rb +14 -10
  241. data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
  242. data/lib/increase/resources/inbound_check_deposits.rb +8 -6
  243. data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
  244. data/lib/increase/resources/inbound_mail_items.rb +7 -6
  245. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
  246. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
  247. data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
  248. data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
  249. data/lib/increase/resources/intrafi_exclusions.rb +17 -13
  250. data/lib/increase/resources/lockbox_addresses.rb +10 -6
  251. data/lib/increase/resources/lockbox_recipients.rb +17 -12
  252. data/lib/increase/resources/oauth_applications.rb +3 -4
  253. data/lib/increase/resources/oauth_connections.rb +6 -5
  254. data/lib/increase/resources/oauth_tokens.rb +14 -7
  255. data/lib/increase/resources/pending_transactions.rb +7 -8
  256. data/lib/increase/resources/physical_card_profiles.rb +18 -15
  257. data/lib/increase/resources/physical_cards.rb +17 -12
  258. data/lib/increase/resources/programs.rb +3 -4
  259. data/lib/increase/resources/real_time_decisions.rb +18 -9
  260. data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
  261. data/lib/increase/resources/routing_numbers.rb +3 -4
  262. data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
  263. data/lib/increase/resources/simulations/ach_transfers.rb +18 -15
  264. data/lib/increase/resources/simulations/card_authentications.rb +10 -8
  265. data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
  266. data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
  267. data/lib/increase/resources/simulations/card_disputes.rb +6 -5
  268. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
  269. data/lib/increase/resources/simulations/card_increments.rb +5 -4
  270. data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
  271. data/lib/increase/resources/simulations/card_refunds.rb +10 -6
  272. data/lib/increase/resources/simulations/card_reversals.rb +3 -4
  273. data/lib/increase/resources/simulations/card_settlements.rb +8 -6
  274. data/lib/increase/resources/simulations/card_tokens.rb +6 -3
  275. data/lib/increase/resources/simulations/check_deposits.rb +11 -9
  276. data/lib/increase/resources/simulations/entities.rb +3 -4
  277. data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
  278. data/lib/increase/resources/simulations/exports.rb +5 -5
  279. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
  280. data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
  281. data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
  282. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
  283. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
  284. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
  285. data/lib/increase/resources/simulations/interest_payments.rb +4 -5
  286. data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
  287. data/lib/increase/resources/simulations/physical_cards.rb +7 -6
  288. data/lib/increase/resources/simulations/programs.rb +4 -2
  289. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
  290. data/lib/increase/resources/supplemental_documents.rb +8 -5
  291. data/lib/increase/resources/swift_transfers.rb +33 -17
  292. data/lib/increase/resources/transactions.rb +6 -5
  293. data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
  294. data/lib/increase/resources/wire_transfers.rb +29 -16
  295. data/lib/increase/version.rb +1 -1
  296. data/rbi/increase/models/ach_prenotification.rbi +1 -1
  297. data/rbi/increase/models/ach_transfer.rbi +19 -1
  298. data/rbi/increase/models/beneficial_owner_create_params.rbi +13 -8
  299. data/rbi/increase/models/beneficial_owner_update_params.rbi +13 -8
  300. data/rbi/increase/models/check_transfer.rbi +12 -2
  301. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  302. data/rbi/increase/models/entity_create_params.rbi +78 -48
  303. data/rbi/increase/models/entity_list_params.rbi +119 -0
  304. data/rbi/increase/models/entity_update_params.rbi +26 -16
  305. data/rbi/increase/models/event.rbi +14 -0
  306. data/rbi/increase/models/event_list_params.rbi +14 -0
  307. data/rbi/increase/models/event_subscription.rbi +14 -0
  308. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  309. data/rbi/increase/models/inbound_wire_transfer.rbi +16 -0
  310. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  311. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +16 -1
  312. data/rbi/increase/models/simulations/card_settlement_create_params.rbi +17 -12
  313. data/rbi/increase/models/simulations/program_create_params.rbi +0 -7
  314. data/rbi/increase/models/swift_transfer.rbi +10 -0
  315. data/rbi/increase/models/swift_transfer_create_params.rbi +13 -0
  316. data/rbi/increase/models/transaction.rbi +19 -1
  317. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  318. data/rbi/increase/resources/entities.rbi +3 -0
  319. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  320. data/rbi/increase/resources/simulations/ach_transfers.rbi +5 -0
  321. data/rbi/increase/resources/simulations/card_settlements.rbi +6 -5
  322. data/rbi/increase/resources/swift_transfers.rbi +4 -0
  323. data/sig/increase/models/ach_prenotification.rbs +1 -1
  324. data/sig/increase/models/ach_transfer.rbs +6 -1
  325. data/sig/increase/models/beneficial_owner_create_params.rbs +7 -5
  326. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -5
  327. data/sig/increase/models/check_transfer.rbs +5 -0
  328. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  329. data/sig/increase/models/entity_create_params.rbs +42 -30
  330. data/sig/increase/models/entity_list_params.rbs +48 -1
  331. data/sig/increase/models/entity_update_params.rbs +14 -10
  332. data/sig/increase/models/event.rbs +8 -0
  333. data/sig/increase/models/event_list_params.rbs +8 -0
  334. data/sig/increase/models/event_subscription.rbs +8 -0
  335. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  336. data/sig/increase/models/inbound_wire_transfer.rbs +10 -0
  337. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -1
  338. data/sig/increase/models/simulations/card_settlement_create_params.rbs +7 -5
  339. data/sig/increase/models/simulations/program_create_params.rbs +1 -8
  340. data/sig/increase/models/swift_transfer.rbs +5 -0
  341. data/sig/increase/models/swift_transfer_create_params.rbs +7 -0
  342. data/sig/increase/models/transaction.rbs +6 -1
  343. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  344. data/sig/increase/resources/entities.rbs +1 -0
  345. data/sig/increase/resources/simulations/ach_transfers.rbs +1 -0
  346. data/sig/increase/resources/simulations/card_settlements.rbs +1 -1
  347. data/sig/increase/resources/swift_transfers.rbs +1 -0
  348. metadata +2 -2
@@ -3,22 +3,27 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class AccountTransfers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::AccountTransferCreateParams} for more details.
8
- #
9
6
  # Create an Account Transfer
10
7
  #
11
8
  # @overload create(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {})
12
9
  #
13
10
  # @param account_id [String] The identifier for the originating Account that will send the transfer.
14
11
  #
15
- # @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for
12
+ # @param amount [Integer]
13
+ # The transfer amount in the minor unit of the account currency. For dollars, for
14
+ # example, this is cents.
16
15
  #
17
- # @param description [String] An internal-facing description for the transfer for display in the API and dashb
16
+ # @param description [String]
17
+ # An internal-facing description for the transfer for display in the API and
18
+ # dashboard. This will also show in the description of the created Transactions.
18
19
  #
19
- # @param destination_account_id [String] The identifier for the destination Account that will receive the transfer.
20
+ # @param destination_account_id [String]
21
+ # The identifier for the destination Account that will receive the transfer.
20
22
  #
21
- # @param require_approval [Boolean] Whether the transfer should require explicit approval via the dashboard or API.
23
+ # @param require_approval [Boolean]
24
+ # Whether the transfer should require explicit approval via the dashboard or API.
25
+ # For more information, see
26
+ # [Transfer Approvals](/documentation/transfer-approvals).
22
27
  #
23
28
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
29
  #
@@ -56,9 +61,6 @@ module Increase
56
61
  )
57
62
  end
58
63
 
59
- # Some parameter documentations has been truncated, see
60
- # {Increase::Models::AccountTransferListParams} for more details.
61
- #
62
64
  # List Account Transfers
63
65
  #
64
66
  # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
@@ -69,9 +71,15 @@ module Increase
69
71
  #
70
72
  # @param cursor [String] Return the page of entries after this one.
71
73
  #
72
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
74
+ # @param idempotency_key [String]
75
+ # Filter records to the one with the specified `idempotency_key` you chose for
76
+ # that object. This value is unique across Increase and is used to ensure that a
77
+ # request is only processed once. Learn more about
78
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
73
79
  #
74
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
80
+ # @param limit [Integer]
81
+ # Limit the size of the list that is returned. The default (and maximum) is 100
82
+ # objects.
75
83
  #
76
84
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
77
85
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class Accounts
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::AccountCreateParams} for more details.
8
- #
9
6
  # Create an Account
10
7
  #
11
8
  # @overload create(name:, entity_id: nil, funding: nil, informational_entity_id: nil, loan: nil, program_id: nil, request_options: {})
@@ -14,13 +11,19 @@ module Increase
14
11
  #
15
12
  # @param entity_id [String] The identifier for the Entity that will own the Account.
16
13
  #
17
- # @param funding [Symbol, Increase::Models::AccountCreateParams::Funding] Whether the Account is funded by a loan or by deposits.
14
+ # @param funding [Symbol, Increase::Models::AccountCreateParams::Funding]
15
+ # Whether the Account is funded by a loan or by deposits.
18
16
  #
19
- # @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi
17
+ # @param informational_entity_id [String]
18
+ # The identifier of an Entity that, while not owning the Account, is associated
19
+ # with its activity. This is generally the beneficiary of the funds.
20
20
  #
21
21
  # @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
22
22
  #
23
- # @param program_id [String] The identifier for the Program that this Account falls under. Required if your G
23
+ # @param program_id [String]
24
+ # The identifier for the Program that this Account falls under. Required if your
25
+ # Group operates more than one Program. List your [Programs](#programs) to find
26
+ # their identifiers.
24
27
  #
25
28
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
26
29
  #
@@ -84,9 +87,6 @@ module Increase
84
87
  )
85
88
  end
86
89
 
87
- # Some parameter documentations has been truncated, see
88
- # {Increase::Models::AccountListParams} for more details.
89
- #
90
90
  # List Accounts
91
91
  #
92
92
  # @overload list(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {})
@@ -97,11 +97,18 @@ module Increase
97
97
  #
98
98
  # @param entity_id [String] Filter Accounts for those belonging to the specified Entity.
99
99
  #
100
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
100
+ # @param idempotency_key [String]
101
+ # Filter records to the one with the specified `idempotency_key` you chose for
102
+ # that object. This value is unique across Increase and is used to ensure that a
103
+ # request is only processed once. Learn more about
104
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
101
105
  #
102
- # @param informational_entity_id [String] Filter Accounts for those belonging to the specified Entity as informational.
106
+ # @param informational_entity_id [String]
107
+ # Filter Accounts for those belonging to the specified Entity as informational.
103
108
  #
104
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
109
+ # @param limit [Integer]
110
+ # Limit the size of the list that is returned. The default (and maximum) is 100
111
+ # objects.
105
112
  #
106
113
  # @param program_id [String] Filter Accounts for those in a specific Program.
107
114
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class ACHPrenotifications
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::ACHPrenotificationCreateParams} for more details.
8
- #
9
6
  # Create an ACH Prenotification
10
7
  #
11
8
  # @overload create(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {})
@@ -14,7 +11,9 @@ module Increase
14
11
  #
15
12
  # @param account_number [String] The account number for the destination account.
16
13
  #
17
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
14
+ # @param routing_number [String]
15
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
16
+ # destination account.
18
17
  #
19
18
  # @param addendum [String] Additional information that will be sent to the recipient.
20
19
  #
@@ -26,15 +25,23 @@ module Increase
26
25
  #
27
26
  # @param company_name [String] The name by which the recipient knows you.
28
27
  #
29
- # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator] Whether the Prenotification is for a future debit or credit.
28
+ # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator]
29
+ # Whether the Prenotification is for a future debit or credit.
30
30
  #
31
- # @param effective_date [Date] The ACH Prenotification effective date in [ISO 8601](https://en.wikipedia.org/wi
31
+ # @param effective_date [Date]
32
+ # The ACH Prenotification effective date in
33
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
32
34
  #
33
35
  # @param individual_id [String] Your identifier for the recipient.
34
36
  #
35
- # @param individual_name [String] The name of therecipient. This value is informational and not verified by the re
37
+ # @param individual_name [String]
38
+ # The name of therecipient. This value is informational and not verified by the
39
+ # recipient's bank.
36
40
  #
37
- # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode] The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-co
41
+ # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
42
+ # The
43
+ # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
44
+ # to use for the ACH Prenotification.
38
45
  #
39
46
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
40
47
  #
@@ -72,9 +79,6 @@ module Increase
72
79
  )
73
80
  end
74
81
 
75
- # Some parameter documentations has been truncated, see
76
- # {Increase::Models::ACHPrenotificationListParams} for more details.
77
- #
78
82
  # List ACH Prenotifications
79
83
  #
80
84
  # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
@@ -83,9 +87,15 @@ module Increase
83
87
  #
84
88
  # @param cursor [String] Return the page of entries after this one.
85
89
  #
86
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
90
+ # @param idempotency_key [String]
91
+ # Filter records to the one with the specified `idempotency_key` you chose for
92
+ # that object. This value is unique across Increase and is used to ensure that a
93
+ # request is only processed once. Learn more about
94
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
87
95
  #
88
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
96
+ # @param limit [Integer]
97
+ # Limit the size of the list that is returned. The default (and maximum) is 100
98
+ # objects.
89
99
  #
90
100
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
91
101
  #
@@ -3,50 +3,97 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class ACHTransfers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::ACHTransferCreateParams} for more details.
8
- #
9
6
  # Create an ACH Transfer
10
7
  #
11
8
  # @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, transaction_timing: nil, request_options: {})
12
9
  #
13
10
  # @param account_id [String] The Increase identifier for the account that will send the transfer.
14
11
  #
15
- # @param amount [Integer] The transfer amount in USD cents. A positive amount originates a credit transfer
16
- #
17
- # @param statement_descriptor [String] A description you choose to give the transfer. This will be saved with the trans
18
- #
19
- # @param account_number [String] The receiver's account number. For credit transfers (positive `amount`) this is
20
- #
21
- # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information passed through to the receiving bank with the transfer. M
22
- #
23
- # @param company_descriptive_date [String] A description of the transfer date (typically `YYMMDD`), sent in the company bat
24
- #
25
- # @param company_discretionary_data [String] Custom data sent in the company batch header. This value is informational and do
26
- #
27
- # @param company_entry_description [String] A short description sent in the company batch header. Most receivers do not surf
28
- #
29
- # @param company_name [String] The name by which the recipient knows you, sent in the company batch header. We
30
- #
31
- # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the receiver's account.
32
- #
33
- # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
34
- #
35
- # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the receiver's bank account.
36
- #
37
- # @param individual_id [String] Your internal identifier for the transfer recipient. This value is informational
38
- #
39
- # @param individual_name [String] The name of the transfer recipient. This value is informational and not verified
40
- #
41
- # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate] Configuration for how the effective date of the transfer will be set. This deter
42
- #
43
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
44
- #
45
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) of the rece
46
- #
47
- # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-co
48
- #
49
- # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming] The timing of the transaction.
12
+ # @param amount [Integer]
13
+ # The transfer amount in USD cents. A positive amount originates a credit transfer
14
+ # pushing funds to the receiving account. A negative amount originates a debit
15
+ # transfer pulling funds from the receiving account.
16
+ #
17
+ # @param statement_descriptor [String]
18
+ # A description you choose to give the transfer. This will be saved with the
19
+ # transfer details, displayed in the dashboard, and returned by the API. If
20
+ # `individual_name` and `company_name` are not explicitly set by this API, the
21
+ # `statement_descriptor` will be sent in those fields to the receiving bank to
22
+ # help the customer recognize the transfer. You are highly encouraged to pass
23
+ # `individual_name` and `company_name` instead of relying on this fallback.
24
+ #
25
+ # @param account_number [String]
26
+ # The receiver's account number. For credit transfers (positive `amount`) this is
27
+ # the account that funds will be sent to. For debit transfers (negative `amount`)
28
+ # this is the account that funds will be pulled from.
29
+ #
30
+ # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda]
31
+ # Additional information passed through to the receiving bank with the transfer.
32
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
33
+ # for addendum data, typically unstructured remittance information. Corporate
34
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
35
+ #
36
+ # @param company_descriptive_date [String]
37
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
38
+ # batch header. This value is informational and does not affect funds movement,
39
+ # settlement timing, or returns. Only set this if your recipient has asked for it.
40
+ #
41
+ # @param company_discretionary_data [String]
42
+ # Custom data sent in the company batch header. This value is informational and
43
+ # does not affect funds movement, settlement timing, or returns. Most ACH
44
+ # transfers do not need this. Only set this if your recipient has asked for it.
45
+ #
46
+ # @param company_entry_description [String]
47
+ # A short description sent in the company batch header. Most receivers do not
48
+ # surface this. Only set this if your recipient has asked for a specific value or
49
+ # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
50
+ # example, Prearranged Payment and Deposit (PPD) payroll credits must use
51
+ # `PAYROLL`, and reversals must use `REVERSAL`.
52
+ #
53
+ # @param company_name [String]
54
+ # The name by which the recipient knows you, sent in the company batch header. We
55
+ # recommend setting this on every transfer; if you do not, we fall back to the ACH
56
+ # company name configured on your account.
57
+ #
58
+ # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
59
+ # The type of entity that owns the receiver's account.
60
+ #
61
+ # @param external_account_id [String]
62
+ # The ID of an External Account to initiate a transfer to. If this parameter is
63
+ # provided, `account_number`, `routing_number`, and `funding` must be absent.
64
+ #
65
+ # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding]
66
+ # The type of the receiver's bank account.
67
+ #
68
+ # @param individual_id [String]
69
+ # Your internal identifier for the transfer recipient. This value is informational
70
+ # and not verified by the recipient's bank. Most callers can leave this unset.
71
+ #
72
+ # @param individual_name [String]
73
+ # The name of the transfer recipient. This value is informational and not verified
74
+ # by the recipient's bank.
75
+ #
76
+ # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
77
+ # Configuration for how the effective date of the transfer will be set. This
78
+ # determines same-day vs future-dated settlement timing. If not set, defaults to a
79
+ # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
80
+ # must be set.
81
+ #
82
+ # @param require_approval [Boolean]
83
+ # Whether the transfer requires explicit approval via the dashboard or API.
84
+ #
85
+ # @param routing_number [String]
86
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
87
+ # receiver's bank.
88
+ #
89
+ # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode]
90
+ # The
91
+ # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
92
+ # to use for the transfer. If not provided, the default is
93
+ # `corporate_credit_or_debit`.
94
+ #
95
+ # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming]
96
+ # The timing of the transaction.
50
97
  #
51
98
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
52
99
  #
@@ -84,9 +131,6 @@ module Increase
84
131
  )
85
132
  end
86
133
 
87
- # Some parameter documentations has been truncated, see
88
- # {Increase::Models::ACHTransferListParams} for more details.
89
- #
90
134
  # List ACH Transfers
91
135
  #
92
136
  # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -99,9 +143,15 @@ module Increase
99
143
  #
100
144
  # @param external_account_id [String] Filter ACH Transfers to those made to the specified External Account.
101
145
  #
102
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
146
+ # @param idempotency_key [String]
147
+ # Filter records to the one with the specified `idempotency_key` you chose for
148
+ # that object. This value is unique across Increase and is used to ensure that a
149
+ # request is only processed once. Learn more about
150
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
103
151
  #
104
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
152
+ # @param limit [Integer]
153
+ # Limit the size of the list that is returned. The default (and maximum) is 100
154
+ # objects.
105
155
  #
106
156
  # @param status [Increase::Models::ACHTransferListParams::Status]
107
157
  #
@@ -3,18 +3,21 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class BeneficialOwners
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::BeneficialOwnerCreateParams} for more details.
8
- #
9
6
  # Create a Beneficial Owner
10
7
  #
11
8
  # @overload create(entity_id:, individual:, prongs:, company_title: nil, request_options: {})
12
9
  #
13
- # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner. Only `c
10
+ # @param entity_id [String]
11
+ # The identifier of the Entity to associate with the new Beneficial Owner. Only
12
+ # `corporation` entities have beneficial owners.
14
13
  #
15
- # @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual] Personal details for the beneficial owner.
14
+ # @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual]
15
+ # Personal details for the beneficial owner.
16
16
  #
17
- # @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
17
+ # @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>]
18
+ # Why this person is considered a beneficial owner of the entity. At least one
19
+ # option is required, if a person is both a control person and owner, submit an
20
+ # array containing both.
18
21
  #
19
22
  # @param company_title [String] This person's role or title within the entity.
20
23
  #
@@ -54,24 +57,32 @@ module Increase
54
57
  )
55
58
  end
56
59
 
57
- # Some parameter documentations has been truncated, see
58
- # {Increase::Models::BeneficialOwnerUpdateParams} for more details.
59
- #
60
60
  # Update a Beneficial Owner
61
61
  #
62
62
  # @overload update(entity_beneficial_owner_id, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, prongs: nil, request_options: {})
63
63
  #
64
64
  # @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
65
65
  #
66
- # @param address [Increase::Models::BeneficialOwnerUpdateParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
66
+ # @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
67
+ # The individual's physical address. Mail receiving locations like PO Boxes and
68
+ # PMB's are disallowed.
67
69
  #
68
- # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
70
+ # @param confirmed_no_us_tax_id [Boolean]
71
+ # The identification method for an individual can only be a passport, driver's
72
+ # license, or other document if you've confirmed the individual does not have a US
73
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
74
+ # Number).
69
75
  #
70
- # @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification] A means of verifying the person's identity.
76
+ # @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
77
+ # A means of verifying the person's identity.
71
78
  #
72
79
  # @param name [String] The individual's legal name.
73
80
  #
74
- # @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
81
+ # @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>]
82
+ # Why this person is considered a beneficial owner of the entity. At least one
83
+ # option is required, if a person is both a control person and owner, submit an
84
+ # array containing both. Providing this replaces the beneficial owner's current
85
+ # prongs.
75
86
  #
76
87
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
77
88
  #
@@ -89,20 +100,25 @@ module Increase
89
100
  )
90
101
  end
91
102
 
92
- # Some parameter documentations has been truncated, see
93
- # {Increase::Models::BeneficialOwnerListParams} for more details.
94
- #
95
103
  # List Beneficial Owners
96
104
  #
97
105
  # @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
98
106
  #
99
- # @param entity_id [String] The identifier of the Entity to list beneficial owners for. Only `corporation` e
107
+ # @param entity_id [String]
108
+ # The identifier of the Entity to list beneficial owners for. Only `corporation`
109
+ # entities have beneficial owners.
100
110
  #
101
111
  # @param cursor [String] Return the page of entries after this one.
102
112
  #
103
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
113
+ # @param idempotency_key [String]
114
+ # Filter records to the one with the specified `idempotency_key` you chose for
115
+ # that object. This value is unique across Increase and is used to ensure that a
116
+ # request is only processed once. Learn more about
117
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
104
118
  #
105
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
119
+ # @param limit [Integer]
120
+ # Limit the size of the list that is returned. The default (and maximum) is 100
121
+ # objects.
106
122
  #
107
123
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
108
124
  #
@@ -3,24 +3,34 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class CardDisputes
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::CardDisputeCreateParams} for more details.
8
- #
9
6
  # Create a Card Dispute
10
7
  #
11
8
  # @overload create(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
12
9
  #
13
- # @param disputed_transaction_id [String] The Transaction you wish to dispute. This Transaction must have a `source_type`
10
+ # @param disputed_transaction_id [String]
11
+ # The Transaction you wish to dispute. This Transaction must have a `source_type`
12
+ # of `card_settlement`.
14
13
  #
15
- # @param network [Symbol, Increase::Models::CardDisputeCreateParams::Network] The network of the disputed transaction. Details specific to the network are req
14
+ # @param network [Symbol, Increase::Models::CardDisputeCreateParams::Network]
15
+ # The network of the disputed transaction. Details specific to the network are
16
+ # required under the sub-object with the same identifier as the network.
16
17
  #
17
- # @param amount [Integer] The monetary amount of the part of the transaction that is being disputed. This
18
+ # @param amount [Integer]
19
+ # The monetary amount of the part of the transaction that is being disputed. This
20
+ # is optional and will default to the full amount of the transaction if not
21
+ # provided. If provided, the amount must be less than or equal to the amount of
22
+ # the transaction.
18
23
  #
19
- # @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>] The files to be attached to the initial dispute submission.
24
+ # @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>]
25
+ # The files to be attached to the initial dispute submission.
20
26
  #
21
- # @param explanation [String] The free-form explanation provided to Increase to provide more context for the u
27
+ # @param explanation [String]
28
+ # The free-form explanation provided to Increase to provide more context for the
29
+ # user submission. This field is not sent directly to the card networks.
22
30
  #
23
- # @param visa [Increase::Models::CardDisputeCreateParams::Visa] The Visa-specific parameters for the dispute. Required if and only if `network`
31
+ # @param visa [Increase::Models::CardDisputeCreateParams::Visa]
32
+ # The Visa-specific parameters for the dispute. Required if and only if `network`
33
+ # is `visa`.
24
34
  #
25
35
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
26
36
  #
@@ -58,9 +68,6 @@ module Increase
58
68
  )
59
69
  end
60
70
 
61
- # Some parameter documentations has been truncated, see
62
- # {Increase::Models::CardDisputeListParams} for more details.
63
- #
64
71
  # List Card Disputes
65
72
  #
66
73
  # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -69,9 +76,15 @@ module Increase
69
76
  #
70
77
  # @param cursor [String] Return the page of entries after this one.
71
78
  #
72
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
79
+ # @param idempotency_key [String]
80
+ # Filter records to the one with the specified `idempotency_key` you chose for
81
+ # that object. This value is unique across Increase and is used to ensure that a
82
+ # request is only processed once. Learn more about
83
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
73
84
  #
74
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
85
+ # @param limit [Integer]
86
+ # Limit the size of the list that is returned. The default (and maximum) is 100
87
+ # objects.
75
88
  #
76
89
  # @param status [Increase::Models::CardDisputeListParams::Status]
77
90
  #
@@ -93,24 +106,32 @@ module Increase
93
106
  )
94
107
  end
95
108
 
96
- # Some parameter documentations has been truncated, see
97
- # {Increase::Models::CardDisputeSubmitUserSubmissionParams} for more details.
98
- #
99
109
  # Submit a User Submission for a Card Dispute
100
110
  #
101
111
  # @overload submit_user_submission(card_dispute_id, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
102
112
  #
103
113
  # @param card_dispute_id [String] The identifier of the Card Dispute to submit a user submission for.
104
114
  #
105
- # @param network [Symbol, Increase::Models::CardDisputeSubmitUserSubmissionParams::Network] The network of the Card Dispute. Details specific to the network are required un
115
+ # @param network [Symbol, Increase::Models::CardDisputeSubmitUserSubmissionParams::Network]
116
+ # The network of the Card Dispute. Details specific to the network are required
117
+ # under the sub-object with the same identifier as the network.
106
118
  #
107
- # @param amount [Integer] The adjusted monetary amount of the part of the transaction that is being disput
119
+ # @param amount [Integer]
120
+ # The adjusted monetary amount of the part of the transaction that is being
121
+ # disputed. This is optional and will default to the most recent amount provided.
122
+ # If provided, the amount must be less than or equal to the amount of the
123
+ # transaction.
108
124
  #
109
- # @param attachment_files [Array<Increase::Models::CardDisputeSubmitUserSubmissionParams::AttachmentFile>] The files to be attached to the user submission.
125
+ # @param attachment_files [Array<Increase::Models::CardDisputeSubmitUserSubmissionParams::AttachmentFile>]
126
+ # The files to be attached to the user submission.
110
127
  #
111
- # @param explanation [String] The free-form explanation provided to Increase to provide more context for the u
128
+ # @param explanation [String]
129
+ # The free-form explanation provided to Increase to provide more context for the
130
+ # user submission. This field is not sent directly to the card networks.
112
131
  #
113
- # @param visa [Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa] The Visa-specific parameters for the dispute. Required if and only if `network`
132
+ # @param visa [Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa]
133
+ # The Visa-specific parameters for the dispute. Required if and only if `network`
134
+ # is `visa`.
114
135
  #
115
136
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
116
137
  #
@@ -23,9 +23,6 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::CardPaymentListParams} for more details.
28
- #
29
26
  # List Card Payments
30
27
  #
31
28
  # @overload list(account_id: nil, card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
@@ -38,7 +35,9 @@ module Increase
38
35
  #
39
36
  # @param cursor [String] Return the page of entries after this one.
40
37
  #
41
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
38
+ # @param limit [Integer]
39
+ # Limit the size of the list that is returned. The default (and maximum) is 100
40
+ # objects.
42
41
  #
43
42
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
44
43
  #
@@ -23,20 +23,21 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::CardPurchaseSupplementListParams} for more details.
28
- #
29
26
  # List Card Purchase Supplements
30
27
  #
31
28
  # @overload list(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
32
29
  #
33
- # @param card_payment_id [String] Filter Card Purchase Supplements to ones belonging to the specified Card Payment
30
+ # @param card_payment_id [String]
31
+ # Filter Card Purchase Supplements to ones belonging to the specified Card
32
+ # Payment.
34
33
  #
35
34
  # @param created_at [Increase::Models::CardPurchaseSupplementListParams::CreatedAt]
36
35
  #
37
36
  # @param cursor [String] Return the page of entries after this one.
38
37
  #
39
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
38
+ # @param limit [Integer]
39
+ # Limit the size of the list that is returned. The default (and maximum) is 100
40
+ # objects.
40
41
  #
41
42
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
42
43
  #