increase 0.3.3 → 1.0.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 (1110) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +807 -56
  4. data/README.md +209 -254
  5. data/SECURITY.md +3 -0
  6. data/lib/increase/client.rb +287 -43
  7. data/lib/increase/errors.rb +223 -63
  8. data/lib/increase/file_part.rb +55 -0
  9. data/lib/increase/internal/page.rb +86 -0
  10. data/lib/increase/internal/transport/base_client.rb +555 -0
  11. data/lib/increase/internal/transport/pooled_net_requester.rb +209 -0
  12. data/lib/increase/internal/type/array_of.rb +162 -0
  13. data/lib/increase/internal/type/base_model.rb +484 -0
  14. data/lib/increase/internal/type/base_page.rb +55 -0
  15. data/lib/increase/internal/type/boolean.rb +71 -0
  16. data/lib/increase/internal/type/converter.rb +292 -0
  17. data/lib/increase/internal/type/enum.rb +123 -0
  18. data/lib/increase/internal/type/file_input.rb +103 -0
  19. data/lib/increase/internal/type/hash_of.rb +182 -0
  20. data/lib/increase/internal/type/request_parameters.rb +42 -0
  21. data/lib/increase/internal/type/union.rb +230 -0
  22. data/lib/increase/internal/type/unknown.rb +75 -0
  23. data/lib/increase/internal/util.rb +914 -0
  24. data/lib/increase/internal.rb +20 -0
  25. data/lib/increase/models/account.rb +224 -0
  26. data/lib/increase/models/account_balance_params.rb +22 -0
  27. data/lib/increase/models/account_close_params.rb +14 -0
  28. data/lib/increase/models/account_create_params.rb +51 -0
  29. data/lib/increase/models/account_list_params.rb +155 -0
  30. data/lib/increase/models/account_number.rb +209 -0
  31. data/lib/increase/models/account_number_create_params.rb +121 -0
  32. data/lib/increase/models/account_number_list_params.rb +183 -0
  33. data/lib/increase/models/account_number_retrieve_params.rb +14 -0
  34. data/lib/increase/models/account_number_update_params.rb +131 -0
  35. data/lib/increase/models/account_retrieve_params.rb +14 -0
  36. data/lib/increase/models/account_statement.rb +105 -0
  37. data/lib/increase/models/account_statement_list_params.rb +92 -0
  38. data/lib/increase/models/account_statement_retrieve_params.rb +14 -0
  39. data/lib/increase/models/account_transfer.rb +389 -0
  40. data/lib/increase/models/account_transfer_approve_params.rb +14 -0
  41. data/lib/increase/models/account_transfer_cancel_params.rb +14 -0
  42. data/lib/increase/models/account_transfer_create_params.rb +58 -0
  43. data/lib/increase/models/account_transfer_list_params.rb +102 -0
  44. data/lib/increase/models/account_transfer_retrieve_params.rb +14 -0
  45. data/lib/increase/models/account_update_params.rb +22 -0
  46. data/lib/increase/models/ach_prenotification.rb +562 -0
  47. data/lib/increase/models/ach_prenotification_create_params.rb +160 -0
  48. data/lib/increase/models/ach_prenotification_list_params.rb +94 -0
  49. data/lib/increase/models/ach_prenotification_retrieve_params.rb +14 -0
  50. data/lib/increase/models/ach_transfer.rb +1481 -0
  51. data/lib/increase/models/ach_transfer_approve_params.rb +14 -0
  52. data/lib/increase/models/ach_transfer_cancel_params.rb +14 -0
  53. data/lib/increase/models/ach_transfer_create_params.rb +430 -0
  54. data/lib/increase/models/ach_transfer_list_params.rb +168 -0
  55. data/lib/increase/models/ach_transfer_retrieve_params.rb +14 -0
  56. data/lib/increase/models/balance_lookup.rb +63 -0
  57. data/lib/increase/models/bookkeeping_account.rb +104 -0
  58. data/lib/increase/models/bookkeeping_account_balance_params.rb +22 -0
  59. data/lib/increase/models/bookkeeping_account_create_params.rb +60 -0
  60. data/lib/increase/models/bookkeeping_account_list_params.rb +45 -0
  61. data/lib/increase/models/bookkeeping_account_update_params.rb +22 -0
  62. data/lib/increase/models/bookkeeping_balance_lookup.rb +54 -0
  63. data/lib/increase/models/bookkeeping_entry.rb +79 -0
  64. data/lib/increase/models/bookkeeping_entry_list_params.rb +42 -0
  65. data/lib/increase/models/bookkeeping_entry_retrieve_params.rb +14 -0
  66. data/lib/increase/models/bookkeeping_entry_set.rb +116 -0
  67. data/lib/increase/models/bookkeeping_entry_set_create_params.rb +67 -0
  68. data/lib/increase/models/bookkeeping_entry_set_list_params.rb +53 -0
  69. data/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb +14 -0
  70. data/lib/increase/models/card.rb +243 -0
  71. data/lib/increase/models/card_create_params.rb +145 -0
  72. data/lib/increase/models/card_details.rb +78 -0
  73. data/lib/increase/models/card_details_params.rb +14 -0
  74. data/lib/increase/models/card_dispute.rb +302 -0
  75. data/lib/increase/models/card_dispute_create_params.rb +45 -0
  76. data/lib/increase/models/card_dispute_list_params.rb +144 -0
  77. data/lib/increase/models/card_dispute_retrieve_params.rb +14 -0
  78. data/lib/increase/models/card_list_params.rb +142 -0
  79. data/lib/increase/models/card_payment.rb +6511 -0
  80. data/lib/increase/models/card_payment_list_params.rb +99 -0
  81. data/lib/increase/models/card_payment_retrieve_params.rb +14 -0
  82. data/lib/increase/models/card_purchase_supplement.rb +452 -0
  83. data/lib/increase/models/card_purchase_supplement_list_params.rb +93 -0
  84. data/lib/increase/models/card_purchase_supplement_retrieve_params.rb +14 -0
  85. data/lib/increase/models/card_retrieve_params.rb +14 -0
  86. data/lib/increase/models/card_update_params.rb +158 -0
  87. data/lib/increase/models/check_deposit.rb +807 -0
  88. data/lib/increase/models/check_deposit_create_params.rb +57 -0
  89. data/lib/increase/models/check_deposit_list_params.rb +102 -0
  90. data/lib/increase/models/check_deposit_retrieve_params.rb +14 -0
  91. data/lib/increase/models/check_transfer.rb +983 -0
  92. data/lib/increase/models/check_transfer_approve_params.rb +14 -0
  93. data/lib/increase/models/check_transfer_cancel_params.rb +14 -0
  94. data/lib/increase/models/check_transfer_create_params.rb +324 -0
  95. data/lib/increase/models/check_transfer_list_params.rb +166 -0
  96. data/lib/increase/models/check_transfer_retrieve_params.rb +14 -0
  97. data/lib/increase/models/check_transfer_stop_payment_params.rb +39 -0
  98. data/lib/increase/models/declined_transaction.rb +1779 -0
  99. data/lib/increase/models/declined_transaction_list_params.rb +153 -0
  100. data/lib/increase/models/declined_transaction_retrieve_params.rb +14 -0
  101. data/lib/increase/models/digital_card_profile.rb +197 -0
  102. data/lib/increase/models/digital_card_profile_archive_params.rb +14 -0
  103. data/lib/increase/models/digital_card_profile_clone_params.rb +115 -0
  104. data/lib/increase/models/digital_card_profile_create_params.rb +115 -0
  105. data/lib/increase/models/digital_card_profile_list_params.rb +91 -0
  106. data/lib/increase/models/digital_card_profile_retrieve_params.rb +14 -0
  107. data/lib/increase/models/digital_wallet_token.rb +281 -0
  108. data/lib/increase/models/digital_wallet_token_list_params.rb +91 -0
  109. data/lib/increase/models/digital_wallet_token_retrieve_params.rb +14 -0
  110. data/lib/increase/models/document.rb +135 -0
  111. data/lib/increase/models/document_create_params.rb +62 -0
  112. data/lib/increase/models/document_list_params.rb +149 -0
  113. data/lib/increase/models/document_retrieve_params.rb +14 -0
  114. data/lib/increase/models/entity.rb +1476 -0
  115. data/lib/increase/models/entity_archive_beneficial_owner_params.rb +26 -0
  116. data/lib/increase/models/entity_archive_params.rb +14 -0
  117. data/lib/increase/models/entity_confirm_params.rb +26 -0
  118. data/lib/increase/models/entity_create_beneficial_owner_params.rb +412 -0
  119. data/lib/increase/models/entity_create_params.rb +2318 -0
  120. data/lib/increase/models/entity_list_params.rb +135 -0
  121. data/lib/increase/models/entity_retrieve_params.rb +14 -0
  122. data/lib/increase/models/entity_supplemental_document.rb +72 -0
  123. data/lib/increase/models/entity_update_address_params.rb +76 -0
  124. data/lib/increase/models/entity_update_beneficial_owner_address_params.rb +95 -0
  125. data/lib/increase/models/entity_update_industry_code_params.rb +28 -0
  126. data/lib/increase/models/event.rb +363 -0
  127. data/lib/increase/models/event_list_params.rb +395 -0
  128. data/lib/increase/models/event_retrieve_params.rb +14 -0
  129. data/lib/increase/models/event_subscription.rb +408 -0
  130. data/lib/increase/models/event_subscription_create_params.rb +334 -0
  131. data/lib/increase/models/event_subscription_list_params.rb +45 -0
  132. data/lib/increase/models/event_subscription_retrieve_params.rb +14 -0
  133. data/lib/increase/models/event_subscription_update_params.rb +39 -0
  134. data/lib/increase/models/export.rb +152 -0
  135. data/lib/increase/models/export_create_params.rb +444 -0
  136. data/lib/increase/models/export_list_params.rb +188 -0
  137. data/lib/increase/models/export_retrieve_params.rb +14 -0
  138. data/lib/increase/models/external_account.rb +166 -0
  139. data/lib/increase/models/external_account_create_params.rb +92 -0
  140. data/lib/increase/models/external_account_list_params.rb +93 -0
  141. data/lib/increase/models/external_account_retrieve_params.rb +14 -0
  142. data/lib/increase/models/external_account_update_params.rb +91 -0
  143. data/lib/increase/models/file.rb +213 -0
  144. data/lib/increase/models/file_create_params.rb +99 -0
  145. data/lib/increase/models/file_link.rb +90 -0
  146. data/lib/increase/models/file_link_create_params.rb +34 -0
  147. data/lib/increase/models/file_list_params.rb +203 -0
  148. data/lib/increase/models/file_retrieve_params.rb +14 -0
  149. data/lib/increase/models/group.rb +104 -0
  150. data/lib/increase/models/group_retrieve_params.rb +14 -0
  151. data/lib/increase/models/inbound_ach_transfer.rb +1095 -0
  152. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +30 -0
  153. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +69 -0
  154. data/lib/increase/models/inbound_ach_transfer_list_params.rb +145 -0
  155. data/lib/increase/models/inbound_ach_transfer_retrieve_params.rb +14 -0
  156. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +67 -0
  157. data/lib/increase/models/inbound_check_deposit.rb +391 -0
  158. data/lib/increase/models/inbound_check_deposit_decline_params.rb +14 -0
  159. data/lib/increase/models/inbound_check_deposit_list_params.rb +100 -0
  160. data/lib/increase/models/inbound_check_deposit_retrieve_params.rb +14 -0
  161. data/lib/increase/models/inbound_check_deposit_return_params.rb +45 -0
  162. data/lib/increase/models/inbound_mail_item.rb +132 -0
  163. data/lib/increase/models/inbound_mail_item_list_params.rb +91 -0
  164. data/lib/increase/models/inbound_mail_item_retrieve_params.rb +14 -0
  165. data/lib/increase/models/inbound_real_time_payments_transfer.rb +290 -0
  166. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +102 -0
  167. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +14 -0
  168. data/lib/increase/models/inbound_wire_drawdown_request.rb +221 -0
  169. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +34 -0
  170. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +14 -0
  171. data/lib/increase/models/inbound_wire_transfer.rb +307 -0
  172. data/lib/increase/models/inbound_wire_transfer_list_params.rb +145 -0
  173. data/lib/increase/models/inbound_wire_transfer_retrieve_params.rb +14 -0
  174. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +36 -0
  175. data/lib/increase/models/intrafi_account_enrollment.rb +121 -0
  176. data/lib/increase/models/intrafi_account_enrollment_create_params.rb +30 -0
  177. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +102 -0
  178. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +14 -0
  179. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +14 -0
  180. data/lib/increase/models/intrafi_balance.rb +180 -0
  181. data/lib/increase/models/intrafi_balance_intrafi_balance_params.rb +14 -0
  182. data/lib/increase/models/intrafi_exclusion.rb +134 -0
  183. data/lib/increase/models/intrafi_exclusion_archive_params.rb +14 -0
  184. data/lib/increase/models/intrafi_exclusion_create_params.rb +30 -0
  185. data/lib/increase/models/intrafi_exclusion_list_params.rb +53 -0
  186. data/lib/increase/models/intrafi_exclusion_retrieve_params.rb +14 -0
  187. data/lib/increase/models/lockbox.rb +182 -0
  188. data/lib/increase/models/lockbox_create_params.rb +38 -0
  189. data/lib/increase/models/lockbox_list_params.rb +102 -0
  190. data/lib/increase/models/lockbox_retrieve_params.rb +14 -0
  191. data/lib/increase/models/lockbox_update_params.rb +52 -0
  192. data/lib/increase/models/oauth_application.rb +106 -0
  193. data/lib/increase/models/oauth_application_list_params.rb +122 -0
  194. data/lib/increase/models/oauth_application_retrieve_params.rb +14 -0
  195. data/lib/increase/models/oauth_connection.rb +104 -0
  196. data/lib/increase/models/oauth_connection_list_params.rb +83 -0
  197. data/lib/increase/models/oauth_connection_retrieve_params.rb +14 -0
  198. data/lib/increase/models/oauth_token.rb +67 -0
  199. data/lib/increase/models/oauth_token_create_params.rb +78 -0
  200. data/lib/increase/models/pending_transaction.rb +1747 -0
  201. data/lib/increase/models/pending_transaction_create_params.rb +43 -0
  202. data/lib/increase/models/pending_transaction_list_params.rb +212 -0
  203. data/lib/increase/models/pending_transaction_release_params.rb +14 -0
  204. data/lib/increase/models/pending_transaction_retrieve_params.rb +14 -0
  205. data/lib/increase/models/physical_card.rb +433 -0
  206. data/lib/increase/models/physical_card_create_params.rb +185 -0
  207. data/lib/increase/models/physical_card_list_params.rb +102 -0
  208. data/lib/increase/models/physical_card_profile.rb +182 -0
  209. data/lib/increase/models/physical_card_profile_archive_params.rb +14 -0
  210. data/lib/increase/models/physical_card_profile_clone_params.rb +85 -0
  211. data/lib/increase/models/physical_card_profile_create_params.rb +93 -0
  212. data/lib/increase/models/physical_card_profile_list_params.rb +97 -0
  213. data/lib/increase/models/physical_card_profile_retrieve_params.rb +14 -0
  214. data/lib/increase/models/physical_card_retrieve_params.rb +14 -0
  215. data/lib/increase/models/physical_card_update_params.rb +39 -0
  216. data/lib/increase/models/program.rb +126 -0
  217. data/lib/increase/models/program_list_params.rb +34 -0
  218. data/lib/increase/models/program_retrieve_params.rb +14 -0
  219. data/lib/increase/models/real_time_decision.rb +1303 -0
  220. data/lib/increase/models/real_time_decision_action_params.rb +351 -0
  221. data/lib/increase/models/real_time_decision_retrieve_params.rb +14 -0
  222. data/lib/increase/models/real_time_payments_transfer.rb +622 -0
  223. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +14 -0
  224. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +14 -0
  225. data/lib/increase/models/real_time_payments_transfer_create_params.rb +112 -0
  226. data/lib/increase/models/real_time_payments_transfer_list_params.rb +169 -0
  227. data/lib/increase/models/real_time_payments_transfer_retrieve_params.rb +14 -0
  228. data/lib/increase/models/routing_number_list_params.rb +42 -0
  229. data/lib/increase/models/routing_number_list_response.rb +125 -0
  230. data/lib/increase/models/simulations/account_statement_create_params.rb +24 -0
  231. data/lib/increase/models/simulations/account_transfer_complete_params.rb +16 -0
  232. data/lib/increase/models/simulations/ach_transfer_acknowledge_params.rb +16 -0
  233. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +104 -0
  234. data/lib/increase/models/simulations/ach_transfer_return_params.rb +250 -0
  235. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +16 -0
  236. data/lib/increase/models/simulations/ach_transfer_submit_params.rb +16 -0
  237. data/lib/increase/models/simulations/card_authorization_create_params.rb +309 -0
  238. data/lib/increase/models/simulations/card_authorization_create_response.rb +59 -0
  239. data/lib/increase/models/simulations/card_authorization_expiration_create_params.rb +24 -0
  240. data/lib/increase/models/simulations/card_dispute_action_params.rb +55 -0
  241. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +37 -0
  242. data/lib/increase/models/simulations/card_increment_create_params.rb +46 -0
  243. data/lib/increase/models/simulations/card_refund_create_params.rb +28 -0
  244. data/lib/increase/models/simulations/card_reversal_create_params.rb +36 -0
  245. data/lib/increase/models/simulations/card_settlement_create_params.rb +45 -0
  246. data/lib/increase/models/simulations/check_deposit_reject_params.rb +16 -0
  247. data/lib/increase/models/simulations/check_deposit_return_params.rb +16 -0
  248. data/lib/increase/models/simulations/check_deposit_submit_params.rb +16 -0
  249. data/lib/increase/models/simulations/check_transfer_mail_params.rb +16 -0
  250. data/lib/increase/models/simulations/digital_wallet_token_request_create_params.rb +24 -0
  251. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +83 -0
  252. data/lib/increase/models/simulations/document_create_params.rb +24 -0
  253. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +241 -0
  254. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +40 -0
  255. data/lib/increase/models/simulations/inbound_funds_hold_release_params.rb +16 -0
  256. data/lib/increase/models/simulations/inbound_funds_hold_release_response.rb +161 -0
  257. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +44 -0
  258. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +77 -0
  259. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +186 -0
  260. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +171 -0
  261. data/lib/increase/models/simulations/interest_payment_create_params.rb +59 -0
  262. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +57 -0
  263. data/lib/increase/models/simulations/physical_card_tracking_updates_params.rb +81 -0
  264. data/lib/increase/models/simulations/program_create_params.rb +32 -0
  265. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +113 -0
  266. data/lib/increase/models/simulations/wire_transfer_reverse_params.rb +16 -0
  267. data/lib/increase/models/simulations/wire_transfer_submit_params.rb +16 -0
  268. data/lib/increase/models/supplemental_document_create_params.rb +30 -0
  269. data/lib/increase/models/supplemental_document_list_params.rb +53 -0
  270. data/lib/increase/models/transaction.rb +5823 -0
  271. data/lib/increase/models/transaction_list_params.rb +226 -0
  272. data/lib/increase/models/transaction_retrieve_params.rb +14 -0
  273. data/lib/increase/models/wire_drawdown_request.rb +249 -0
  274. data/lib/increase/models/wire_drawdown_request_create_params.rb +129 -0
  275. data/lib/increase/models/wire_drawdown_request_list_params.rb +91 -0
  276. data/lib/increase/models/wire_drawdown_request_retrieve_params.rb +14 -0
  277. data/lib/increase/models/wire_transfer.rb +677 -0
  278. data/lib/increase/models/wire_transfer_approve_params.rb +14 -0
  279. data/lib/increase/models/wire_transfer_cancel_params.rb +14 -0
  280. data/lib/increase/models/wire_transfer_create_params.rb +151 -0
  281. data/lib/increase/models/wire_transfer_list_params.rb +110 -0
  282. data/lib/increase/models/wire_transfer_retrieve_params.rb +14 -0
  283. data/lib/increase/models.rb +483 -0
  284. data/lib/increase/request_options.rb +77 -0
  285. data/lib/increase/resources/account_numbers.rb +130 -13
  286. data/lib/increase/resources/account_statements.rb +60 -9
  287. data/lib/increase/resources/account_transfers.rb +135 -15
  288. data/lib/increase/resources/accounts.rb +168 -15
  289. data/lib/increase/resources/ach_prenotifications.rb +109 -11
  290. data/lib/increase/resources/ach_transfers.rb +167 -15
  291. data/lib/increase/resources/bookkeeping_accounts.rb +120 -0
  292. data/lib/increase/resources/bookkeeping_entries.rb +64 -0
  293. data/lib/increase/resources/bookkeeping_entry_sets.rb +95 -0
  294. data/lib/increase/resources/card_disputes.rb +91 -11
  295. data/lib/increase/resources/card_payments.rb +68 -0
  296. data/lib/increase/resources/card_purchase_supplements.rb +66 -0
  297. data/lib/increase/resources/cards.rb +146 -15
  298. data/lib/increase/resources/check_deposits.rb +95 -11
  299. data/lib/increase/resources/check_transfers.rb +167 -17
  300. data/lib/increase/resources/declined_transactions.rb +64 -9
  301. data/lib/increase/resources/digital_card_profiles.rb +164 -0
  302. data/lib/increase/resources/digital_wallet_tokens.rb +60 -9
  303. data/lib/increase/resources/documents.rb +89 -10
  304. data/lib/increase/resources/entities.rb +293 -14
  305. data/lib/increase/resources/event_subscriptions.rb +113 -13
  306. data/lib/increase/resources/events.rb +62 -9
  307. data/lib/increase/resources/exports.rb +109 -0
  308. data/lib/increase/resources/external_accounts.rb +125 -13
  309. data/lib/increase/resources/file_links.rb +41 -0
  310. data/lib/increase/resources/files.rb +94 -11
  311. data/lib/increase/resources/groups.rb +26 -7
  312. data/lib/increase/resources/inbound_ach_transfers.rb +154 -0
  313. data/lib/increase/resources/inbound_check_deposits.rb +112 -0
  314. data/lib/increase/resources/inbound_mail_items.rb +66 -0
  315. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +68 -0
  316. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +56 -9
  317. data/lib/increase/resources/inbound_wire_transfers.rb +94 -0
  318. data/lib/increase/resources/intrafi_account_enrollments.rb +112 -0
  319. data/lib/increase/resources/intrafi_balances.rb +36 -0
  320. data/lib/increase/resources/intrafi_exclusions.rb +113 -0
  321. data/lib/increase/resources/lockboxes.rb +122 -0
  322. data/lib/increase/resources/oauth_applications.rb +66 -0
  323. data/lib/increase/resources/oauth_connections.rb +60 -9
  324. data/lib/increase/resources/oauth_tokens.rb +47 -0
  325. data/lib/increase/resources/pending_transactions.rb +122 -10
  326. data/lib/increase/resources/physical_card_profiles.rb +156 -0
  327. data/lib/increase/resources/physical_cards.rb +123 -0
  328. data/lib/increase/resources/programs.rb +62 -0
  329. data/lib/increase/resources/real_time_decisions.rb +63 -9
  330. data/lib/increase/resources/real_time_payments_transfers.rb +157 -0
  331. data/lib/increase/resources/routing_numbers.rb +41 -7
  332. data/lib/increase/resources/simulations/account_statements.rb +39 -0
  333. data/lib/increase/resources/simulations/account_transfers.rb +39 -0
  334. data/lib/increase/resources/simulations/ach_transfers.rb +151 -0
  335. data/lib/increase/resources/simulations/card_authorization_expirations.rb +38 -0
  336. data/lib/increase/resources/simulations/card_authorizations.rb +79 -0
  337. data/lib/increase/resources/simulations/card_disputes.rb +45 -0
  338. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +46 -0
  339. data/lib/increase/resources/simulations/card_increments.rb +46 -0
  340. data/lib/increase/resources/simulations/card_refunds.rb +42 -0
  341. data/lib/increase/resources/simulations/card_reversals.rb +46 -0
  342. data/lib/increase/resources/simulations/card_settlements.rb +49 -0
  343. data/lib/increase/resources/simulations/check_deposits.rb +80 -0
  344. data/lib/increase/resources/simulations/check_transfers.rb +39 -0
  345. data/lib/increase/resources/simulations/digital_wallet_token_requests.rb +39 -0
  346. data/lib/increase/resources/simulations/documents.rb +38 -0
  347. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +73 -0
  348. data/lib/increase/resources/simulations/inbound_check_deposits.rb +47 -0
  349. data/lib/increase/resources/simulations/inbound_funds_holds.rb +37 -0
  350. data/lib/increase/resources/simulations/inbound_mail_items.rb +46 -0
  351. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +56 -0
  352. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +81 -0
  353. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +74 -0
  354. data/lib/increase/resources/simulations/interest_payments.rb +50 -0
  355. data/lib/increase/resources/simulations/physical_cards.rb +79 -0
  356. data/lib/increase/resources/simulations/programs.rb +43 -0
  357. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +43 -0
  358. data/lib/increase/resources/simulations/wire_transfers.rb +61 -0
  359. data/lib/increase/resources/simulations.rb +127 -0
  360. data/lib/increase/resources/supplemental_documents.rb +70 -0
  361. data/lib/increase/resources/transactions.rb +64 -9
  362. data/lib/increase/resources/wire_drawdown_requests.rb +109 -11
  363. data/lib/increase/resources/wire_transfers.rb +159 -15
  364. data/lib/increase/version.rb +1 -1
  365. data/lib/increase.rb +386 -22
  366. data/manifest.yaml +15 -0
  367. data/rbi/increase/client.rbi +221 -0
  368. data/rbi/increase/errors.rbi +206 -0
  369. data/rbi/increase/file_part.rbi +37 -0
  370. data/rbi/increase/internal/page.rbi +22 -0
  371. data/rbi/increase/internal/transport/base_client.rbi +293 -0
  372. data/rbi/increase/internal/transport/pooled_net_requester.rbi +79 -0
  373. data/rbi/increase/internal/type/array_of.rbi +104 -0
  374. data/rbi/increase/internal/type/base_model.rbi +302 -0
  375. data/rbi/increase/internal/type/base_page.rbi +42 -0
  376. data/rbi/increase/internal/type/boolean.rbi +56 -0
  377. data/rbi/increase/internal/type/converter.rbi +162 -0
  378. data/rbi/increase/internal/type/enum.rbi +82 -0
  379. data/rbi/increase/internal/type/file_input.rbi +59 -0
  380. data/rbi/increase/internal/type/hash_of.rbi +104 -0
  381. data/rbi/increase/internal/type/request_parameters.rbi +29 -0
  382. data/rbi/increase/internal/type/union.rbi +116 -0
  383. data/rbi/increase/internal/type/unknown.rbi +56 -0
  384. data/rbi/increase/internal/util.rbi +487 -0
  385. data/rbi/increase/internal.rbi +16 -0
  386. data/rbi/increase/models/account.rbi +269 -0
  387. data/rbi/increase/models/account_balance_params.rbi +43 -0
  388. data/rbi/increase/models/account_close_params.rbi +27 -0
  389. data/rbi/increase/models/account_create_params.rbi +80 -0
  390. data/rbi/increase/models/account_list_params.rbi +280 -0
  391. data/rbi/increase/models/account_number.rbi +348 -0
  392. data/rbi/increase/models/account_number_create_params.rbi +262 -0
  393. data/rbi/increase/models/account_number_list_params.rbi +396 -0
  394. data/rbi/increase/models/account_number_retrieve_params.rbi +30 -0
  395. data/rbi/increase/models/account_number_update_params.rbi +320 -0
  396. data/rbi/increase/models/account_retrieve_params.rbi +27 -0
  397. data/rbi/increase/models/account_statement.rbi +136 -0
  398. data/rbi/increase/models/account_statement_list_params.rbi +167 -0
  399. data/rbi/increase/models/account_statement_retrieve_params.rbi +30 -0
  400. data/rbi/increase/models/account_transfer.rbi +634 -0
  401. data/rbi/increase/models/account_transfer_approve_params.rbi +30 -0
  402. data/rbi/increase/models/account_transfer_cancel_params.rbi +30 -0
  403. data/rbi/increase/models/account_transfer_create_params.rbi +83 -0
  404. data/rbi/increase/models/account_transfer_list_params.rbi +177 -0
  405. data/rbi/increase/models/account_transfer_retrieve_params.rbi +30 -0
  406. data/rbi/increase/models/account_update_params.rbi +43 -0
  407. data/rbi/increase/models/ach_prenotification.rbi +1094 -0
  408. data/rbi/increase/models/ach_prenotification_create_params.rbi +294 -0
  409. data/rbi/increase/models/ach_prenotification_list_params.rbi +168 -0
  410. data/rbi/increase/models/ach_prenotification_retrieve_params.rbi +30 -0
  411. data/rbi/increase/models/ach_transfer.rbi +2672 -0
  412. data/rbi/increase/models/ach_transfer_approve_params.rbi +27 -0
  413. data/rbi/increase/models/ach_transfer_cancel_params.rbi +27 -0
  414. data/rbi/increase/models/ach_transfer_create_params.rbi +904 -0
  415. data/rbi/increase/models/ach_transfer_list_params.rbi +330 -0
  416. data/rbi/increase/models/ach_transfer_retrieve_params.rbi +30 -0
  417. data/rbi/increase/models/balance_lookup.rbi +90 -0
  418. data/rbi/increase/models/bookkeeping_account.rbi +165 -0
  419. data/rbi/increase/models/bookkeeping_account_balance_params.rbi +46 -0
  420. data/rbi/increase/models/bookkeeping_account_create_params.rbi +130 -0
  421. data/rbi/increase/models/bookkeeping_account_list_params.rbi +79 -0
  422. data/rbi/increase/models/bookkeeping_account_update_params.rbi +43 -0
  423. data/rbi/increase/models/bookkeeping_balance_lookup.rbi +85 -0
  424. data/rbi/increase/models/bookkeeping_entry.rbi +108 -0
  425. data/rbi/increase/models/bookkeeping_entry_list_params.rbi +73 -0
  426. data/rbi/increase/models/bookkeeping_entry_retrieve_params.rbi +30 -0
  427. data/rbi/increase/models/bookkeeping_entry_set.rbi +162 -0
  428. data/rbi/increase/models/bookkeeping_entry_set_create_params.rbi +110 -0
  429. data/rbi/increase/models/bookkeeping_entry_set_list_params.rbi +90 -0
  430. data/rbi/increase/models/bookkeeping_entry_set_retrieve_params.rbi +30 -0
  431. data/rbi/increase/models/card.rbi +317 -0
  432. data/rbi/increase/models/card_create_params.rbi +241 -0
  433. data/rbi/increase/models/card_details.rbi +103 -0
  434. data/rbi/increase/models/card_details_params.rbi +27 -0
  435. data/rbi/increase/models/card_dispute.rbi +425 -0
  436. data/rbi/increase/models/card_dispute_create_params.rbi +70 -0
  437. data/rbi/increase/models/card_dispute_list_params.rbi +289 -0
  438. data/rbi/increase/models/card_dispute_retrieve_params.rbi +30 -0
  439. data/rbi/increase/models/card_list_params.rbi +252 -0
  440. data/rbi/increase/models/card_payment.rbi +11956 -0
  441. data/rbi/increase/models/card_payment_list_params.rbi +168 -0
  442. data/rbi/increase/models/card_payment_retrieve_params.rbi +30 -0
  443. data/rbi/increase/models/card_purchase_supplement.rbi +687 -0
  444. data/rbi/increase/models/card_purchase_supplement_list_params.rbi +168 -0
  445. data/rbi/increase/models/card_purchase_supplement_retrieve_params.rbi +30 -0
  446. data/rbi/increase/models/card_retrieve_params.rbi +27 -0
  447. data/rbi/increase/models/card_update_params.rbi +267 -0
  448. data/rbi/increase/models/check_deposit.rbi +1393 -0
  449. data/rbi/increase/models/check_deposit_create_params.rbi +78 -0
  450. data/rbi/increase/models/check_deposit_list_params.rbi +174 -0
  451. data/rbi/increase/models/check_deposit_retrieve_params.rbi +30 -0
  452. data/rbi/increase/models/check_transfer.rbi +1670 -0
  453. data/rbi/increase/models/check_transfer_approve_params.rbi +30 -0
  454. data/rbi/increase/models/check_transfer_cancel_params.rbi +30 -0
  455. data/rbi/increase/models/check_transfer_create_params.rbi +573 -0
  456. data/rbi/increase/models/check_transfer_list_params.rbi +332 -0
  457. data/rbi/increase/models/check_transfer_retrieve_params.rbi +30 -0
  458. data/rbi/increase/models/check_transfer_stop_payment_params.rbi +99 -0
  459. data/rbi/increase/models/declined_transaction.rbi +3355 -0
  460. data/rbi/increase/models/declined_transaction_list_params.rbi +322 -0
  461. data/rbi/increase/models/declined_transaction_retrieve_params.rbi +30 -0
  462. data/rbi/increase/models/digital_card_profile.rbi +258 -0
  463. data/rbi/increase/models/digital_card_profile_archive_params.rbi +30 -0
  464. data/rbi/increase/models/digital_card_profile_clone_params.rbi +188 -0
  465. data/rbi/increase/models/digital_card_profile_create_params.rbi +174 -0
  466. data/rbi/increase/models/digital_card_profile_list_params.rbi +203 -0
  467. data/rbi/increase/models/digital_card_profile_retrieve_params.rbi +30 -0
  468. data/rbi/increase/models/digital_wallet_token.rbi +508 -0
  469. data/rbi/increase/models/digital_wallet_token_list_params.rbi +162 -0
  470. data/rbi/increase/models/digital_wallet_token_retrieve_params.rbi +30 -0
  471. data/rbi/increase/models/document.rbi +198 -0
  472. data/rbi/increase/models/document_create_params.rbi +132 -0
  473. data/rbi/increase/models/document_list_params.rbi +289 -0
  474. data/rbi/increase/models/document_retrieve_params.rbi +27 -0
  475. data/rbi/increase/models/entity.rbi +2531 -0
  476. data/rbi/increase/models/entity_archive_beneficial_owner_params.rbi +48 -0
  477. data/rbi/increase/models/entity_archive_params.rbi +27 -0
  478. data/rbi/increase/models/entity_confirm_params.rbi +45 -0
  479. data/rbi/increase/models/entity_create_beneficial_owner_params.rbi +764 -0
  480. data/rbi/increase/models/entity_create_params.rbi +4200 -0
  481. data/rbi/increase/models/entity_list_params.rbi +256 -0
  482. data/rbi/increase/models/entity_retrieve_params.rbi +27 -0
  483. data/rbi/increase/models/entity_supplemental_document.rbi +108 -0
  484. data/rbi/increase/models/entity_update_address_params.rbi +129 -0
  485. data/rbi/increase/models/entity_update_beneficial_owner_address_params.rbi +163 -0
  486. data/rbi/increase/models/entity_update_industry_code_params.rbi +49 -0
  487. data/rbi/increase/models/event.rbi +698 -0
  488. data/rbi/increase/models/event_list_params.rbi +862 -0
  489. data/rbi/increase/models/event_retrieve_params.rbi +27 -0
  490. data/rbi/increase/models/event_subscription.rbi +833 -0
  491. data/rbi/increase/models/event_subscription_create_params.rbi +753 -0
  492. data/rbi/increase/models/event_subscription_list_params.rbi +79 -0
  493. data/rbi/increase/models/event_subscription_retrieve_params.rbi +30 -0
  494. data/rbi/increase/models/event_subscription_update_params.rbi +99 -0
  495. data/rbi/increase/models/export.rbi +196 -0
  496. data/rbi/increase/models/export_create_params.rbi +933 -0
  497. data/rbi/increase/models/export_list_params.rbi +386 -0
  498. data/rbi/increase/models/export_retrieve_params.rbi +27 -0
  499. data/rbi/increase/models/external_account.rbi +236 -0
  500. data/rbi/increase/models/external_account_create_params.rbi +191 -0
  501. data/rbi/increase/models/external_account_list_params.rbi +198 -0
  502. data/rbi/increase/models/external_account_retrieve_params.rbi +30 -0
  503. data/rbi/increase/models/external_account_update_params.rbi +223 -0
  504. data/rbi/increase/models/file.rbi +291 -0
  505. data/rbi/increase/models/file_create_params.rbi +188 -0
  506. data/rbi/increase/models/file_link.rbi +115 -0
  507. data/rbi/increase/models/file_link_create_params.rbi +56 -0
  508. data/rbi/increase/models/file_list_params.rbi +410 -0
  509. data/rbi/increase/models/file_retrieve_params.rbi +27 -0
  510. data/rbi/increase/models/group.rbi +139 -0
  511. data/rbi/increase/models/group_retrieve_params.rbi +27 -0
  512. data/rbi/increase/models/inbound_ach_transfer.rbi +1898 -0
  513. data/rbi/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbi +60 -0
  514. data/rbi/increase/models/inbound_ach_transfer_decline_params.rbi +154 -0
  515. data/rbi/increase/models/inbound_ach_transfer_list_params.rbi +297 -0
  516. data/rbi/increase/models/inbound_ach_transfer_retrieve_params.rbi +30 -0
  517. data/rbi/increase/models/inbound_ach_transfer_transfer_return_params.rbi +149 -0
  518. data/rbi/increase/models/inbound_check_deposit.rbi +609 -0
  519. data/rbi/increase/models/inbound_check_deposit_decline_params.rbi +30 -0
  520. data/rbi/increase/models/inbound_check_deposit_list_params.rbi +176 -0
  521. data/rbi/increase/models/inbound_check_deposit_retrieve_params.rbi +30 -0
  522. data/rbi/increase/models/inbound_check_deposit_return_params.rbi +104 -0
  523. data/rbi/increase/models/inbound_mail_item.rbi +201 -0
  524. data/rbi/increase/models/inbound_mail_item_list_params.rbi +160 -0
  525. data/rbi/increase/models/inbound_mail_item_retrieve_params.rbi +30 -0
  526. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +516 -0
  527. data/rbi/increase/models/inbound_real_time_payments_transfer_list_params.rbi +184 -0
  528. data/rbi/increase/models/inbound_real_time_payments_transfer_retrieve_params.rbi +30 -0
  529. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +261 -0
  530. data/rbi/increase/models/inbound_wire_drawdown_request_list_params.rbi +62 -0
  531. data/rbi/increase/models/inbound_wire_drawdown_request_retrieve_params.rbi +30 -0
  532. data/rbi/increase/models/inbound_wire_transfer.rbi +400 -0
  533. data/rbi/increase/models/inbound_wire_transfer_list_params.rbi +300 -0
  534. data/rbi/increase/models/inbound_wire_transfer_retrieve_params.rbi +30 -0
  535. data/rbi/increase/models/inbound_wire_transfer_reverse_params.rbi +84 -0
  536. data/rbi/increase/models/intrafi_account_enrollment.rbi +185 -0
  537. data/rbi/increase/models/intrafi_account_enrollment_create_params.rbi +54 -0
  538. data/rbi/increase/models/intrafi_account_enrollment_list_params.rbi +226 -0
  539. data/rbi/increase/models/intrafi_account_enrollment_retrieve_params.rbi +30 -0
  540. data/rbi/increase/models/intrafi_account_enrollment_unenroll_params.rbi +30 -0
  541. data/rbi/increase/models/intrafi_balance.rbi +262 -0
  542. data/rbi/increase/models/intrafi_balance_intrafi_balance_params.rbi +30 -0
  543. data/rbi/increase/models/intrafi_exclusion.rbi +176 -0
  544. data/rbi/increase/models/intrafi_exclusion_archive_params.rbi +30 -0
  545. data/rbi/increase/models/intrafi_exclusion_create_params.rbi +54 -0
  546. data/rbi/increase/models/intrafi_exclusion_list_params.rbi +90 -0
  547. data/rbi/increase/models/intrafi_exclusion_retrieve_params.rbi +30 -0
  548. data/rbi/increase/models/lockbox.rbi +232 -0
  549. data/rbi/increase/models/lockbox_create_params.rbi +65 -0
  550. data/rbi/increase/models/lockbox_list_params.rbi +172 -0
  551. data/rbi/increase/models/lockbox_retrieve_params.rbi +27 -0
  552. data/rbi/increase/models/lockbox_update_params.rbi +97 -0
  553. data/rbi/increase/models/oauth_application.rbi +146 -0
  554. data/rbi/increase/models/oauth_application_list_params.rbi +259 -0
  555. data/rbi/increase/models/oauth_application_retrieve_params.rbi +30 -0
  556. data/rbi/increase/models/oauth_connection.rbi +142 -0
  557. data/rbi/increase/models/oauth_connection_list_params.rbi +183 -0
  558. data/rbi/increase/models/oauth_connection_retrieve_params.rbi +30 -0
  559. data/rbi/increase/models/oauth_token.rbi +98 -0
  560. data/rbi/increase/models/oauth_token_create_params.rbi +133 -0
  561. data/rbi/increase/models/pending_transaction.rbi +3220 -0
  562. data/rbi/increase/models/pending_transaction_create_params.rbi +69 -0
  563. data/rbi/increase/models/pending_transaction_list_params.rbi +475 -0
  564. data/rbi/increase/models/pending_transaction_release_params.rbi +30 -0
  565. data/rbi/increase/models/pending_transaction_retrieve_params.rbi +30 -0
  566. data/rbi/increase/models/physical_card.rbi +691 -0
  567. data/rbi/increase/models/physical_card_create_params.rbi +327 -0
  568. data/rbi/increase/models/physical_card_list_params.rbi +174 -0
  569. data/rbi/increase/models/physical_card_profile.rbi +245 -0
  570. data/rbi/increase/models/physical_card_profile_archive_params.rbi +30 -0
  571. data/rbi/increase/models/physical_card_profile_clone_params.rbi +143 -0
  572. data/rbi/increase/models/physical_card_profile_create_params.rbi +139 -0
  573. data/rbi/increase/models/physical_card_profile_list_params.rbi +219 -0
  574. data/rbi/increase/models/physical_card_profile_retrieve_params.rbi +30 -0
  575. data/rbi/increase/models/physical_card_retrieve_params.rbi +30 -0
  576. data/rbi/increase/models/physical_card_update_params.rbi +83 -0
  577. data/rbi/increase/models/program.rbi +155 -0
  578. data/rbi/increase/models/program_list_params.rbi +59 -0
  579. data/rbi/increase/models/program_retrieve_params.rbi +27 -0
  580. data/rbi/increase/models/real_time_decision.rbi +2466 -0
  581. data/rbi/increase/models/real_time_decision_action_params.rbi +806 -0
  582. data/rbi/increase/models/real_time_decision_retrieve_params.rbi +30 -0
  583. data/rbi/increase/models/real_time_payments_transfer.rbi +1151 -0
  584. data/rbi/increase/models/real_time_payments_transfer_approve_params.rbi +30 -0
  585. data/rbi/increase/models/real_time_payments_transfer_cancel_params.rbi +30 -0
  586. data/rbi/increase/models/real_time_payments_transfer_create_params.rbi +161 -0
  587. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +351 -0
  588. data/rbi/increase/models/real_time_payments_transfer_retrieve_params.rbi +30 -0
  589. data/rbi/increase/models/routing_number_list_params.rbi +67 -0
  590. data/rbi/increase/models/routing_number_list_response.rbi +246 -0
  591. data/rbi/increase/models/simulations/account_statement_create_params.rbi +45 -0
  592. data/rbi/increase/models/simulations/account_transfer_complete_params.rbi +32 -0
  593. data/rbi/increase/models/simulations/ach_transfer_acknowledge_params.rbi +32 -0
  594. data/rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +219 -0
  595. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +581 -0
  596. data/rbi/increase/models/simulations/ach_transfer_settle_params.rbi +32 -0
  597. data/rbi/increase/models/simulations/ach_transfer_submit_params.rbi +32 -0
  598. data/rbi/increase/models/simulations/card_authorization_create_params.rbi +648 -0
  599. data/rbi/increase/models/simulations/card_authorization_create_response.rbi +123 -0
  600. data/rbi/increase/models/simulations/card_authorization_expiration_create_params.rbi +48 -0
  601. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +124 -0
  602. data/rbi/increase/models/simulations/card_fuel_confirmation_create_params.rbi +58 -0
  603. data/rbi/increase/models/simulations/card_increment_create_params.rbi +73 -0
  604. data/rbi/increase/models/simulations/card_refund_create_params.rbi +50 -0
  605. data/rbi/increase/models/simulations/card_reversal_create_params.rbi +61 -0
  606. data/rbi/increase/models/simulations/card_settlement_create_params.rbi +71 -0
  607. data/rbi/increase/models/simulations/check_deposit_reject_params.rbi +32 -0
  608. data/rbi/increase/models/simulations/check_deposit_return_params.rbi +32 -0
  609. data/rbi/increase/models/simulations/check_deposit_submit_params.rbi +32 -0
  610. data/rbi/increase/models/simulations/check_transfer_mail_params.rbi +32 -0
  611. data/rbi/increase/models/simulations/digital_wallet_token_request_create_params.rbi +45 -0
  612. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +167 -0
  613. data/rbi/increase/models/simulations/document_create_params.rbi +45 -0
  614. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +508 -0
  615. data/rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi +64 -0
  616. data/rbi/increase/models/simulations/inbound_funds_hold_release_params.rbi +32 -0
  617. data/rbi/increase/models/simulations/inbound_funds_hold_release_response.rbi +280 -0
  618. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +69 -0
  619. data/rbi/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbi +113 -0
  620. data/rbi/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbi +248 -0
  621. data/rbi/increase/models/simulations/inbound_wire_transfer_create_params.rbi +251 -0
  622. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +89 -0
  623. data/rbi/increase/models/simulations/physical_card_advance_shipment_params.rbi +134 -0
  624. data/rbi/increase/models/simulations/physical_card_tracking_updates_params.rbi +152 -0
  625. data/rbi/increase/models/simulations/program_create_params.rbi +59 -0
  626. data/rbi/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +277 -0
  627. data/rbi/increase/models/simulations/wire_transfer_reverse_params.rbi +32 -0
  628. data/rbi/increase/models/simulations/wire_transfer_submit_params.rbi +32 -0
  629. data/rbi/increase/models/supplemental_document_create_params.rbi +54 -0
  630. data/rbi/increase/models/supplemental_document_list_params.rbi +87 -0
  631. data/rbi/increase/models/transaction.rbi +10456 -0
  632. data/rbi/increase/models/transaction_list_params.rbi +473 -0
  633. data/rbi/increase/models/transaction_retrieve_params.rbi +30 -0
  634. data/rbi/increase/models/wire_drawdown_request.rbi +324 -0
  635. data/rbi/increase/models/wire_drawdown_request_create_params.rbi +179 -0
  636. data/rbi/increase/models/wire_drawdown_request_list_params.rbi +205 -0
  637. data/rbi/increase/models/wire_drawdown_request_retrieve_params.rbi +30 -0
  638. data/rbi/increase/models/wire_transfer.rbi +974 -0
  639. data/rbi/increase/models/wire_transfer_approve_params.rbi +30 -0
  640. data/rbi/increase/models/wire_transfer_cancel_params.rbi +27 -0
  641. data/rbi/increase/models/wire_transfer_create_params.rbi +211 -0
  642. data/rbi/increase/models/wire_transfer_list_params.rbi +185 -0
  643. data/rbi/increase/models/wire_transfer_retrieve_params.rbi +30 -0
  644. data/rbi/increase/models.rbi +517 -0
  645. data/rbi/increase/request_options.rbi +59 -0
  646. data/rbi/increase/resources/account_numbers.rbi +113 -0
  647. data/rbi/increase/resources/account_statements.rbi +50 -0
  648. data/rbi/increase/resources/account_transfers.rbi +110 -0
  649. data/rbi/increase/resources/accounts.rbi +137 -0
  650. data/rbi/increase/resources/ach_prenotifications.rbi +107 -0
  651. data/rbi/increase/resources/ach_transfers.rbi +179 -0
  652. data/rbi/increase/resources/bookkeeping_accounts.rbi +94 -0
  653. data/rbi/increase/resources/bookkeeping_entries.rbi +47 -0
  654. data/rbi/increase/resources/bookkeeping_entry_sets.rbi +75 -0
  655. data/rbi/increase/resources/card_disputes.rbi +78 -0
  656. data/rbi/increase/resources/card_payments.rbi +52 -0
  657. data/rbi/increase/resources/card_purchase_supplements.rbi +51 -0
  658. data/rbi/increase/resources/cards.rbi +134 -0
  659. data/rbi/increase/resources/check_deposits.rbi +81 -0
  660. data/rbi/increase/resources/check_transfers.rbi +146 -0
  661. data/rbi/increase/resources/declined_transactions.rbi +55 -0
  662. data/rbi/increase/resources/digital_card_profiles.rbi +147 -0
  663. data/rbi/increase/resources/digital_wallet_tokens.rbi +49 -0
  664. data/rbi/increase/resources/documents.rbi +75 -0
  665. data/rbi/increase/resources/entities.rbi +241 -0
  666. data/rbi/increase/resources/event_subscriptions.rbi +94 -0
  667. data/rbi/increase/resources/events.rbi +51 -0
  668. data/rbi/increase/resources/exports.rbi +94 -0
  669. data/rbi/increase/resources/external_accounts.rbi +110 -0
  670. data/rbi/increase/resources/file_links.rbi +30 -0
  671. data/rbi/increase/resources/files.rbi +78 -0
  672. data/rbi/increase/resources/groups.rbi +21 -0
  673. data/rbi/increase/resources/inbound_ach_transfers.rbi +114 -0
  674. data/rbi/increase/resources/inbound_check_deposits.rbi +85 -0
  675. data/rbi/increase/resources/inbound_mail_items.rbi +49 -0
  676. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +57 -0
  677. data/rbi/increase/resources/inbound_wire_drawdown_requests.rbi +46 -0
  678. data/rbi/increase/resources/inbound_wire_transfers.rbi +72 -0
  679. data/rbi/increase/resources/intrafi_account_enrollments.rbi +86 -0
  680. data/rbi/increase/resources/intrafi_balances.rbi +28 -0
  681. data/rbi/increase/resources/intrafi_exclusions.rbi +86 -0
  682. data/rbi/increase/resources/lockboxes.rbi +98 -0
  683. data/rbi/increase/resources/oauth_applications.rbi +48 -0
  684. data/rbi/increase/resources/oauth_connections.rbi +50 -0
  685. data/rbi/increase/resources/oauth_tokens.rbi +44 -0
  686. data/rbi/increase/resources/pending_transactions.rbi +98 -0
  687. data/rbi/increase/resources/physical_card_profiles.rbi +128 -0
  688. data/rbi/increase/resources/physical_cards.rbi +96 -0
  689. data/rbi/increase/resources/programs.rbi +44 -0
  690. data/rbi/increase/resources/real_time_decisions.rbi +65 -0
  691. data/rbi/increase/resources/real_time_payments_transfers.rbi +141 -0
  692. data/rbi/increase/resources/routing_numbers.rbi +38 -0
  693. data/rbi/increase/resources/simulations/account_statements.rbi +29 -0
  694. data/rbi/increase/resources/simulations/account_transfers.rbi +31 -0
  695. data/rbi/increase/resources/simulations/ach_transfers.rbi +115 -0
  696. data/rbi/increase/resources/simulations/card_authorization_expirations.rbi +28 -0
  697. data/rbi/increase/resources/simulations/card_authorizations.rbi +97 -0
  698. data/rbi/increase/resources/simulations/card_disputes.rbi +38 -0
  699. data/rbi/increase/resources/simulations/card_fuel_confirmations.rbi +34 -0
  700. data/rbi/increase/resources/simulations/card_increments.rbi +38 -0
  701. data/rbi/increase/resources/simulations/card_refunds.rbi +30 -0
  702. data/rbi/increase/resources/simulations/card_reversals.rbi +35 -0
  703. data/rbi/increase/resources/simulations/card_settlements.rbi +40 -0
  704. data/rbi/increase/resources/simulations/check_deposits.rbi +60 -0
  705. data/rbi/increase/resources/simulations/check_transfers.rbi +31 -0
  706. data/rbi/increase/resources/simulations/digital_wallet_token_requests.rbi +31 -0
  707. data/rbi/increase/resources/simulations/documents.rbi +28 -0
  708. data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +75 -0
  709. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +39 -0
  710. data/rbi/increase/resources/simulations/inbound_funds_holds.rbi +31 -0
  711. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +36 -0
  712. data/rbi/increase/resources/simulations/inbound_real_time_payments_transfers.rbi +49 -0
  713. data/rbi/increase/resources/simulations/inbound_wire_drawdown_requests.rbi +92 -0
  714. data/rbi/increase/resources/simulations/inbound_wire_transfers.rbi +91 -0
  715. data/rbi/increase/resources/simulations/interest_payments.rbi +41 -0
  716. data/rbi/increase/resources/simulations/physical_cards.rbi +66 -0
  717. data/rbi/increase/resources/simulations/programs.rbi +34 -0
  718. data/rbi/increase/resources/simulations/real_time_payments_transfers.rbi +35 -0
  719. data/rbi/increase/resources/simulations/wire_transfers.rbi +47 -0
  720. data/rbi/increase/resources/simulations.rbi +105 -0
  721. data/rbi/increase/resources/supplemental_documents.rbi +58 -0
  722. data/rbi/increase/resources/transactions.rbi +55 -0
  723. data/rbi/increase/resources/wire_drawdown_requests.rbi +110 -0
  724. data/rbi/increase/resources/wire_transfers.rbi +151 -0
  725. data/rbi/increase/version.rbi +5 -0
  726. data/sig/increase/client.rbs +135 -0
  727. data/sig/increase/errors.rbs +145 -0
  728. data/sig/increase/file_part.rbs +21 -0
  729. data/sig/increase/internal/page.rbs +13 -0
  730. data/sig/increase/internal/transport/base_client.rbs +131 -0
  731. data/sig/increase/internal/transport/pooled_net_requester.rbs +45 -0
  732. data/sig/increase/internal/type/array_of.rbs +48 -0
  733. data/sig/increase/internal/type/base_model.rbs +102 -0
  734. data/sig/increase/internal/type/base_page.rbs +24 -0
  735. data/sig/increase/internal/type/boolean.rbs +26 -0
  736. data/sig/increase/internal/type/converter.rbs +56 -0
  737. data/sig/increase/internal/type/enum.rbs +32 -0
  738. data/sig/increase/internal/type/file_input.rbs +25 -0
  739. data/sig/increase/internal/type/hash_of.rbs +48 -0
  740. data/sig/increase/internal/type/request_parameters.rbs +17 -0
  741. data/sig/increase/internal/type/union.rbs +52 -0
  742. data/sig/increase/internal/type/unknown.rbs +26 -0
  743. data/sig/increase/internal/util.rbs +185 -0
  744. data/sig/increase/internal.rbs +9 -0
  745. data/sig/increase/models/account.rbs +157 -0
  746. data/sig/increase/models/account_balance_params.rbs +25 -0
  747. data/sig/increase/models/account_close_params.rbs +15 -0
  748. data/sig/increase/models/account_create_params.rbs +47 -0
  749. data/sig/increase/models/account_list_params.rbs +149 -0
  750. data/sig/increase/models/account_number.rbs +157 -0
  751. data/sig/increase/models/account_number_create_params.rbs +111 -0
  752. data/sig/increase/models/account_number_list_params.rbs +182 -0
  753. data/sig/increase/models/account_number_retrieve_params.rbs +15 -0
  754. data/sig/increase/models/account_number_update_params.rbs +138 -0
  755. data/sig/increase/models/account_retrieve_params.rbs +15 -0
  756. data/sig/increase/models/account_statement.rbs +70 -0
  757. data/sig/increase/models/account_statement_list_params.rbs +86 -0
  758. data/sig/increase/models/account_statement_retrieve_params.rbs +15 -0
  759. data/sig/increase/models/account_transfer.rbs +266 -0
  760. data/sig/increase/models/account_transfer_approve_params.rbs +15 -0
  761. data/sig/increase/models/account_transfer_cancel_params.rbs +15 -0
  762. data/sig/increase/models/account_transfer_create_params.rbs +48 -0
  763. data/sig/increase/models/account_transfer_list_params.rbs +93 -0
  764. data/sig/increase/models/account_transfer_retrieve_params.rbs +15 -0
  765. data/sig/increase/models/account_update_params.rbs +25 -0
  766. data/sig/increase/models/ach_prenotification.rbs +561 -0
  767. data/sig/increase/models/ach_prenotification_create_params.rbs +148 -0
  768. data/sig/increase/models/ach_prenotification_list_params.rbs +86 -0
  769. data/sig/increase/models/ach_prenotification_retrieve_params.rbs +15 -0
  770. data/sig/increase/models/ach_transfer.rbs +1207 -0
  771. data/sig/increase/models/ach_transfer_approve_params.rbs +15 -0
  772. data/sig/increase/models/ach_transfer_cancel_params.rbs +15 -0
  773. data/sig/increase/models/ach_transfer_create_params.rbs +379 -0
  774. data/sig/increase/models/ach_transfer_list_params.rbs +172 -0
  775. data/sig/increase/models/ach_transfer_retrieve_params.rbs +15 -0
  776. data/sig/increase/models/balance_lookup.rbs +45 -0
  777. data/sig/increase/models/bookkeeping_account.rbs +74 -0
  778. data/sig/increase/models/bookkeeping_account_balance_params.rbs +25 -0
  779. data/sig/increase/models/bookkeeping_account_create_params.rbs +63 -0
  780. data/sig/increase/models/bookkeeping_account_list_params.rbs +38 -0
  781. data/sig/increase/models/bookkeeping_account_update_params.rbs +23 -0
  782. data/sig/increase/models/bookkeeping_balance_lookup.rbs +40 -0
  783. data/sig/increase/models/bookkeeping_entry.rbs +55 -0
  784. data/sig/increase/models/bookkeeping_entry_list_params.rbs +38 -0
  785. data/sig/increase/models/bookkeeping_entry_retrieve_params.rbs +15 -0
  786. data/sig/increase/models/bookkeeping_entry_set.rbs +78 -0
  787. data/sig/increase/models/bookkeeping_entry_set_create_params.rbs +52 -0
  788. data/sig/increase/models/bookkeeping_entry_set_list_params.rbs +49 -0
  789. data/sig/increase/models/bookkeeping_entry_set_retrieve_params.rbs +15 -0
  790. data/sig/increase/models/card.rbs +167 -0
  791. data/sig/increase/models/card_create_params.rbs +126 -0
  792. data/sig/increase/models/card_details.rbs +55 -0
  793. data/sig/increase/models/card_details_params.rbs +15 -0
  794. data/sig/increase/models/card_dispute.rbs +207 -0
  795. data/sig/increase/models/card_dispute_create_params.rbs +34 -0
  796. data/sig/increase/models/card_dispute_list_params.rbs +146 -0
  797. data/sig/increase/models/card_dispute_retrieve_params.rbs +15 -0
  798. data/sig/increase/models/card_list_params.rbs +138 -0
  799. data/sig/increase/models/card_payment.rbs +4955 -0
  800. data/sig/increase/models/card_payment_list_params.rbs +93 -0
  801. data/sig/increase/models/card_payment_retrieve_params.rbs +15 -0
  802. data/sig/increase/models/card_purchase_supplement.rbs +329 -0
  803. data/sig/increase/models/card_purchase_supplement_list_params.rbs +86 -0
  804. data/sig/increase/models/card_purchase_supplement_retrieve_params.rbs +15 -0
  805. data/sig/increase/models/card_retrieve_params.rbs +15 -0
  806. data/sig/increase/models/card_update_params.rbs +147 -0
  807. data/sig/increase/models/check_deposit.rbs +643 -0
  808. data/sig/increase/models/check_deposit_create_params.rbs +48 -0
  809. data/sig/increase/models/check_deposit_list_params.rbs +93 -0
  810. data/sig/increase/models/check_deposit_retrieve_params.rbs +15 -0
  811. data/sig/increase/models/check_transfer.rbs +729 -0
  812. data/sig/increase/models/check_transfer_approve_params.rbs +15 -0
  813. data/sig/increase/models/check_transfer_cancel_params.rbs +15 -0
  814. data/sig/increase/models/check_transfer_create_params.rbs +262 -0
  815. data/sig/increase/models/check_transfer_list_params.rbs +169 -0
  816. data/sig/increase/models/check_transfer_retrieve_params.rbs +15 -0
  817. data/sig/increase/models/check_transfer_stop_payment_params.rbs +45 -0
  818. data/sig/increase/models/declined_transaction.rbs +1469 -0
  819. data/sig/increase/models/declined_transaction_list_params.rbs +159 -0
  820. data/sig/increase/models/declined_transaction_retrieve_params.rbs +15 -0
  821. data/sig/increase/models/digital_card_profile.rbs +129 -0
  822. data/sig/increase/models/digital_card_profile_archive_params.rbs +15 -0
  823. data/sig/increase/models/digital_card_profile_clone_params.rbs +100 -0
  824. data/sig/increase/models/digital_card_profile_create_params.rbs +90 -0
  825. data/sig/increase/models/digital_card_profile_list_params.rbs +92 -0
  826. data/sig/increase/models/digital_card_profile_retrieve_params.rbs +15 -0
  827. data/sig/increase/models/digital_wallet_token.rbs +238 -0
  828. data/sig/increase/models/digital_wallet_token_list_params.rbs +86 -0
  829. data/sig/increase/models/digital_wallet_token_retrieve_params.rbs +15 -0
  830. data/sig/increase/models/document.rbs +103 -0
  831. data/sig/increase/models/document_create_params.rbs +61 -0
  832. data/sig/increase/models/document_list_params.rbs +149 -0
  833. data/sig/increase/models/document_retrieve_params.rbs +15 -0
  834. data/sig/increase/models/entity.rbs +1170 -0
  835. data/sig/increase/models/entity_archive_beneficial_owner_params.rbs +24 -0
  836. data/sig/increase/models/entity_archive_params.rbs +15 -0
  837. data/sig/increase/models/entity_confirm_params.rbs +25 -0
  838. data/sig/increase/models/entity_create_beneficial_owner_params.rbs +333 -0
  839. data/sig/increase/models/entity_create_params.rbs +1889 -0
  840. data/sig/increase/models/entity_list_params.rbs +131 -0
  841. data/sig/increase/models/entity_retrieve_params.rbs +15 -0
  842. data/sig/increase/models/entity_supplemental_document.rbs +50 -0
  843. data/sig/increase/models/entity_update_address_params.rbs +63 -0
  844. data/sig/increase/models/entity_update_beneficial_owner_address_params.rbs +81 -0
  845. data/sig/increase/models/entity_update_industry_code_params.rbs +23 -0
  846. data/sig/increase/models/event.rbs +423 -0
  847. data/sig/increase/models/event_list_params.rbs +482 -0
  848. data/sig/increase/models/event_retrieve_params.rbs +15 -0
  849. data/sig/increase/models/event_subscription.rbs +453 -0
  850. data/sig/increase/models/event_subscription_create_params.rbs +417 -0
  851. data/sig/increase/models/event_subscription_list_params.rbs +38 -0
  852. data/sig/increase/models/event_subscription_retrieve_params.rbs +15 -0
  853. data/sig/increase/models/event_subscription_update_params.rbs +45 -0
  854. data/sig/increase/models/export.rbs +118 -0
  855. data/sig/increase/models/export_create_params.rbs +427 -0
  856. data/sig/increase/models/export_list_params.rbs +195 -0
  857. data/sig/increase/models/export_retrieve_params.rbs +15 -0
  858. data/sig/increase/models/external_account.rbs +123 -0
  859. data/sig/increase/models/external_account_create_params.rbs +88 -0
  860. data/sig/increase/models/external_account_list_params.rbs +93 -0
  861. data/sig/increase/models/external_account_retrieve_params.rbs +15 -0
  862. data/sig/increase/models/external_account_update_params.rbs +100 -0
  863. data/sig/increase/models/file.rbs +196 -0
  864. data/sig/increase/models/file_create_params.rbs +110 -0
  865. data/sig/increase/models/file_link.rbs +60 -0
  866. data/sig/increase/models/file_link_create_params.rbs +30 -0
  867. data/sig/increase/models/file_list_params.rbs +226 -0
  868. data/sig/increase/models/file_retrieve_params.rbs +15 -0
  869. data/sig/increase/models/group.rbs +78 -0
  870. data/sig/increase/models/group_retrieve_params.rbs +15 -0
  871. data/sig/increase/models/inbound_ach_transfer.rbs +886 -0
  872. data/sig/increase/models/inbound_ach_transfer_create_notification_of_change_params.rbs +32 -0
  873. data/sig/increase/models/inbound_ach_transfer_decline_params.rbs +76 -0
  874. data/sig/increase/models/inbound_ach_transfer_list_params.rbs +143 -0
  875. data/sig/increase/models/inbound_ach_transfer_retrieve_params.rbs +15 -0
  876. data/sig/increase/models/inbound_ach_transfer_transfer_return_params.rbs +74 -0
  877. data/sig/increase/models/inbound_check_deposit.rbs +304 -0
  878. data/sig/increase/models/inbound_check_deposit_decline_params.rbs +15 -0
  879. data/sig/increase/models/inbound_check_deposit_list_params.rbs +93 -0
  880. data/sig/increase/models/inbound_check_deposit_retrieve_params.rbs +15 -0
  881. data/sig/increase/models/inbound_check_deposit_return_params.rbs +52 -0
  882. data/sig/increase/models/inbound_mail_item.rbs +100 -0
  883. data/sig/increase/models/inbound_mail_item_list_params.rbs +86 -0
  884. data/sig/increase/models/inbound_mail_item_retrieve_params.rbs +15 -0
  885. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +222 -0
  886. data/sig/increase/models/inbound_real_time_payments_transfer_list_params.rbs +93 -0
  887. data/sig/increase/models/inbound_real_time_payments_transfer_retrieve_params.rbs +15 -0
  888. data/sig/increase/models/inbound_wire_drawdown_request.rbs +140 -0
  889. data/sig/increase/models/inbound_wire_drawdown_request_list_params.rbs +32 -0
  890. data/sig/increase/models/inbound_wire_drawdown_request_retrieve_params.rbs +15 -0
  891. data/sig/increase/models/inbound_wire_transfer.rbs +211 -0
  892. data/sig/increase/models/inbound_wire_transfer_list_params.rbs +143 -0
  893. data/sig/increase/models/inbound_wire_transfer_retrieve_params.rbs +15 -0
  894. data/sig/increase/models/inbound_wire_transfer_reverse_params.rbs +38 -0
  895. data/sig/increase/models/intrafi_account_enrollment.rbs +88 -0
  896. data/sig/increase/models/intrafi_account_enrollment_create_params.rbs +28 -0
  897. data/sig/increase/models/intrafi_account_enrollment_list_params.rbs +107 -0
  898. data/sig/increase/models/intrafi_account_enrollment_retrieve_params.rbs +15 -0
  899. data/sig/increase/models/intrafi_account_enrollment_unenroll_params.rbs +15 -0
  900. data/sig/increase/models/intrafi_balance.rbs +130 -0
  901. data/sig/increase/models/intrafi_balance_intrafi_balance_params.rbs +15 -0
  902. data/sig/increase/models/intrafi_exclusion.rbs +92 -0
  903. data/sig/increase/models/intrafi_exclusion_archive_params.rbs +15 -0
  904. data/sig/increase/models/intrafi_exclusion_create_params.rbs +28 -0
  905. data/sig/increase/models/intrafi_exclusion_list_params.rbs +49 -0
  906. data/sig/increase/models/intrafi_exclusion_retrieve_params.rbs +15 -0
  907. data/sig/increase/models/lockbox.rbs +126 -0
  908. data/sig/increase/models/lockbox_create_params.rbs +36 -0
  909. data/sig/increase/models/lockbox_list_params.rbs +93 -0
  910. data/sig/increase/models/lockbox_retrieve_params.rbs +15 -0
  911. data/sig/increase/models/lockbox_update_params.rbs +58 -0
  912. data/sig/increase/models/oauth_application.rbs +74 -0
  913. data/sig/increase/models/oauth_application_list_params.rbs +123 -0
  914. data/sig/increase/models/oauth_application_retrieve_params.rbs +15 -0
  915. data/sig/increase/models/oauth_connection.rbs +74 -0
  916. data/sig/increase/models/oauth_connection_list_params.rbs +86 -0
  917. data/sig/increase/models/oauth_connection_retrieve_params.rbs +15 -0
  918. data/sig/increase/models/oauth_token.rbs +50 -0
  919. data/sig/increase/models/oauth_token_create_params.rbs +68 -0
  920. data/sig/increase/models/pending_transaction.rbs +1266 -0
  921. data/sig/increase/models/pending_transaction_create_params.rbs +34 -0
  922. data/sig/increase/models/pending_transaction_list_params.rbs +227 -0
  923. data/sig/increase/models/pending_transaction_release_params.rbs +15 -0
  924. data/sig/increase/models/pending_transaction_retrieve_params.rbs +15 -0
  925. data/sig/increase/models/physical_card.rbs +338 -0
  926. data/sig/increase/models/physical_card_create_params.rbs +152 -0
  927. data/sig/increase/models/physical_card_list_params.rbs +93 -0
  928. data/sig/increase/models/physical_card_profile.rbs +136 -0
  929. data/sig/increase/models/physical_card_profile_archive_params.rbs +15 -0
  930. data/sig/increase/models/physical_card_profile_clone_params.rbs +72 -0
  931. data/sig/increase/models/physical_card_profile_create_params.rbs +69 -0
  932. data/sig/increase/models/physical_card_profile_list_params.rbs +104 -0
  933. data/sig/increase/models/physical_card_profile_retrieve_params.rbs +15 -0
  934. data/sig/increase/models/physical_card_retrieve_params.rbs +15 -0
  935. data/sig/increase/models/physical_card_update_params.rbs +41 -0
  936. data/sig/increase/models/program.rbs +87 -0
  937. data/sig/increase/models/program_list_params.rbs +32 -0
  938. data/sig/increase/models/program_retrieve_params.rbs +15 -0
  939. data/sig/increase/models/real_time_decision.rbs +998 -0
  940. data/sig/increase/models/real_time_decision_action_params.rbs +317 -0
  941. data/sig/increase/models/real_time_decision_retrieve_params.rbs +15 -0
  942. data/sig/increase/models/real_time_payments_transfer.rbs +467 -0
  943. data/sig/increase/models/real_time_payments_transfer_approve_params.rbs +15 -0
  944. data/sig/increase/models/real_time_payments_transfer_cancel_params.rbs +15 -0
  945. data/sig/increase/models/real_time_payments_transfer_create_params.rbs +90 -0
  946. data/sig/increase/models/real_time_payments_transfer_list_params.rbs +170 -0
  947. data/sig/increase/models/real_time_payments_transfer_retrieve_params.rbs +15 -0
  948. data/sig/increase/models/routing_number_list_params.rbs +36 -0
  949. data/sig/increase/models/routing_number_list_response.rbs +97 -0
  950. data/sig/increase/models/simulations/account_statement_create_params.rbs +25 -0
  951. data/sig/increase/models/simulations/account_transfer_complete_params.rbs +17 -0
  952. data/sig/increase/models/simulations/ach_transfer_acknowledge_params.rbs +17 -0
  953. data/sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs +117 -0
  954. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +320 -0
  955. data/sig/increase/models/simulations/ach_transfer_settle_params.rbs +17 -0
  956. data/sig/increase/models/simulations/ach_transfer_submit_params.rbs +17 -0
  957. data/sig/increase/models/simulations/card_authorization_create_params.rbs +314 -0
  958. data/sig/increase/models/simulations/card_authorization_create_response.rbs +42 -0
  959. data/sig/increase/models/simulations/card_authorization_expiration_create_params.rbs +26 -0
  960. data/sig/increase/models/simulations/card_dispute_action_params.rbs +59 -0
  961. data/sig/increase/models/simulations/card_fuel_confirmation_create_params.rbs +30 -0
  962. data/sig/increase/models/simulations/card_increment_create_params.rbs +40 -0
  963. data/sig/increase/models/simulations/card_refund_create_params.rbs +26 -0
  964. data/sig/increase/models/simulations/card_reversal_create_params.rbs +32 -0
  965. data/sig/increase/models/simulations/card_settlement_create_params.rbs +36 -0
  966. data/sig/increase/models/simulations/check_deposit_reject_params.rbs +17 -0
  967. data/sig/increase/models/simulations/check_deposit_return_params.rbs +17 -0
  968. data/sig/increase/models/simulations/check_deposit_submit_params.rbs +17 -0
  969. data/sig/increase/models/simulations/check_transfer_mail_params.rbs +17 -0
  970. data/sig/increase/models/simulations/digital_wallet_token_request_create_params.rbs +25 -0
  971. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +66 -0
  972. data/sig/increase/models/simulations/document_create_params.rbs +25 -0
  973. data/sig/increase/models/simulations/inbound_ach_transfer_create_params.rbs +243 -0
  974. data/sig/increase/models/simulations/inbound_check_deposit_create_params.rbs +34 -0
  975. data/sig/increase/models/simulations/inbound_funds_hold_release_params.rbs +17 -0
  976. data/sig/increase/models/simulations/inbound_funds_hold_release_response.rbs +117 -0
  977. data/sig/increase/models/simulations/inbound_mail_item_create_params.rbs +36 -0
  978. data/sig/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rbs +68 -0
  979. data/sig/increase/models/simulations/inbound_wire_drawdown_request_create_params.rbs +147 -0
  980. data/sig/increase/models/simulations/inbound_wire_transfer_create_params.rbs +138 -0
  981. data/sig/increase/models/simulations/interest_payment_create_params.rbs +54 -0
  982. data/sig/increase/models/simulations/physical_card_advance_shipment_params.rbs +68 -0
  983. data/sig/increase/models/simulations/physical_card_tracking_updates_params.rbs +80 -0
  984. data/sig/increase/models/simulations/program_create_params.rbs +32 -0
  985. data/sig/increase/models/simulations/real_time_payments_transfer_complete_params.rbs +141 -0
  986. data/sig/increase/models/simulations/wire_transfer_reverse_params.rbs +17 -0
  987. data/sig/increase/models/simulations/wire_transfer_submit_params.rbs +17 -0
  988. data/sig/increase/models/supplemental_document_create_params.rbs +28 -0
  989. data/sig/increase/models/supplemental_document_list_params.rbs +47 -0
  990. data/sig/increase/models/transaction.rbs +4400 -0
  991. data/sig/increase/models/transaction_list_params.rbs +253 -0
  992. data/sig/increase/models/transaction_retrieve_params.rbs +15 -0
  993. data/sig/increase/models/wire_drawdown_request.rbs +161 -0
  994. data/sig/increase/models/wire_drawdown_request_create_params.rbs +100 -0
  995. data/sig/increase/models/wire_drawdown_request_list_params.rbs +93 -0
  996. data/sig/increase/models/wire_drawdown_request_retrieve_params.rbs +15 -0
  997. data/sig/increase/models/wire_transfer.rbs +469 -0
  998. data/sig/increase/models/wire_transfer_approve_params.rbs +15 -0
  999. data/sig/increase/models/wire_transfer_cancel_params.rbs +15 -0
  1000. data/sig/increase/models/wire_transfer_create_params.rbs +125 -0
  1001. data/sig/increase/models/wire_transfer_list_params.rbs +100 -0
  1002. data/sig/increase/models/wire_transfer_retrieve_params.rbs +15 -0
  1003. data/sig/increase/models.rbs +441 -0
  1004. data/sig/increase/request_options.rbs +34 -0
  1005. data/sig/increase/resources/account_numbers.rbs +40 -0
  1006. data/sig/increase/resources/account_statements.rbs +20 -0
  1007. data/sig/increase/resources/account_transfers.rbs +40 -0
  1008. data/sig/increase/resources/accounts.rbs +49 -0
  1009. data/sig/increase/resources/ach_prenotifications.rbs +37 -0
  1010. data/sig/increase/resources/ach_transfers.rbs +56 -0
  1011. data/sig/increase/resources/bookkeeping_accounts.rbs +34 -0
  1012. data/sig/increase/resources/bookkeeping_entries.rbs +19 -0
  1013. data/sig/increase/resources/bookkeeping_entry_sets.rbs +27 -0
  1014. data/sig/increase/resources/card_disputes.rbs +28 -0
  1015. data/sig/increase/resources/card_payments.rbs +21 -0
  1016. data/sig/increase/resources/card_purchase_supplements.rbs +20 -0
  1017. data/sig/increase/resources/cards.rbs +46 -0
  1018. data/sig/increase/resources/check_deposits.rbs +30 -0
  1019. data/sig/increase/resources/check_transfers.rbs +50 -0
  1020. data/sig/increase/resources/declined_transactions.rbs +22 -0
  1021. data/sig/increase/resources/digital_card_profiles.rbs +52 -0
  1022. data/sig/increase/resources/digital_wallet_tokens.rbs +20 -0
  1023. data/sig/increase/resources/documents.rbs +28 -0
  1024. data/sig/increase/resources/entities.rbs +76 -0
  1025. data/sig/increase/resources/event_subscriptions.rbs +33 -0
  1026. data/sig/increase/resources/events.rbs +21 -0
  1027. data/sig/increase/resources/exports.rbs +33 -0
  1028. data/sig/increase/resources/external_accounts.rbs +39 -0
  1029. data/sig/increase/resources/file_links.rbs +13 -0
  1030. data/sig/increase/resources/files.rbs +28 -0
  1031. data/sig/increase/resources/groups.rbs +11 -0
  1032. data/sig/increase/resources/inbound_ach_transfers.rbs +41 -0
  1033. data/sig/increase/resources/inbound_check_deposits.rbs +32 -0
  1034. data/sig/increase/resources/inbound_mail_items.rbs +20 -0
  1035. data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +21 -0
  1036. data/sig/increase/resources/inbound_wire_drawdown_requests.rbs +18 -0
  1037. data/sig/increase/resources/inbound_wire_transfers.rbs +28 -0
  1038. data/sig/increase/resources/intrafi_account_enrollments.rbs +32 -0
  1039. data/sig/increase/resources/intrafi_balances.rbs +12 -0
  1040. data/sig/increase/resources/intrafi_exclusions.rbs +31 -0
  1041. data/sig/increase/resources/lockboxes.rbs +36 -0
  1042. data/sig/increase/resources/oauth_applications.rbs +20 -0
  1043. data/sig/increase/resources/oauth_connections.rbs +20 -0
  1044. data/sig/increase/resources/oauth_tokens.rbs +16 -0
  1045. data/sig/increase/resources/pending_transactions.rbs +35 -0
  1046. data/sig/increase/resources/physical_card_profiles.rbs +45 -0
  1047. data/sig/increase/resources/physical_cards.rbs +35 -0
  1048. data/sig/increase/resources/programs.rbs +18 -0
  1049. data/sig/increase/resources/real_time_decisions.rbs +22 -0
  1050. data/sig/increase/resources/real_time_payments_transfers.rbs +48 -0
  1051. data/sig/increase/resources/routing_numbers.rbs +14 -0
  1052. data/sig/increase/resources/simulations/account_statements.rbs +14 -0
  1053. data/sig/increase/resources/simulations/account_transfers.rbs +14 -0
  1054. data/sig/increase/resources/simulations/ach_transfers.rbs +37 -0
  1055. data/sig/increase/resources/simulations/card_authorization_expirations.rbs +14 -0
  1056. data/sig/increase/resources/simulations/card_authorizations.rbs +30 -0
  1057. data/sig/increase/resources/simulations/card_disputes.rbs +16 -0
  1058. data/sig/increase/resources/simulations/card_fuel_confirmations.rbs +15 -0
  1059. data/sig/increase/resources/simulations/card_increments.rbs +16 -0
  1060. data/sig/increase/resources/simulations/card_refunds.rbs +14 -0
  1061. data/sig/increase/resources/simulations/card_reversals.rbs +15 -0
  1062. data/sig/increase/resources/simulations/card_settlements.rbs +16 -0
  1063. data/sig/increase/resources/simulations/check_deposits.rbs +24 -0
  1064. data/sig/increase/resources/simulations/check_transfers.rbs +14 -0
  1065. data/sig/increase/resources/simulations/digital_wallet_token_requests.rbs +14 -0
  1066. data/sig/increase/resources/simulations/documents.rbs +14 -0
  1067. data/sig/increase/resources/simulations/inbound_ach_transfers.rbs +25 -0
  1068. data/sig/increase/resources/simulations/inbound_check_deposits.rbs +16 -0
  1069. data/sig/increase/resources/simulations/inbound_funds_holds.rbs +14 -0
  1070. data/sig/increase/resources/simulations/inbound_mail_items.rbs +16 -0
  1071. data/sig/increase/resources/simulations/inbound_real_time_payments_transfers.rbs +20 -0
  1072. data/sig/increase/resources/simulations/inbound_wire_drawdown_requests.rbs +33 -0
  1073. data/sig/increase/resources/simulations/inbound_wire_transfers.rbs +30 -0
  1074. data/sig/increase/resources/simulations/interest_payments.rbs +18 -0
  1075. data/sig/increase/resources/simulations/physical_cards.rbs +25 -0
  1076. data/sig/increase/resources/simulations/programs.rbs +15 -0
  1077. data/sig/increase/resources/simulations/real_time_payments_transfers.rbs +15 -0
  1078. data/sig/increase/resources/simulations/wire_transfers.rbs +19 -0
  1079. data/sig/increase/resources/simulations.rbs +61 -0
  1080. data/sig/increase/resources/supplemental_documents.rbs +21 -0
  1081. data/sig/increase/resources/transactions.rbs +22 -0
  1082. data/sig/increase/resources/wire_drawdown_requests.rbs +37 -0
  1083. data/sig/increase/resources/wire_transfers.rbs +52 -0
  1084. data/sig/increase/version.rbs +3 -0
  1085. metadata +1068 -176
  1086. data/.rspec +0 -3
  1087. data/.standard.yml +0 -3
  1088. data/Gemfile +0 -6
  1089. data/LICENSE.txt +0 -21
  1090. data/OPENAPI_VERSION +0 -1
  1091. data/Rakefile +0 -10
  1092. data/bin/generate +0 -152
  1093. data/bin/setup +0 -8
  1094. data/generate/resource.rb.erb +0 -18
  1095. data/lib/increase/configuration.rb +0 -50
  1096. data/lib/increase/file_upload.rb +0 -57
  1097. data/lib/increase/middleware/encode_json.rb +0 -57
  1098. data/lib/increase/middleware/parse_json.rb +0 -42
  1099. data/lib/increase/middleware/raise_api_error.rb +0 -13
  1100. data/lib/increase/resource.rb +0 -205
  1101. data/lib/increase/resources/card_profiles.rb +0 -17
  1102. data/lib/increase/resources/inbound_ach_transfer_returns.rb +0 -17
  1103. data/lib/increase/resources/limits.rb +0 -19
  1104. data/lib/increase/resources.rb +0 -4
  1105. data/lib/increase/response_array.rb +0 -19
  1106. data/lib/increase/response_hash.rb +0 -15
  1107. data/lib/increase/util.rb +0 -15
  1108. data/lib/increase/webhook/signature.rb +0 -70
  1109. data/openapi.json +0 -32098
  1110. data/sig/increase.rbs +0 -4
@@ -0,0 +1,2318 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::Entities#create
6
+ class EntityCreateParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute structure
11
+ # The type of Entity to create.
12
+ #
13
+ # @return [Symbol, Increase::Models::EntityCreateParams::Structure]
14
+ required :structure, enum: -> { Increase::EntityCreateParams::Structure }
15
+
16
+ # @!attribute corporation
17
+ # Details of the corporation entity to create. Required if `structure` is equal to
18
+ # `corporation`.
19
+ #
20
+ # @return [Increase::Models::EntityCreateParams::Corporation, nil]
21
+ optional :corporation, -> { Increase::EntityCreateParams::Corporation }
22
+
23
+ # @!attribute description
24
+ # The description you choose to give the entity.
25
+ #
26
+ # @return [String, nil]
27
+ optional :description, String
28
+
29
+ # @!attribute government_authority
30
+ # Details of the Government Authority entity to create. Required if `structure` is
31
+ # equal to `Government Authority`.
32
+ #
33
+ # @return [Increase::Models::EntityCreateParams::GovernmentAuthority, nil]
34
+ optional :government_authority, -> { Increase::EntityCreateParams::GovernmentAuthority }
35
+
36
+ # @!attribute joint
37
+ # Details of the joint entity to create. Required if `structure` is equal to
38
+ # `joint`.
39
+ #
40
+ # @return [Increase::Models::EntityCreateParams::Joint, nil]
41
+ optional :joint, -> { Increase::EntityCreateParams::Joint }
42
+
43
+ # @!attribute natural_person
44
+ # Details of the natural person entity to create. Required if `structure` is equal
45
+ # to `natural_person`. Natural people entities should be submitted with
46
+ # `social_security_number` or `individual_taxpayer_identification_number`
47
+ # identification methods.
48
+ #
49
+ # @return [Increase::Models::EntityCreateParams::NaturalPerson, nil]
50
+ optional :natural_person, -> { Increase::EntityCreateParams::NaturalPerson }
51
+
52
+ # @!attribute supplemental_documents
53
+ # Additional documentation associated with the entity.
54
+ #
55
+ # @return [Array<Increase::Models::EntityCreateParams::SupplementalDocument>, nil]
56
+ optional :supplemental_documents,
57
+ -> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::SupplementalDocument] }
58
+
59
+ # @!attribute third_party_verification
60
+ # A reference to data stored in a third-party verification service. Your
61
+ # integration may or may not use this field.
62
+ #
63
+ # @return [Increase::Models::EntityCreateParams::ThirdPartyVerification, nil]
64
+ optional :third_party_verification, -> { Increase::EntityCreateParams::ThirdPartyVerification }
65
+
66
+ # @!attribute trust
67
+ # Details of the trust entity to create. Required if `structure` is equal to
68
+ # `trust`.
69
+ #
70
+ # @return [Increase::Models::EntityCreateParams::Trust, nil]
71
+ optional :trust, -> { Increase::EntityCreateParams::Trust }
72
+
73
+ # @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {})
74
+ # Some parameter documentations has been truncated, see
75
+ # {Increase::Models::EntityCreateParams} for more details.
76
+ #
77
+ # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
78
+ #
79
+ # @param corporation [Increase::Models::EntityCreateParams::Corporation] Details of the corporation entity to create. Required if `structure` is equal to
80
+ #
81
+ # @param description [String] The description you choose to give the entity.
82
+ #
83
+ # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority] Details of the Government Authority entity to create. Required if `structure` is
84
+ #
85
+ # @param joint [Increase::Models::EntityCreateParams::Joint] Details of the joint entity to create. Required if `structure` is equal to `join
86
+ #
87
+ # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] Details of the natural person entity to create. Required if `structure` is equal
88
+ #
89
+ # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
90
+ #
91
+ # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
92
+ #
93
+ # @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
94
+ #
95
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
96
+
97
+ # The type of Entity to create.
98
+ module Structure
99
+ extend Increase::Internal::Type::Enum
100
+
101
+ # A corporation.
102
+ CORPORATION = :corporation
103
+
104
+ # An individual person.
105
+ NATURAL_PERSON = :natural_person
106
+
107
+ # Multiple individual people.
108
+ JOINT = :joint
109
+
110
+ # A trust.
111
+ TRUST = :trust
112
+
113
+ # A government authority.
114
+ GOVERNMENT_AUTHORITY = :government_authority
115
+
116
+ # @!method self.values
117
+ # @return [Array<Symbol>]
118
+ end
119
+
120
+ class Corporation < Increase::Internal::Type::BaseModel
121
+ # @!attribute address
122
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
123
+ # are disallowed.
124
+ #
125
+ # @return [Increase::Models::EntityCreateParams::Corporation::Address]
126
+ required :address, -> { Increase::EntityCreateParams::Corporation::Address }
127
+
128
+ # @!attribute beneficial_owners
129
+ # The identifying details of each person who owns 25% or more of the business and
130
+ # one control person, like the CEO, CFO, or other executive. You can submit
131
+ # between 1 and 5 people to this list.
132
+ #
133
+ # @return [Array<Increase::Models::EntityCreateParams::Corporation::BeneficialOwner>]
134
+ required :beneficial_owners,
135
+ -> {
136
+ Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::Corporation::BeneficialOwner]
137
+ }
138
+
139
+ # @!attribute name
140
+ # The legal name of the corporation.
141
+ #
142
+ # @return [String]
143
+ required :name, String
144
+
145
+ # @!attribute tax_identifier
146
+ # The Employer Identification Number (EIN) for the corporation.
147
+ #
148
+ # @return [String]
149
+ required :tax_identifier, String
150
+
151
+ # @!attribute beneficial_ownership_exemption_reason
152
+ # If the entity is exempt from the requirement to submit beneficial owners,
153
+ # provide the justification. If a reason is provided, you do not need to submit a
154
+ # list of beneficial owners.
155
+ #
156
+ # @return [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason, nil]
157
+ optional :beneficial_ownership_exemption_reason,
158
+ enum: -> { Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason }
159
+
160
+ # @!attribute incorporation_state
161
+ # The two-letter United States Postal Service (USPS) abbreviation for the
162
+ # corporation's state of incorporation.
163
+ #
164
+ # @return [String, nil]
165
+ optional :incorporation_state, String
166
+
167
+ # @!attribute industry_code
168
+ # The North American Industry Classification System (NAICS) code for the
169
+ # corporation's primary line of business. This is a number, like `5132` for
170
+ # `Software Publishers`. A full list of classification codes is available
171
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
172
+ #
173
+ # @return [String, nil]
174
+ optional :industry_code, String
175
+
176
+ # @!attribute website
177
+ # The website of the corporation.
178
+ #
179
+ # @return [String, nil]
180
+ optional :website, String
181
+
182
+ # @!method initialize(address:, beneficial_owners:, name:, tax_identifier:, beneficial_ownership_exemption_reason: nil, incorporation_state: nil, industry_code: nil, website: nil)
183
+ # Some parameter documentations has been truncated, see
184
+ # {Increase::Models::EntityCreateParams::Corporation} for more details.
185
+ #
186
+ # Details of the corporation entity to create. Required if `structure` is equal to
187
+ # `corporation`.
188
+ #
189
+ # @param address [Increase::Models::EntityCreateParams::Corporation::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
190
+ #
191
+ # @param beneficial_owners [Array<Increase::Models::EntityCreateParams::Corporation::BeneficialOwner>] The identifying details of each person who owns 25% or more of the business and
192
+ #
193
+ # @param name [String] The legal name of the corporation.
194
+ #
195
+ # @param tax_identifier [String] The Employer Identification Number (EIN) for the corporation.
196
+ #
197
+ # @param beneficial_ownership_exemption_reason [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason] If the entity is exempt from the requirement to submit beneficial owners, provid
198
+ #
199
+ # @param incorporation_state [String] The two-letter United States Postal Service (USPS) abbreviation for the corporat
200
+ #
201
+ # @param industry_code [String] The North American Industry Classification System (NAICS) code for the corporati
202
+ #
203
+ # @param website [String] The website of the corporation.
204
+
205
+ # @see Increase::Models::EntityCreateParams::Corporation#address
206
+ class Address < Increase::Internal::Type::BaseModel
207
+ # @!attribute city
208
+ # The city of the address.
209
+ #
210
+ # @return [String]
211
+ required :city, String
212
+
213
+ # @!attribute line1
214
+ # The first line of the address. This is usually the street number and street.
215
+ #
216
+ # @return [String]
217
+ required :line1, String
218
+
219
+ # @!attribute state
220
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
221
+ # the address.
222
+ #
223
+ # @return [String]
224
+ required :state, String
225
+
226
+ # @!attribute zip
227
+ # The ZIP code of the address.
228
+ #
229
+ # @return [String]
230
+ required :zip, String
231
+
232
+ # @!attribute line2
233
+ # The second line of the address. This might be the floor or room number.
234
+ #
235
+ # @return [String, nil]
236
+ optional :line2, String
237
+
238
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
239
+ # Some parameter documentations has been truncated, see
240
+ # {Increase::Models::EntityCreateParams::Corporation::Address} for more details.
241
+ #
242
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
243
+ # are disallowed.
244
+ #
245
+ # @param city [String] The city of the address.
246
+ #
247
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
248
+ #
249
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
250
+ #
251
+ # @param zip [String] The ZIP code of the address.
252
+ #
253
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
254
+ end
255
+
256
+ class BeneficialOwner < Increase::Internal::Type::BaseModel
257
+ # @!attribute individual
258
+ # Personal details for the beneficial owner.
259
+ #
260
+ # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual]
261
+ required :individual, -> { Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual }
262
+
263
+ # @!attribute prongs
264
+ # Why this person is considered a beneficial owner of the entity. At least one
265
+ # option is required, if a person is both a control person and owner, submit an
266
+ # array containing both.
267
+ #
268
+ # @return [Array<Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Prong>]
269
+ required :prongs,
270
+ -> {
271
+ Increase::Internal::Type::ArrayOf[enum: Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong]
272
+ }
273
+
274
+ # @!attribute company_title
275
+ # This person's role or title within the entity.
276
+ #
277
+ # @return [String, nil]
278
+ optional :company_title, String
279
+
280
+ # @!method initialize(individual:, prongs:, company_title: nil)
281
+ # Some parameter documentations has been truncated, see
282
+ # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner} for more
283
+ # details.
284
+ #
285
+ # @param individual [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual] Personal details for the beneficial owner.
286
+ #
287
+ # @param prongs [Array<Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
288
+ #
289
+ # @param company_title [String] This person's role or title within the entity.
290
+
291
+ # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner#individual
292
+ class Individual < Increase::Internal::Type::BaseModel
293
+ # @!attribute address
294
+ # The individual's physical address. Mail receiving locations like PO Boxes and
295
+ # PMB's are disallowed.
296
+ #
297
+ # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address]
298
+ required :address,
299
+ -> {
300
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address
301
+ }
302
+
303
+ # @!attribute date_of_birth
304
+ # The person's date of birth in YYYY-MM-DD format.
305
+ #
306
+ # @return [Date]
307
+ required :date_of_birth, Date
308
+
309
+ # @!attribute identification
310
+ # A means of verifying the person's identity.
311
+ #
312
+ # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification]
313
+ required :identification,
314
+ -> {
315
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification
316
+ }
317
+
318
+ # @!attribute name
319
+ # The person's legal name.
320
+ #
321
+ # @return [String]
322
+ required :name, String
323
+
324
+ # @!attribute confirmed_no_us_tax_id
325
+ # The identification method for an individual can only be a passport, driver's
326
+ # license, or other document if you've confirmed the individual does not have a US
327
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
328
+ # Number).
329
+ #
330
+ # @return [Boolean, nil]
331
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
332
+
333
+ # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
334
+ # Some parameter documentations has been truncated, see
335
+ # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual}
336
+ # for more details.
337
+ #
338
+ # Personal details for the beneficial owner.
339
+ #
340
+ # @param address [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
341
+ #
342
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
343
+ #
344
+ # @param identification [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification] A means of verifying the person's identity.
345
+ #
346
+ # @param name [String] The person's legal name.
347
+ #
348
+ # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
349
+
350
+ # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#address
351
+ class Address < Increase::Internal::Type::BaseModel
352
+ # @!attribute country
353
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
354
+ #
355
+ # @return [String]
356
+ required :country, String
357
+
358
+ # @!attribute line1
359
+ # The first line of the address. This is usually the street number and street.
360
+ #
361
+ # @return [String]
362
+ required :line1, String
363
+
364
+ # @!attribute city
365
+ # The city, district, town, or village of the address. Required in certain
366
+ # countries.
367
+ #
368
+ # @return [String, nil]
369
+ optional :city, String
370
+
371
+ # @!attribute line2
372
+ # The second line of the address. This might be the floor or room number.
373
+ #
374
+ # @return [String, nil]
375
+ optional :line2, String
376
+
377
+ # @!attribute state
378
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
379
+ # state, province, or region of the address. Required in certain countries.
380
+ #
381
+ # @return [String, nil]
382
+ optional :state, String
383
+
384
+ # @!attribute zip
385
+ # The ZIP or postal code of the address. Required in certain countries.
386
+ #
387
+ # @return [String, nil]
388
+ optional :zip, String
389
+
390
+ # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil)
391
+ # Some parameter documentations has been truncated, see
392
+ # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address}
393
+ # for more details.
394
+ #
395
+ # The individual's physical address. Mail receiving locations like PO Boxes and
396
+ # PMB's are disallowed.
397
+ #
398
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
399
+ #
400
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
401
+ #
402
+ # @param city [String] The city, district, town, or village of the address. Required in certain countri
403
+ #
404
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
405
+ #
406
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
407
+ #
408
+ # @param zip [String] The ZIP or postal code of the address. Required in certain countries.
409
+ end
410
+
411
+ # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#identification
412
+ class Identification < Increase::Internal::Type::BaseModel
413
+ # @!attribute method_
414
+ # A method that can be used to verify the individual's identity.
415
+ #
416
+ # @return [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method]
417
+ required :method_,
418
+ enum: -> {
419
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method
420
+ },
421
+ api_name: :method
422
+
423
+ # @!attribute number
424
+ # An identification number that can be used to verify the individual's identity,
425
+ # such as a social security number.
426
+ #
427
+ # @return [String]
428
+ required :number, String
429
+
430
+ # @!attribute drivers_license
431
+ # Information about the United States driver's license used for identification.
432
+ # Required if `method` is equal to `drivers_license`.
433
+ #
434
+ # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense, nil]
435
+ optional :drivers_license,
436
+ -> {
437
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense
438
+ }
439
+
440
+ # @!attribute other
441
+ # Information about the identification document provided. Required if `method` is
442
+ # equal to `other`.
443
+ #
444
+ # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other, nil]
445
+ optional :other,
446
+ -> {
447
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other
448
+ }
449
+
450
+ # @!attribute passport
451
+ # Information about the passport used for identification. Required if `method` is
452
+ # equal to `passport`.
453
+ #
454
+ # @return [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport, nil]
455
+ optional :passport,
456
+ -> {
457
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport
458
+ }
459
+
460
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
461
+ # Some parameter documentations has been truncated, see
462
+ # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification}
463
+ # for more details.
464
+ #
465
+ # A means of verifying the person's identity.
466
+ #
467
+ # @param method_ [Symbol, Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method] A method that can be used to verify the individual's identity.
468
+ #
469
+ # @param number [String] An identification number that can be used to verify the individual's identity, s
470
+ #
471
+ # @param drivers_license [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
472
+ #
473
+ # @param other [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other] Information about the identification document provided. Required if `method` is
474
+ #
475
+ # @param passport [Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is
476
+
477
+ # A method that can be used to verify the individual's identity.
478
+ #
479
+ # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#method_
480
+ module Method
481
+ extend Increase::Internal::Type::Enum
482
+
483
+ # A social security number.
484
+ SOCIAL_SECURITY_NUMBER = :social_security_number
485
+
486
+ # An individual taxpayer identification number (ITIN).
487
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
488
+
489
+ # A passport number.
490
+ PASSPORT = :passport
491
+
492
+ # A driver's license number.
493
+ DRIVERS_LICENSE = :drivers_license
494
+
495
+ # Another identifying document.
496
+ OTHER = :other
497
+
498
+ # @!method self.values
499
+ # @return [Array<Symbol>]
500
+ end
501
+
502
+ # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#drivers_license
503
+ class DriversLicense < Increase::Internal::Type::BaseModel
504
+ # @!attribute expiration_date
505
+ # The driver's license's expiration date in YYYY-MM-DD format.
506
+ #
507
+ # @return [Date]
508
+ required :expiration_date, Date
509
+
510
+ # @!attribute file_id
511
+ # The identifier of the File containing the front of the driver's license.
512
+ #
513
+ # @return [String]
514
+ required :file_id, String
515
+
516
+ # @!attribute state
517
+ # The state that issued the provided driver's license.
518
+ #
519
+ # @return [String]
520
+ required :state, String
521
+
522
+ # @!attribute back_file_id
523
+ # The identifier of the File containing the back of the driver's license.
524
+ #
525
+ # @return [String, nil]
526
+ optional :back_file_id, String
527
+
528
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
529
+ # Information about the United States driver's license used for identification.
530
+ # Required if `method` is equal to `drivers_license`.
531
+ #
532
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
533
+ #
534
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
535
+ #
536
+ # @param state [String] The state that issued the provided driver's license.
537
+ #
538
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
539
+ end
540
+
541
+ # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#other
542
+ class Other < Increase::Internal::Type::BaseModel
543
+ # @!attribute country
544
+ # The two-character ISO 3166-1 code representing the country that issued the
545
+ # document.
546
+ #
547
+ # @return [String]
548
+ required :country, String
549
+
550
+ # @!attribute description
551
+ # A description of the document submitted.
552
+ #
553
+ # @return [String]
554
+ required :description, String
555
+
556
+ # @!attribute file_id
557
+ # The identifier of the File containing the front of the document.
558
+ #
559
+ # @return [String]
560
+ required :file_id, String
561
+
562
+ # @!attribute back_file_id
563
+ # The identifier of the File containing the back of the document. Not every
564
+ # document has a reverse side.
565
+ #
566
+ # @return [String, nil]
567
+ optional :back_file_id, String
568
+
569
+ # @!attribute expiration_date
570
+ # The document's expiration date in YYYY-MM-DD format.
571
+ #
572
+ # @return [Date, nil]
573
+ optional :expiration_date, Date
574
+
575
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
576
+ # Some parameter documentations has been truncated, see
577
+ # {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other}
578
+ # for more details.
579
+ #
580
+ # Information about the identification document provided. Required if `method` is
581
+ # equal to `other`.
582
+ #
583
+ # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
584
+ #
585
+ # @param description [String] A description of the document submitted.
586
+ #
587
+ # @param file_id [String] The identifier of the File containing the front of the document.
588
+ #
589
+ # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
590
+ #
591
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
592
+ end
593
+
594
+ # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification#passport
595
+ class Passport < Increase::Internal::Type::BaseModel
596
+ # @!attribute country
597
+ # The country that issued the passport.
598
+ #
599
+ # @return [String]
600
+ required :country, String
601
+
602
+ # @!attribute expiration_date
603
+ # The passport's expiration date in YYYY-MM-DD format.
604
+ #
605
+ # @return [Date]
606
+ required :expiration_date, Date
607
+
608
+ # @!attribute file_id
609
+ # The identifier of the File containing the passport.
610
+ #
611
+ # @return [String]
612
+ required :file_id, String
613
+
614
+ # @!method initialize(country:, expiration_date:, file_id:)
615
+ # Information about the passport used for identification. Required if `method` is
616
+ # equal to `passport`.
617
+ #
618
+ # @param country [String] The country that issued the passport.
619
+ #
620
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
621
+ #
622
+ # @param file_id [String] The identifier of the File containing the passport.
623
+ end
624
+ end
625
+ end
626
+
627
+ module Prong
628
+ extend Increase::Internal::Type::Enum
629
+
630
+ # A person with 25% or greater direct or indirect ownership of the entity.
631
+ OWNERSHIP = :ownership
632
+
633
+ # A person who manages, directs, or has significant control of the entity.
634
+ CONTROL = :control
635
+
636
+ # @!method self.values
637
+ # @return [Array<Symbol>]
638
+ end
639
+ end
640
+
641
+ # If the entity is exempt from the requirement to submit beneficial owners,
642
+ # provide the justification. If a reason is provided, you do not need to submit a
643
+ # list of beneficial owners.
644
+ #
645
+ # @see Increase::Models::EntityCreateParams::Corporation#beneficial_ownership_exemption_reason
646
+ module BeneficialOwnershipExemptionReason
647
+ extend Increase::Internal::Type::Enum
648
+
649
+ # A regulated financial institution.
650
+ REGULATED_FINANCIAL_INSTITUTION = :regulated_financial_institution
651
+
652
+ # A publicly traded company.
653
+ PUBLICLY_TRADED_COMPANY = :publicly_traded_company
654
+
655
+ # A public entity acting on behalf of the federal or a state government.
656
+ PUBLIC_ENTITY = :public_entity
657
+
658
+ # @!method self.values
659
+ # @return [Array<Symbol>]
660
+ end
661
+ end
662
+
663
+ class GovernmentAuthority < Increase::Internal::Type::BaseModel
664
+ # @!attribute address
665
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
666
+ # are disallowed.
667
+ #
668
+ # @return [Increase::Models::EntityCreateParams::GovernmentAuthority::Address]
669
+ required :address, -> { Increase::EntityCreateParams::GovernmentAuthority::Address }
670
+
671
+ # @!attribute authorized_persons
672
+ # The identifying details of authorized officials acting on the entity's behalf.
673
+ #
674
+ # @return [Array<Increase::Models::EntityCreateParams::GovernmentAuthority::AuthorizedPerson>]
675
+ required :authorized_persons,
676
+ -> {
677
+ Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::GovernmentAuthority::AuthorizedPerson]
678
+ }
679
+
680
+ # @!attribute category
681
+ # The category of the government authority.
682
+ #
683
+ # @return [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category]
684
+ required :category, enum: -> { Increase::EntityCreateParams::GovernmentAuthority::Category }
685
+
686
+ # @!attribute name
687
+ # The legal name of the government authority.
688
+ #
689
+ # @return [String]
690
+ required :name, String
691
+
692
+ # @!attribute tax_identifier
693
+ # The Employer Identification Number (EIN) for the government authority.
694
+ #
695
+ # @return [String]
696
+ required :tax_identifier, String
697
+
698
+ # @!attribute website
699
+ # The website of the government authority.
700
+ #
701
+ # @return [String, nil]
702
+ optional :website, String
703
+
704
+ # @!method initialize(address:, authorized_persons:, category:, name:, tax_identifier:, website: nil)
705
+ # Some parameter documentations has been truncated, see
706
+ # {Increase::Models::EntityCreateParams::GovernmentAuthority} for more details.
707
+ #
708
+ # Details of the Government Authority entity to create. Required if `structure` is
709
+ # equal to `Government Authority`.
710
+ #
711
+ # @param address [Increase::Models::EntityCreateParams::GovernmentAuthority::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
712
+ #
713
+ # @param authorized_persons [Array<Increase::Models::EntityCreateParams::GovernmentAuthority::AuthorizedPerson>] The identifying details of authorized officials acting on the entity's behalf.
714
+ #
715
+ # @param category [Symbol, Increase::Models::EntityCreateParams::GovernmentAuthority::Category] The category of the government authority.
716
+ #
717
+ # @param name [String] The legal name of the government authority.
718
+ #
719
+ # @param tax_identifier [String] The Employer Identification Number (EIN) for the government authority.
720
+ #
721
+ # @param website [String] The website of the government authority.
722
+
723
+ # @see Increase::Models::EntityCreateParams::GovernmentAuthority#address
724
+ class Address < Increase::Internal::Type::BaseModel
725
+ # @!attribute city
726
+ # The city of the address.
727
+ #
728
+ # @return [String]
729
+ required :city, String
730
+
731
+ # @!attribute line1
732
+ # The first line of the address. This is usually the street number and street.
733
+ #
734
+ # @return [String]
735
+ required :line1, String
736
+
737
+ # @!attribute state
738
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
739
+ # the address.
740
+ #
741
+ # @return [String]
742
+ required :state, String
743
+
744
+ # @!attribute zip
745
+ # The ZIP code of the address.
746
+ #
747
+ # @return [String]
748
+ required :zip, String
749
+
750
+ # @!attribute line2
751
+ # The second line of the address. This might be the floor or room number.
752
+ #
753
+ # @return [String, nil]
754
+ optional :line2, String
755
+
756
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
757
+ # Some parameter documentations has been truncated, see
758
+ # {Increase::Models::EntityCreateParams::GovernmentAuthority::Address} for more
759
+ # details.
760
+ #
761
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
762
+ # are disallowed.
763
+ #
764
+ # @param city [String] The city of the address.
765
+ #
766
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
767
+ #
768
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
769
+ #
770
+ # @param zip [String] The ZIP code of the address.
771
+ #
772
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
773
+ end
774
+
775
+ class AuthorizedPerson < Increase::Internal::Type::BaseModel
776
+ # @!attribute name
777
+ # The person's legal name.
778
+ #
779
+ # @return [String]
780
+ required :name, String
781
+
782
+ # @!method initialize(name:)
783
+ # @param name [String] The person's legal name.
784
+ end
785
+
786
+ # The category of the government authority.
787
+ #
788
+ # @see Increase::Models::EntityCreateParams::GovernmentAuthority#category
789
+ module Category
790
+ extend Increase::Internal::Type::Enum
791
+
792
+ # The Public Entity is a Municipality.
793
+ MUNICIPALITY = :municipality
794
+
795
+ # @!method self.values
796
+ # @return [Array<Symbol>]
797
+ end
798
+ end
799
+
800
+ class Joint < Increase::Internal::Type::BaseModel
801
+ # @!attribute individuals
802
+ # The two individuals that share control of the entity.
803
+ #
804
+ # @return [Array<Increase::Models::EntityCreateParams::Joint::Individual>]
805
+ required :individuals,
806
+ -> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::Joint::Individual] }
807
+
808
+ # @!attribute name
809
+ # The name of the joint entity.
810
+ #
811
+ # @return [String, nil]
812
+ optional :name, String
813
+
814
+ # @!method initialize(individuals:, name: nil)
815
+ # Details of the joint entity to create. Required if `structure` is equal to
816
+ # `joint`.
817
+ #
818
+ # @param individuals [Array<Increase::Models::EntityCreateParams::Joint::Individual>] The two individuals that share control of the entity.
819
+ #
820
+ # @param name [String] The name of the joint entity.
821
+
822
+ class Individual < Increase::Internal::Type::BaseModel
823
+ # @!attribute address
824
+ # The individual's physical address. Mail receiving locations like PO Boxes and
825
+ # PMB's are disallowed.
826
+ #
827
+ # @return [Increase::Models::EntityCreateParams::Joint::Individual::Address]
828
+ required :address, -> { Increase::EntityCreateParams::Joint::Individual::Address }
829
+
830
+ # @!attribute date_of_birth
831
+ # The person's date of birth in YYYY-MM-DD format.
832
+ #
833
+ # @return [Date]
834
+ required :date_of_birth, Date
835
+
836
+ # @!attribute identification
837
+ # A means of verifying the person's identity.
838
+ #
839
+ # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification]
840
+ required :identification, -> { Increase::EntityCreateParams::Joint::Individual::Identification }
841
+
842
+ # @!attribute name
843
+ # The person's legal name.
844
+ #
845
+ # @return [String]
846
+ required :name, String
847
+
848
+ # @!attribute confirmed_no_us_tax_id
849
+ # The identification method for an individual can only be a passport, driver's
850
+ # license, or other document if you've confirmed the individual does not have a US
851
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
852
+ # Number).
853
+ #
854
+ # @return [Boolean, nil]
855
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
856
+
857
+ # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
858
+ # Some parameter documentations has been truncated, see
859
+ # {Increase::Models::EntityCreateParams::Joint::Individual} for more details.
860
+ #
861
+ # @param address [Increase::Models::EntityCreateParams::Joint::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
862
+ #
863
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
864
+ #
865
+ # @param identification [Increase::Models::EntityCreateParams::Joint::Individual::Identification] A means of verifying the person's identity.
866
+ #
867
+ # @param name [String] The person's legal name.
868
+ #
869
+ # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
870
+
871
+ # @see Increase::Models::EntityCreateParams::Joint::Individual#address
872
+ class Address < Increase::Internal::Type::BaseModel
873
+ # @!attribute city
874
+ # The city of the address.
875
+ #
876
+ # @return [String]
877
+ required :city, String
878
+
879
+ # @!attribute line1
880
+ # The first line of the address. This is usually the street number and street.
881
+ #
882
+ # @return [String]
883
+ required :line1, String
884
+
885
+ # @!attribute state
886
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
887
+ # the address.
888
+ #
889
+ # @return [String]
890
+ required :state, String
891
+
892
+ # @!attribute zip
893
+ # The ZIP code of the address.
894
+ #
895
+ # @return [String]
896
+ required :zip, String
897
+
898
+ # @!attribute line2
899
+ # The second line of the address. This might be the floor or room number.
900
+ #
901
+ # @return [String, nil]
902
+ optional :line2, String
903
+
904
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
905
+ # Some parameter documentations has been truncated, see
906
+ # {Increase::Models::EntityCreateParams::Joint::Individual::Address} for more
907
+ # details.
908
+ #
909
+ # The individual's physical address. Mail receiving locations like PO Boxes and
910
+ # PMB's are disallowed.
911
+ #
912
+ # @param city [String] The city of the address.
913
+ #
914
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
915
+ #
916
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
917
+ #
918
+ # @param zip [String] The ZIP code of the address.
919
+ #
920
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
921
+ end
922
+
923
+ # @see Increase::Models::EntityCreateParams::Joint::Individual#identification
924
+ class Identification < Increase::Internal::Type::BaseModel
925
+ # @!attribute method_
926
+ # A method that can be used to verify the individual's identity.
927
+ #
928
+ # @return [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method]
929
+ required :method_,
930
+ enum: -> { Increase::EntityCreateParams::Joint::Individual::Identification::Method },
931
+ api_name: :method
932
+
933
+ # @!attribute number
934
+ # An identification number that can be used to verify the individual's identity,
935
+ # such as a social security number.
936
+ #
937
+ # @return [String]
938
+ required :number, String
939
+
940
+ # @!attribute drivers_license
941
+ # Information about the United States driver's license used for identification.
942
+ # Required if `method` is equal to `drivers_license`.
943
+ #
944
+ # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense, nil]
945
+ optional :drivers_license,
946
+ -> { Increase::EntityCreateParams::Joint::Individual::Identification::DriversLicense }
947
+
948
+ # @!attribute other
949
+ # Information about the identification document provided. Required if `method` is
950
+ # equal to `other`.
951
+ #
952
+ # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other, nil]
953
+ optional :other, -> { Increase::EntityCreateParams::Joint::Individual::Identification::Other }
954
+
955
+ # @!attribute passport
956
+ # Information about the passport used for identification. Required if `method` is
957
+ # equal to `passport`.
958
+ #
959
+ # @return [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport, nil]
960
+ optional :passport,
961
+ -> {
962
+ Increase::EntityCreateParams::Joint::Individual::Identification::Passport
963
+ }
964
+
965
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
966
+ # Some parameter documentations has been truncated, see
967
+ # {Increase::Models::EntityCreateParams::Joint::Individual::Identification} for
968
+ # more details.
969
+ #
970
+ # A means of verifying the person's identity.
971
+ #
972
+ # @param method_ [Symbol, Increase::Models::EntityCreateParams::Joint::Individual::Identification::Method] A method that can be used to verify the individual's identity.
973
+ #
974
+ # @param number [String] An identification number that can be used to verify the individual's identity, s
975
+ #
976
+ # @param drivers_license [Increase::Models::EntityCreateParams::Joint::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
977
+ #
978
+ # @param other [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other] Information about the identification document provided. Required if `method` is
979
+ #
980
+ # @param passport [Increase::Models::EntityCreateParams::Joint::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is
981
+
982
+ # A method that can be used to verify the individual's identity.
983
+ #
984
+ # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#method_
985
+ module Method
986
+ extend Increase::Internal::Type::Enum
987
+
988
+ # A social security number.
989
+ SOCIAL_SECURITY_NUMBER = :social_security_number
990
+
991
+ # An individual taxpayer identification number (ITIN).
992
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
993
+
994
+ # A passport number.
995
+ PASSPORT = :passport
996
+
997
+ # A driver's license number.
998
+ DRIVERS_LICENSE = :drivers_license
999
+
1000
+ # Another identifying document.
1001
+ OTHER = :other
1002
+
1003
+ # @!method self.values
1004
+ # @return [Array<Symbol>]
1005
+ end
1006
+
1007
+ # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#drivers_license
1008
+ class DriversLicense < Increase::Internal::Type::BaseModel
1009
+ # @!attribute expiration_date
1010
+ # The driver's license's expiration date in YYYY-MM-DD format.
1011
+ #
1012
+ # @return [Date]
1013
+ required :expiration_date, Date
1014
+
1015
+ # @!attribute file_id
1016
+ # The identifier of the File containing the front of the driver's license.
1017
+ #
1018
+ # @return [String]
1019
+ required :file_id, String
1020
+
1021
+ # @!attribute state
1022
+ # The state that issued the provided driver's license.
1023
+ #
1024
+ # @return [String]
1025
+ required :state, String
1026
+
1027
+ # @!attribute back_file_id
1028
+ # The identifier of the File containing the back of the driver's license.
1029
+ #
1030
+ # @return [String, nil]
1031
+ optional :back_file_id, String
1032
+
1033
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
1034
+ # Information about the United States driver's license used for identification.
1035
+ # Required if `method` is equal to `drivers_license`.
1036
+ #
1037
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
1038
+ #
1039
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
1040
+ #
1041
+ # @param state [String] The state that issued the provided driver's license.
1042
+ #
1043
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
1044
+ end
1045
+
1046
+ # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#other
1047
+ class Other < Increase::Internal::Type::BaseModel
1048
+ # @!attribute country
1049
+ # The two-character ISO 3166-1 code representing the country that issued the
1050
+ # document.
1051
+ #
1052
+ # @return [String]
1053
+ required :country, String
1054
+
1055
+ # @!attribute description
1056
+ # A description of the document submitted.
1057
+ #
1058
+ # @return [String]
1059
+ required :description, String
1060
+
1061
+ # @!attribute file_id
1062
+ # The identifier of the File containing the front of the document.
1063
+ #
1064
+ # @return [String]
1065
+ required :file_id, String
1066
+
1067
+ # @!attribute back_file_id
1068
+ # The identifier of the File containing the back of the document. Not every
1069
+ # document has a reverse side.
1070
+ #
1071
+ # @return [String, nil]
1072
+ optional :back_file_id, String
1073
+
1074
+ # @!attribute expiration_date
1075
+ # The document's expiration date in YYYY-MM-DD format.
1076
+ #
1077
+ # @return [Date, nil]
1078
+ optional :expiration_date, Date
1079
+
1080
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
1081
+ # Some parameter documentations has been truncated, see
1082
+ # {Increase::Models::EntityCreateParams::Joint::Individual::Identification::Other}
1083
+ # for more details.
1084
+ #
1085
+ # Information about the identification document provided. Required if `method` is
1086
+ # equal to `other`.
1087
+ #
1088
+ # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
1089
+ #
1090
+ # @param description [String] A description of the document submitted.
1091
+ #
1092
+ # @param file_id [String] The identifier of the File containing the front of the document.
1093
+ #
1094
+ # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
1095
+ #
1096
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
1097
+ end
1098
+
1099
+ # @see Increase::Models::EntityCreateParams::Joint::Individual::Identification#passport
1100
+ class Passport < Increase::Internal::Type::BaseModel
1101
+ # @!attribute country
1102
+ # The country that issued the passport.
1103
+ #
1104
+ # @return [String]
1105
+ required :country, String
1106
+
1107
+ # @!attribute expiration_date
1108
+ # The passport's expiration date in YYYY-MM-DD format.
1109
+ #
1110
+ # @return [Date]
1111
+ required :expiration_date, Date
1112
+
1113
+ # @!attribute file_id
1114
+ # The identifier of the File containing the passport.
1115
+ #
1116
+ # @return [String]
1117
+ required :file_id, String
1118
+
1119
+ # @!method initialize(country:, expiration_date:, file_id:)
1120
+ # Information about the passport used for identification. Required if `method` is
1121
+ # equal to `passport`.
1122
+ #
1123
+ # @param country [String] The country that issued the passport.
1124
+ #
1125
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
1126
+ #
1127
+ # @param file_id [String] The identifier of the File containing the passport.
1128
+ end
1129
+ end
1130
+ end
1131
+ end
1132
+
1133
+ class NaturalPerson < Increase::Internal::Type::BaseModel
1134
+ # @!attribute address
1135
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1136
+ # PMB's are disallowed.
1137
+ #
1138
+ # @return [Increase::Models::EntityCreateParams::NaturalPerson::Address]
1139
+ required :address, -> { Increase::EntityCreateParams::NaturalPerson::Address }
1140
+
1141
+ # @!attribute date_of_birth
1142
+ # The person's date of birth in YYYY-MM-DD format.
1143
+ #
1144
+ # @return [Date]
1145
+ required :date_of_birth, Date
1146
+
1147
+ # @!attribute identification
1148
+ # A means of verifying the person's identity.
1149
+ #
1150
+ # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification]
1151
+ required :identification, -> { Increase::EntityCreateParams::NaturalPerson::Identification }
1152
+
1153
+ # @!attribute name
1154
+ # The person's legal name.
1155
+ #
1156
+ # @return [String]
1157
+ required :name, String
1158
+
1159
+ # @!attribute confirmed_no_us_tax_id
1160
+ # The identification method for an individual can only be a passport, driver's
1161
+ # license, or other document if you've confirmed the individual does not have a US
1162
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
1163
+ # Number).
1164
+ #
1165
+ # @return [Boolean, nil]
1166
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
1167
+
1168
+ # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
1169
+ # Some parameter documentations has been truncated, see
1170
+ # {Increase::Models::EntityCreateParams::NaturalPerson} for more details.
1171
+ #
1172
+ # Details of the natural person entity to create. Required if `structure` is equal
1173
+ # to `natural_person`. Natural people entities should be submitted with
1174
+ # `social_security_number` or `individual_taxpayer_identification_number`
1175
+ # identification methods.
1176
+ #
1177
+ # @param address [Increase::Models::EntityCreateParams::NaturalPerson::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
1178
+ #
1179
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
1180
+ #
1181
+ # @param identification [Increase::Models::EntityCreateParams::NaturalPerson::Identification] A means of verifying the person's identity.
1182
+ #
1183
+ # @param name [String] The person's legal name.
1184
+ #
1185
+ # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
1186
+
1187
+ # @see Increase::Models::EntityCreateParams::NaturalPerson#address
1188
+ class Address < Increase::Internal::Type::BaseModel
1189
+ # @!attribute city
1190
+ # The city of the address.
1191
+ #
1192
+ # @return [String]
1193
+ required :city, String
1194
+
1195
+ # @!attribute line1
1196
+ # The first line of the address. This is usually the street number and street.
1197
+ #
1198
+ # @return [String]
1199
+ required :line1, String
1200
+
1201
+ # @!attribute state
1202
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1203
+ # the address.
1204
+ #
1205
+ # @return [String]
1206
+ required :state, String
1207
+
1208
+ # @!attribute zip
1209
+ # The ZIP code of the address.
1210
+ #
1211
+ # @return [String]
1212
+ required :zip, String
1213
+
1214
+ # @!attribute line2
1215
+ # The second line of the address. This might be the floor or room number.
1216
+ #
1217
+ # @return [String, nil]
1218
+ optional :line2, String
1219
+
1220
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
1221
+ # Some parameter documentations has been truncated, see
1222
+ # {Increase::Models::EntityCreateParams::NaturalPerson::Address} for more details.
1223
+ #
1224
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1225
+ # PMB's are disallowed.
1226
+ #
1227
+ # @param city [String] The city of the address.
1228
+ #
1229
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1230
+ #
1231
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
1232
+ #
1233
+ # @param zip [String] The ZIP code of the address.
1234
+ #
1235
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
1236
+ end
1237
+
1238
+ # @see Increase::Models::EntityCreateParams::NaturalPerson#identification
1239
+ class Identification < Increase::Internal::Type::BaseModel
1240
+ # @!attribute method_
1241
+ # A method that can be used to verify the individual's identity.
1242
+ #
1243
+ # @return [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method]
1244
+ required :method_,
1245
+ enum: -> { Increase::EntityCreateParams::NaturalPerson::Identification::Method },
1246
+ api_name: :method
1247
+
1248
+ # @!attribute number
1249
+ # An identification number that can be used to verify the individual's identity,
1250
+ # such as a social security number.
1251
+ #
1252
+ # @return [String]
1253
+ required :number, String
1254
+
1255
+ # @!attribute drivers_license
1256
+ # Information about the United States driver's license used for identification.
1257
+ # Required if `method` is equal to `drivers_license`.
1258
+ #
1259
+ # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense, nil]
1260
+ optional :drivers_license,
1261
+ -> { Increase::EntityCreateParams::NaturalPerson::Identification::DriversLicense }
1262
+
1263
+ # @!attribute other
1264
+ # Information about the identification document provided. Required if `method` is
1265
+ # equal to `other`.
1266
+ #
1267
+ # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other, nil]
1268
+ optional :other, -> { Increase::EntityCreateParams::NaturalPerson::Identification::Other }
1269
+
1270
+ # @!attribute passport
1271
+ # Information about the passport used for identification. Required if `method` is
1272
+ # equal to `passport`.
1273
+ #
1274
+ # @return [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport, nil]
1275
+ optional :passport, -> { Increase::EntityCreateParams::NaturalPerson::Identification::Passport }
1276
+
1277
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
1278
+ # Some parameter documentations has been truncated, see
1279
+ # {Increase::Models::EntityCreateParams::NaturalPerson::Identification} for more
1280
+ # details.
1281
+ #
1282
+ # A means of verifying the person's identity.
1283
+ #
1284
+ # @param method_ [Symbol, Increase::Models::EntityCreateParams::NaturalPerson::Identification::Method] A method that can be used to verify the individual's identity.
1285
+ #
1286
+ # @param number [String] An identification number that can be used to verify the individual's identity, s
1287
+ #
1288
+ # @param drivers_license [Increase::Models::EntityCreateParams::NaturalPerson::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
1289
+ #
1290
+ # @param other [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other] Information about the identification document provided. Required if `method` is
1291
+ #
1292
+ # @param passport [Increase::Models::EntityCreateParams::NaturalPerson::Identification::Passport] Information about the passport used for identification. Required if `method` is
1293
+
1294
+ # A method that can be used to verify the individual's identity.
1295
+ #
1296
+ # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#method_
1297
+ module Method
1298
+ extend Increase::Internal::Type::Enum
1299
+
1300
+ # A social security number.
1301
+ SOCIAL_SECURITY_NUMBER = :social_security_number
1302
+
1303
+ # An individual taxpayer identification number (ITIN).
1304
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1305
+
1306
+ # A passport number.
1307
+ PASSPORT = :passport
1308
+
1309
+ # A driver's license number.
1310
+ DRIVERS_LICENSE = :drivers_license
1311
+
1312
+ # Another identifying document.
1313
+ OTHER = :other
1314
+
1315
+ # @!method self.values
1316
+ # @return [Array<Symbol>]
1317
+ end
1318
+
1319
+ # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#drivers_license
1320
+ class DriversLicense < Increase::Internal::Type::BaseModel
1321
+ # @!attribute expiration_date
1322
+ # The driver's license's expiration date in YYYY-MM-DD format.
1323
+ #
1324
+ # @return [Date]
1325
+ required :expiration_date, Date
1326
+
1327
+ # @!attribute file_id
1328
+ # The identifier of the File containing the front of the driver's license.
1329
+ #
1330
+ # @return [String]
1331
+ required :file_id, String
1332
+
1333
+ # @!attribute state
1334
+ # The state that issued the provided driver's license.
1335
+ #
1336
+ # @return [String]
1337
+ required :state, String
1338
+
1339
+ # @!attribute back_file_id
1340
+ # The identifier of the File containing the back of the driver's license.
1341
+ #
1342
+ # @return [String, nil]
1343
+ optional :back_file_id, String
1344
+
1345
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
1346
+ # Information about the United States driver's license used for identification.
1347
+ # Required if `method` is equal to `drivers_license`.
1348
+ #
1349
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
1350
+ #
1351
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
1352
+ #
1353
+ # @param state [String] The state that issued the provided driver's license.
1354
+ #
1355
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
1356
+ end
1357
+
1358
+ # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#other
1359
+ class Other < Increase::Internal::Type::BaseModel
1360
+ # @!attribute country
1361
+ # The two-character ISO 3166-1 code representing the country that issued the
1362
+ # document.
1363
+ #
1364
+ # @return [String]
1365
+ required :country, String
1366
+
1367
+ # @!attribute description
1368
+ # A description of the document submitted.
1369
+ #
1370
+ # @return [String]
1371
+ required :description, String
1372
+
1373
+ # @!attribute file_id
1374
+ # The identifier of the File containing the front of the document.
1375
+ #
1376
+ # @return [String]
1377
+ required :file_id, String
1378
+
1379
+ # @!attribute back_file_id
1380
+ # The identifier of the File containing the back of the document. Not every
1381
+ # document has a reverse side.
1382
+ #
1383
+ # @return [String, nil]
1384
+ optional :back_file_id, String
1385
+
1386
+ # @!attribute expiration_date
1387
+ # The document's expiration date in YYYY-MM-DD format.
1388
+ #
1389
+ # @return [Date, nil]
1390
+ optional :expiration_date, Date
1391
+
1392
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
1393
+ # Some parameter documentations has been truncated, see
1394
+ # {Increase::Models::EntityCreateParams::NaturalPerson::Identification::Other} for
1395
+ # more details.
1396
+ #
1397
+ # Information about the identification document provided. Required if `method` is
1398
+ # equal to `other`.
1399
+ #
1400
+ # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
1401
+ #
1402
+ # @param description [String] A description of the document submitted.
1403
+ #
1404
+ # @param file_id [String] The identifier of the File containing the front of the document.
1405
+ #
1406
+ # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
1407
+ #
1408
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
1409
+ end
1410
+
1411
+ # @see Increase::Models::EntityCreateParams::NaturalPerson::Identification#passport
1412
+ class Passport < Increase::Internal::Type::BaseModel
1413
+ # @!attribute country
1414
+ # The country that issued the passport.
1415
+ #
1416
+ # @return [String]
1417
+ required :country, String
1418
+
1419
+ # @!attribute expiration_date
1420
+ # The passport's expiration date in YYYY-MM-DD format.
1421
+ #
1422
+ # @return [Date]
1423
+ required :expiration_date, Date
1424
+
1425
+ # @!attribute file_id
1426
+ # The identifier of the File containing the passport.
1427
+ #
1428
+ # @return [String]
1429
+ required :file_id, String
1430
+
1431
+ # @!method initialize(country:, expiration_date:, file_id:)
1432
+ # Information about the passport used for identification. Required if `method` is
1433
+ # equal to `passport`.
1434
+ #
1435
+ # @param country [String] The country that issued the passport.
1436
+ #
1437
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
1438
+ #
1439
+ # @param file_id [String] The identifier of the File containing the passport.
1440
+ end
1441
+ end
1442
+ end
1443
+
1444
+ class SupplementalDocument < Increase::Internal::Type::BaseModel
1445
+ # @!attribute file_id
1446
+ # The identifier of the File containing the document.
1447
+ #
1448
+ # @return [String]
1449
+ required :file_id, String
1450
+
1451
+ # @!method initialize(file_id:)
1452
+ # @param file_id [String] The identifier of the File containing the document.
1453
+ end
1454
+
1455
+ class ThirdPartyVerification < Increase::Internal::Type::BaseModel
1456
+ # @!attribute reference
1457
+ # The reference identifier for the third party verification.
1458
+ #
1459
+ # @return [String]
1460
+ required :reference, String
1461
+
1462
+ # @!attribute vendor
1463
+ # The vendor that was used to perform the verification.
1464
+ #
1465
+ # @return [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor]
1466
+ required :vendor, enum: -> { Increase::EntityCreateParams::ThirdPartyVerification::Vendor }
1467
+
1468
+ # @!method initialize(reference:, vendor:)
1469
+ # A reference to data stored in a third-party verification service. Your
1470
+ # integration may or may not use this field.
1471
+ #
1472
+ # @param reference [String] The reference identifier for the third party verification.
1473
+ #
1474
+ # @param vendor [Symbol, Increase::Models::EntityCreateParams::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification.
1475
+
1476
+ # The vendor that was used to perform the verification.
1477
+ #
1478
+ # @see Increase::Models::EntityCreateParams::ThirdPartyVerification#vendor
1479
+ module Vendor
1480
+ extend Increase::Internal::Type::Enum
1481
+
1482
+ # Alloy. See https://alloy.com for more information.
1483
+ ALLOY = :alloy
1484
+
1485
+ # Middesk. See https://middesk.com for more information.
1486
+ MIDDESK = :middesk
1487
+
1488
+ # Oscilar. See https://oscilar.com for more information.
1489
+ OSCILAR = :oscilar
1490
+
1491
+ # @!method self.values
1492
+ # @return [Array<Symbol>]
1493
+ end
1494
+ end
1495
+
1496
+ class Trust < Increase::Internal::Type::BaseModel
1497
+ # @!attribute address
1498
+ # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
1499
+ # are disallowed.
1500
+ #
1501
+ # @return [Increase::Models::EntityCreateParams::Trust::Address]
1502
+ required :address, -> { Increase::EntityCreateParams::Trust::Address }
1503
+
1504
+ # @!attribute category
1505
+ # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
1506
+ # their own Employer Identification Number. Revocable trusts require information
1507
+ # about the individual `grantor` who created the trust.
1508
+ #
1509
+ # @return [Symbol, Increase::Models::EntityCreateParams::Trust::Category]
1510
+ required :category, enum: -> { Increase::EntityCreateParams::Trust::Category }
1511
+
1512
+ # @!attribute name
1513
+ # The legal name of the trust.
1514
+ #
1515
+ # @return [String]
1516
+ required :name, String
1517
+
1518
+ # @!attribute trustees
1519
+ # The trustees of the trust.
1520
+ #
1521
+ # @return [Array<Increase::Models::EntityCreateParams::Trust::Trustee>]
1522
+ required :trustees,
1523
+ -> {
1524
+ Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::Trust::Trustee]
1525
+ }
1526
+
1527
+ # @!attribute formation_document_file_id
1528
+ # The identifier of the File containing the formation document of the trust.
1529
+ #
1530
+ # @return [String, nil]
1531
+ optional :formation_document_file_id, String
1532
+
1533
+ # @!attribute formation_state
1534
+ # The two-letter United States Postal Service (USPS) abbreviation for the state in
1535
+ # which the trust was formed.
1536
+ #
1537
+ # @return [String, nil]
1538
+ optional :formation_state, String
1539
+
1540
+ # @!attribute grantor
1541
+ # The grantor of the trust. Required if `category` is equal to `revocable`.
1542
+ #
1543
+ # @return [Increase::Models::EntityCreateParams::Trust::Grantor, nil]
1544
+ optional :grantor, -> { Increase::EntityCreateParams::Trust::Grantor }
1545
+
1546
+ # @!attribute tax_identifier
1547
+ # The Employer Identification Number (EIN) for the trust. Required if `category`
1548
+ # is equal to `irrevocable`.
1549
+ #
1550
+ # @return [String, nil]
1551
+ optional :tax_identifier, String
1552
+
1553
+ # @!method initialize(address:, category:, name:, trustees:, formation_document_file_id: nil, formation_state: nil, grantor: nil, tax_identifier: nil)
1554
+ # Some parameter documentations has been truncated, see
1555
+ # {Increase::Models::EntityCreateParams::Trust} for more details.
1556
+ #
1557
+ # Details of the trust entity to create. Required if `structure` is equal to
1558
+ # `trust`.
1559
+ #
1560
+ # @param address [Increase::Models::EntityCreateParams::Trust::Address] The trust's physical address. Mail receiving locations like PO Boxes and PMB's a
1561
+ #
1562
+ # @param category [Symbol, Increase::Models::EntityCreateParams::Trust::Category] Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require th
1563
+ #
1564
+ # @param name [String] The legal name of the trust.
1565
+ #
1566
+ # @param trustees [Array<Increase::Models::EntityCreateParams::Trust::Trustee>] The trustees of the trust.
1567
+ #
1568
+ # @param formation_document_file_id [String] The identifier of the File containing the formation document of the trust.
1569
+ #
1570
+ # @param formation_state [String] The two-letter United States Postal Service (USPS) abbreviation for the state in
1571
+ #
1572
+ # @param grantor [Increase::Models::EntityCreateParams::Trust::Grantor] The grantor of the trust. Required if `category` is equal to `revocable`.
1573
+ #
1574
+ # @param tax_identifier [String] The Employer Identification Number (EIN) for the trust. Required if `category` i
1575
+
1576
+ # @see Increase::Models::EntityCreateParams::Trust#address
1577
+ class Address < Increase::Internal::Type::BaseModel
1578
+ # @!attribute city
1579
+ # The city of the address.
1580
+ #
1581
+ # @return [String]
1582
+ required :city, String
1583
+
1584
+ # @!attribute line1
1585
+ # The first line of the address. This is usually the street number and street.
1586
+ #
1587
+ # @return [String]
1588
+ required :line1, String
1589
+
1590
+ # @!attribute state
1591
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1592
+ # the address.
1593
+ #
1594
+ # @return [String]
1595
+ required :state, String
1596
+
1597
+ # @!attribute zip
1598
+ # The ZIP code of the address.
1599
+ #
1600
+ # @return [String]
1601
+ required :zip, String
1602
+
1603
+ # @!attribute line2
1604
+ # The second line of the address. This might be the floor or room number.
1605
+ #
1606
+ # @return [String, nil]
1607
+ optional :line2, String
1608
+
1609
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
1610
+ # Some parameter documentations has been truncated, see
1611
+ # {Increase::Models::EntityCreateParams::Trust::Address} for more details.
1612
+ #
1613
+ # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
1614
+ # are disallowed.
1615
+ #
1616
+ # @param city [String] The city of the address.
1617
+ #
1618
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1619
+ #
1620
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
1621
+ #
1622
+ # @param zip [String] The ZIP code of the address.
1623
+ #
1624
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
1625
+ end
1626
+
1627
+ # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
1628
+ # their own Employer Identification Number. Revocable trusts require information
1629
+ # about the individual `grantor` who created the trust.
1630
+ #
1631
+ # @see Increase::Models::EntityCreateParams::Trust#category
1632
+ module Category
1633
+ extend Increase::Internal::Type::Enum
1634
+
1635
+ # The trust is revocable by the grantor.
1636
+ REVOCABLE = :revocable
1637
+
1638
+ # The trust cannot be revoked.
1639
+ IRREVOCABLE = :irrevocable
1640
+
1641
+ # @!method self.values
1642
+ # @return [Array<Symbol>]
1643
+ end
1644
+
1645
+ class Trustee < Increase::Internal::Type::BaseModel
1646
+ # @!attribute structure
1647
+ # The structure of the trustee.
1648
+ #
1649
+ # @return [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure]
1650
+ required :structure, enum: -> { Increase::EntityCreateParams::Trust::Trustee::Structure }
1651
+
1652
+ # @!attribute individual
1653
+ # Details of the individual trustee. Required when the trustee `structure` is
1654
+ # equal to `individual`.
1655
+ #
1656
+ # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual, nil]
1657
+ optional :individual, -> { Increase::EntityCreateParams::Trust::Trustee::Individual }
1658
+
1659
+ # @!method initialize(structure:, individual: nil)
1660
+ # Some parameter documentations has been truncated, see
1661
+ # {Increase::Models::EntityCreateParams::Trust::Trustee} for more details.
1662
+ #
1663
+ # @param structure [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Structure] The structure of the trustee.
1664
+ #
1665
+ # @param individual [Increase::Models::EntityCreateParams::Trust::Trustee::Individual] Details of the individual trustee. Required when the trustee `structure` is equa
1666
+
1667
+ # The structure of the trustee.
1668
+ #
1669
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee#structure
1670
+ module Structure
1671
+ extend Increase::Internal::Type::Enum
1672
+
1673
+ # The trustee is an individual.
1674
+ INDIVIDUAL = :individual
1675
+
1676
+ # @!method self.values
1677
+ # @return [Array<Symbol>]
1678
+ end
1679
+
1680
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee#individual
1681
+ class Individual < Increase::Internal::Type::BaseModel
1682
+ # @!attribute address
1683
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1684
+ # PMB's are disallowed.
1685
+ #
1686
+ # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address]
1687
+ required :address, -> { Increase::EntityCreateParams::Trust::Trustee::Individual::Address }
1688
+
1689
+ # @!attribute date_of_birth
1690
+ # The person's date of birth in YYYY-MM-DD format.
1691
+ #
1692
+ # @return [Date]
1693
+ required :date_of_birth, Date
1694
+
1695
+ # @!attribute identification
1696
+ # A means of verifying the person's identity.
1697
+ #
1698
+ # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification]
1699
+ required :identification,
1700
+ -> {
1701
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification
1702
+ }
1703
+
1704
+ # @!attribute name
1705
+ # The person's legal name.
1706
+ #
1707
+ # @return [String]
1708
+ required :name, String
1709
+
1710
+ # @!attribute confirmed_no_us_tax_id
1711
+ # The identification method for an individual can only be a passport, driver's
1712
+ # license, or other document if you've confirmed the individual does not have a US
1713
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
1714
+ # Number).
1715
+ #
1716
+ # @return [Boolean, nil]
1717
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
1718
+
1719
+ # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
1720
+ # Some parameter documentations has been truncated, see
1721
+ # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual} for more
1722
+ # details.
1723
+ #
1724
+ # Details of the individual trustee. Required when the trustee `structure` is
1725
+ # equal to `individual`.
1726
+ #
1727
+ # @param address [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
1728
+ #
1729
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
1730
+ #
1731
+ # @param identification [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification] A means of verifying the person's identity.
1732
+ #
1733
+ # @param name [String] The person's legal name.
1734
+ #
1735
+ # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
1736
+
1737
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#address
1738
+ class Address < Increase::Internal::Type::BaseModel
1739
+ # @!attribute city
1740
+ # The city of the address.
1741
+ #
1742
+ # @return [String]
1743
+ required :city, String
1744
+
1745
+ # @!attribute line1
1746
+ # The first line of the address. This is usually the street number and street.
1747
+ #
1748
+ # @return [String]
1749
+ required :line1, String
1750
+
1751
+ # @!attribute state
1752
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1753
+ # the address.
1754
+ #
1755
+ # @return [String]
1756
+ required :state, String
1757
+
1758
+ # @!attribute zip
1759
+ # The ZIP code of the address.
1760
+ #
1761
+ # @return [String]
1762
+ required :zip, String
1763
+
1764
+ # @!attribute line2
1765
+ # The second line of the address. This might be the floor or room number.
1766
+ #
1767
+ # @return [String, nil]
1768
+ optional :line2, String
1769
+
1770
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
1771
+ # Some parameter documentations has been truncated, see
1772
+ # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Address} for
1773
+ # more details.
1774
+ #
1775
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1776
+ # PMB's are disallowed.
1777
+ #
1778
+ # @param city [String] The city of the address.
1779
+ #
1780
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1781
+ #
1782
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
1783
+ #
1784
+ # @param zip [String] The ZIP code of the address.
1785
+ #
1786
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
1787
+ end
1788
+
1789
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual#identification
1790
+ class Identification < Increase::Internal::Type::BaseModel
1791
+ # @!attribute method_
1792
+ # A method that can be used to verify the individual's identity.
1793
+ #
1794
+ # @return [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method]
1795
+ required :method_,
1796
+ enum: -> {
1797
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method
1798
+ },
1799
+ api_name: :method
1800
+
1801
+ # @!attribute number
1802
+ # An identification number that can be used to verify the individual's identity,
1803
+ # such as a social security number.
1804
+ #
1805
+ # @return [String]
1806
+ required :number, String
1807
+
1808
+ # @!attribute drivers_license
1809
+ # Information about the United States driver's license used for identification.
1810
+ # Required if `method` is equal to `drivers_license`.
1811
+ #
1812
+ # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense, nil]
1813
+ optional :drivers_license,
1814
+ -> {
1815
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense
1816
+ }
1817
+
1818
+ # @!attribute other
1819
+ # Information about the identification document provided. Required if `method` is
1820
+ # equal to `other`.
1821
+ #
1822
+ # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other, nil]
1823
+ optional :other,
1824
+ -> {
1825
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Other
1826
+ }
1827
+
1828
+ # @!attribute passport
1829
+ # Information about the passport used for identification. Required if `method` is
1830
+ # equal to `passport`.
1831
+ #
1832
+ # @return [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport, nil]
1833
+ optional :passport,
1834
+ -> {
1835
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport
1836
+ }
1837
+
1838
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
1839
+ # Some parameter documentations has been truncated, see
1840
+ # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification}
1841
+ # for more details.
1842
+ #
1843
+ # A means of verifying the person's identity.
1844
+ #
1845
+ # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Method] A method that can be used to verify the individual's identity.
1846
+ #
1847
+ # @param number [String] An identification number that can be used to verify the individual's identity, s
1848
+ #
1849
+ # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
1850
+ #
1851
+ # @param other [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other] Information about the identification document provided. Required if `method` is
1852
+ #
1853
+ # @param passport [Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport] Information about the passport used for identification. Required if `method` is
1854
+
1855
+ # A method that can be used to verify the individual's identity.
1856
+ #
1857
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#method_
1858
+ module Method
1859
+ extend Increase::Internal::Type::Enum
1860
+
1861
+ # A social security number.
1862
+ SOCIAL_SECURITY_NUMBER = :social_security_number
1863
+
1864
+ # An individual taxpayer identification number (ITIN).
1865
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
1866
+
1867
+ # A passport number.
1868
+ PASSPORT = :passport
1869
+
1870
+ # A driver's license number.
1871
+ DRIVERS_LICENSE = :drivers_license
1872
+
1873
+ # Another identifying document.
1874
+ OTHER = :other
1875
+
1876
+ # @!method self.values
1877
+ # @return [Array<Symbol>]
1878
+ end
1879
+
1880
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#drivers_license
1881
+ class DriversLicense < Increase::Internal::Type::BaseModel
1882
+ # @!attribute expiration_date
1883
+ # The driver's license's expiration date in YYYY-MM-DD format.
1884
+ #
1885
+ # @return [Date]
1886
+ required :expiration_date, Date
1887
+
1888
+ # @!attribute file_id
1889
+ # The identifier of the File containing the front of the driver's license.
1890
+ #
1891
+ # @return [String]
1892
+ required :file_id, String
1893
+
1894
+ # @!attribute state
1895
+ # The state that issued the provided driver's license.
1896
+ #
1897
+ # @return [String]
1898
+ required :state, String
1899
+
1900
+ # @!attribute back_file_id
1901
+ # The identifier of the File containing the back of the driver's license.
1902
+ #
1903
+ # @return [String, nil]
1904
+ optional :back_file_id, String
1905
+
1906
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
1907
+ # Information about the United States driver's license used for identification.
1908
+ # Required if `method` is equal to `drivers_license`.
1909
+ #
1910
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
1911
+ #
1912
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
1913
+ #
1914
+ # @param state [String] The state that issued the provided driver's license.
1915
+ #
1916
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
1917
+ end
1918
+
1919
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#other
1920
+ class Other < Increase::Internal::Type::BaseModel
1921
+ # @!attribute country
1922
+ # The two-character ISO 3166-1 code representing the country that issued the
1923
+ # document.
1924
+ #
1925
+ # @return [String]
1926
+ required :country, String
1927
+
1928
+ # @!attribute description
1929
+ # A description of the document submitted.
1930
+ #
1931
+ # @return [String]
1932
+ required :description, String
1933
+
1934
+ # @!attribute file_id
1935
+ # The identifier of the File containing the front of the document.
1936
+ #
1937
+ # @return [String]
1938
+ required :file_id, String
1939
+
1940
+ # @!attribute back_file_id
1941
+ # The identifier of the File containing the back of the document. Not every
1942
+ # document has a reverse side.
1943
+ #
1944
+ # @return [String, nil]
1945
+ optional :back_file_id, String
1946
+
1947
+ # @!attribute expiration_date
1948
+ # The document's expiration date in YYYY-MM-DD format.
1949
+ #
1950
+ # @return [Date, nil]
1951
+ optional :expiration_date, Date
1952
+
1953
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
1954
+ # Some parameter documentations has been truncated, see
1955
+ # {Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification::Other}
1956
+ # for more details.
1957
+ #
1958
+ # Information about the identification document provided. Required if `method` is
1959
+ # equal to `other`.
1960
+ #
1961
+ # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
1962
+ #
1963
+ # @param description [String] A description of the document submitted.
1964
+ #
1965
+ # @param file_id [String] The identifier of the File containing the front of the document.
1966
+ #
1967
+ # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
1968
+ #
1969
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
1970
+ end
1971
+
1972
+ # @see Increase::Models::EntityCreateParams::Trust::Trustee::Individual::Identification#passport
1973
+ class Passport < Increase::Internal::Type::BaseModel
1974
+ # @!attribute country
1975
+ # The country that issued the passport.
1976
+ #
1977
+ # @return [String]
1978
+ required :country, String
1979
+
1980
+ # @!attribute expiration_date
1981
+ # The passport's expiration date in YYYY-MM-DD format.
1982
+ #
1983
+ # @return [Date]
1984
+ required :expiration_date, Date
1985
+
1986
+ # @!attribute file_id
1987
+ # The identifier of the File containing the passport.
1988
+ #
1989
+ # @return [String]
1990
+ required :file_id, String
1991
+
1992
+ # @!method initialize(country:, expiration_date:, file_id:)
1993
+ # Information about the passport used for identification. Required if `method` is
1994
+ # equal to `passport`.
1995
+ #
1996
+ # @param country [String] The country that issued the passport.
1997
+ #
1998
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
1999
+ #
2000
+ # @param file_id [String] The identifier of the File containing the passport.
2001
+ end
2002
+ end
2003
+ end
2004
+ end
2005
+
2006
+ # @see Increase::Models::EntityCreateParams::Trust#grantor
2007
+ class Grantor < Increase::Internal::Type::BaseModel
2008
+ # @!attribute address
2009
+ # The individual's physical address. Mail receiving locations like PO Boxes and
2010
+ # PMB's are disallowed.
2011
+ #
2012
+ # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Address]
2013
+ required :address, -> { Increase::EntityCreateParams::Trust::Grantor::Address }
2014
+
2015
+ # @!attribute date_of_birth
2016
+ # The person's date of birth in YYYY-MM-DD format.
2017
+ #
2018
+ # @return [Date]
2019
+ required :date_of_birth, Date
2020
+
2021
+ # @!attribute identification
2022
+ # A means of verifying the person's identity.
2023
+ #
2024
+ # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification]
2025
+ required :identification, -> { Increase::EntityCreateParams::Trust::Grantor::Identification }
2026
+
2027
+ # @!attribute name
2028
+ # The person's legal name.
2029
+ #
2030
+ # @return [String]
2031
+ required :name, String
2032
+
2033
+ # @!attribute confirmed_no_us_tax_id
2034
+ # The identification method for an individual can only be a passport, driver's
2035
+ # license, or other document if you've confirmed the individual does not have a US
2036
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
2037
+ # Number).
2038
+ #
2039
+ # @return [Boolean, nil]
2040
+ optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
2041
+
2042
+ # @!method initialize(address:, date_of_birth:, identification:, name:, confirmed_no_us_tax_id: nil)
2043
+ # Some parameter documentations has been truncated, see
2044
+ # {Increase::Models::EntityCreateParams::Trust::Grantor} for more details.
2045
+ #
2046
+ # The grantor of the trust. Required if `category` is equal to `revocable`.
2047
+ #
2048
+ # @param address [Increase::Models::EntityCreateParams::Trust::Grantor::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
2049
+ #
2050
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
2051
+ #
2052
+ # @param identification [Increase::Models::EntityCreateParams::Trust::Grantor::Identification] A means of verifying the person's identity.
2053
+ #
2054
+ # @param name [String] The person's legal name.
2055
+ #
2056
+ # @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
2057
+
2058
+ # @see Increase::Models::EntityCreateParams::Trust::Grantor#address
2059
+ class Address < Increase::Internal::Type::BaseModel
2060
+ # @!attribute city
2061
+ # The city of the address.
2062
+ #
2063
+ # @return [String]
2064
+ required :city, String
2065
+
2066
+ # @!attribute line1
2067
+ # The first line of the address. This is usually the street number and street.
2068
+ #
2069
+ # @return [String]
2070
+ required :line1, String
2071
+
2072
+ # @!attribute state
2073
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
2074
+ # the address.
2075
+ #
2076
+ # @return [String]
2077
+ required :state, String
2078
+
2079
+ # @!attribute zip
2080
+ # The ZIP code of the address.
2081
+ #
2082
+ # @return [String]
2083
+ required :zip, String
2084
+
2085
+ # @!attribute line2
2086
+ # The second line of the address. This might be the floor or room number.
2087
+ #
2088
+ # @return [String, nil]
2089
+ optional :line2, String
2090
+
2091
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
2092
+ # Some parameter documentations has been truncated, see
2093
+ # {Increase::Models::EntityCreateParams::Trust::Grantor::Address} for more
2094
+ # details.
2095
+ #
2096
+ # The individual's physical address. Mail receiving locations like PO Boxes and
2097
+ # PMB's are disallowed.
2098
+ #
2099
+ # @param city [String] The city of the address.
2100
+ #
2101
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
2102
+ #
2103
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
2104
+ #
2105
+ # @param zip [String] The ZIP code of the address.
2106
+ #
2107
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
2108
+ end
2109
+
2110
+ # @see Increase::Models::EntityCreateParams::Trust::Grantor#identification
2111
+ class Identification < Increase::Internal::Type::BaseModel
2112
+ # @!attribute method_
2113
+ # A method that can be used to verify the individual's identity.
2114
+ #
2115
+ # @return [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method]
2116
+ required :method_,
2117
+ enum: -> { Increase::EntityCreateParams::Trust::Grantor::Identification::Method },
2118
+ api_name: :method
2119
+
2120
+ # @!attribute number
2121
+ # An identification number that can be used to verify the individual's identity,
2122
+ # such as a social security number.
2123
+ #
2124
+ # @return [String]
2125
+ required :number, String
2126
+
2127
+ # @!attribute drivers_license
2128
+ # Information about the United States driver's license used for identification.
2129
+ # Required if `method` is equal to `drivers_license`.
2130
+ #
2131
+ # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense, nil]
2132
+ optional :drivers_license,
2133
+ -> { Increase::EntityCreateParams::Trust::Grantor::Identification::DriversLicense }
2134
+
2135
+ # @!attribute other
2136
+ # Information about the identification document provided. Required if `method` is
2137
+ # equal to `other`.
2138
+ #
2139
+ # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other, nil]
2140
+ optional :other, -> { Increase::EntityCreateParams::Trust::Grantor::Identification::Other }
2141
+
2142
+ # @!attribute passport
2143
+ # Information about the passport used for identification. Required if `method` is
2144
+ # equal to `passport`.
2145
+ #
2146
+ # @return [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport, nil]
2147
+ optional :passport, -> { Increase::EntityCreateParams::Trust::Grantor::Identification::Passport }
2148
+
2149
+ # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
2150
+ # Some parameter documentations has been truncated, see
2151
+ # {Increase::Models::EntityCreateParams::Trust::Grantor::Identification} for more
2152
+ # details.
2153
+ #
2154
+ # A means of verifying the person's identity.
2155
+ #
2156
+ # @param method_ [Symbol, Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Method] A method that can be used to verify the individual's identity.
2157
+ #
2158
+ # @param number [String] An identification number that can be used to verify the individual's identity, s
2159
+ #
2160
+ # @param drivers_license [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
2161
+ #
2162
+ # @param other [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other] Information about the identification document provided. Required if `method` is
2163
+ #
2164
+ # @param passport [Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Passport] Information about the passport used for identification. Required if `method` is
2165
+
2166
+ # A method that can be used to verify the individual's identity.
2167
+ #
2168
+ # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#method_
2169
+ module Method
2170
+ extend Increase::Internal::Type::Enum
2171
+
2172
+ # A social security number.
2173
+ SOCIAL_SECURITY_NUMBER = :social_security_number
2174
+
2175
+ # An individual taxpayer identification number (ITIN).
2176
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER = :individual_taxpayer_identification_number
2177
+
2178
+ # A passport number.
2179
+ PASSPORT = :passport
2180
+
2181
+ # A driver's license number.
2182
+ DRIVERS_LICENSE = :drivers_license
2183
+
2184
+ # Another identifying document.
2185
+ OTHER = :other
2186
+
2187
+ # @!method self.values
2188
+ # @return [Array<Symbol>]
2189
+ end
2190
+
2191
+ # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#drivers_license
2192
+ class DriversLicense < Increase::Internal::Type::BaseModel
2193
+ # @!attribute expiration_date
2194
+ # The driver's license's expiration date in YYYY-MM-DD format.
2195
+ #
2196
+ # @return [Date]
2197
+ required :expiration_date, Date
2198
+
2199
+ # @!attribute file_id
2200
+ # The identifier of the File containing the front of the driver's license.
2201
+ #
2202
+ # @return [String]
2203
+ required :file_id, String
2204
+
2205
+ # @!attribute state
2206
+ # The state that issued the provided driver's license.
2207
+ #
2208
+ # @return [String]
2209
+ required :state, String
2210
+
2211
+ # @!attribute back_file_id
2212
+ # The identifier of the File containing the back of the driver's license.
2213
+ #
2214
+ # @return [String, nil]
2215
+ optional :back_file_id, String
2216
+
2217
+ # @!method initialize(expiration_date:, file_id:, state:, back_file_id: nil)
2218
+ # Information about the United States driver's license used for identification.
2219
+ # Required if `method` is equal to `drivers_license`.
2220
+ #
2221
+ # @param expiration_date [Date] The driver's license's expiration date in YYYY-MM-DD format.
2222
+ #
2223
+ # @param file_id [String] The identifier of the File containing the front of the driver's license.
2224
+ #
2225
+ # @param state [String] The state that issued the provided driver's license.
2226
+ #
2227
+ # @param back_file_id [String] The identifier of the File containing the back of the driver's license.
2228
+ end
2229
+
2230
+ # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#other
2231
+ class Other < Increase::Internal::Type::BaseModel
2232
+ # @!attribute country
2233
+ # The two-character ISO 3166-1 code representing the country that issued the
2234
+ # document.
2235
+ #
2236
+ # @return [String]
2237
+ required :country, String
2238
+
2239
+ # @!attribute description
2240
+ # A description of the document submitted.
2241
+ #
2242
+ # @return [String]
2243
+ required :description, String
2244
+
2245
+ # @!attribute file_id
2246
+ # The identifier of the File containing the front of the document.
2247
+ #
2248
+ # @return [String]
2249
+ required :file_id, String
2250
+
2251
+ # @!attribute back_file_id
2252
+ # The identifier of the File containing the back of the document. Not every
2253
+ # document has a reverse side.
2254
+ #
2255
+ # @return [String, nil]
2256
+ optional :back_file_id, String
2257
+
2258
+ # @!attribute expiration_date
2259
+ # The document's expiration date in YYYY-MM-DD format.
2260
+ #
2261
+ # @return [Date, nil]
2262
+ optional :expiration_date, Date
2263
+
2264
+ # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
2265
+ # Some parameter documentations has been truncated, see
2266
+ # {Increase::Models::EntityCreateParams::Trust::Grantor::Identification::Other}
2267
+ # for more details.
2268
+ #
2269
+ # Information about the identification document provided. Required if `method` is
2270
+ # equal to `other`.
2271
+ #
2272
+ # @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
2273
+ #
2274
+ # @param description [String] A description of the document submitted.
2275
+ #
2276
+ # @param file_id [String] The identifier of the File containing the front of the document.
2277
+ #
2278
+ # @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
2279
+ #
2280
+ # @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
2281
+ end
2282
+
2283
+ # @see Increase::Models::EntityCreateParams::Trust::Grantor::Identification#passport
2284
+ class Passport < Increase::Internal::Type::BaseModel
2285
+ # @!attribute country
2286
+ # The country that issued the passport.
2287
+ #
2288
+ # @return [String]
2289
+ required :country, String
2290
+
2291
+ # @!attribute expiration_date
2292
+ # The passport's expiration date in YYYY-MM-DD format.
2293
+ #
2294
+ # @return [Date]
2295
+ required :expiration_date, Date
2296
+
2297
+ # @!attribute file_id
2298
+ # The identifier of the File containing the passport.
2299
+ #
2300
+ # @return [String]
2301
+ required :file_id, String
2302
+
2303
+ # @!method initialize(country:, expiration_date:, file_id:)
2304
+ # Information about the passport used for identification. Required if `method` is
2305
+ # equal to `passport`.
2306
+ #
2307
+ # @param country [String] The country that issued the passport.
2308
+ #
2309
+ # @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
2310
+ #
2311
+ # @param file_id [String] The identifier of the File containing the passport.
2312
+ end
2313
+ end
2314
+ end
2315
+ end
2316
+ end
2317
+ end
2318
+ end