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
@@ -136,50 +136,78 @@ module Increase
136
136
  required :validation, -> { Increase::Entity::Validation }, nil?: true
137
137
 
138
138
  # @!method initialize(id:, corporation:, created_at:, creating_entity_onboarding_session_id:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:, validation:)
139
- # Some parameter documentations has been truncated, see {Increase::Models::Entity}
140
- # for more details.
141
- #
142
139
  # Entities are the legal entities that own accounts. They can be people,
143
140
  # corporations, joint accounts, trusts, or government authorities. To learn more,
144
141
  # see [Entities](/documentation/entities).
145
142
  #
146
143
  # @param id [String] The entity's identifier.
147
144
  #
148
- # @param corporation [Increase::Models::Entity::Corporation, nil] Details of the corporation entity. Will be present if `structure` is equal to `c
145
+ # @param corporation [Increase::Models::Entity::Corporation, nil]
146
+ # Details of the corporation entity. Will be present if `structure` is equal to
147
+ # `corporation`.
149
148
  #
150
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity
149
+ # @param created_at [Time]
150
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity
151
+ # was created.
151
152
  #
152
- # @param creating_entity_onboarding_session_id [String, nil] The identifier of the Entity Onboarding Session that was used to create this Ent
153
+ # @param creating_entity_onboarding_session_id [String, nil]
154
+ # The identifier of the Entity Onboarding Session that was used to create this
155
+ # Entity, if any.
153
156
  #
154
157
  # @param description [String, nil] The entity's description for display purposes.
155
158
  #
156
- # @param details_confirmed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity'
159
+ # @param details_confirmed_at [Time, nil]
160
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
161
+ # Entity's details were most recently confirmed.
157
162
  #
158
- # @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil] Details of the government authority entity. Will be present if `structure` is eq
163
+ # @param government_authority [Increase::Models::Entity::GovernmentAuthority, nil]
164
+ # Details of the government authority entity. Will be present if `structure` is
165
+ # equal to `government_authority`.
159
166
  #
160
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
167
+ # @param idempotency_key [String, nil]
168
+ # The idempotency key you chose for this object. This value is unique across
169
+ # Increase and is used to ensure that a request is only processed once. Learn more
170
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
161
171
  #
162
- # @param joint [Increase::Models::Entity::Joint, nil] Details of the joint entity. Will be present if `structure` is equal to `joint`.
172
+ # @param joint [Increase::Models::Entity::Joint, nil]
173
+ # Details of the joint entity. Will be present if `structure` is equal to `joint`.
163
174
  #
164
- # @param natural_person [Increase::Models::Entity::NaturalPerson, nil] Details of the natural person entity. Will be present if `structure` is equal to
175
+ # @param natural_person [Increase::Models::Entity::NaturalPerson, nil]
176
+ # Details of the natural person entity. Will be present if `structure` is equal to
177
+ # `natural_person`.
165
178
  #
166
- # @param risk_rating [Increase::Models::Entity::RiskRating, nil] An assessment of the entity’s potential risk of involvement in financial crimes,
179
+ # @param risk_rating [Increase::Models::Entity::RiskRating, nil]
180
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
181
+ # such as money laundering.
167
182
  #
168
183
  # @param status [Symbol, Increase::Models::Entity::Status] The status of the entity.
169
184
  #
170
185
  # @param structure [Symbol, Increase::Models::Entity::Structure] The entity's legal structure.
171
186
  #
172
- # @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>] Additional documentation associated with the entity. This is limited to the firs
187
+ # @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>]
188
+ # Additional documentation associated with the entity. This is limited to the
189
+ # first 10 documents for an entity. If an entity has more than 10 documents, use
190
+ # the GET /entity_supplemental_documents list endpoint to retrieve them.
173
191
  #
174
- # @param terms_agreements [Array<Increase::Models::Entity::TermsAgreement>] The terms that the Entity agreed to. Not all programs are required to submit thi
192
+ # @param terms_agreements [Array<Increase::Models::Entity::TermsAgreement>]
193
+ # The terms that the Entity agreed to. Not all programs are required to submit
194
+ # this data.
175
195
  #
176
- # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] If you are using a third-party service for identity verification, you can use th
196
+ # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil]
197
+ # If you are using a third-party service for identity verification, you can use
198
+ # this field to associate this Entity with the identifier that represents them in
199
+ # that service.
177
200
  #
178
- # @param trust [Increase::Models::Entity::Trust, nil] Details of the trust entity. Will be present if `structure` is equal to `trust`.
201
+ # @param trust [Increase::Models::Entity::Trust, nil]
202
+ # Details of the trust entity. Will be present if `structure` is equal to `trust`.
179
203
  #
180
- # @param type [Symbol, Increase::Models::Entity::Type] A constant representing the object's type. For this resource it will always be `
204
+ # @param type [Symbol, Increase::Models::Entity::Type]
205
+ # A constant representing the object's type. For this resource it will always be
206
+ # `entity`.
181
207
  #
182
- # @param validation [Increase::Models::Entity::Validation, nil] The validation results for the entity. Learn more about [validations](/documenta
208
+ # @param validation [Increase::Models::Entity::Validation, nil]
209
+ # The validation results for the entity. Learn more about
210
+ # [validations](/documentation/entity-validation).
183
211
 
184
212
  # @see Increase::Models::Entity#corporation
185
213
  class Corporation < Increase::Internal::Type::BaseModel
@@ -246,25 +274,32 @@ module Increase
246
274
  required :website, String, nil?: true
247
275
 
248
276
  # @!method initialize(address:, beneficial_owners:, beneficial_ownership_exemption_reason:, email:, incorporation_state:, industry_code:, legal_identifier:, name:, website:)
249
- # Some parameter documentations has been truncated, see
250
- # {Increase::Models::Entity::Corporation} for more details.
251
- #
252
277
  # Details of the corporation entity. Will be present if `structure` is equal to
253
278
  # `corporation`.
254
279
  #
255
280
  # @param address [Increase::Models::Entity::Corporation::Address] The corporation's address.
256
281
  #
257
- # @param beneficial_owners [Array<Increase::Models::Entity::Corporation::BeneficialOwner>] The identifying details of anyone controlling or owning 25% or more of the corpo
282
+ # @param beneficial_owners [Array<Increase::Models::Entity::Corporation::BeneficialOwner>]
283
+ # The identifying details of anyone controlling or owning 25% or more of the
284
+ # corporation.
258
285
  #
259
- # @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::Entity::Corporation::BeneficialOwnershipExemptionReason, nil] If the entity is exempt from the requirement to submit beneficial owners, the ju
286
+ # @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::Entity::Corporation::BeneficialOwnershipExemptionReason, nil]
287
+ # If the entity is exempt from the requirement to submit beneficial owners, the
288
+ # justification for the exemption.
260
289
  #
261
290
  # @param email [String, nil] An email address for the business.
262
291
  #
263
- # @param incorporation_state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the corporat
292
+ # @param incorporation_state [String, nil]
293
+ # The two-letter United States Postal Service (USPS) abbreviation for the
294
+ # corporation's state of incorporation.
264
295
  #
265
- # @param industry_code [String, nil] The numeric North American Industry Classification System (NAICS) code submitted
296
+ # @param industry_code [String, nil]
297
+ # The numeric North American Industry Classification System (NAICS) code submitted
298
+ # for the corporation.
266
299
  #
267
- # @param legal_identifier [Increase::Models::Entity::Corporation::LegalIdentifier, nil] The legal identifier of the corporation, like an Employer Identification Number
300
+ # @param legal_identifier [Increase::Models::Entity::Corporation::LegalIdentifier, nil]
301
+ # The legal identifier of the corporation, like an Employer Identification Number
302
+ # (EIN).
268
303
  #
269
304
  # @param name [String] The legal name of the corporation.
270
305
  #
@@ -310,9 +345,6 @@ module Increase
310
345
  required :zip, String, nil?: true
311
346
 
312
347
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
313
- # Some parameter documentations has been truncated, see
314
- # {Increase::Models::Entity::Corporation::Address} for more details.
315
- #
316
348
  # The corporation's address.
317
349
  #
318
350
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -323,7 +355,9 @@ module Increase
323
355
  #
324
356
  # @param line2 [String, nil] The second line of the address.
325
357
  #
326
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
358
+ # @param state [String, nil]
359
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
360
+ # state, province, or region of the address.
327
361
  #
328
362
  # @param zip [String, nil] The ZIP or postal code of the address.
329
363
  end
@@ -359,9 +393,11 @@ module Increase
359
393
  #
360
394
  # @param company_title [String, nil] This person's role or title within the entity.
361
395
  #
362
- # @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual] Personal details for the beneficial owner.
396
+ # @param individual [Increase::Models::Entity::Corporation::BeneficialOwner::Individual]
397
+ # Personal details for the beneficial owner.
363
398
  #
364
- # @param prongs [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>] Why this person is considered a beneficial owner of the entity.
399
+ # @param prongs [Array<Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Prong>]
400
+ # Why this person is considered a beneficial owner of the entity.
365
401
 
366
402
  # @see Increase::Models::Entity::Corporation::BeneficialOwner#individual
367
403
  class Individual < Increase::Internal::Type::BaseModel
@@ -394,11 +430,13 @@ module Increase
394
430
  # @!method initialize(address:, date_of_birth:, identification:, name:)
395
431
  # Personal details for the beneficial owner.
396
432
  #
397
- # @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address] The person's address.
433
+ # @param address [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address]
434
+ # The person's address.
398
435
  #
399
436
  # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
400
437
  #
401
- # @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification, nil] A means of verifying the person's identity.
438
+ # @param identification [Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification, nil]
439
+ # A means of verifying the person's identity.
402
440
  #
403
441
  # @param name [String] The person's legal name.
404
442
 
@@ -442,10 +480,6 @@ module Increase
442
480
  required :zip, String, nil?: true
443
481
 
444
482
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
445
- # Some parameter documentations has been truncated, see
446
- # {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Address}
447
- # for more details.
448
- #
449
483
  # The person's address.
450
484
  #
451
485
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -456,7 +490,9 @@ module Increase
456
490
  #
457
491
  # @param line2 [String, nil] The second line of the address.
458
492
  #
459
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
493
+ # @param state [String, nil]
494
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
495
+ # state, province, or region of the address.
460
496
  #
461
497
  # @param zip [String, nil] The ZIP or postal code of the address.
462
498
  end
@@ -481,15 +517,14 @@ module Increase
481
517
  required :number_last4, String
482
518
 
483
519
  # @!method initialize(method_:, number_last4:)
484
- # Some parameter documentations has been truncated, see
485
- # {Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification}
486
- # for more details.
487
- #
488
520
  # A means of verifying the person's identity.
489
521
  #
490
- # @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity.
522
+ # @param method_ [Symbol, Increase::Models::Entity::Corporation::BeneficialOwner::Individual::Identification::Method]
523
+ # A method that can be used to verify the individual's identity.
491
524
  #
492
- # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
525
+ # @param number_last4 [String]
526
+ # The last 4 digits of the identification number that can be used to verify the
527
+ # individual's identity.
493
528
 
494
529
  # A method that can be used to verify the individual's identity.
495
530
  #
@@ -573,7 +608,8 @@ module Increase
573
608
  # The legal identifier of the corporation, like an Employer Identification Number
574
609
  # (EIN).
575
610
  #
576
- # @param category [Symbol, Increase::Models::Entity::Corporation::LegalIdentifier::Category] The category of the legal identifier.
611
+ # @param category [Symbol, Increase::Models::Entity::Corporation::LegalIdentifier::Category]
612
+ # The category of the legal identifier.
577
613
  #
578
614
  # @param value [String] The legal identifier itself.
579
615
 
@@ -638,11 +674,14 @@ module Increase
638
674
  # Details of the government authority entity. Will be present if `structure` is
639
675
  # equal to `government_authority`.
640
676
  #
641
- # @param address [Increase::Models::Entity::GovernmentAuthority::Address] The government authority's address.
677
+ # @param address [Increase::Models::Entity::GovernmentAuthority::Address]
678
+ # The government authority's address.
642
679
  #
643
- # @param authorized_persons [Array<Increase::Models::Entity::GovernmentAuthority::AuthorizedPerson>] The identifying details of authorized persons of the government authority.
680
+ # @param authorized_persons [Array<Increase::Models::Entity::GovernmentAuthority::AuthorizedPerson>]
681
+ # The identifying details of authorized persons of the government authority.
644
682
  #
645
- # @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category] The category of the government authority.
683
+ # @param category [Symbol, Increase::Models::Entity::GovernmentAuthority::Category]
684
+ # The category of the government authority.
646
685
  #
647
686
  # @param name [String] The government authority's name.
648
687
  #
@@ -690,9 +729,6 @@ module Increase
690
729
  required :zip, String, nil?: true
691
730
 
692
731
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
693
- # Some parameter documentations has been truncated, see
694
- # {Increase::Models::Entity::GovernmentAuthority::Address} for more details.
695
- #
696
732
  # The government authority's address.
697
733
  #
698
734
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -703,7 +739,9 @@ module Increase
703
739
  #
704
740
  # @param line2 [String, nil] The second line of the address.
705
741
  #
706
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
742
+ # @param state [String, nil]
743
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
744
+ # state, province, or region of the address.
707
745
  #
708
746
  # @param zip [String, nil] The ZIP or postal code of the address.
709
747
  end
@@ -767,7 +805,8 @@ module Increase
767
805
  # @!method initialize(individuals:, name:)
768
806
  # Details of the joint entity. Will be present if `structure` is equal to `joint`.
769
807
  #
770
- # @param individuals [Array<Increase::Models::Entity::Joint::Individual>] The two individuals that share control of the entity.
808
+ # @param individuals [Array<Increase::Models::Entity::Joint::Individual>]
809
+ # The two individuals that share control of the entity.
771
810
  #
772
811
  # @param name [String] The entity's name.
773
812
 
@@ -801,7 +840,8 @@ module Increase
801
840
  #
802
841
  # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
803
842
  #
804
- # @param identification [Increase::Models::Entity::Joint::Individual::Identification, nil] A means of verifying the person's identity.
843
+ # @param identification [Increase::Models::Entity::Joint::Individual::Identification, nil]
844
+ # A means of verifying the person's identity.
805
845
  #
806
846
  # @param name [String] The person's legal name.
807
847
 
@@ -845,9 +885,6 @@ module Increase
845
885
  required :zip, String, nil?: true
846
886
 
847
887
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
848
- # Some parameter documentations has been truncated, see
849
- # {Increase::Models::Entity::Joint::Individual::Address} for more details.
850
- #
851
888
  # The person's address.
852
889
  #
853
890
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -858,7 +895,9 @@ module Increase
858
895
  #
859
896
  # @param line2 [String, nil] The second line of the address.
860
897
  #
861
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
898
+ # @param state [String, nil]
899
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
900
+ # state, province, or region of the address.
862
901
  #
863
902
  # @param zip [String, nil] The ZIP or postal code of the address.
864
903
  end
@@ -881,14 +920,14 @@ module Increase
881
920
  required :number_last4, String
882
921
 
883
922
  # @!method initialize(method_:, number_last4:)
884
- # Some parameter documentations has been truncated, see
885
- # {Increase::Models::Entity::Joint::Individual::Identification} for more details.
886
- #
887
923
  # A means of verifying the person's identity.
888
924
  #
889
- # @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method] A method that can be used to verify the individual's identity.
925
+ # @param method_ [Symbol, Increase::Models::Entity::Joint::Individual::Identification::Method]
926
+ # A method that can be used to verify the individual's identity.
890
927
  #
891
- # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
928
+ # @param number_last4 [String]
929
+ # The last 4 digits of the identification number that can be used to verify the
930
+ # individual's identity.
892
931
 
893
932
  # A method that can be used to verify the individual's identity.
894
933
  #
@@ -952,7 +991,8 @@ module Increase
952
991
  #
953
992
  # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
954
993
  #
955
- # @param identification [Increase::Models::Entity::NaturalPerson::Identification, nil] A means of verifying the person's identity.
994
+ # @param identification [Increase::Models::Entity::NaturalPerson::Identification, nil]
995
+ # A means of verifying the person's identity.
956
996
  #
957
997
  # @param name [String] The person's legal name.
958
998
 
@@ -996,9 +1036,6 @@ module Increase
996
1036
  required :zip, String, nil?: true
997
1037
 
998
1038
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
999
- # Some parameter documentations has been truncated, see
1000
- # {Increase::Models::Entity::NaturalPerson::Address} for more details.
1001
- #
1002
1039
  # The person's address.
1003
1040
  #
1004
1041
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -1009,7 +1046,9 @@ module Increase
1009
1046
  #
1010
1047
  # @param line2 [String, nil] The second line of the address.
1011
1048
  #
1012
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
1049
+ # @param state [String, nil]
1050
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1051
+ # state, province, or region of the address.
1013
1052
  #
1014
1053
  # @param zip [String, nil] The ZIP or postal code of the address.
1015
1054
  end
@@ -1034,14 +1073,14 @@ module Increase
1034
1073
  required :number_last4, String
1035
1074
 
1036
1075
  # @!method initialize(method_:, number_last4:)
1037
- # Some parameter documentations has been truncated, see
1038
- # {Increase::Models::Entity::NaturalPerson::Identification} for more details.
1039
- #
1040
1076
  # A means of verifying the person's identity.
1041
1077
  #
1042
- # @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method] A method that can be used to verify the individual's identity.
1078
+ # @param method_ [Symbol, Increase::Models::Entity::NaturalPerson::Identification::Method]
1079
+ # A method that can be used to verify the individual's identity.
1043
1080
  #
1044
- # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
1081
+ # @param number_last4 [String]
1082
+ # The last 4 digits of the identification number that can be used to verify the
1083
+ # individual's identity.
1045
1084
 
1046
1085
  # A method that can be used to verify the individual's identity.
1047
1086
  #
@@ -1086,13 +1125,12 @@ module Increase
1086
1125
  required :rating, enum: -> { Increase::Entity::RiskRating::Rating }
1087
1126
 
1088
1127
  # @!method initialize(rated_at:, rating:)
1089
- # Some parameter documentations has been truncated, see
1090
- # {Increase::Models::Entity::RiskRating} for more details.
1091
- #
1092
1128
  # An assessment of the entity’s potential risk of involvement in financial crimes,
1093
1129
  # such as money laundering.
1094
1130
  #
1095
- # @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
1131
+ # @param rated_at [Time]
1132
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1133
+ # rating was performed.
1096
1134
  #
1097
1135
  # @param rating [Symbol, Increase::Models::Entity::RiskRating::Rating] The rating given to this entity.
1098
1136
 
@@ -1180,9 +1218,6 @@ module Increase
1180
1218
  required :terms_url, String
1181
1219
 
1182
1220
  # @!method initialize(agreed_at:, ip_address:, terms_url:)
1183
- # Some parameter documentations has been truncated, see
1184
- # {Increase::Models::Entity::TermsAgreement} for more details.
1185
- #
1186
1221
  # @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
1187
1222
  #
1188
1223
  # @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
@@ -1211,7 +1246,8 @@ module Increase
1211
1246
  #
1212
1247
  # @param reference [String] The reference identifier for the third party verification.
1213
1248
  #
1214
- # @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification.
1249
+ # @param vendor [Symbol, Increase::Models::Entity::ThirdPartyVerification::Vendor]
1250
+ # The vendor that was used to perform the verification.
1215
1251
 
1216
1252
  # The vendor that was used to perform the verification.
1217
1253
  #
@@ -1291,20 +1327,22 @@ module Increase
1291
1327
  required :trustees, -> { Increase::Internal::Type::ArrayOf[Increase::Entity::Trust::Trustee] }
1292
1328
 
1293
1329
  # @!method initialize(address:, category:, formation_document_file_id:, formation_state:, grantor:, name:, tax_identifier:, trustees:)
1294
- # Some parameter documentations has been truncated, see
1295
- # {Increase::Models::Entity::Trust} for more details.
1296
- #
1297
1330
  # Details of the trust entity. Will be present if `structure` is equal to `trust`.
1298
1331
  #
1299
1332
  # @param address [Increase::Models::Entity::Trust::Address] The trust's address.
1300
1333
  #
1301
- # @param category [Symbol, Increase::Models::Entity::Trust::Category] Whether the trust is `revocable` or `irrevocable`.
1334
+ # @param category [Symbol, Increase::Models::Entity::Trust::Category]
1335
+ # Whether the trust is `revocable` or `irrevocable`.
1302
1336
  #
1303
- # @param formation_document_file_id [String, nil] The ID for the File containing the formation document of the trust.
1337
+ # @param formation_document_file_id [String, nil]
1338
+ # The ID for the File containing the formation document of the trust.
1304
1339
  #
1305
- # @param formation_state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the state in
1340
+ # @param formation_state [String, nil]
1341
+ # The two-letter United States Postal Service (USPS) abbreviation for the state in
1342
+ # which the trust was formed.
1306
1343
  #
1307
- # @param grantor [Increase::Models::Entity::Trust::Grantor, nil] The grantor of the trust. Will be present if the `category` is `revocable`.
1344
+ # @param grantor [Increase::Models::Entity::Trust::Grantor, nil]
1345
+ # The grantor of the trust. Will be present if the `category` is `revocable`.
1308
1346
  #
1309
1347
  # @param name [String] The trust's name.
1310
1348
  #
@@ -1352,9 +1390,6 @@ module Increase
1352
1390
  required :zip, String, nil?: true
1353
1391
 
1354
1392
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1355
- # Some parameter documentations has been truncated, see
1356
- # {Increase::Models::Entity::Trust::Address} for more details.
1357
- #
1358
1393
  # The trust's address.
1359
1394
  #
1360
1395
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -1365,7 +1400,9 @@ module Increase
1365
1400
  #
1366
1401
  # @param line2 [String, nil] The second line of the address.
1367
1402
  #
1368
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
1403
+ # @param state [String, nil]
1404
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1405
+ # state, province, or region of the address.
1369
1406
  #
1370
1407
  # @param zip [String, nil] The ZIP or postal code of the address.
1371
1408
  end
@@ -1419,7 +1456,8 @@ module Increase
1419
1456
  #
1420
1457
  # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
1421
1458
  #
1422
- # @param identification [Increase::Models::Entity::Trust::Grantor::Identification, nil] A means of verifying the person's identity.
1459
+ # @param identification [Increase::Models::Entity::Trust::Grantor::Identification, nil]
1460
+ # A means of verifying the person's identity.
1423
1461
  #
1424
1462
  # @param name [String] The person's legal name.
1425
1463
 
@@ -1463,9 +1501,6 @@ module Increase
1463
1501
  required :zip, String, nil?: true
1464
1502
 
1465
1503
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1466
- # Some parameter documentations has been truncated, see
1467
- # {Increase::Models::Entity::Trust::Grantor::Address} for more details.
1468
- #
1469
1504
  # The person's address.
1470
1505
  #
1471
1506
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -1476,7 +1511,9 @@ module Increase
1476
1511
  #
1477
1512
  # @param line2 [String, nil] The second line of the address.
1478
1513
  #
1479
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
1514
+ # @param state [String, nil]
1515
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1516
+ # state, province, or region of the address.
1480
1517
  #
1481
1518
  # @param zip [String, nil] The ZIP or postal code of the address.
1482
1519
  end
@@ -1499,14 +1536,14 @@ module Increase
1499
1536
  required :number_last4, String
1500
1537
 
1501
1538
  # @!method initialize(method_:, number_last4:)
1502
- # Some parameter documentations has been truncated, see
1503
- # {Increase::Models::Entity::Trust::Grantor::Identification} for more details.
1504
- #
1505
1539
  # A means of verifying the person's identity.
1506
1540
  #
1507
- # @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method] A method that can be used to verify the individual's identity.
1541
+ # @param method_ [Symbol, Increase::Models::Entity::Trust::Grantor::Identification::Method]
1542
+ # A method that can be used to verify the individual's identity.
1508
1543
  #
1509
- # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
1544
+ # @param number_last4 [String]
1545
+ # The last 4 digits of the identification number that can be used to verify the
1546
+ # individual's identity.
1510
1547
 
1511
1548
  # A method that can be used to verify the individual's identity.
1512
1549
  #
@@ -1550,12 +1587,12 @@ module Increase
1550
1587
  required :structure, enum: -> { Increase::Entity::Trust::Trustee::Structure }
1551
1588
 
1552
1589
  # @!method initialize(individual:, structure:)
1553
- # Some parameter documentations has been truncated, see
1554
- # {Increase::Models::Entity::Trust::Trustee} for more details.
1590
+ # @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil]
1591
+ # The individual trustee of the trust. Will be present if the trustee's
1592
+ # `structure` is equal to `individual`.
1555
1593
  #
1556
- # @param individual [Increase::Models::Entity::Trust::Trustee::Individual, nil] The individual trustee of the trust. Will be present if the trustee's `structure
1557
- #
1558
- # @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure] The structure of the trustee. Will always be equal to `individual`.
1594
+ # @param structure [Symbol, Increase::Models::Entity::Trust::Trustee::Structure]
1595
+ # The structure of the trustee. Will always be equal to `individual`.
1559
1596
 
1560
1597
  # @see Increase::Models::Entity::Trust::Trustee#individual
1561
1598
  class Individual < Increase::Internal::Type::BaseModel
@@ -1595,7 +1632,8 @@ module Increase
1595
1632
  #
1596
1633
  # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
1597
1634
  #
1598
- # @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification, nil] A means of verifying the person's identity.
1635
+ # @param identification [Increase::Models::Entity::Trust::Trustee::Individual::Identification, nil]
1636
+ # A means of verifying the person's identity.
1599
1637
  #
1600
1638
  # @param name [String] The person's legal name.
1601
1639
 
@@ -1639,10 +1677,6 @@ module Increase
1639
1677
  required :zip, String, nil?: true
1640
1678
 
1641
1679
  # @!method initialize(city:, country:, line1:, line2:, state:, zip:)
1642
- # Some parameter documentations has been truncated, see
1643
- # {Increase::Models::Entity::Trust::Trustee::Individual::Address} for more
1644
- # details.
1645
- #
1646
1680
  # The person's address.
1647
1681
  #
1648
1682
  # @param city [String, nil] The city, district, town, or village of the address.
@@ -1653,7 +1687,9 @@ module Increase
1653
1687
  #
1654
1688
  # @param line2 [String, nil] The second line of the address.
1655
1689
  #
1656
- # @param state [String, nil] The two-letter United States Postal Service (USPS) abbreviation for the US state
1690
+ # @param state [String, nil]
1691
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
1692
+ # state, province, or region of the address.
1657
1693
  #
1658
1694
  # @param zip [String, nil] The ZIP or postal code of the address.
1659
1695
  end
@@ -1676,15 +1712,14 @@ module Increase
1676
1712
  required :number_last4, String
1677
1713
 
1678
1714
  # @!method initialize(method_:, number_last4:)
1679
- # Some parameter documentations has been truncated, see
1680
- # {Increase::Models::Entity::Trust::Trustee::Individual::Identification} for more
1681
- # details.
1682
- #
1683
1715
  # A means of verifying the person's identity.
1684
1716
  #
1685
- # @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method] A method that can be used to verify the individual's identity.
1717
+ # @param method_ [Symbol, Increase::Models::Entity::Trust::Trustee::Individual::Identification::Method]
1718
+ # A method that can be used to verify the individual's identity.
1686
1719
  #
1687
- # @param number_last4 [String] The last 4 digits of the identification number that can be used to verify the in
1720
+ # @param number_last4 [String]
1721
+ # The last 4 digits of the identification number that can be used to verify the
1722
+ # individual's identity.
1688
1723
 
1689
1724
  # A method that can be used to verify the individual's identity.
1690
1725
  #
@@ -1757,15 +1792,15 @@ module Increase
1757
1792
  required :status, enum: -> { Increase::Entity::Validation::Status }
1758
1793
 
1759
1794
  # @!method initialize(issues:, status:)
1760
- # Some parameter documentations has been truncated, see
1761
- # {Increase::Models::Entity::Validation} for more details.
1762
- #
1763
1795
  # The validation results for the entity. Learn more about
1764
1796
  # [validations](/documentation/entity-validation).
1765
1797
  #
1766
- # @param issues [Array<Increase::Models::Entity::Validation::Issue>] The list of issues that need to be addressed.
1798
+ # @param issues [Array<Increase::Models::Entity::Validation::Issue>]
1799
+ # The list of issues that need to be addressed.
1767
1800
  #
1768
- # @param status [Symbol, Increase::Models::Entity::Validation::Status] The validation status for the entity. If the status is `invalid`, the `issues` a
1801
+ # @param status [Symbol, Increase::Models::Entity::Validation::Status]
1802
+ # The validation status for the entity. If the status is `invalid`, the `issues`
1803
+ # array will be populated.
1769
1804
 
1770
1805
  class Issue < Increase::Internal::Type::BaseModel
1771
1806
  # @!attribute beneficial_owner_address
@@ -1806,18 +1841,21 @@ module Increase
1806
1841
  nil?: true
1807
1842
 
1808
1843
  # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_tax_identifier:)
1809
- # Some parameter documentations has been truncated, see
1810
- # {Increase::Models::Entity::Validation::Issue} for more details.
1811
- #
1812
- # @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil] Details when the issue is with a beneficial owner's address.
1844
+ # @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil]
1845
+ # Details when the issue is with a beneficial owner's address.
1813
1846
  #
1814
- # @param beneficial_owner_identity [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil] Details when the issue is with a beneficial owner's identity verification.
1847
+ # @param beneficial_owner_identity [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil]
1848
+ # Details when the issue is with a beneficial owner's identity verification.
1815
1849
  #
1816
- # @param category [Symbol, Increase::Models::Entity::Validation::Issue::Category] The type of issue. We may add additional possible values for this enum over time
1850
+ # @param category [Symbol, Increase::Models::Entity::Validation::Issue::Category]
1851
+ # The type of issue. We may add additional possible values for this enum over
1852
+ # time; your application should be able to handle such additions gracefully.
1817
1853
  #
1818
- # @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil] Details when the issue is with the entity's address.
1854
+ # @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
1855
+ # Details when the issue is with the entity's address.
1819
1856
  #
1820
- # @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil] Details when the issue is with the entity's tax ID.
1857
+ # @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil]
1858
+ # Details when the issue is with the entity's tax ID.
1821
1859
 
1822
1860
  # @see Increase::Models::Entity::Validation::Issue#beneficial_owner_address
1823
1861
  class BeneficialOwnerAddress < Increase::Internal::Type::BaseModel
@@ -1838,7 +1876,8 @@ module Increase
1838
1876
  #
1839
1877
  # @param beneficial_owner_id [String] The ID of the beneficial owner.
1840
1878
  #
1841
- # @param reason [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason] The reason the address is invalid.
1879
+ # @param reason [Symbol, Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress::Reason]
1880
+ # The reason the address is invalid.
1842
1881
 
1843
1882
  # The reason the address is invalid.
1844
1883
  #
@@ -1902,7 +1941,8 @@ module Increase
1902
1941
  # @!method initialize(reason:)
1903
1942
  # Details when the issue is with the entity's address.
1904
1943
  #
1905
- # @param reason [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason] The reason the address is invalid.
1944
+ # @param reason [Symbol, Increase::Models::Entity::Validation::Issue::EntityAddress::Reason]
1945
+ # The reason the address is invalid.
1906
1946
 
1907
1947
  # The reason the address is invalid.
1908
1948
  #