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,30 +3,46 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class CardPushTransfers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::CardPushTransferCreateParams} for more details.
8
- #
9
6
  # Create a Card Push Transfer
10
7
  #
11
8
  # @overload create(business_application_identifier:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, presentment_amount:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, merchant_legal_business_name: nil, merchant_street_address: nil, recipient_address_city: nil, recipient_address_line1: nil, recipient_address_postal_code: nil, recipient_address_state: nil, require_approval: nil, request_options: {})
12
9
  #
13
- # @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier] The Business Application Identifier describes the type of transaction being perf
10
+ # @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier]
11
+ # The Business Application Identifier describes the type of transaction being
12
+ # performed. Your program must be approved for the specified Business Application
13
+ # Identifier in order to use it.
14
14
  #
15
- # @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
15
+ # @param card_token_id [String]
16
+ # The Increase identifier for the Card Token that represents the card number
17
+ # you're pushing funds to.
16
18
  #
17
- # @param merchant_category_code [String] The merchant category code (MCC) of the merchant (generally your business) sendi
19
+ # @param merchant_category_code [String]
20
+ # The merchant category code (MCC) of the merchant (generally your business)
21
+ # sending the transfer. This is a four-digit code that describes the type of
22
+ # business or service provided by the merchant. Your program must be approved for
23
+ # the specified MCC in order to use it.
18
24
  #
19
- # @param merchant_city_name [String] The city name of the merchant (generally your business) sending the transfer.
25
+ # @param merchant_city_name [String]
26
+ # The city name of the merchant (generally your business) sending the transfer.
20
27
  #
21
- # @param merchant_name [String] The merchant name shows up as the statement descriptor for the transfer. This is
28
+ # @param merchant_name [String]
29
+ # The merchant name shows up as the statement descriptor for the transfer. This is
30
+ # typically the name of your business or organization.
22
31
  #
23
- # @param merchant_name_prefix [String] For certain Business Application Identifiers, the statement descriptor is `merch
32
+ # @param merchant_name_prefix [String]
33
+ # For certain Business Application Identifiers, the statement descriptor is
34
+ # `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to
35
+ # four character prefix that identifies the merchant.
24
36
  #
25
- # @param merchant_postal_code [String] The postal code of the merchant (generally your business) sending the transfer.
37
+ # @param merchant_postal_code [String]
38
+ # The postal code of the merchant (generally your business) sending the transfer.
26
39
  #
27
40
  # @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
28
41
  #
29
- # @param presentment_amount [Increase::Models::CardPushTransferCreateParams::PresentmentAmount] The amount to transfer. The receiving bank will convert this to the cardholder's
42
+ # @param presentment_amount [Increase::Models::CardPushTransferCreateParams::PresentmentAmount]
43
+ # The amount to transfer. The receiving bank will convert this to the cardholder's
44
+ # currency. The amount that is applied to your Increase account matches the
45
+ # currency of your account.
30
46
  #
31
47
  # @param recipient_name [String] The name of the funds recipient.
32
48
  #
@@ -40,21 +56,33 @@ module Increase
40
56
  #
41
57
  # @param sender_name [String] The name of the funds originator.
42
58
  #
43
- # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer.
59
+ # @param source_account_number_id [String]
60
+ # The identifier of the Account Number from which to send the transfer.
44
61
  #
45
- # @param merchant_legal_business_name [String] The legal business name of the merchant (generally your business) sending the tr
62
+ # @param merchant_legal_business_name [String]
63
+ # The legal business name of the merchant (generally your business) sending the
64
+ # transfer. Required if the card is issued in Canada.
46
65
  #
47
- # @param merchant_street_address [String] The street address of the merchant (generally your business) sending the transfe
66
+ # @param merchant_street_address [String]
67
+ # The street address of the merchant (generally your business) sending the
68
+ # transfer. Required if the card is issued in Canada.
48
69
  #
49
- # @param recipient_address_city [String] The city of the recipient. Required if the card is issued in Canada.
70
+ # @param recipient_address_city [String]
71
+ # The city of the recipient. Required if the card is issued in Canada.
50
72
  #
51
- # @param recipient_address_line1 [String] The first line of the recipient's address. Required if the card is issued in Can
73
+ # @param recipient_address_line1 [String]
74
+ # The first line of the recipient's address. Required if the card is issued in
75
+ # Canada.
52
76
  #
53
- # @param recipient_address_postal_code [String] The postal code of the recipient. Required if the card is issued in Canada.
77
+ # @param recipient_address_postal_code [String]
78
+ # The postal code of the recipient. Required if the card is issued in Canada.
54
79
  #
55
- # @param recipient_address_state [String] The state or province of the recipient. Required if the card is issued in Canada
80
+ # @param recipient_address_state [String]
81
+ # The state or province of the recipient. Required if the card is issued in
82
+ # Canada.
56
83
  #
57
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
84
+ # @param require_approval [Boolean]
85
+ # Whether the transfer requires explicit approval via the dashboard or API.
58
86
  #
59
87
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
60
88
  #
@@ -92,9 +120,6 @@ module Increase
92
120
  )
93
121
  end
94
122
 
95
- # Some parameter documentations has been truncated, see
96
- # {Increase::Models::CardPushTransferListParams} for more details.
97
- #
98
123
  # List Card Push Transfers
99
124
  #
100
125
  # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -105,9 +130,15 @@ module Increase
105
130
  #
106
131
  # @param cursor [String] Return the page of entries after this one.
107
132
  #
108
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
133
+ # @param idempotency_key [String]
134
+ # Filter records to the one with the specified `idempotency_key` you chose for
135
+ # that object. This value is unique across Increase and is used to ensure that a
136
+ # request is only processed once. Learn more about
137
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
109
138
  #
110
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
139
+ # @param limit [Integer]
140
+ # Limit the size of the list that is returned. The default (and maximum) is 100
141
+ # objects.
111
142
  #
112
143
  # @param status [Increase::Models::CardPushTransferListParams::Status]
113
144
  #
@@ -23,9 +23,6 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::CardTokenListParams} for more details.
28
- #
29
26
  # List Card Tokens
30
27
  #
31
28
  # @overload list(created_at: nil, cursor: nil, limit: nil, request_options: {})
@@ -34,7 +31,9 @@ module Increase
34
31
  #
35
32
  # @param cursor [String] Return the page of entries after this one.
36
33
  #
37
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
34
+ # @param limit [Integer]
35
+ # Limit the size of the list that is returned. The default (and maximum) is 100
36
+ # objects.
38
37
  #
39
38
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
40
39
  #
@@ -3,24 +3,28 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class CardValidations
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::CardValidationCreateParams} for more details.
8
- #
9
6
  # Create a Card Validation
10
7
  #
11
8
  # @overload create(account_id:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, cardholder_first_name: nil, cardholder_last_name: nil, cardholder_middle_name: nil, cardholder_postal_code: nil, cardholder_street_address: nil, request_options: {})
12
9
  #
13
10
  # @param account_id [String] The identifier of the Account from which to send the validation.
14
11
  #
15
- # @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
12
+ # @param card_token_id [String]
13
+ # The Increase identifier for the Card Token that represents the card number
14
+ # you're validating.
16
15
  #
17
- # @param merchant_category_code [String] A four-digit code (MCC) identifying the type of business or service provided by
16
+ # @param merchant_category_code [String]
17
+ # A four-digit code (MCC) identifying the type of business or service provided by
18
+ # the merchant.
18
19
  #
19
20
  # @param merchant_city_name [String] The city where the merchant (typically your business) is located.
20
21
  #
21
- # @param merchant_name [String] The merchant name that will appear in the cardholder’s statement descriptor. Typ
22
+ # @param merchant_name [String]
23
+ # The merchant name that will appear in the cardholder’s statement descriptor.
24
+ # Typically your business name.
22
25
  #
23
- # @param merchant_postal_code [String] The postal code for the merchant’s (typically your business’s) location.
26
+ # @param merchant_postal_code [String]
27
+ # The postal code for the merchant’s (typically your business’s) location.
24
28
  #
25
29
  # @param merchant_state [String] The U.S. state where the merchant (typically your business) is located.
26
30
  #
@@ -70,9 +74,6 @@ module Increase
70
74
  )
71
75
  end
72
76
 
73
- # Some parameter documentations has been truncated, see
74
- # {Increase::Models::CardValidationListParams} for more details.
75
- #
76
77
  # List Card Validations
77
78
  #
78
79
  # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -83,9 +84,15 @@ module Increase
83
84
  #
84
85
  # @param cursor [String] Return the page of entries after this one.
85
86
  #
86
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
87
+ # @param idempotency_key [String]
88
+ # Filter records to the one with the specified `idempotency_key` you chose for
89
+ # that object. This value is unique across Increase and is used to ensure that a
90
+ # request is only processed once. Learn more about
91
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
87
92
  #
88
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
93
+ # @param limit [Integer]
94
+ # Limit the size of the list that is returned. The default (and maximum) is 100
95
+ # objects.
89
96
  #
90
97
  # @param status [Increase::Models::CardValidationListParams::Status]
91
98
  #
@@ -3,24 +3,29 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class Cards
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::CardCreateParams} for more details.
8
- #
9
6
  # Create a Card
10
7
  #
11
8
  # @overload create(account_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
12
9
  #
13
10
  # @param account_id [String] The Account the card should belong to.
14
11
  #
15
- # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls] Controls that restrict how this card can be used.
12
+ # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
13
+ # Controls that restrict how this card can be used.
16
14
  #
17
15
  # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
18
16
  #
19
17
  # @param description [String] The description you choose to give the card.
20
18
  #
21
- # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre
19
+ # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
20
+ # The contact information used in the two-factor steps for digital wallet card
21
+ # creation. To add the card to a digital wallet, you may supply an email or phone
22
+ # number with this request. Otherwise, subscribe and then action a Real Time
23
+ # Decision with the category `digital_wallet_token_requested` or
24
+ # `digital_wallet_authentication_requested`.
22
25
  #
23
- # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
26
+ # @param entity_id [String]
27
+ # The Entity the card belongs to. You only need to supply this in rare situations
28
+ # when the card is not for the Account holder.
24
29
  #
25
30
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
26
31
  #
@@ -52,24 +57,28 @@ module Increase
52
57
  )
53
58
  end
54
59
 
55
- # Some parameter documentations has been truncated, see
56
- # {Increase::Models::CardUpdateParams} for more details.
57
- #
58
60
  # Update a Card
59
61
  #
60
62
  # @overload update(card_id, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
61
63
  #
62
64
  # @param card_id [String] The card identifier.
63
65
  #
64
- # @param authorization_controls [Increase::Models::CardUpdateParams::AuthorizationControls] Controls that restrict how this card can be used.
66
+ # @param authorization_controls [Increase::Models::CardUpdateParams::AuthorizationControls]
67
+ # Controls that restrict how this card can be used.
65
68
  #
66
- # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress] The card's updated billing address.
69
+ # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
70
+ # The card's updated billing address.
67
71
  #
68
72
  # @param description [String] The description you choose to give the card.
69
73
  #
70
- # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet] The contact information used in the two-factor steps for digital wallet card cre
74
+ # @param digital_wallet [Increase::Models::CardUpdateParams::DigitalWallet]
75
+ # The contact information used in the two-factor steps for digital wallet card
76
+ # creation. At least one field must be present to complete the digital wallet
77
+ # steps.
71
78
  #
72
- # @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
79
+ # @param entity_id [String]
80
+ # The Entity the card belongs to. You only need to supply this in rare situations
81
+ # when the card is not for the Account holder.
73
82
  #
74
83
  # @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
75
84
  #
@@ -89,9 +98,6 @@ module Increase
89
98
  )
90
99
  end
91
100
 
92
- # Some parameter documentations has been truncated, see
93
- # {Increase::Models::CardListParams} for more details.
94
- #
95
101
  # List Cards
96
102
  #
97
103
  # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -102,9 +108,15 @@ module Increase
102
108
  #
103
109
  # @param cursor [String] Return the page of entries after this one.
104
110
  #
105
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
111
+ # @param idempotency_key [String]
112
+ # Filter records to the one with the specified `idempotency_key` you chose for
113
+ # that object. This value is unique across Increase and is used to ensure that a
114
+ # request is only processed once. Learn more about
115
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
106
116
  #
107
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
117
+ # @param limit [Integer]
118
+ # Limit the size of the list that is returned. The default (and maximum) is 100
119
+ # objects.
108
120
  #
109
121
  # @param status [Increase::Models::CardListParams::Status]
110
122
  #
@@ -126,9 +138,6 @@ module Increase
126
138
  )
127
139
  end
128
140
 
129
- # Some parameter documentations has been truncated, see
130
- # {Increase::Models::CardCreateDetailsIframeParams} for more details.
131
- #
132
141
  # Create an iframe URL for a Card to display the card details. More details about
133
142
  # styling and usage can be found in the
134
143
  # [documentation](/documentation/embedded-card-component).
@@ -137,7 +146,9 @@ module Increase
137
146
  #
138
147
  # @param card_id [String] The identifier of the Card to create an iframe for.
139
148
  #
140
- # @param physical_card_id [String] The identifier of the Physical Card to create an iframe for. This will inform th
149
+ # @param physical_card_id [String]
150
+ # The identifier of the Physical Card to create an iframe for. This will inform
151
+ # the appearance of the card rendered in the iframe.
141
152
  #
142
153
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
143
154
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class CheckDeposits
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::CheckDepositCreateParams} for more details.
8
- #
9
6
  # Create a Check Deposit
10
7
  #
11
8
  # @overload create(account_id:, amount:, back_image_file_id:, front_image_file_id:, description: nil, request_options: {})
@@ -18,7 +15,8 @@ module Increase
18
15
  #
19
16
  # @param front_image_file_id [String] The File containing the check's front image.
20
17
  #
21
- # @param description [String] The description you choose to give the Check Deposit, for display purposes only.
18
+ # @param description [String]
19
+ # The description you choose to give the Check Deposit, for display purposes only.
22
20
  #
23
21
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
22
  #
@@ -56,9 +54,6 @@ module Increase
56
54
  )
57
55
  end
58
56
 
59
- # Some parameter documentations has been truncated, see
60
- # {Increase::Models::CheckDepositListParams} for more details.
61
- #
62
57
  # List Check Deposits
63
58
  #
64
59
  # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
@@ -69,9 +64,15 @@ module Increase
69
64
  #
70
65
  # @param cursor [String] Return the page of entries after this one.
71
66
  #
72
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
67
+ # @param idempotency_key [String]
68
+ # Filter records to the one with the specified `idempotency_key` you chose for
69
+ # that object. This value is unique across Increase and is used to ensure that a
70
+ # request is only processed once. Learn more about
71
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
73
72
  #
74
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
73
+ # @param limit [Integer]
74
+ # Limit the size of the list that is returned. The default (and maximum) is 100
75
+ # objects.
75
76
  #
76
77
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
77
78
  #
@@ -3,9 +3,6 @@
3
3
  module Increase
4
4
  module Resources
5
5
  class CheckTransfers
6
- # Some parameter documentations has been truncated, see
7
- # {Increase::Models::CheckTransferCreateParams} for more details.
8
- #
9
6
  # Create a Check Transfer
10
7
  #
11
8
  # @overload create(account_id:, amount:, fulfillment_method:, source_account_number_id:, balance_check: nil, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, valid_until_date: nil, request_options: {})
@@ -14,21 +11,40 @@ module Increase
14
11
  #
15
12
  # @param amount [Integer] The transfer amount in USD cents.
16
13
  #
17
- # @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod] Whether Increase will print and mail the check or if you will do it yourself.
14
+ # @param fulfillment_method [Symbol, Increase::Models::CheckTransferCreateParams::FulfillmentMethod]
15
+ # Whether Increase will print and mail the check or if you will do it yourself.
18
16
  #
19
- # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer and print o
17
+ # @param source_account_number_id [String]
18
+ # The identifier of the Account Number from which to send the transfer and print
19
+ # on the check.
20
20
  #
21
- # @param balance_check [Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck] How the account's available balance should be checked. If omitted, the default b
21
+ # @param balance_check [Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck]
22
+ # How the account's available balance should be checked. If omitted, the default
23
+ # behavior is `balance_check: full`.
22
24
  #
23
- # @param check_number [String] The check number Increase should use for the check. This should not contain lead
25
+ # @param check_number [String]
26
+ # The check number Increase should use for the check. This should not contain
27
+ # leading zeroes and must be unique across the `source_account_number`. If this is
28
+ # omitted, Increase will generate a check number for you.
24
29
  #
25
- # @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] Details relating to the physical check that Increase will print and mail. This i
30
+ # @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck]
31
+ # Details relating to the physical check that Increase will print and mail. This
32
+ # is required if `fulfillment_method` is equal to `physical_check`. It must not be
33
+ # included if any other `fulfillment_method` is provided.
26
34
  #
27
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
35
+ # @param require_approval [Boolean]
36
+ # Whether the transfer requires explicit approval via the dashboard or API.
28
37
  #
29
- # @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty] Details relating to the custom fulfillment you will perform. This is required if
38
+ # @param third_party [Increase::Models::CheckTransferCreateParams::ThirdParty]
39
+ # Details relating to the custom fulfillment you will perform. This is required if
40
+ # `fulfillment_method` is equal to `third_party`. It must not be included if any
41
+ # other `fulfillment_method` is provided.
30
42
  #
31
- # @param valid_until_date [Date] If provided, the check will be valid on or before this date. After this date, th
43
+ # @param valid_until_date [Date]
44
+ # If provided, the check will be valid on or before this date. After this date,
45
+ # the check transfer will be automatically stopped and deposits will not be
46
+ # accepted. For checks printed by Increase, this date is included on the check as
47
+ # its expiry.
32
48
  #
33
49
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
34
50
  #
@@ -66,9 +82,6 @@ module Increase
66
82
  )
67
83
  end
68
84
 
69
- # Some parameter documentations has been truncated, see
70
- # {Increase::Models::CheckTransferListParams} for more details.
71
- #
72
85
  # List Check Transfers
73
86
  #
74
87
  # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -79,9 +92,15 @@ module Increase
79
92
  #
80
93
  # @param cursor [String] Return the page of entries after this one.
81
94
  #
82
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
95
+ # @param idempotency_key [String]
96
+ # Filter records to the one with the specified `idempotency_key` you chose for
97
+ # that object. This value is unique across Increase and is used to ensure that a
98
+ # request is only processed once. Learn more about
99
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
83
100
  #
84
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
101
+ # @param limit [Integer]
102
+ # Limit the size of the list that is returned. The default (and maximum) is 100
103
+ # objects.
85
104
  #
86
105
  # @param status [Increase::Models::CheckTransferListParams::Status]
87
106
  #
@@ -150,7 +169,8 @@ module Increase
150
169
  #
151
170
  # @param check_transfer_id [String] The identifier of the Check Transfer.
152
171
  #
153
- # @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason] The reason why this transfer should be stopped.
172
+ # @param reason [Symbol, Increase::Models::CheckTransferStopPaymentParams::Reason]
173
+ # The reason why this transfer should be stopped.
154
174
  #
155
175
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
156
176
  #
@@ -23,9 +23,6 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::DeclinedTransactionListParams} for more details.
28
- #
29
26
  # List Declined Transactions
30
27
  #
31
28
  # @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: 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 route_id [String] Filter Declined Transactions to those belonging to the specified route.
44
43
  #
@@ -23,7 +23,8 @@ module Increase
23
23
  #
24
24
  # @param contact_website [String] A website the user can visit to view and receive support for their card.
25
25
  #
26
- # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor] The Card's text color, specified as an RGB triple. The default is white.
26
+ # @param text_color [Increase::Models::DigitalCardProfileCreateParams::TextColor]
27
+ # The Card's text color, specified as an RGB triple. The default is white.
27
28
  #
28
29
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
29
30
  #
@@ -61,18 +62,21 @@ module Increase
61
62
  )
62
63
  end
63
64
 
64
- # Some parameter documentations has been truncated, see
65
- # {Increase::Models::DigitalCardProfileListParams} for more details.
66
- #
67
65
  # List Card Profiles
68
66
  #
69
67
  # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
70
68
  #
71
69
  # @param cursor [String] Return the page of entries after this one.
72
70
  #
73
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
71
+ # @param idempotency_key [String]
72
+ # Filter records to the one with the specified `idempotency_key` you chose for
73
+ # that object. This value is unique across Increase and is used to ensure that a
74
+ # request is only processed once. Learn more about
75
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
74
76
  #
75
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
77
+ # @param limit [Integer]
78
+ # Limit the size of the list that is returned. The default (and maximum) is 100
79
+ # objects.
76
80
  #
77
81
  # @param status [Increase::Models::DigitalCardProfileListParams::Status]
78
82
  #
@@ -136,7 +140,8 @@ module Increase
136
140
  #
137
141
  # @param issuer_name [String] A user-facing description for whoever is issuing the card.
138
142
  #
139
- # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor] The Card's text color, specified as an RGB triple. The default is white.
143
+ # @param text_color [Increase::Models::DigitalCardProfileCloneParams::TextColor]
144
+ # The Card's text color, specified as an RGB triple. The default is white.
140
145
  #
141
146
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
142
147
  #
@@ -23,9 +23,6 @@ module Increase
23
23
  )
24
24
  end
25
25
 
26
- # Some parameter documentations has been truncated, see
27
- # {Increase::Models::DigitalWalletTokenListParams} for more details.
28
- #
29
26
  # List Digital Wallet Tokens
30
27
  #
31
28
  # @overload list(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
@@ -36,7 +33,9 @@ module Increase
36
33
  #
37
34
  # @param cursor [String] Return the page of entries after this one.
38
35
  #
39
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
36
+ # @param limit [Integer]
37
+ # Limit the size of the list that is returned. The default (and maximum) is 100
38
+ # objects.
40
39
  #
41
40
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
42
41
  #