increase 1.340.0 → 1.341.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (306) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -6
  4. data/lib/increase/internal/type/converter.rb +13 -12
  5. data/lib/increase/models/account.rb +40 -19
  6. data/lib/increase/models/account_create_params.rb +14 -11
  7. data/lib/increase/models/account_list_params.rb +25 -17
  8. data/lib/increase/models/account_number.rb +22 -14
  9. data/lib/increase/models/account_number_create_params.rb +12 -13
  10. data/lib/increase/models/account_number_list_params.rb +26 -20
  11. data/lib/increase/models/account_number_update_params.rb +12 -11
  12. data/lib/increase/models/account_statement.rb +15 -11
  13. data/lib/increase/models/account_statement_list_params.rb +15 -12
  14. data/lib/increase/models/account_transfer.rb +58 -29
  15. data/lib/increase/models/account_transfer_create_params.rb +12 -7
  16. data/lib/increase/models/account_transfer_list_params.rb +20 -12
  17. data/lib/increase/models/ach_prenotification.rb +48 -27
  18. data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
  19. data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
  20. data/lib/increase/models/ach_transfer.rb +199 -103
  21. data/lib/increase/models/ach_transfer_create_params.rb +110 -61
  22. data/lib/increase/models/ach_transfer_list_params.rb +23 -16
  23. data/lib/increase/models/balance_lookup.rb +14 -11
  24. data/lib/increase/models/beneficial_owner_create_params.rb +48 -37
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
  27. data/lib/increase/models/card.rb +69 -47
  28. data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
  29. data/lib/increase/models/card_create_params.rb +65 -56
  30. data/lib/increase/models/card_details.rb +7 -5
  31. data/lib/increase/models/card_dispute.rb +530 -306
  32. data/lib/increase/models/card_dispute_create_params.rb +271 -175
  33. data/lib/increase/models/card_dispute_list_params.rb +24 -16
  34. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
  35. data/lib/increase/models/card_iframe_url.rb +3 -4
  36. data/lib/increase/models/card_list_params.rb +23 -16
  37. data/lib/increase/models/card_payment.rb +1941 -1200
  38. data/lib/increase/models/card_payment_list_params.rb +15 -11
  39. data/lib/increase/models/card_purchase_supplement.rb +37 -25
  40. data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
  41. data/lib/increase/models/card_push_transfer.rb +121 -65
  42. data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
  43. data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
  44. data/lib/increase/models/card_token.rb +9 -6
  45. data/lib/increase/models/card_token_capabilities.rb +11 -8
  46. data/lib/increase/models/card_token_list_params.rb +15 -11
  47. data/lib/increase/models/card_update_params.rb +65 -57
  48. data/lib/increase/models/card_validation.rb +76 -43
  49. data/lib/increase/models/card_validation_create_params.rb +11 -7
  50. data/lib/increase/models/card_validation_list_params.rb +23 -16
  51. data/lib/increase/models/check_deposit.rb +103 -52
  52. data/lib/increase/models/check_deposit_create_params.rb +2 -4
  53. data/lib/increase/models/check_deposit_list_params.rb +20 -12
  54. data/lib/increase/models/check_transfer.rb +124 -75
  55. data/lib/increase/models/check_transfer_create_params.rb +91 -51
  56. data/lib/increase/models/check_transfer_list_params.rb +24 -16
  57. data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
  58. data/lib/increase/models/declined_transaction.rb +339 -206
  59. data/lib/increase/models/declined_transaction_list_params.rb +18 -15
  60. data/lib/increase/models/digital_card_profile.rb +16 -9
  61. data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
  62. data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
  63. data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
  64. data/lib/increase/models/digital_wallet_token.rb +26 -17
  65. data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
  66. data/lib/increase/models/entity.rb +175 -135
  67. data/lib/increase/models/entity_archive_params.rb +3 -4
  68. data/lib/increase/models/entity_beneficial_owner.rb +24 -19
  69. data/lib/increase/models/entity_create_params.rb +323 -236
  70. data/lib/increase/models/entity_list_params.rb +67 -16
  71. data/lib/increase/models/entity_onboarding_session.rb +25 -11
  72. data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
  73. data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
  74. data/lib/increase/models/entity_supplemental_document.rb +10 -6
  75. data/lib/increase/models/entity_update_params.rb +112 -86
  76. data/lib/increase/models/event.rb +6 -5
  77. data/lib/increase/models/event_list_params.rb +23 -17
  78. data/lib/increase/models/event_subscription.rb +17 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +14 -8
  80. data/lib/increase/models/event_subscription_list_params.rb +8 -5
  81. data/lib/increase/models/event_subscription_update_params.rb +2 -1
  82. data/lib/increase/models/export.rb +69 -30
  83. data/lib/increase/models/export_create_params.rb +76 -46
  84. data/lib/increase/models/export_list_params.rb +26 -17
  85. data/lib/increase/models/external_account.rb +14 -8
  86. data/lib/increase/models/external_account_create_params.rb +7 -6
  87. data/lib/increase/models/external_account_list_params.rb +12 -9
  88. data/lib/increase/models/external_account_update_params.rb +6 -3
  89. data/lib/increase/models/fednow_transfer.rb +62 -32
  90. data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
  91. data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
  92. data/lib/increase/models/file.rb +13 -7
  93. data/lib/increase/models/file_create_params.rb +6 -5
  94. data/lib/increase/models/file_link.rb +17 -8
  95. data/lib/increase/models/file_link_create_params.rb +3 -4
  96. data/lib/increase/models/file_list_params.rb +23 -16
  97. data/lib/increase/models/group.rb +6 -5
  98. data/lib/increase/models/inbound_ach_transfer.rb +115 -51
  99. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
  100. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
  101. data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
  102. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
  103. data/lib/increase/models/inbound_check_deposit.rb +46 -19
  104. data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
  105. data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
  106. data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
  107. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
  108. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
  109. data/lib/increase/models/inbound_mail_item.rb +13 -8
  110. data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
  111. data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
  112. data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
  113. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
  114. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
  115. data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
  116. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
  117. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
  118. data/lib/increase/models/inbound_wire_transfer.rb +33 -21
  119. data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
  120. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
  121. data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
  122. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
  123. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
  124. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
  125. data/lib/increase/models/intrafi_balance.rb +18 -12
  126. data/lib/increase/models/intrafi_exclusion.rb +13 -7
  127. data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
  128. data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
  129. data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
  130. data/lib/increase/models/lockbox_address.rb +16 -11
  131. data/lib/increase/models/lockbox_address_list_params.rb +20 -12
  132. data/lib/increase/models/lockbox_address_update_params.rb +2 -1
  133. data/lib/increase/models/lockbox_recipient.rb +22 -10
  134. data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
  135. data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
  136. data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
  137. data/lib/increase/models/oauth_application.rb +12 -7
  138. data/lib/increase/models/oauth_application_list_params.rb +18 -15
  139. data/lib/increase/models/oauth_connection.rb +9 -6
  140. data/lib/increase/models/oauth_connection_list_params.rb +10 -9
  141. data/lib/increase/models/oauth_token.rb +6 -5
  142. data/lib/increase/models/oauth_token_create_params.rb +14 -7
  143. data/lib/increase/models/pending_transaction.rb +392 -239
  144. data/lib/increase/models/pending_transaction_create_params.rb +6 -6
  145. data/lib/increase/models/pending_transaction_list_params.rb +23 -19
  146. data/lib/increase/models/physical_card.rb +36 -24
  147. data/lib/increase/models/physical_card_create_params.rb +22 -17
  148. data/lib/increase/models/physical_card_list_params.rb +20 -12
  149. data/lib/increase/models/physical_card_profile.rb +33 -17
  150. data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
  151. data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
  152. data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
  153. data/lib/increase/models/physical_card_update_params.rb +2 -1
  154. data/lib/increase/models/program.rb +15 -8
  155. data/lib/increase/models/program_list_params.rb +3 -4
  156. data/lib/increase/models/real_time_decision.rb +561 -370
  157. data/lib/increase/models/real_time_decision_action_params.rb +86 -75
  158. data/lib/increase/models/real_time_payments_transfer.rb +90 -47
  159. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
  160. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
  161. data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
  162. data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
  163. data/lib/increase/models/routing_number_list_params.rb +3 -4
  164. data/lib/increase/models/routing_number_list_response.rb +11 -8
  165. data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
  166. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
  167. data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -4
  168. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
  169. data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
  170. data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
  171. data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
  172. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
  173. data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
  174. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
  175. data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
  176. data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
  177. data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
  178. data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
  179. data/lib/increase/models/simulations/card_settlement_create_params.rb +6 -5
  180. data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
  181. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
  182. data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
  183. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
  184. data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
  185. data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
  186. data/lib/increase/models/simulations/export_create_params.rb +5 -5
  187. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
  188. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
  189. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
  190. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
  191. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
  192. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
  193. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
  194. data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
  195. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
  196. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
  197. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
  198. data/lib/increase/models/simulations/program_create_params.rb +4 -2
  199. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
  200. data/lib/increase/models/supplemental_document_list_params.rb +8 -5
  201. data/lib/increase/models/swift_transfer.rb +48 -26
  202. data/lib/increase/models/swift_transfer_create_params.rb +28 -19
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +995 -534
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +6 -5
  207. data/lib/increase/models/wire_drawdown_request.rb +44 -26
  208. data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
  209. data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
  210. data/lib/increase/models/wire_transfer.rb +100 -55
  211. data/lib/increase/models/wire_transfer_create_params.rb +43 -26
  212. data/lib/increase/models/wire_transfer_list_params.rb +23 -16
  213. data/lib/increase/resources/account_numbers.rb +20 -16
  214. data/lib/increase/resources/account_statements.rb +3 -4
  215. data/lib/increase/resources/account_transfers.rb +20 -12
  216. data/lib/increase/resources/accounts.rb +19 -12
  217. data/lib/increase/resources/ach_prenotifications.rb +23 -13
  218. data/lib/increase/resources/ach_transfers.rb +93 -43
  219. data/lib/increase/resources/beneficial_owners.rb +35 -19
  220. data/lib/increase/resources/card_disputes.rb +43 -22
  221. data/lib/increase/resources/card_payments.rb +3 -4
  222. data/lib/increase/resources/card_purchase_supplements.rb +6 -5
  223. data/lib/increase/resources/card_push_transfers.rb +55 -24
  224. data/lib/increase/resources/card_tokens.rb +3 -4
  225. data/lib/increase/resources/card_validations.rb +19 -12
  226. data/lib/increase/resources/cards.rb +33 -22
  227. data/lib/increase/resources/check_deposits.rb +10 -9
  228. data/lib/increase/resources/check_transfers.rb +37 -17
  229. data/lib/increase/resources/declined_transactions.rb +3 -4
  230. data/lib/increase/resources/digital_card_profiles.rb +12 -7
  231. data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
  232. data/lib/increase/resources/entities.rb +69 -33
  233. data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
  234. data/lib/increase/resources/event_subscriptions.rb +22 -13
  235. data/lib/increase/resources/events.rb +10 -9
  236. data/lib/increase/resources/exports.rb +40 -22
  237. data/lib/increase/resources/external_accounts.rb +21 -14
  238. data/lib/increase/resources/fednow_transfers.rb +21 -14
  239. data/lib/increase/resources/file_links.rb +3 -4
  240. data/lib/increase/resources/files.rb +14 -10
  241. data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
  242. data/lib/increase/resources/inbound_check_deposits.rb +8 -6
  243. data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
  244. data/lib/increase/resources/inbound_mail_items.rb +7 -6
  245. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
  246. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
  247. data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
  248. data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
  249. data/lib/increase/resources/intrafi_exclusions.rb +17 -13
  250. data/lib/increase/resources/lockbox_addresses.rb +10 -6
  251. data/lib/increase/resources/lockbox_recipients.rb +17 -12
  252. data/lib/increase/resources/oauth_applications.rb +3 -4
  253. data/lib/increase/resources/oauth_connections.rb +6 -5
  254. data/lib/increase/resources/oauth_tokens.rb +14 -7
  255. data/lib/increase/resources/pending_transactions.rb +7 -8
  256. data/lib/increase/resources/physical_card_profiles.rb +18 -15
  257. data/lib/increase/resources/physical_cards.rb +17 -12
  258. data/lib/increase/resources/programs.rb +3 -4
  259. data/lib/increase/resources/real_time_decisions.rb +18 -9
  260. data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
  261. data/lib/increase/resources/routing_numbers.rb +3 -4
  262. data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
  263. data/lib/increase/resources/simulations/ach_transfers.rb +12 -14
  264. data/lib/increase/resources/simulations/card_authentications.rb +10 -8
  265. data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
  266. data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
  267. data/lib/increase/resources/simulations/card_disputes.rb +6 -5
  268. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
  269. data/lib/increase/resources/simulations/card_increments.rb +5 -4
  270. data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
  271. data/lib/increase/resources/simulations/card_refunds.rb +10 -6
  272. data/lib/increase/resources/simulations/card_reversals.rb +3 -4
  273. data/lib/increase/resources/simulations/card_settlements.rb +6 -5
  274. data/lib/increase/resources/simulations/card_tokens.rb +6 -3
  275. data/lib/increase/resources/simulations/check_deposits.rb +11 -9
  276. data/lib/increase/resources/simulations/entities.rb +3 -4
  277. data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
  278. data/lib/increase/resources/simulations/exports.rb +5 -5
  279. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
  280. data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
  281. data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
  282. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
  283. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
  284. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
  285. data/lib/increase/resources/simulations/interest_payments.rb +4 -5
  286. data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
  287. data/lib/increase/resources/simulations/physical_cards.rb +7 -6
  288. data/lib/increase/resources/simulations/programs.rb +4 -2
  289. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
  290. data/lib/increase/resources/supplemental_documents.rb +8 -5
  291. data/lib/increase/resources/swift_transfers.rb +28 -16
  292. data/lib/increase/resources/transactions.rb +6 -5
  293. data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
  294. data/lib/increase/resources/wire_transfers.rb +29 -16
  295. data/lib/increase/version.rb +1 -1
  296. data/rbi/increase/models/check_transfer.rbi +8 -0
  297. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  298. data/rbi/increase/models/entity_list_params.rbi +119 -0
  299. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  300. data/rbi/increase/resources/entities.rbi +3 -0
  301. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  302. data/sig/increase/models/check_transfer.rbs +5 -0
  303. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  304. data/sig/increase/models/entity_list_params.rbs +48 -1
  305. data/sig/increase/resources/entities.rbs +1 -0
  306. metadata +2 -2
@@ -162,9 +162,6 @@ module Increase
162
162
  required :unstructured_remittance_information, String
163
163
 
164
164
  # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
165
- # Some parameter documentations has been truncated, see
166
- # {Increase::Models::FednowTransfer} for more details.
167
- #
168
165
  # FedNow transfers move funds, within seconds, between your Increase account and
169
166
  # any other account supporting FedNow.
170
167
  #
@@ -174,47 +171,75 @@ module Increase
174
171
  #
175
172
  # @param account_number [String] The destination account number.
176
173
  #
177
- # @param acknowledgement [Increase::Models::FednowTransfer::Acknowledgement, nil] If the transfer is acknowledged by the recipient bank, this will contain supplem
174
+ # @param acknowledgement [Increase::Models::FednowTransfer::Acknowledgement, nil]
175
+ # If the transfer is acknowledged by the recipient bank, this will contain
176
+ # supplemental details.
178
177
  #
179
178
  # @param amount [Integer] The transfer amount in USD cents.
180
179
  #
181
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
180
+ # @param created_at [Time]
181
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
182
+ # the transfer was created.
182
183
  #
183
- # @param created_by [Increase::Models::FednowTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
184
+ # @param created_by [Increase::Models::FednowTransfer::CreatedBy, nil]
185
+ # What object created the transfer, either via the API or the dashboard.
184
186
  #
185
187
  # @param creditor_address [Increase::Models::FednowTransfer::CreditorAddress, nil] The creditor's address.
186
188
  #
187
- # @param creditor_name [String] The name of the transfer's recipient. This is set by the sender when creating th
189
+ # @param creditor_name [String]
190
+ # The name of the transfer's recipient. This is set by the sender when creating
191
+ # the transfer.
188
192
  #
189
- # @param currency [Symbol, Increase::Models::FednowTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
193
+ # @param currency [Symbol, Increase::Models::FednowTransfer::Currency]
194
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
195
+ # currency. For FedNow transfers this is always equal to `USD`.
190
196
  #
191
197
  # @param debtor_address [Increase::Models::FednowTransfer::DebtorAddress, nil] The debtor's address.
192
198
  #
193
- # @param debtor_name [String] The name of the transfer's sender. If not provided, defaults to the name of the
199
+ # @param debtor_name [String]
200
+ # The name of the transfer's sender. If not provided, defaults to the name of the
201
+ # account's entity.
194
202
  #
195
- # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
203
+ # @param external_account_id [String, nil]
204
+ # The identifier of the External Account the transfer was made to, if any.
196
205
  #
197
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
206
+ # @param idempotency_key [String, nil]
207
+ # The idempotency key you chose for this object. This value is unique across
208
+ # Increase and is used to ensure that a request is only processed once. Learn more
209
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
198
210
  #
199
211
  # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer.
200
212
  #
201
- # @param rejection [Increase::Models::FednowTransfer::Rejection, nil] If the transfer is rejected by FedNow or the destination financial institution,
213
+ # @param rejection [Increase::Models::FednowTransfer::Rejection, nil]
214
+ # If the transfer is rejected by FedNow or the destination financial institution,
215
+ # this will contain supplemental details.
202
216
  #
203
- # @param routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN)
217
+ # @param routing_number [String]
218
+ # The destination American Bankers' Association (ABA) Routing Transit Number
219
+ # (RTN).
204
220
  #
205
- # @param source_account_number_id [String] The Account Number the recipient will see as having sent the transfer.
221
+ # @param source_account_number_id [String]
222
+ # The Account Number the recipient will see as having sent the transfer.
206
223
  #
207
224
  # @param status [Symbol, Increase::Models::FednowTransfer::Status] The lifecycle status of the transfer.
208
225
  #
209
- # @param submission [Increase::Models::FednowTransfer::Submission, nil] After the transfer is submitted to FedNow, this will contain supplemental detail
226
+ # @param submission [Increase::Models::FednowTransfer::Submission, nil]
227
+ # After the transfer is submitted to FedNow, this will contain supplemental
228
+ # details.
210
229
  #
211
230
  # @param transaction_id [String, nil] The Transaction funding the transfer once it is complete.
212
231
  #
213
- # @param type [Symbol, Increase::Models::FednowTransfer::Type] A constant representing the object's type. For this resource it will always be `
232
+ # @param type [Symbol, Increase::Models::FednowTransfer::Type]
233
+ # A constant representing the object's type. For this resource it will always be
234
+ # `fednow_transfer`.
214
235
  #
215
- # @param unique_end_to_end_transaction_reference [String] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
236
+ # @param unique_end_to_end_transaction_reference [String]
237
+ # The Unique End-to-end Transaction Reference
238
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
239
+ # of the transfer.
216
240
  #
217
- # @param unstructured_remittance_information [String] Unstructured information that will show on the recipient's bank statement.
241
+ # @param unstructured_remittance_information [String]
242
+ # Unstructured information that will show on the recipient's bank statement.
218
243
 
219
244
  # @see Increase::Models::FednowTransfer#acknowledgement
220
245
  class Acknowledgement < Increase::Internal::Type::BaseModel
@@ -260,13 +285,17 @@ module Increase
260
285
  # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
261
286
  # What object created the transfer, either via the API or the dashboard.
262
287
  #
263
- # @param category [Symbol, Increase::Models::FednowTransfer::CreatedBy::Category] The type of object that created this transfer.
288
+ # @param category [Symbol, Increase::Models::FednowTransfer::CreatedBy::Category]
289
+ # The type of object that created this transfer.
264
290
  #
265
- # @param api_key [Increase::Models::FednowTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
291
+ # @param api_key [Increase::Models::FednowTransfer::CreatedBy::APIKey, nil]
292
+ # If present, details about the API key that created the transfer.
266
293
  #
267
- # @param oauth_application [Increase::Models::FednowTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
294
+ # @param oauth_application [Increase::Models::FednowTransfer::CreatedBy::OAuthApplication, nil]
295
+ # If present, details about the OAuth Application that created the transfer.
268
296
  #
269
- # @param user [Increase::Models::FednowTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
297
+ # @param user [Increase::Models::FednowTransfer::CreatedBy::User, nil]
298
+ # If present, details about the User that created the transfer.
270
299
 
271
300
  # The type of object that created this transfer.
272
301
  #
@@ -443,17 +472,19 @@ module Increase
443
472
  required :rejected_at, Time, nil?: true
444
473
 
445
474
  # @!method initialize(reject_reason_additional_information:, reject_reason_code:, rejected_at:)
446
- # Some parameter documentations has been truncated, see
447
- # {Increase::Models::FednowTransfer::Rejection} for more details.
448
- #
449
475
  # If the transfer is rejected by FedNow or the destination financial institution,
450
476
  # this will contain supplemental details.
451
477
  #
452
- # @param reject_reason_additional_information [String, nil] Additional information about the rejection provided by the recipient bank.
478
+ # @param reject_reason_additional_information [String, nil]
479
+ # Additional information about the rejection provided by the recipient bank.
453
480
  #
454
- # @param reject_reason_code [Symbol, Increase::Models::FednowTransfer::Rejection::RejectReasonCode] The reason the transfer was rejected as provided by the recipient bank or the Fe
481
+ # @param reject_reason_code [Symbol, Increase::Models::FednowTransfer::Rejection::RejectReasonCode]
482
+ # The reason the transfer was rejected as provided by the recipient bank or the
483
+ # FedNow network.
455
484
  #
456
- # @param rejected_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
485
+ # @param rejected_at [Time, nil]
486
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
487
+ # the transfer was rejected.
457
488
 
458
489
  # The reason the transfer was rejected as provided by the recipient bank or the
459
490
  # FedNow network.
@@ -565,15 +596,14 @@ module Increase
565
596
  required :submitted_at, Time, nil?: true
566
597
 
567
598
  # @!method initialize(message_identification:, submitted_at:)
568
- # Some parameter documentations has been truncated, see
569
- # {Increase::Models::FednowTransfer::Submission} for more details.
570
- #
571
599
  # After the transfer is submitted to FedNow, this will contain supplemental
572
600
  # details.
573
601
  #
574
602
  # @param message_identification [String] The FedNow network identification of the message submitted.
575
603
  #
576
- # @param submitted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
604
+ # @param submitted_at [Time, nil]
605
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
606
+ # the transfer was submitted to FedNow.
577
607
  end
578
608
 
579
609
  # A constant representing the object's type. For this resource it will always be
@@ -75,28 +75,31 @@ module Increase
75
75
  optional :routing_number, String
76
76
 
77
77
  # @!method initialize(amount:, creditor_name:, debtor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, creditor_address: nil, debtor_address: nil, external_account_id: nil, require_approval: nil, routing_number: nil, request_options: {})
78
- # Some parameter documentations has been truncated, see
79
- # {Increase::Models::FednowTransferCreateParams} for more details.
80
- #
81
78
  # @param amount [Integer] The amount, in minor units, to send to the creditor.
82
79
  #
83
80
  # @param creditor_name [String] The creditor's name.
84
81
  #
85
82
  # @param debtor_name [String] The debtor's name.
86
83
  #
87
- # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
84
+ # @param source_account_number_id [String]
85
+ # The Account Number to include in the transfer as the debtor's account number.
88
86
  #
89
- # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
87
+ # @param unstructured_remittance_information [String]
88
+ # Unstructured remittance information to include in the transfer.
90
89
  #
91
90
  # @param account_number [String] The creditor's account number.
92
91
  #
93
- # @param creditor_address [Increase::Models::FednowTransferCreateParams::CreditorAddress] The creditor's address.
92
+ # @param creditor_address [Increase::Models::FednowTransferCreateParams::CreditorAddress]
93
+ # The creditor's address.
94
94
  #
95
95
  # @param debtor_address [Increase::Models::FednowTransferCreateParams::DebtorAddress] The debtor's address.
96
96
  #
97
- # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
97
+ # @param external_account_id [String]
98
+ # The ID of an External Account to initiate a transfer to. If this parameter is
99
+ # provided, `account_number` and `routing_number` must be absent.
98
100
  #
99
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
101
+ # @param require_approval [Boolean]
102
+ # Whether the transfer requires explicit approval via the dashboard or API.
100
103
  #
101
104
  # @param routing_number [String] The creditor's bank account routing number.
102
105
  #
@@ -52,20 +52,24 @@ module Increase
52
52
  optional :status, -> { Increase::FednowTransferListParams::Status }
53
53
 
54
54
  # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
55
- # Some parameter documentations has been truncated, see
56
- # {Increase::Models::FednowTransferListParams} for more details.
57
- #
58
55
  # @param account_id [String] Filter FedNow Transfers to those that originated from the specified Account.
59
56
  #
60
57
  # @param created_at [Increase::Models::FednowTransferListParams::CreatedAt]
61
58
  #
62
59
  # @param cursor [String] Return the page of entries after this one.
63
60
  #
64
- # @param external_account_id [String] Filter FedNow Transfers to those made to the specified External Account.
61
+ # @param external_account_id [String]
62
+ # Filter FedNow Transfers to those made to the specified External Account.
65
63
  #
66
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
64
+ # @param idempotency_key [String]
65
+ # Filter records to the one with the specified `idempotency_key` you chose for
66
+ # that object. This value is unique across Increase and is used to ensure that a
67
+ # request is only processed once. Learn more about
68
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
67
69
  #
68
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
70
+ # @param limit [Integer]
71
+ # Limit the size of the list that is returned. The default (and maximum) is 100
72
+ # objects.
69
73
  #
70
74
  # @param status [Increase::Models::FednowTransferListParams::Status]
71
75
  #
@@ -101,16 +105,21 @@ module Increase
101
105
  optional :on_or_before, Time
102
106
 
103
107
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
104
- # Some parameter documentations has been truncated, see
105
- # {Increase::Models::FednowTransferListParams::CreatedAt} for more details.
106
- #
107
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
108
+ # @param after [Time]
109
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
110
+ # timestamp.
108
111
  #
109
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
112
+ # @param before [Time]
113
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
114
+ # timestamp.
110
115
  #
111
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
116
+ # @param on_or_after [Time]
117
+ # Return results on or after this
118
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
112
119
  #
113
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
120
+ # @param on_or_before [Time]
121
+ # Return results on or before this
122
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
114
123
  end
115
124
 
116
125
  class Status < Increase::Internal::Type::BaseModel
@@ -126,10 +135,9 @@ module Increase
126
135
  api_name: :in
127
136
 
128
137
  # @!method initialize(in_: nil)
129
- # Some parameter documentations has been truncated, see
130
- # {Increase::Models::FednowTransferListParams::Status} for more details.
131
- #
132
- # @param in_ [Array<Symbol, Increase::Models::FednowTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
138
+ # @param in_ [Array<Symbol, Increase::Models::FednowTransferListParams::Status::In>]
139
+ # Return results whose value is in the provided list. For GET requests, this
140
+ # should be encoded as a comma-delimited string, such as `?in=one,two,three`.
133
141
 
134
142
  module In
135
143
  extend Increase::Internal::Type::Enum
@@ -64,9 +64,6 @@ module Increase
64
64
  required :type, enum: -> { Increase::File::Type }
65
65
 
66
66
  # @!method initialize(id:, created_at:, description:, direction:, filename:, idempotency_key:, mime_type:, purpose:, type:)
67
- # Some parameter documentations has been truncated, see {Increase::Models::File}
68
- # for more details.
69
- #
70
67
  # Files are objects that represent a file hosted on Increase's servers. The file
71
68
  # may have been uploaded by you (for example, when uploading a check image) or it
72
69
  # may have been created by Increase (for example, an autogenerated statement PDF).
@@ -78,17 +75,26 @@ module Increase
78
75
  #
79
76
  # @param description [String, nil] A description of the File.
80
77
  #
81
- # @param direction [Symbol, Increase::Models::File::Direction] Whether the File was generated by Increase or by you and sent to Increase.
78
+ # @param direction [Symbol, Increase::Models::File::Direction]
79
+ # Whether the File was generated by Increase or by you and sent to Increase.
82
80
  #
83
81
  # @param filename [String, nil] The filename that was provided upon upload or generated by Increase.
84
82
  #
85
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
83
+ # @param idempotency_key [String, nil]
84
+ # The idempotency key you chose for this object. This value is unique across
85
+ # Increase and is used to ensure that a request is only processed once. Learn more
86
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
86
87
  #
87
88
  # @param mime_type [String] The MIME type of the file.
88
89
  #
89
- # @param purpose [Symbol, Increase::Models::File::Purpose] What the File will be used for. We may add additional possible values for this e
90
+ # @param purpose [Symbol, Increase::Models::File::Purpose]
91
+ # What the File will be used for. We may add additional possible values for this
92
+ # enum over time; your application should be able to handle such additions
93
+ # gracefully.
90
94
  #
91
- # @param type [Symbol, Increase::Models::File::Type] A constant representing the object's type. For this resource it will always be `
95
+ # @param type [Symbol, Increase::Models::File::Type]
96
+ # A constant representing the object's type. For this resource it will always be
97
+ # `file`.
92
98
 
93
99
  # Whether the File was generated by Increase or by you and sent to Increase.
94
100
  #
@@ -28,12 +28,13 @@ module Increase
28
28
  optional :description, String
29
29
 
30
30
  # @!method initialize(file:, purpose:, description: nil, request_options: {})
31
- # Some parameter documentations has been truncated, see
32
- # {Increase::Models::FileCreateParams} for more details.
31
+ # @param file [Pathname, StringIO, IO, String, Increase::FilePart]
32
+ # The file contents. This should follow the specifications of
33
+ # [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file
34
+ # transfers for the multipart/form-data protocol.
33
35
  #
34
- # @param file [Pathname, StringIO, IO, String, Increase::FilePart] The file contents. This should follow the specifications of [RFC 7578](https://d
35
- #
36
- # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] What the File will be used for in Increase's systems.
36
+ # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose]
37
+ # What the File will be used for in Increase's systems.
37
38
  #
38
39
  # @param description [String] The description you choose to give the File.
39
40
  #
@@ -54,24 +54,33 @@ module Increase
54
54
  required :unauthenticated_url, String
55
55
 
56
56
  # @!method initialize(id:, created_at:, expires_at:, file_id:, idempotency_key:, type:, unauthenticated_url:)
57
- # Some parameter documentations has been truncated, see
58
- # {Increase::Models::FileLink} for more details.
59
- #
60
57
  # File Links let you generate a URL that can be used to download a File.
61
58
  #
62
59
  # @param id [String] The File Link identifier.
63
60
  #
64
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Li
61
+ # @param created_at [Time]
62
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File
63
+ # Link was created.
65
64
  #
66
- # @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File Li
65
+ # @param expires_at [Time]
66
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the File
67
+ # Link will expire.
67
68
  #
68
69
  # @param file_id [String] The identifier of the File the File Link points to.
69
70
  #
70
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
71
+ # @param idempotency_key [String, nil]
72
+ # The idempotency key you chose for this object. This value is unique across
73
+ # Increase and is used to ensure that a request is only processed once. Learn more
74
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
71
75
  #
72
- # @param type [Symbol, Increase::Models::FileLink::Type] A constant representing the object's type. For this resource it will always be `
76
+ # @param type [Symbol, Increase::Models::FileLink::Type]
77
+ # A constant representing the object's type. For this resource it will always be
78
+ # `file_link`.
73
79
  #
74
- # @param unauthenticated_url [String] A URL where the File can be downloaded. The URL will expire after the `expires_a
80
+ # @param unauthenticated_url [String]
81
+ # A URL where the File can be downloaded. The URL will expire after the
82
+ # `expires_at` time. This URL is unauthenticated and can be used to download the
83
+ # File without an Increase API key.
75
84
 
76
85
  # A constant representing the object's type. For this resource it will always be
77
86
  # `file_link`.
@@ -21,12 +21,11 @@ module Increase
21
21
  optional :expires_at, Time
22
22
 
23
23
  # @!method initialize(file_id:, expires_at: nil, request_options: {})
24
- # Some parameter documentations has been truncated, see
25
- # {Increase::Models::FileLinkCreateParams} for more details.
26
- #
27
24
  # @param file_id [String] The File to create a File Link for.
28
25
  #
29
- # @param expires_at [Time] The time at which the File Link will expire. The default is 1 hour from the time
26
+ # @param expires_at [Time]
27
+ # The time at which the File Link will expire. The default is 1 hour from the time
28
+ # of the request. The maximum is 1 day from the time of the request.
30
29
  #
31
30
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
32
31
  end
@@ -40,16 +40,19 @@ module Increase
40
40
  optional :purpose, -> { Increase::FileListParams::Purpose }
41
41
 
42
42
  # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, purpose: nil, request_options: {})
43
- # Some parameter documentations has been truncated, see
44
- # {Increase::Models::FileListParams} for more details.
45
- #
46
43
  # @param created_at [Increase::Models::FileListParams::CreatedAt]
47
44
  #
48
45
  # @param cursor [String] Return the page of entries after this one.
49
46
  #
50
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
47
+ # @param idempotency_key [String]
48
+ # Filter records to the one with the specified `idempotency_key` you chose for
49
+ # that object. This value is unique across Increase and is used to ensure that a
50
+ # request is only processed once. Learn more about
51
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
51
52
  #
52
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
53
+ # @param limit [Integer]
54
+ # Limit the size of the list that is returned. The default (and maximum) is 100
55
+ # objects.
53
56
  #
54
57
  # @param purpose [Increase::Models::FileListParams::Purpose]
55
58
  #
@@ -85,16 +88,21 @@ module Increase
85
88
  optional :on_or_before, Time
86
89
 
87
90
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
88
- # Some parameter documentations has been truncated, see
89
- # {Increase::Models::FileListParams::CreatedAt} for more details.
90
- #
91
- # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
91
+ # @param after [Time]
92
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
93
+ # timestamp.
92
94
  #
93
- # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
95
+ # @param before [Time]
96
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
97
+ # timestamp.
94
98
  #
95
- # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
99
+ # @param on_or_after [Time]
100
+ # Return results on or after this
101
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
96
102
  #
97
- # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
103
+ # @param on_or_before [Time]
104
+ # Return results on or before this
105
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
98
106
  end
99
107
 
100
108
  class Purpose < Increase::Internal::Type::BaseModel
@@ -108,10 +116,9 @@ module Increase
108
116
  api_name: :in
109
117
 
110
118
  # @!method initialize(in_: nil)
111
- # Some parameter documentations has been truncated, see
112
- # {Increase::Models::FileListParams::Purpose} for more details.
113
- #
114
- # @param in_ [Array<Symbol, Increase::Models::FileListParams::Purpose::In>] Filter Files for those with the specified purpose or purposes. For GET requests,
119
+ # @param in_ [Array<Symbol, Increase::Models::FileListParams::Purpose::In>]
120
+ # Filter Files for those with the specified purpose or purposes. For GET requests,
121
+ # this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
115
122
 
116
123
  module In
117
124
  extend Increase::Internal::Type::Enum
@@ -25,9 +25,6 @@ module Increase
25
25
  required :type, enum: -> { Increase::Group::Type }
26
26
 
27
27
  # @!method initialize(id:, created_at:, type:)
28
- # Some parameter documentations has been truncated, see {Increase::Models::Group}
29
- # for more details.
30
- #
31
28
  # Groups represent organizations using Increase. You can retrieve information
32
29
  # about your own organization via the API. More commonly, OAuth platforms can
33
30
  # retrieve information about the organizations that have granted them access.
@@ -35,9 +32,13 @@ module Increase
35
32
  #
36
33
  # @param id [String] The Group identifier.
37
34
  #
38
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group w
35
+ # @param created_at [Time]
36
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
37
+ # was created.
39
38
  #
40
- # @param type [Symbol, Increase::Models::Group::Type] A constant representing the object's type. For this resource it will always be `
39
+ # @param type [Symbol, Increase::Models::Group::Type]
40
+ # A constant representing the object's type. For this resource it will always be
41
+ # `group`.
41
42
 
42
43
  # A constant representing the object's type. For this resource it will always be
43
44
  # `group`.