increase 0.3.2 → 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 +213 -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,4200 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ class EntityCreateParams < Increase::Internal::Type::BaseModel
6
+ extend Increase::Internal::Type::RequestParameters::Converter
7
+ include Increase::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(Increase::EntityCreateParams, Increase::Internal::AnyHash)
12
+ end
13
+
14
+ # The type of Entity to create.
15
+ sig { returns(Increase::EntityCreateParams::Structure::OrSymbol) }
16
+ attr_accessor :structure
17
+
18
+ # Details of the corporation entity to create. Required if `structure` is equal to
19
+ # `corporation`.
20
+ sig { returns(T.nilable(Increase::EntityCreateParams::Corporation)) }
21
+ attr_reader :corporation
22
+
23
+ sig do
24
+ params(
25
+ corporation: Increase::EntityCreateParams::Corporation::OrHash
26
+ ).void
27
+ end
28
+ attr_writer :corporation
29
+
30
+ # The description you choose to give the entity.
31
+ sig { returns(T.nilable(String)) }
32
+ attr_reader :description
33
+
34
+ sig { params(description: String).void }
35
+ attr_writer :description
36
+
37
+ # Details of the Government Authority entity to create. Required if `structure` is
38
+ # equal to `Government Authority`.
39
+ sig do
40
+ returns(T.nilable(Increase::EntityCreateParams::GovernmentAuthority))
41
+ end
42
+ attr_reader :government_authority
43
+
44
+ sig do
45
+ params(
46
+ government_authority:
47
+ Increase::EntityCreateParams::GovernmentAuthority::OrHash
48
+ ).void
49
+ end
50
+ attr_writer :government_authority
51
+
52
+ # Details of the joint entity to create. Required if `structure` is equal to
53
+ # `joint`.
54
+ sig { returns(T.nilable(Increase::EntityCreateParams::Joint)) }
55
+ attr_reader :joint
56
+
57
+ sig { params(joint: Increase::EntityCreateParams::Joint::OrHash).void }
58
+ attr_writer :joint
59
+
60
+ # Details of the natural person entity to create. Required if `structure` is equal
61
+ # to `natural_person`. Natural people entities should be submitted with
62
+ # `social_security_number` or `individual_taxpayer_identification_number`
63
+ # identification methods.
64
+ sig { returns(T.nilable(Increase::EntityCreateParams::NaturalPerson)) }
65
+ attr_reader :natural_person
66
+
67
+ sig do
68
+ params(
69
+ natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash
70
+ ).void
71
+ end
72
+ attr_writer :natural_person
73
+
74
+ # Additional documentation associated with the entity.
75
+ sig do
76
+ returns(
77
+ T.nilable(
78
+ T::Array[Increase::EntityCreateParams::SupplementalDocument]
79
+ )
80
+ )
81
+ end
82
+ attr_reader :supplemental_documents
83
+
84
+ sig do
85
+ params(
86
+ supplemental_documents:
87
+ T::Array[Increase::EntityCreateParams::SupplementalDocument::OrHash]
88
+ ).void
89
+ end
90
+ attr_writer :supplemental_documents
91
+
92
+ # A reference to data stored in a third-party verification service. Your
93
+ # integration may or may not use this field.
94
+ sig do
95
+ returns(T.nilable(Increase::EntityCreateParams::ThirdPartyVerification))
96
+ end
97
+ attr_reader :third_party_verification
98
+
99
+ sig do
100
+ params(
101
+ third_party_verification:
102
+ Increase::EntityCreateParams::ThirdPartyVerification::OrHash
103
+ ).void
104
+ end
105
+ attr_writer :third_party_verification
106
+
107
+ # Details of the trust entity to create. Required if `structure` is equal to
108
+ # `trust`.
109
+ sig { returns(T.nilable(Increase::EntityCreateParams::Trust)) }
110
+ attr_reader :trust
111
+
112
+ sig { params(trust: Increase::EntityCreateParams::Trust::OrHash).void }
113
+ attr_writer :trust
114
+
115
+ sig do
116
+ params(
117
+ structure: Increase::EntityCreateParams::Structure::OrSymbol,
118
+ corporation: Increase::EntityCreateParams::Corporation::OrHash,
119
+ description: String,
120
+ government_authority:
121
+ Increase::EntityCreateParams::GovernmentAuthority::OrHash,
122
+ joint: Increase::EntityCreateParams::Joint::OrHash,
123
+ natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
124
+ supplemental_documents:
125
+ T::Array[
126
+ Increase::EntityCreateParams::SupplementalDocument::OrHash
127
+ ],
128
+ third_party_verification:
129
+ Increase::EntityCreateParams::ThirdPartyVerification::OrHash,
130
+ trust: Increase::EntityCreateParams::Trust::OrHash,
131
+ request_options: Increase::RequestOptions::OrHash
132
+ ).returns(T.attached_class)
133
+ end
134
+ def self.new(
135
+ # The type of Entity to create.
136
+ structure:,
137
+ # Details of the corporation entity to create. Required if `structure` is equal to
138
+ # `corporation`.
139
+ corporation: nil,
140
+ # The description you choose to give the entity.
141
+ description: nil,
142
+ # Details of the Government Authority entity to create. Required if `structure` is
143
+ # equal to `Government Authority`.
144
+ government_authority: nil,
145
+ # Details of the joint entity to create. Required if `structure` is equal to
146
+ # `joint`.
147
+ joint: nil,
148
+ # Details of the natural person entity to create. Required if `structure` is equal
149
+ # to `natural_person`. Natural people entities should be submitted with
150
+ # `social_security_number` or `individual_taxpayer_identification_number`
151
+ # identification methods.
152
+ natural_person: nil,
153
+ # Additional documentation associated with the entity.
154
+ supplemental_documents: nil,
155
+ # A reference to data stored in a third-party verification service. Your
156
+ # integration may or may not use this field.
157
+ third_party_verification: nil,
158
+ # Details of the trust entity to create. Required if `structure` is equal to
159
+ # `trust`.
160
+ trust: nil,
161
+ request_options: {}
162
+ )
163
+ end
164
+
165
+ sig do
166
+ override.returns(
167
+ {
168
+ structure: Increase::EntityCreateParams::Structure::OrSymbol,
169
+ corporation: Increase::EntityCreateParams::Corporation,
170
+ description: String,
171
+ government_authority:
172
+ Increase::EntityCreateParams::GovernmentAuthority,
173
+ joint: Increase::EntityCreateParams::Joint,
174
+ natural_person: Increase::EntityCreateParams::NaturalPerson,
175
+ supplemental_documents:
176
+ T::Array[Increase::EntityCreateParams::SupplementalDocument],
177
+ third_party_verification:
178
+ Increase::EntityCreateParams::ThirdPartyVerification,
179
+ trust: Increase::EntityCreateParams::Trust,
180
+ request_options: Increase::RequestOptions
181
+ }
182
+ )
183
+ end
184
+ def to_hash
185
+ end
186
+
187
+ # The type of Entity to create.
188
+ module Structure
189
+ extend Increase::Internal::Type::Enum
190
+
191
+ TaggedSymbol =
192
+ T.type_alias do
193
+ T.all(Symbol, Increase::EntityCreateParams::Structure)
194
+ end
195
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
196
+
197
+ # A corporation.
198
+ CORPORATION =
199
+ T.let(
200
+ :corporation,
201
+ Increase::EntityCreateParams::Structure::TaggedSymbol
202
+ )
203
+
204
+ # An individual person.
205
+ NATURAL_PERSON =
206
+ T.let(
207
+ :natural_person,
208
+ Increase::EntityCreateParams::Structure::TaggedSymbol
209
+ )
210
+
211
+ # Multiple individual people.
212
+ JOINT =
213
+ T.let(:joint, Increase::EntityCreateParams::Structure::TaggedSymbol)
214
+
215
+ # A trust.
216
+ TRUST =
217
+ T.let(:trust, Increase::EntityCreateParams::Structure::TaggedSymbol)
218
+
219
+ # A government authority.
220
+ GOVERNMENT_AUTHORITY =
221
+ T.let(
222
+ :government_authority,
223
+ Increase::EntityCreateParams::Structure::TaggedSymbol
224
+ )
225
+
226
+ sig do
227
+ override.returns(
228
+ T::Array[Increase::EntityCreateParams::Structure::TaggedSymbol]
229
+ )
230
+ end
231
+ def self.values
232
+ end
233
+ end
234
+
235
+ class Corporation < Increase::Internal::Type::BaseModel
236
+ OrHash =
237
+ T.type_alias do
238
+ T.any(
239
+ Increase::EntityCreateParams::Corporation,
240
+ Increase::Internal::AnyHash
241
+ )
242
+ end
243
+
244
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
245
+ # are disallowed.
246
+ sig { returns(Increase::EntityCreateParams::Corporation::Address) }
247
+ attr_reader :address
248
+
249
+ sig do
250
+ params(
251
+ address: Increase::EntityCreateParams::Corporation::Address::OrHash
252
+ ).void
253
+ end
254
+ attr_writer :address
255
+
256
+ # The identifying details of each person who owns 25% or more of the business and
257
+ # one control person, like the CEO, CFO, or other executive. You can submit
258
+ # between 1 and 5 people to this list.
259
+ sig do
260
+ returns(
261
+ T::Array[Increase::EntityCreateParams::Corporation::BeneficialOwner]
262
+ )
263
+ end
264
+ attr_accessor :beneficial_owners
265
+
266
+ # The legal name of the corporation.
267
+ sig { returns(String) }
268
+ attr_accessor :name
269
+
270
+ # The Employer Identification Number (EIN) for the corporation.
271
+ sig { returns(String) }
272
+ attr_accessor :tax_identifier
273
+
274
+ # If the entity is exempt from the requirement to submit beneficial owners,
275
+ # provide the justification. If a reason is provided, you do not need to submit a
276
+ # list of beneficial owners.
277
+ sig do
278
+ returns(
279
+ T.nilable(
280
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol
281
+ )
282
+ )
283
+ end
284
+ attr_reader :beneficial_ownership_exemption_reason
285
+
286
+ sig do
287
+ params(
288
+ beneficial_ownership_exemption_reason:
289
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol
290
+ ).void
291
+ end
292
+ attr_writer :beneficial_ownership_exemption_reason
293
+
294
+ # The two-letter United States Postal Service (USPS) abbreviation for the
295
+ # corporation's state of incorporation.
296
+ sig { returns(T.nilable(String)) }
297
+ attr_reader :incorporation_state
298
+
299
+ sig { params(incorporation_state: String).void }
300
+ attr_writer :incorporation_state
301
+
302
+ # The North American Industry Classification System (NAICS) code for the
303
+ # corporation's primary line of business. This is a number, like `5132` for
304
+ # `Software Publishers`. A full list of classification codes is available
305
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
306
+ sig { returns(T.nilable(String)) }
307
+ attr_reader :industry_code
308
+
309
+ sig { params(industry_code: String).void }
310
+ attr_writer :industry_code
311
+
312
+ # The website of the corporation.
313
+ sig { returns(T.nilable(String)) }
314
+ attr_reader :website
315
+
316
+ sig { params(website: String).void }
317
+ attr_writer :website
318
+
319
+ # Details of the corporation entity to create. Required if `structure` is equal to
320
+ # `corporation`.
321
+ sig do
322
+ params(
323
+ address: Increase::EntityCreateParams::Corporation::Address::OrHash,
324
+ beneficial_owners:
325
+ T::Array[
326
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::OrHash
327
+ ],
328
+ name: String,
329
+ tax_identifier: String,
330
+ beneficial_ownership_exemption_reason:
331
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol,
332
+ incorporation_state: String,
333
+ industry_code: String,
334
+ website: String
335
+ ).returns(T.attached_class)
336
+ end
337
+ def self.new(
338
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
339
+ # are disallowed.
340
+ address:,
341
+ # The identifying details of each person who owns 25% or more of the business and
342
+ # one control person, like the CEO, CFO, or other executive. You can submit
343
+ # between 1 and 5 people to this list.
344
+ beneficial_owners:,
345
+ # The legal name of the corporation.
346
+ name:,
347
+ # The Employer Identification Number (EIN) for the corporation.
348
+ tax_identifier:,
349
+ # If the entity is exempt from the requirement to submit beneficial owners,
350
+ # provide the justification. If a reason is provided, you do not need to submit a
351
+ # list of beneficial owners.
352
+ beneficial_ownership_exemption_reason: nil,
353
+ # The two-letter United States Postal Service (USPS) abbreviation for the
354
+ # corporation's state of incorporation.
355
+ incorporation_state: nil,
356
+ # The North American Industry Classification System (NAICS) code for the
357
+ # corporation's primary line of business. This is a number, like `5132` for
358
+ # `Software Publishers`. A full list of classification codes is available
359
+ # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
360
+ industry_code: nil,
361
+ # The website of the corporation.
362
+ website: nil
363
+ )
364
+ end
365
+
366
+ sig do
367
+ override.returns(
368
+ {
369
+ address: Increase::EntityCreateParams::Corporation::Address,
370
+ beneficial_owners:
371
+ T::Array[
372
+ Increase::EntityCreateParams::Corporation::BeneficialOwner
373
+ ],
374
+ name: String,
375
+ tax_identifier: String,
376
+ beneficial_ownership_exemption_reason:
377
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::OrSymbol,
378
+ incorporation_state: String,
379
+ industry_code: String,
380
+ website: String
381
+ }
382
+ )
383
+ end
384
+ def to_hash
385
+ end
386
+
387
+ class Address < Increase::Internal::Type::BaseModel
388
+ OrHash =
389
+ T.type_alias do
390
+ T.any(
391
+ Increase::EntityCreateParams::Corporation::Address,
392
+ Increase::Internal::AnyHash
393
+ )
394
+ end
395
+
396
+ # The city of the address.
397
+ sig { returns(String) }
398
+ attr_accessor :city
399
+
400
+ # The first line of the address. This is usually the street number and street.
401
+ sig { returns(String) }
402
+ attr_accessor :line1
403
+
404
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
405
+ # the address.
406
+ sig { returns(String) }
407
+ attr_accessor :state
408
+
409
+ # The ZIP code of the address.
410
+ sig { returns(String) }
411
+ attr_accessor :zip
412
+
413
+ # The second line of the address. This might be the floor or room number.
414
+ sig { returns(T.nilable(String)) }
415
+ attr_reader :line2
416
+
417
+ sig { params(line2: String).void }
418
+ attr_writer :line2
419
+
420
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
421
+ # are disallowed.
422
+ sig do
423
+ params(
424
+ city: String,
425
+ line1: String,
426
+ state: String,
427
+ zip: String,
428
+ line2: String
429
+ ).returns(T.attached_class)
430
+ end
431
+ def self.new(
432
+ # The city of the address.
433
+ city:,
434
+ # The first line of the address. This is usually the street number and street.
435
+ line1:,
436
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
437
+ # the address.
438
+ state:,
439
+ # The ZIP code of the address.
440
+ zip:,
441
+ # The second line of the address. This might be the floor or room number.
442
+ line2: nil
443
+ )
444
+ end
445
+
446
+ sig do
447
+ override.returns(
448
+ {
449
+ city: String,
450
+ line1: String,
451
+ state: String,
452
+ zip: String,
453
+ line2: String
454
+ }
455
+ )
456
+ end
457
+ def to_hash
458
+ end
459
+ end
460
+
461
+ class BeneficialOwner < Increase::Internal::Type::BaseModel
462
+ OrHash =
463
+ T.type_alias do
464
+ T.any(
465
+ Increase::EntityCreateParams::Corporation::BeneficialOwner,
466
+ Increase::Internal::AnyHash
467
+ )
468
+ end
469
+
470
+ # Personal details for the beneficial owner.
471
+ sig do
472
+ returns(
473
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual
474
+ )
475
+ end
476
+ attr_reader :individual
477
+
478
+ sig do
479
+ params(
480
+ individual:
481
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::OrHash
482
+ ).void
483
+ end
484
+ attr_writer :individual
485
+
486
+ # Why this person is considered a beneficial owner of the entity. At least one
487
+ # option is required, if a person is both a control person and owner, submit an
488
+ # array containing both.
489
+ sig do
490
+ returns(
491
+ T::Array[
492
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong::OrSymbol
493
+ ]
494
+ )
495
+ end
496
+ attr_accessor :prongs
497
+
498
+ # This person's role or title within the entity.
499
+ sig { returns(T.nilable(String)) }
500
+ attr_reader :company_title
501
+
502
+ sig { params(company_title: String).void }
503
+ attr_writer :company_title
504
+
505
+ sig do
506
+ params(
507
+ individual:
508
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::OrHash,
509
+ prongs:
510
+ T::Array[
511
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong::OrSymbol
512
+ ],
513
+ company_title: String
514
+ ).returns(T.attached_class)
515
+ end
516
+ def self.new(
517
+ # Personal details for the beneficial owner.
518
+ individual:,
519
+ # Why this person is considered a beneficial owner of the entity. At least one
520
+ # option is required, if a person is both a control person and owner, submit an
521
+ # array containing both.
522
+ prongs:,
523
+ # This person's role or title within the entity.
524
+ company_title: nil
525
+ )
526
+ end
527
+
528
+ sig do
529
+ override.returns(
530
+ {
531
+ individual:
532
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual,
533
+ prongs:
534
+ T::Array[
535
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong::OrSymbol
536
+ ],
537
+ company_title: String
538
+ }
539
+ )
540
+ end
541
+ def to_hash
542
+ end
543
+
544
+ class Individual < Increase::Internal::Type::BaseModel
545
+ OrHash =
546
+ T.type_alias do
547
+ T.any(
548
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual,
549
+ Increase::Internal::AnyHash
550
+ )
551
+ end
552
+
553
+ # The individual's physical address. Mail receiving locations like PO Boxes and
554
+ # PMB's are disallowed.
555
+ sig do
556
+ returns(
557
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address
558
+ )
559
+ end
560
+ attr_reader :address
561
+
562
+ sig do
563
+ params(
564
+ address:
565
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address::OrHash
566
+ ).void
567
+ end
568
+ attr_writer :address
569
+
570
+ # The person's date of birth in YYYY-MM-DD format.
571
+ sig { returns(Date) }
572
+ attr_accessor :date_of_birth
573
+
574
+ # A means of verifying the person's identity.
575
+ sig do
576
+ returns(
577
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification
578
+ )
579
+ end
580
+ attr_reader :identification
581
+
582
+ sig do
583
+ params(
584
+ identification:
585
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::OrHash
586
+ ).void
587
+ end
588
+ attr_writer :identification
589
+
590
+ # The person's legal name.
591
+ sig { returns(String) }
592
+ attr_accessor :name
593
+
594
+ # The identification method for an individual can only be a passport, driver's
595
+ # license, or other document if you've confirmed the individual does not have a US
596
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
597
+ # Number).
598
+ sig { returns(T.nilable(T::Boolean)) }
599
+ attr_reader :confirmed_no_us_tax_id
600
+
601
+ sig { params(confirmed_no_us_tax_id: T::Boolean).void }
602
+ attr_writer :confirmed_no_us_tax_id
603
+
604
+ # Personal details for the beneficial owner.
605
+ sig do
606
+ params(
607
+ address:
608
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address::OrHash,
609
+ date_of_birth: Date,
610
+ identification:
611
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::OrHash,
612
+ name: String,
613
+ confirmed_no_us_tax_id: T::Boolean
614
+ ).returns(T.attached_class)
615
+ end
616
+ def self.new(
617
+ # The individual's physical address. Mail receiving locations like PO Boxes and
618
+ # PMB's are disallowed.
619
+ address:,
620
+ # The person's date of birth in YYYY-MM-DD format.
621
+ date_of_birth:,
622
+ # A means of verifying the person's identity.
623
+ identification:,
624
+ # The person's legal name.
625
+ name:,
626
+ # The identification method for an individual can only be a passport, driver's
627
+ # license, or other document if you've confirmed the individual does not have a US
628
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
629
+ # Number).
630
+ confirmed_no_us_tax_id: nil
631
+ )
632
+ end
633
+
634
+ sig do
635
+ override.returns(
636
+ {
637
+ address:
638
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address,
639
+ date_of_birth: Date,
640
+ identification:
641
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification,
642
+ name: String,
643
+ confirmed_no_us_tax_id: T::Boolean
644
+ }
645
+ )
646
+ end
647
+ def to_hash
648
+ end
649
+
650
+ class Address < Increase::Internal::Type::BaseModel
651
+ OrHash =
652
+ T.type_alias do
653
+ T.any(
654
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address,
655
+ Increase::Internal::AnyHash
656
+ )
657
+ end
658
+
659
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
660
+ sig { returns(String) }
661
+ attr_accessor :country
662
+
663
+ # The first line of the address. This is usually the street number and street.
664
+ sig { returns(String) }
665
+ attr_accessor :line1
666
+
667
+ # The city, district, town, or village of the address. Required in certain
668
+ # countries.
669
+ sig { returns(T.nilable(String)) }
670
+ attr_reader :city
671
+
672
+ sig { params(city: String).void }
673
+ attr_writer :city
674
+
675
+ # The second line of the address. This might be the floor or room number.
676
+ sig { returns(T.nilable(String)) }
677
+ attr_reader :line2
678
+
679
+ sig { params(line2: String).void }
680
+ attr_writer :line2
681
+
682
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
683
+ # state, province, or region of the address. Required in certain countries.
684
+ sig { returns(T.nilable(String)) }
685
+ attr_reader :state
686
+
687
+ sig { params(state: String).void }
688
+ attr_writer :state
689
+
690
+ # The ZIP or postal code of the address. Required in certain countries.
691
+ sig { returns(T.nilable(String)) }
692
+ attr_reader :zip
693
+
694
+ sig { params(zip: String).void }
695
+ attr_writer :zip
696
+
697
+ # The individual's physical address. Mail receiving locations like PO Boxes and
698
+ # PMB's are disallowed.
699
+ sig do
700
+ params(
701
+ country: String,
702
+ line1: String,
703
+ city: String,
704
+ line2: String,
705
+ state: String,
706
+ zip: String
707
+ ).returns(T.attached_class)
708
+ end
709
+ def self.new(
710
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
711
+ country:,
712
+ # The first line of the address. This is usually the street number and street.
713
+ line1:,
714
+ # The city, district, town, or village of the address. Required in certain
715
+ # countries.
716
+ city: nil,
717
+ # The second line of the address. This might be the floor or room number.
718
+ line2: nil,
719
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
720
+ # state, province, or region of the address. Required in certain countries.
721
+ state: nil,
722
+ # The ZIP or postal code of the address. Required in certain countries.
723
+ zip: nil
724
+ )
725
+ end
726
+
727
+ sig do
728
+ override.returns(
729
+ {
730
+ country: String,
731
+ line1: String,
732
+ city: String,
733
+ line2: String,
734
+ state: String,
735
+ zip: String
736
+ }
737
+ )
738
+ end
739
+ def to_hash
740
+ end
741
+ end
742
+
743
+ class Identification < Increase::Internal::Type::BaseModel
744
+ OrHash =
745
+ T.type_alias do
746
+ T.any(
747
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification,
748
+ Increase::Internal::AnyHash
749
+ )
750
+ end
751
+
752
+ # A method that can be used to verify the individual's identity.
753
+ sig do
754
+ returns(
755
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::OrSymbol
756
+ )
757
+ end
758
+ attr_accessor :method_
759
+
760
+ # An identification number that can be used to verify the individual's identity,
761
+ # such as a social security number.
762
+ sig { returns(String) }
763
+ attr_accessor :number
764
+
765
+ # Information about the United States driver's license used for identification.
766
+ # Required if `method` is equal to `drivers_license`.
767
+ sig do
768
+ returns(
769
+ T.nilable(
770
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense
771
+ )
772
+ )
773
+ end
774
+ attr_reader :drivers_license
775
+
776
+ sig do
777
+ params(
778
+ drivers_license:
779
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense::OrHash
780
+ ).void
781
+ end
782
+ attr_writer :drivers_license
783
+
784
+ # Information about the identification document provided. Required if `method` is
785
+ # equal to `other`.
786
+ sig do
787
+ returns(
788
+ T.nilable(
789
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other
790
+ )
791
+ )
792
+ end
793
+ attr_reader :other
794
+
795
+ sig do
796
+ params(
797
+ other:
798
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other::OrHash
799
+ ).void
800
+ end
801
+ attr_writer :other
802
+
803
+ # Information about the passport used for identification. Required if `method` is
804
+ # equal to `passport`.
805
+ sig do
806
+ returns(
807
+ T.nilable(
808
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport
809
+ )
810
+ )
811
+ end
812
+ attr_reader :passport
813
+
814
+ sig do
815
+ params(
816
+ passport:
817
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport::OrHash
818
+ ).void
819
+ end
820
+ attr_writer :passport
821
+
822
+ # A means of verifying the person's identity.
823
+ sig do
824
+ params(
825
+ method_:
826
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::OrSymbol,
827
+ number: String,
828
+ drivers_license:
829
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense::OrHash,
830
+ other:
831
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other::OrHash,
832
+ passport:
833
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport::OrHash
834
+ ).returns(T.attached_class)
835
+ end
836
+ def self.new(
837
+ # A method that can be used to verify the individual's identity.
838
+ method_:,
839
+ # An identification number that can be used to verify the individual's identity,
840
+ # such as a social security number.
841
+ number:,
842
+ # Information about the United States driver's license used for identification.
843
+ # Required if `method` is equal to `drivers_license`.
844
+ drivers_license: nil,
845
+ # Information about the identification document provided. Required if `method` is
846
+ # equal to `other`.
847
+ other: nil,
848
+ # Information about the passport used for identification. Required if `method` is
849
+ # equal to `passport`.
850
+ passport: nil
851
+ )
852
+ end
853
+
854
+ sig do
855
+ override.returns(
856
+ {
857
+ method_:
858
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::OrSymbol,
859
+ number: String,
860
+ drivers_license:
861
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense,
862
+ other:
863
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other,
864
+ passport:
865
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport
866
+ }
867
+ )
868
+ end
869
+ def to_hash
870
+ end
871
+
872
+ # A method that can be used to verify the individual's identity.
873
+ module Method
874
+ extend Increase::Internal::Type::Enum
875
+
876
+ TaggedSymbol =
877
+ T.type_alias do
878
+ T.all(
879
+ Symbol,
880
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method
881
+ )
882
+ end
883
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
884
+
885
+ # A social security number.
886
+ SOCIAL_SECURITY_NUMBER =
887
+ T.let(
888
+ :social_security_number,
889
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
890
+ )
891
+
892
+ # An individual taxpayer identification number (ITIN).
893
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
894
+ T.let(
895
+ :individual_taxpayer_identification_number,
896
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
897
+ )
898
+
899
+ # A passport number.
900
+ PASSPORT =
901
+ T.let(
902
+ :passport,
903
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
904
+ )
905
+
906
+ # A driver's license number.
907
+ DRIVERS_LICENSE =
908
+ T.let(
909
+ :drivers_license,
910
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
911
+ )
912
+
913
+ # Another identifying document.
914
+ OTHER =
915
+ T.let(
916
+ :other,
917
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
918
+ )
919
+
920
+ sig do
921
+ override.returns(
922
+ T::Array[
923
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Method::TaggedSymbol
924
+ ]
925
+ )
926
+ end
927
+ def self.values
928
+ end
929
+ end
930
+
931
+ class DriversLicense < Increase::Internal::Type::BaseModel
932
+ OrHash =
933
+ T.type_alias do
934
+ T.any(
935
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::DriversLicense,
936
+ Increase::Internal::AnyHash
937
+ )
938
+ end
939
+
940
+ # The driver's license's expiration date in YYYY-MM-DD format.
941
+ sig { returns(Date) }
942
+ attr_accessor :expiration_date
943
+
944
+ # The identifier of the File containing the front of the driver's license.
945
+ sig { returns(String) }
946
+ attr_accessor :file_id
947
+
948
+ # The state that issued the provided driver's license.
949
+ sig { returns(String) }
950
+ attr_accessor :state
951
+
952
+ # The identifier of the File containing the back of the driver's license.
953
+ sig { returns(T.nilable(String)) }
954
+ attr_reader :back_file_id
955
+
956
+ sig { params(back_file_id: String).void }
957
+ attr_writer :back_file_id
958
+
959
+ # Information about the United States driver's license used for identification.
960
+ # Required if `method` is equal to `drivers_license`.
961
+ sig do
962
+ params(
963
+ expiration_date: Date,
964
+ file_id: String,
965
+ state: String,
966
+ back_file_id: String
967
+ ).returns(T.attached_class)
968
+ end
969
+ def self.new(
970
+ # The driver's license's expiration date in YYYY-MM-DD format.
971
+ expiration_date:,
972
+ # The identifier of the File containing the front of the driver's license.
973
+ file_id:,
974
+ # The state that issued the provided driver's license.
975
+ state:,
976
+ # The identifier of the File containing the back of the driver's license.
977
+ back_file_id: nil
978
+ )
979
+ end
980
+
981
+ sig do
982
+ override.returns(
983
+ {
984
+ expiration_date: Date,
985
+ file_id: String,
986
+ state: String,
987
+ back_file_id: String
988
+ }
989
+ )
990
+ end
991
+ def to_hash
992
+ end
993
+ end
994
+
995
+ class Other < Increase::Internal::Type::BaseModel
996
+ OrHash =
997
+ T.type_alias do
998
+ T.any(
999
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Other,
1000
+ Increase::Internal::AnyHash
1001
+ )
1002
+ end
1003
+
1004
+ # The two-character ISO 3166-1 code representing the country that issued the
1005
+ # document.
1006
+ sig { returns(String) }
1007
+ attr_accessor :country
1008
+
1009
+ # A description of the document submitted.
1010
+ sig { returns(String) }
1011
+ attr_accessor :description
1012
+
1013
+ # The identifier of the File containing the front of the document.
1014
+ sig { returns(String) }
1015
+ attr_accessor :file_id
1016
+
1017
+ # The identifier of the File containing the back of the document. Not every
1018
+ # document has a reverse side.
1019
+ sig { returns(T.nilable(String)) }
1020
+ attr_reader :back_file_id
1021
+
1022
+ sig { params(back_file_id: String).void }
1023
+ attr_writer :back_file_id
1024
+
1025
+ # The document's expiration date in YYYY-MM-DD format.
1026
+ sig { returns(T.nilable(Date)) }
1027
+ attr_reader :expiration_date
1028
+
1029
+ sig { params(expiration_date: Date).void }
1030
+ attr_writer :expiration_date
1031
+
1032
+ # Information about the identification document provided. Required if `method` is
1033
+ # equal to `other`.
1034
+ sig do
1035
+ params(
1036
+ country: String,
1037
+ description: String,
1038
+ file_id: String,
1039
+ back_file_id: String,
1040
+ expiration_date: Date
1041
+ ).returns(T.attached_class)
1042
+ end
1043
+ def self.new(
1044
+ # The two-character ISO 3166-1 code representing the country that issued the
1045
+ # document.
1046
+ country:,
1047
+ # A description of the document submitted.
1048
+ description:,
1049
+ # The identifier of the File containing the front of the document.
1050
+ file_id:,
1051
+ # The identifier of the File containing the back of the document. Not every
1052
+ # document has a reverse side.
1053
+ back_file_id: nil,
1054
+ # The document's expiration date in YYYY-MM-DD format.
1055
+ expiration_date: nil
1056
+ )
1057
+ end
1058
+
1059
+ sig do
1060
+ override.returns(
1061
+ {
1062
+ country: String,
1063
+ description: String,
1064
+ file_id: String,
1065
+ back_file_id: String,
1066
+ expiration_date: Date
1067
+ }
1068
+ )
1069
+ end
1070
+ def to_hash
1071
+ end
1072
+ end
1073
+
1074
+ class Passport < Increase::Internal::Type::BaseModel
1075
+ OrHash =
1076
+ T.type_alias do
1077
+ T.any(
1078
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Individual::Identification::Passport,
1079
+ Increase::Internal::AnyHash
1080
+ )
1081
+ end
1082
+
1083
+ # The country that issued the passport.
1084
+ sig { returns(String) }
1085
+ attr_accessor :country
1086
+
1087
+ # The passport's expiration date in YYYY-MM-DD format.
1088
+ sig { returns(Date) }
1089
+ attr_accessor :expiration_date
1090
+
1091
+ # The identifier of the File containing the passport.
1092
+ sig { returns(String) }
1093
+ attr_accessor :file_id
1094
+
1095
+ # Information about the passport used for identification. Required if `method` is
1096
+ # equal to `passport`.
1097
+ sig do
1098
+ params(
1099
+ country: String,
1100
+ expiration_date: Date,
1101
+ file_id: String
1102
+ ).returns(T.attached_class)
1103
+ end
1104
+ def self.new(
1105
+ # The country that issued the passport.
1106
+ country:,
1107
+ # The passport's expiration date in YYYY-MM-DD format.
1108
+ expiration_date:,
1109
+ # The identifier of the File containing the passport.
1110
+ file_id:
1111
+ )
1112
+ end
1113
+
1114
+ sig do
1115
+ override.returns(
1116
+ { country: String, expiration_date: Date, file_id: String }
1117
+ )
1118
+ end
1119
+ def to_hash
1120
+ end
1121
+ end
1122
+ end
1123
+ end
1124
+
1125
+ module Prong
1126
+ extend Increase::Internal::Type::Enum
1127
+
1128
+ TaggedSymbol =
1129
+ T.type_alias do
1130
+ T.all(
1131
+ Symbol,
1132
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong
1133
+ )
1134
+ end
1135
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1136
+
1137
+ # A person with 25% or greater direct or indirect ownership of the entity.
1138
+ OWNERSHIP =
1139
+ T.let(
1140
+ :ownership,
1141
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong::TaggedSymbol
1142
+ )
1143
+
1144
+ # A person who manages, directs, or has significant control of the entity.
1145
+ CONTROL =
1146
+ T.let(
1147
+ :control,
1148
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong::TaggedSymbol
1149
+ )
1150
+
1151
+ sig do
1152
+ override.returns(
1153
+ T::Array[
1154
+ Increase::EntityCreateParams::Corporation::BeneficialOwner::Prong::TaggedSymbol
1155
+ ]
1156
+ )
1157
+ end
1158
+ def self.values
1159
+ end
1160
+ end
1161
+ end
1162
+
1163
+ # If the entity is exempt from the requirement to submit beneficial owners,
1164
+ # provide the justification. If a reason is provided, you do not need to submit a
1165
+ # list of beneficial owners.
1166
+ module BeneficialOwnershipExemptionReason
1167
+ extend Increase::Internal::Type::Enum
1168
+
1169
+ TaggedSymbol =
1170
+ T.type_alias do
1171
+ T.all(
1172
+ Symbol,
1173
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason
1174
+ )
1175
+ end
1176
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1177
+
1178
+ # A regulated financial institution.
1179
+ REGULATED_FINANCIAL_INSTITUTION =
1180
+ T.let(
1181
+ :regulated_financial_institution,
1182
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol
1183
+ )
1184
+
1185
+ # A publicly traded company.
1186
+ PUBLICLY_TRADED_COMPANY =
1187
+ T.let(
1188
+ :publicly_traded_company,
1189
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol
1190
+ )
1191
+
1192
+ # A public entity acting on behalf of the federal or a state government.
1193
+ PUBLIC_ENTITY =
1194
+ T.let(
1195
+ :public_entity,
1196
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol
1197
+ )
1198
+
1199
+ sig do
1200
+ override.returns(
1201
+ T::Array[
1202
+ Increase::EntityCreateParams::Corporation::BeneficialOwnershipExemptionReason::TaggedSymbol
1203
+ ]
1204
+ )
1205
+ end
1206
+ def self.values
1207
+ end
1208
+ end
1209
+ end
1210
+
1211
+ class GovernmentAuthority < Increase::Internal::Type::BaseModel
1212
+ OrHash =
1213
+ T.type_alias do
1214
+ T.any(
1215
+ Increase::EntityCreateParams::GovernmentAuthority,
1216
+ Increase::Internal::AnyHash
1217
+ )
1218
+ end
1219
+
1220
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
1221
+ # are disallowed.
1222
+ sig do
1223
+ returns(Increase::EntityCreateParams::GovernmentAuthority::Address)
1224
+ end
1225
+ attr_reader :address
1226
+
1227
+ sig do
1228
+ params(
1229
+ address:
1230
+ Increase::EntityCreateParams::GovernmentAuthority::Address::OrHash
1231
+ ).void
1232
+ end
1233
+ attr_writer :address
1234
+
1235
+ # The identifying details of authorized officials acting on the entity's behalf.
1236
+ sig do
1237
+ returns(
1238
+ T::Array[
1239
+ Increase::EntityCreateParams::GovernmentAuthority::AuthorizedPerson
1240
+ ]
1241
+ )
1242
+ end
1243
+ attr_accessor :authorized_persons
1244
+
1245
+ # The category of the government authority.
1246
+ sig do
1247
+ returns(
1248
+ Increase::EntityCreateParams::GovernmentAuthority::Category::OrSymbol
1249
+ )
1250
+ end
1251
+ attr_accessor :category
1252
+
1253
+ # The legal name of the government authority.
1254
+ sig { returns(String) }
1255
+ attr_accessor :name
1256
+
1257
+ # The Employer Identification Number (EIN) for the government authority.
1258
+ sig { returns(String) }
1259
+ attr_accessor :tax_identifier
1260
+
1261
+ # The website of the government authority.
1262
+ sig { returns(T.nilable(String)) }
1263
+ attr_reader :website
1264
+
1265
+ sig { params(website: String).void }
1266
+ attr_writer :website
1267
+
1268
+ # Details of the Government Authority entity to create. Required if `structure` is
1269
+ # equal to `Government Authority`.
1270
+ sig do
1271
+ params(
1272
+ address:
1273
+ Increase::EntityCreateParams::GovernmentAuthority::Address::OrHash,
1274
+ authorized_persons:
1275
+ T::Array[
1276
+ Increase::EntityCreateParams::GovernmentAuthority::AuthorizedPerson::OrHash
1277
+ ],
1278
+ category:
1279
+ Increase::EntityCreateParams::GovernmentAuthority::Category::OrSymbol,
1280
+ name: String,
1281
+ tax_identifier: String,
1282
+ website: String
1283
+ ).returns(T.attached_class)
1284
+ end
1285
+ def self.new(
1286
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
1287
+ # are disallowed.
1288
+ address:,
1289
+ # The identifying details of authorized officials acting on the entity's behalf.
1290
+ authorized_persons:,
1291
+ # The category of the government authority.
1292
+ category:,
1293
+ # The legal name of the government authority.
1294
+ name:,
1295
+ # The Employer Identification Number (EIN) for the government authority.
1296
+ tax_identifier:,
1297
+ # The website of the government authority.
1298
+ website: nil
1299
+ )
1300
+ end
1301
+
1302
+ sig do
1303
+ override.returns(
1304
+ {
1305
+ address:
1306
+ Increase::EntityCreateParams::GovernmentAuthority::Address,
1307
+ authorized_persons:
1308
+ T::Array[
1309
+ Increase::EntityCreateParams::GovernmentAuthority::AuthorizedPerson
1310
+ ],
1311
+ category:
1312
+ Increase::EntityCreateParams::GovernmentAuthority::Category::OrSymbol,
1313
+ name: String,
1314
+ tax_identifier: String,
1315
+ website: String
1316
+ }
1317
+ )
1318
+ end
1319
+ def to_hash
1320
+ end
1321
+
1322
+ class Address < Increase::Internal::Type::BaseModel
1323
+ OrHash =
1324
+ T.type_alias do
1325
+ T.any(
1326
+ Increase::EntityCreateParams::GovernmentAuthority::Address,
1327
+ Increase::Internal::AnyHash
1328
+ )
1329
+ end
1330
+
1331
+ # The city of the address.
1332
+ sig { returns(String) }
1333
+ attr_accessor :city
1334
+
1335
+ # The first line of the address. This is usually the street number and street.
1336
+ sig { returns(String) }
1337
+ attr_accessor :line1
1338
+
1339
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1340
+ # the address.
1341
+ sig { returns(String) }
1342
+ attr_accessor :state
1343
+
1344
+ # The ZIP code of the address.
1345
+ sig { returns(String) }
1346
+ attr_accessor :zip
1347
+
1348
+ # The second line of the address. This might be the floor or room number.
1349
+ sig { returns(T.nilable(String)) }
1350
+ attr_reader :line2
1351
+
1352
+ sig { params(line2: String).void }
1353
+ attr_writer :line2
1354
+
1355
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
1356
+ # are disallowed.
1357
+ sig do
1358
+ params(
1359
+ city: String,
1360
+ line1: String,
1361
+ state: String,
1362
+ zip: String,
1363
+ line2: String
1364
+ ).returns(T.attached_class)
1365
+ end
1366
+ def self.new(
1367
+ # The city of the address.
1368
+ city:,
1369
+ # The first line of the address. This is usually the street number and street.
1370
+ line1:,
1371
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1372
+ # the address.
1373
+ state:,
1374
+ # The ZIP code of the address.
1375
+ zip:,
1376
+ # The second line of the address. This might be the floor or room number.
1377
+ line2: nil
1378
+ )
1379
+ end
1380
+
1381
+ sig do
1382
+ override.returns(
1383
+ {
1384
+ city: String,
1385
+ line1: String,
1386
+ state: String,
1387
+ zip: String,
1388
+ line2: String
1389
+ }
1390
+ )
1391
+ end
1392
+ def to_hash
1393
+ end
1394
+ end
1395
+
1396
+ class AuthorizedPerson < Increase::Internal::Type::BaseModel
1397
+ OrHash =
1398
+ T.type_alias do
1399
+ T.any(
1400
+ Increase::EntityCreateParams::GovernmentAuthority::AuthorizedPerson,
1401
+ Increase::Internal::AnyHash
1402
+ )
1403
+ end
1404
+
1405
+ # The person's legal name.
1406
+ sig { returns(String) }
1407
+ attr_accessor :name
1408
+
1409
+ sig { params(name: String).returns(T.attached_class) }
1410
+ def self.new(
1411
+ # The person's legal name.
1412
+ name:
1413
+ )
1414
+ end
1415
+
1416
+ sig { override.returns({ name: String }) }
1417
+ def to_hash
1418
+ end
1419
+ end
1420
+
1421
+ # The category of the government authority.
1422
+ module Category
1423
+ extend Increase::Internal::Type::Enum
1424
+
1425
+ TaggedSymbol =
1426
+ T.type_alias do
1427
+ T.all(
1428
+ Symbol,
1429
+ Increase::EntityCreateParams::GovernmentAuthority::Category
1430
+ )
1431
+ end
1432
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1433
+
1434
+ # The Public Entity is a Municipality.
1435
+ MUNICIPALITY =
1436
+ T.let(
1437
+ :municipality,
1438
+ Increase::EntityCreateParams::GovernmentAuthority::Category::TaggedSymbol
1439
+ )
1440
+
1441
+ sig do
1442
+ override.returns(
1443
+ T::Array[
1444
+ Increase::EntityCreateParams::GovernmentAuthority::Category::TaggedSymbol
1445
+ ]
1446
+ )
1447
+ end
1448
+ def self.values
1449
+ end
1450
+ end
1451
+ end
1452
+
1453
+ class Joint < Increase::Internal::Type::BaseModel
1454
+ OrHash =
1455
+ T.type_alias do
1456
+ T.any(
1457
+ Increase::EntityCreateParams::Joint,
1458
+ Increase::Internal::AnyHash
1459
+ )
1460
+ end
1461
+
1462
+ # The two individuals that share control of the entity.
1463
+ sig do
1464
+ returns(T::Array[Increase::EntityCreateParams::Joint::Individual])
1465
+ end
1466
+ attr_accessor :individuals
1467
+
1468
+ # The name of the joint entity.
1469
+ sig { returns(T.nilable(String)) }
1470
+ attr_reader :name
1471
+
1472
+ sig { params(name: String).void }
1473
+ attr_writer :name
1474
+
1475
+ # Details of the joint entity to create. Required if `structure` is equal to
1476
+ # `joint`.
1477
+ sig do
1478
+ params(
1479
+ individuals:
1480
+ T::Array[Increase::EntityCreateParams::Joint::Individual::OrHash],
1481
+ name: String
1482
+ ).returns(T.attached_class)
1483
+ end
1484
+ def self.new(
1485
+ # The two individuals that share control of the entity.
1486
+ individuals:,
1487
+ # The name of the joint entity.
1488
+ name: nil
1489
+ )
1490
+ end
1491
+
1492
+ sig do
1493
+ override.returns(
1494
+ {
1495
+ individuals:
1496
+ T::Array[Increase::EntityCreateParams::Joint::Individual],
1497
+ name: String
1498
+ }
1499
+ )
1500
+ end
1501
+ def to_hash
1502
+ end
1503
+
1504
+ class Individual < Increase::Internal::Type::BaseModel
1505
+ OrHash =
1506
+ T.type_alias do
1507
+ T.any(
1508
+ Increase::EntityCreateParams::Joint::Individual,
1509
+ Increase::Internal::AnyHash
1510
+ )
1511
+ end
1512
+
1513
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1514
+ # PMB's are disallowed.
1515
+ sig do
1516
+ returns(Increase::EntityCreateParams::Joint::Individual::Address)
1517
+ end
1518
+ attr_reader :address
1519
+
1520
+ sig do
1521
+ params(
1522
+ address:
1523
+ Increase::EntityCreateParams::Joint::Individual::Address::OrHash
1524
+ ).void
1525
+ end
1526
+ attr_writer :address
1527
+
1528
+ # The person's date of birth in YYYY-MM-DD format.
1529
+ sig { returns(Date) }
1530
+ attr_accessor :date_of_birth
1531
+
1532
+ # A means of verifying the person's identity.
1533
+ sig do
1534
+ returns(
1535
+ Increase::EntityCreateParams::Joint::Individual::Identification
1536
+ )
1537
+ end
1538
+ attr_reader :identification
1539
+
1540
+ sig do
1541
+ params(
1542
+ identification:
1543
+ Increase::EntityCreateParams::Joint::Individual::Identification::OrHash
1544
+ ).void
1545
+ end
1546
+ attr_writer :identification
1547
+
1548
+ # The person's legal name.
1549
+ sig { returns(String) }
1550
+ attr_accessor :name
1551
+
1552
+ # The identification method for an individual can only be a passport, driver's
1553
+ # license, or other document if you've confirmed the individual does not have a US
1554
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
1555
+ # Number).
1556
+ sig { returns(T.nilable(T::Boolean)) }
1557
+ attr_reader :confirmed_no_us_tax_id
1558
+
1559
+ sig { params(confirmed_no_us_tax_id: T::Boolean).void }
1560
+ attr_writer :confirmed_no_us_tax_id
1561
+
1562
+ sig do
1563
+ params(
1564
+ address:
1565
+ Increase::EntityCreateParams::Joint::Individual::Address::OrHash,
1566
+ date_of_birth: Date,
1567
+ identification:
1568
+ Increase::EntityCreateParams::Joint::Individual::Identification::OrHash,
1569
+ name: String,
1570
+ confirmed_no_us_tax_id: T::Boolean
1571
+ ).returns(T.attached_class)
1572
+ end
1573
+ def self.new(
1574
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1575
+ # PMB's are disallowed.
1576
+ address:,
1577
+ # The person's date of birth in YYYY-MM-DD format.
1578
+ date_of_birth:,
1579
+ # A means of verifying the person's identity.
1580
+ identification:,
1581
+ # The person's legal name.
1582
+ name:,
1583
+ # The identification method for an individual can only be a passport, driver's
1584
+ # license, or other document if you've confirmed the individual does not have a US
1585
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
1586
+ # Number).
1587
+ confirmed_no_us_tax_id: nil
1588
+ )
1589
+ end
1590
+
1591
+ sig do
1592
+ override.returns(
1593
+ {
1594
+ address:
1595
+ Increase::EntityCreateParams::Joint::Individual::Address,
1596
+ date_of_birth: Date,
1597
+ identification:
1598
+ Increase::EntityCreateParams::Joint::Individual::Identification,
1599
+ name: String,
1600
+ confirmed_no_us_tax_id: T::Boolean
1601
+ }
1602
+ )
1603
+ end
1604
+ def to_hash
1605
+ end
1606
+
1607
+ class Address < Increase::Internal::Type::BaseModel
1608
+ OrHash =
1609
+ T.type_alias do
1610
+ T.any(
1611
+ Increase::EntityCreateParams::Joint::Individual::Address,
1612
+ Increase::Internal::AnyHash
1613
+ )
1614
+ end
1615
+
1616
+ # The city of the address.
1617
+ sig { returns(String) }
1618
+ attr_accessor :city
1619
+
1620
+ # The first line of the address. This is usually the street number and street.
1621
+ sig { returns(String) }
1622
+ attr_accessor :line1
1623
+
1624
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1625
+ # the address.
1626
+ sig { returns(String) }
1627
+ attr_accessor :state
1628
+
1629
+ # The ZIP code of the address.
1630
+ sig { returns(String) }
1631
+ attr_accessor :zip
1632
+
1633
+ # The second line of the address. This might be the floor or room number.
1634
+ sig { returns(T.nilable(String)) }
1635
+ attr_reader :line2
1636
+
1637
+ sig { params(line2: String).void }
1638
+ attr_writer :line2
1639
+
1640
+ # The individual's physical address. Mail receiving locations like PO Boxes and
1641
+ # PMB's are disallowed.
1642
+ sig do
1643
+ params(
1644
+ city: String,
1645
+ line1: String,
1646
+ state: String,
1647
+ zip: String,
1648
+ line2: String
1649
+ ).returns(T.attached_class)
1650
+ end
1651
+ def self.new(
1652
+ # The city of the address.
1653
+ city:,
1654
+ # The first line of the address. This is usually the street number and street.
1655
+ line1:,
1656
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
1657
+ # the address.
1658
+ state:,
1659
+ # The ZIP code of the address.
1660
+ zip:,
1661
+ # The second line of the address. This might be the floor or room number.
1662
+ line2: nil
1663
+ )
1664
+ end
1665
+
1666
+ sig do
1667
+ override.returns(
1668
+ {
1669
+ city: String,
1670
+ line1: String,
1671
+ state: String,
1672
+ zip: String,
1673
+ line2: String
1674
+ }
1675
+ )
1676
+ end
1677
+ def to_hash
1678
+ end
1679
+ end
1680
+
1681
+ class Identification < Increase::Internal::Type::BaseModel
1682
+ OrHash =
1683
+ T.type_alias do
1684
+ T.any(
1685
+ Increase::EntityCreateParams::Joint::Individual::Identification,
1686
+ Increase::Internal::AnyHash
1687
+ )
1688
+ end
1689
+
1690
+ # A method that can be used to verify the individual's identity.
1691
+ sig do
1692
+ returns(
1693
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::OrSymbol
1694
+ )
1695
+ end
1696
+ attr_accessor :method_
1697
+
1698
+ # An identification number that can be used to verify the individual's identity,
1699
+ # such as a social security number.
1700
+ sig { returns(String) }
1701
+ attr_accessor :number
1702
+
1703
+ # Information about the United States driver's license used for identification.
1704
+ # Required if `method` is equal to `drivers_license`.
1705
+ sig do
1706
+ returns(
1707
+ T.nilable(
1708
+ Increase::EntityCreateParams::Joint::Individual::Identification::DriversLicense
1709
+ )
1710
+ )
1711
+ end
1712
+ attr_reader :drivers_license
1713
+
1714
+ sig do
1715
+ params(
1716
+ drivers_license:
1717
+ Increase::EntityCreateParams::Joint::Individual::Identification::DriversLicense::OrHash
1718
+ ).void
1719
+ end
1720
+ attr_writer :drivers_license
1721
+
1722
+ # Information about the identification document provided. Required if `method` is
1723
+ # equal to `other`.
1724
+ sig do
1725
+ returns(
1726
+ T.nilable(
1727
+ Increase::EntityCreateParams::Joint::Individual::Identification::Other
1728
+ )
1729
+ )
1730
+ end
1731
+ attr_reader :other
1732
+
1733
+ sig do
1734
+ params(
1735
+ other:
1736
+ Increase::EntityCreateParams::Joint::Individual::Identification::Other::OrHash
1737
+ ).void
1738
+ end
1739
+ attr_writer :other
1740
+
1741
+ # Information about the passport used for identification. Required if `method` is
1742
+ # equal to `passport`.
1743
+ sig do
1744
+ returns(
1745
+ T.nilable(
1746
+ Increase::EntityCreateParams::Joint::Individual::Identification::Passport
1747
+ )
1748
+ )
1749
+ end
1750
+ attr_reader :passport
1751
+
1752
+ sig do
1753
+ params(
1754
+ passport:
1755
+ Increase::EntityCreateParams::Joint::Individual::Identification::Passport::OrHash
1756
+ ).void
1757
+ end
1758
+ attr_writer :passport
1759
+
1760
+ # A means of verifying the person's identity.
1761
+ sig do
1762
+ params(
1763
+ method_:
1764
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::OrSymbol,
1765
+ number: String,
1766
+ drivers_license:
1767
+ Increase::EntityCreateParams::Joint::Individual::Identification::DriversLicense::OrHash,
1768
+ other:
1769
+ Increase::EntityCreateParams::Joint::Individual::Identification::Other::OrHash,
1770
+ passport:
1771
+ Increase::EntityCreateParams::Joint::Individual::Identification::Passport::OrHash
1772
+ ).returns(T.attached_class)
1773
+ end
1774
+ def self.new(
1775
+ # A method that can be used to verify the individual's identity.
1776
+ method_:,
1777
+ # An identification number that can be used to verify the individual's identity,
1778
+ # such as a social security number.
1779
+ number:,
1780
+ # Information about the United States driver's license used for identification.
1781
+ # Required if `method` is equal to `drivers_license`.
1782
+ drivers_license: nil,
1783
+ # Information about the identification document provided. Required if `method` is
1784
+ # equal to `other`.
1785
+ other: nil,
1786
+ # Information about the passport used for identification. Required if `method` is
1787
+ # equal to `passport`.
1788
+ passport: nil
1789
+ )
1790
+ end
1791
+
1792
+ sig do
1793
+ override.returns(
1794
+ {
1795
+ method_:
1796
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::OrSymbol,
1797
+ number: String,
1798
+ drivers_license:
1799
+ Increase::EntityCreateParams::Joint::Individual::Identification::DriversLicense,
1800
+ other:
1801
+ Increase::EntityCreateParams::Joint::Individual::Identification::Other,
1802
+ passport:
1803
+ Increase::EntityCreateParams::Joint::Individual::Identification::Passport
1804
+ }
1805
+ )
1806
+ end
1807
+ def to_hash
1808
+ end
1809
+
1810
+ # A method that can be used to verify the individual's identity.
1811
+ module Method
1812
+ extend Increase::Internal::Type::Enum
1813
+
1814
+ TaggedSymbol =
1815
+ T.type_alias do
1816
+ T.all(
1817
+ Symbol,
1818
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method
1819
+ )
1820
+ end
1821
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1822
+
1823
+ # A social security number.
1824
+ SOCIAL_SECURITY_NUMBER =
1825
+ T.let(
1826
+ :social_security_number,
1827
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::TaggedSymbol
1828
+ )
1829
+
1830
+ # An individual taxpayer identification number (ITIN).
1831
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
1832
+ T.let(
1833
+ :individual_taxpayer_identification_number,
1834
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::TaggedSymbol
1835
+ )
1836
+
1837
+ # A passport number.
1838
+ PASSPORT =
1839
+ T.let(
1840
+ :passport,
1841
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::TaggedSymbol
1842
+ )
1843
+
1844
+ # A driver's license number.
1845
+ DRIVERS_LICENSE =
1846
+ T.let(
1847
+ :drivers_license,
1848
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::TaggedSymbol
1849
+ )
1850
+
1851
+ # Another identifying document.
1852
+ OTHER =
1853
+ T.let(
1854
+ :other,
1855
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::TaggedSymbol
1856
+ )
1857
+
1858
+ sig do
1859
+ override.returns(
1860
+ T::Array[
1861
+ Increase::EntityCreateParams::Joint::Individual::Identification::Method::TaggedSymbol
1862
+ ]
1863
+ )
1864
+ end
1865
+ def self.values
1866
+ end
1867
+ end
1868
+
1869
+ class DriversLicense < Increase::Internal::Type::BaseModel
1870
+ OrHash =
1871
+ T.type_alias do
1872
+ T.any(
1873
+ Increase::EntityCreateParams::Joint::Individual::Identification::DriversLicense,
1874
+ Increase::Internal::AnyHash
1875
+ )
1876
+ end
1877
+
1878
+ # The driver's license's expiration date in YYYY-MM-DD format.
1879
+ sig { returns(Date) }
1880
+ attr_accessor :expiration_date
1881
+
1882
+ # The identifier of the File containing the front of the driver's license.
1883
+ sig { returns(String) }
1884
+ attr_accessor :file_id
1885
+
1886
+ # The state that issued the provided driver's license.
1887
+ sig { returns(String) }
1888
+ attr_accessor :state
1889
+
1890
+ # The identifier of the File containing the back of the driver's license.
1891
+ sig { returns(T.nilable(String)) }
1892
+ attr_reader :back_file_id
1893
+
1894
+ sig { params(back_file_id: String).void }
1895
+ attr_writer :back_file_id
1896
+
1897
+ # Information about the United States driver's license used for identification.
1898
+ # Required if `method` is equal to `drivers_license`.
1899
+ sig do
1900
+ params(
1901
+ expiration_date: Date,
1902
+ file_id: String,
1903
+ state: String,
1904
+ back_file_id: String
1905
+ ).returns(T.attached_class)
1906
+ end
1907
+ def self.new(
1908
+ # The driver's license's expiration date in YYYY-MM-DD format.
1909
+ expiration_date:,
1910
+ # The identifier of the File containing the front of the driver's license.
1911
+ file_id:,
1912
+ # The state that issued the provided driver's license.
1913
+ state:,
1914
+ # The identifier of the File containing the back of the driver's license.
1915
+ back_file_id: nil
1916
+ )
1917
+ end
1918
+
1919
+ sig do
1920
+ override.returns(
1921
+ {
1922
+ expiration_date: Date,
1923
+ file_id: String,
1924
+ state: String,
1925
+ back_file_id: String
1926
+ }
1927
+ )
1928
+ end
1929
+ def to_hash
1930
+ end
1931
+ end
1932
+
1933
+ class Other < Increase::Internal::Type::BaseModel
1934
+ OrHash =
1935
+ T.type_alias do
1936
+ T.any(
1937
+ Increase::EntityCreateParams::Joint::Individual::Identification::Other,
1938
+ Increase::Internal::AnyHash
1939
+ )
1940
+ end
1941
+
1942
+ # The two-character ISO 3166-1 code representing the country that issued the
1943
+ # document.
1944
+ sig { returns(String) }
1945
+ attr_accessor :country
1946
+
1947
+ # A description of the document submitted.
1948
+ sig { returns(String) }
1949
+ attr_accessor :description
1950
+
1951
+ # The identifier of the File containing the front of the document.
1952
+ sig { returns(String) }
1953
+ attr_accessor :file_id
1954
+
1955
+ # The identifier of the File containing the back of the document. Not every
1956
+ # document has a reverse side.
1957
+ sig { returns(T.nilable(String)) }
1958
+ attr_reader :back_file_id
1959
+
1960
+ sig { params(back_file_id: String).void }
1961
+ attr_writer :back_file_id
1962
+
1963
+ # The document's expiration date in YYYY-MM-DD format.
1964
+ sig { returns(T.nilable(Date)) }
1965
+ attr_reader :expiration_date
1966
+
1967
+ sig { params(expiration_date: Date).void }
1968
+ attr_writer :expiration_date
1969
+
1970
+ # Information about the identification document provided. Required if `method` is
1971
+ # equal to `other`.
1972
+ sig do
1973
+ params(
1974
+ country: String,
1975
+ description: String,
1976
+ file_id: String,
1977
+ back_file_id: String,
1978
+ expiration_date: Date
1979
+ ).returns(T.attached_class)
1980
+ end
1981
+ def self.new(
1982
+ # The two-character ISO 3166-1 code representing the country that issued the
1983
+ # document.
1984
+ country:,
1985
+ # A description of the document submitted.
1986
+ description:,
1987
+ # The identifier of the File containing the front of the document.
1988
+ file_id:,
1989
+ # The identifier of the File containing the back of the document. Not every
1990
+ # document has a reverse side.
1991
+ back_file_id: nil,
1992
+ # The document's expiration date in YYYY-MM-DD format.
1993
+ expiration_date: nil
1994
+ )
1995
+ end
1996
+
1997
+ sig do
1998
+ override.returns(
1999
+ {
2000
+ country: String,
2001
+ description: String,
2002
+ file_id: String,
2003
+ back_file_id: String,
2004
+ expiration_date: Date
2005
+ }
2006
+ )
2007
+ end
2008
+ def to_hash
2009
+ end
2010
+ end
2011
+
2012
+ class Passport < Increase::Internal::Type::BaseModel
2013
+ OrHash =
2014
+ T.type_alias do
2015
+ T.any(
2016
+ Increase::EntityCreateParams::Joint::Individual::Identification::Passport,
2017
+ Increase::Internal::AnyHash
2018
+ )
2019
+ end
2020
+
2021
+ # The country that issued the passport.
2022
+ sig { returns(String) }
2023
+ attr_accessor :country
2024
+
2025
+ # The passport's expiration date in YYYY-MM-DD format.
2026
+ sig { returns(Date) }
2027
+ attr_accessor :expiration_date
2028
+
2029
+ # The identifier of the File containing the passport.
2030
+ sig { returns(String) }
2031
+ attr_accessor :file_id
2032
+
2033
+ # Information about the passport used for identification. Required if `method` is
2034
+ # equal to `passport`.
2035
+ sig do
2036
+ params(
2037
+ country: String,
2038
+ expiration_date: Date,
2039
+ file_id: String
2040
+ ).returns(T.attached_class)
2041
+ end
2042
+ def self.new(
2043
+ # The country that issued the passport.
2044
+ country:,
2045
+ # The passport's expiration date in YYYY-MM-DD format.
2046
+ expiration_date:,
2047
+ # The identifier of the File containing the passport.
2048
+ file_id:
2049
+ )
2050
+ end
2051
+
2052
+ sig do
2053
+ override.returns(
2054
+ { country: String, expiration_date: Date, file_id: String }
2055
+ )
2056
+ end
2057
+ def to_hash
2058
+ end
2059
+ end
2060
+ end
2061
+ end
2062
+ end
2063
+
2064
+ class NaturalPerson < Increase::Internal::Type::BaseModel
2065
+ OrHash =
2066
+ T.type_alias do
2067
+ T.any(
2068
+ Increase::EntityCreateParams::NaturalPerson,
2069
+ Increase::Internal::AnyHash
2070
+ )
2071
+ end
2072
+
2073
+ # The individual's physical address. Mail receiving locations like PO Boxes and
2074
+ # PMB's are disallowed.
2075
+ sig { returns(Increase::EntityCreateParams::NaturalPerson::Address) }
2076
+ attr_reader :address
2077
+
2078
+ sig do
2079
+ params(
2080
+ address:
2081
+ Increase::EntityCreateParams::NaturalPerson::Address::OrHash
2082
+ ).void
2083
+ end
2084
+ attr_writer :address
2085
+
2086
+ # The person's date of birth in YYYY-MM-DD format.
2087
+ sig { returns(Date) }
2088
+ attr_accessor :date_of_birth
2089
+
2090
+ # A means of verifying the person's identity.
2091
+ sig do
2092
+ returns(Increase::EntityCreateParams::NaturalPerson::Identification)
2093
+ end
2094
+ attr_reader :identification
2095
+
2096
+ sig do
2097
+ params(
2098
+ identification:
2099
+ Increase::EntityCreateParams::NaturalPerson::Identification::OrHash
2100
+ ).void
2101
+ end
2102
+ attr_writer :identification
2103
+
2104
+ # The person's legal name.
2105
+ sig { returns(String) }
2106
+ attr_accessor :name
2107
+
2108
+ # The identification method for an individual can only be a passport, driver's
2109
+ # license, or other document if you've confirmed the individual does not have a US
2110
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
2111
+ # Number).
2112
+ sig { returns(T.nilable(T::Boolean)) }
2113
+ attr_reader :confirmed_no_us_tax_id
2114
+
2115
+ sig { params(confirmed_no_us_tax_id: T::Boolean).void }
2116
+ attr_writer :confirmed_no_us_tax_id
2117
+
2118
+ # Details of the natural person entity to create. Required if `structure` is equal
2119
+ # to `natural_person`. Natural people entities should be submitted with
2120
+ # `social_security_number` or `individual_taxpayer_identification_number`
2121
+ # identification methods.
2122
+ sig do
2123
+ params(
2124
+ address:
2125
+ Increase::EntityCreateParams::NaturalPerson::Address::OrHash,
2126
+ date_of_birth: Date,
2127
+ identification:
2128
+ Increase::EntityCreateParams::NaturalPerson::Identification::OrHash,
2129
+ name: String,
2130
+ confirmed_no_us_tax_id: T::Boolean
2131
+ ).returns(T.attached_class)
2132
+ end
2133
+ def self.new(
2134
+ # The individual's physical address. Mail receiving locations like PO Boxes and
2135
+ # PMB's are disallowed.
2136
+ address:,
2137
+ # The person's date of birth in YYYY-MM-DD format.
2138
+ date_of_birth:,
2139
+ # A means of verifying the person's identity.
2140
+ identification:,
2141
+ # The person's legal name.
2142
+ name:,
2143
+ # The identification method for an individual can only be a passport, driver's
2144
+ # license, or other document if you've confirmed the individual does not have a US
2145
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
2146
+ # Number).
2147
+ confirmed_no_us_tax_id: nil
2148
+ )
2149
+ end
2150
+
2151
+ sig do
2152
+ override.returns(
2153
+ {
2154
+ address: Increase::EntityCreateParams::NaturalPerson::Address,
2155
+ date_of_birth: Date,
2156
+ identification:
2157
+ Increase::EntityCreateParams::NaturalPerson::Identification,
2158
+ name: String,
2159
+ confirmed_no_us_tax_id: T::Boolean
2160
+ }
2161
+ )
2162
+ end
2163
+ def to_hash
2164
+ end
2165
+
2166
+ class Address < Increase::Internal::Type::BaseModel
2167
+ OrHash =
2168
+ T.type_alias do
2169
+ T.any(
2170
+ Increase::EntityCreateParams::NaturalPerson::Address,
2171
+ Increase::Internal::AnyHash
2172
+ )
2173
+ end
2174
+
2175
+ # The city of the address.
2176
+ sig { returns(String) }
2177
+ attr_accessor :city
2178
+
2179
+ # The first line of the address. This is usually the street number and street.
2180
+ sig { returns(String) }
2181
+ attr_accessor :line1
2182
+
2183
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
2184
+ # the address.
2185
+ sig { returns(String) }
2186
+ attr_accessor :state
2187
+
2188
+ # The ZIP code of the address.
2189
+ sig { returns(String) }
2190
+ attr_accessor :zip
2191
+
2192
+ # The second line of the address. This might be the floor or room number.
2193
+ sig { returns(T.nilable(String)) }
2194
+ attr_reader :line2
2195
+
2196
+ sig { params(line2: String).void }
2197
+ attr_writer :line2
2198
+
2199
+ # The individual's physical address. Mail receiving locations like PO Boxes and
2200
+ # PMB's are disallowed.
2201
+ sig do
2202
+ params(
2203
+ city: String,
2204
+ line1: String,
2205
+ state: String,
2206
+ zip: String,
2207
+ line2: String
2208
+ ).returns(T.attached_class)
2209
+ end
2210
+ def self.new(
2211
+ # The city of the address.
2212
+ city:,
2213
+ # The first line of the address. This is usually the street number and street.
2214
+ line1:,
2215
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
2216
+ # the address.
2217
+ state:,
2218
+ # The ZIP code of the address.
2219
+ zip:,
2220
+ # The second line of the address. This might be the floor or room number.
2221
+ line2: nil
2222
+ )
2223
+ end
2224
+
2225
+ sig do
2226
+ override.returns(
2227
+ {
2228
+ city: String,
2229
+ line1: String,
2230
+ state: String,
2231
+ zip: String,
2232
+ line2: String
2233
+ }
2234
+ )
2235
+ end
2236
+ def to_hash
2237
+ end
2238
+ end
2239
+
2240
+ class Identification < Increase::Internal::Type::BaseModel
2241
+ OrHash =
2242
+ T.type_alias do
2243
+ T.any(
2244
+ Increase::EntityCreateParams::NaturalPerson::Identification,
2245
+ Increase::Internal::AnyHash
2246
+ )
2247
+ end
2248
+
2249
+ # A method that can be used to verify the individual's identity.
2250
+ sig do
2251
+ returns(
2252
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::OrSymbol
2253
+ )
2254
+ end
2255
+ attr_accessor :method_
2256
+
2257
+ # An identification number that can be used to verify the individual's identity,
2258
+ # such as a social security number.
2259
+ sig { returns(String) }
2260
+ attr_accessor :number
2261
+
2262
+ # Information about the United States driver's license used for identification.
2263
+ # Required if `method` is equal to `drivers_license`.
2264
+ sig do
2265
+ returns(
2266
+ T.nilable(
2267
+ Increase::EntityCreateParams::NaturalPerson::Identification::DriversLicense
2268
+ )
2269
+ )
2270
+ end
2271
+ attr_reader :drivers_license
2272
+
2273
+ sig do
2274
+ params(
2275
+ drivers_license:
2276
+ Increase::EntityCreateParams::NaturalPerson::Identification::DriversLicense::OrHash
2277
+ ).void
2278
+ end
2279
+ attr_writer :drivers_license
2280
+
2281
+ # Information about the identification document provided. Required if `method` is
2282
+ # equal to `other`.
2283
+ sig do
2284
+ returns(
2285
+ T.nilable(
2286
+ Increase::EntityCreateParams::NaturalPerson::Identification::Other
2287
+ )
2288
+ )
2289
+ end
2290
+ attr_reader :other
2291
+
2292
+ sig do
2293
+ params(
2294
+ other:
2295
+ Increase::EntityCreateParams::NaturalPerson::Identification::Other::OrHash
2296
+ ).void
2297
+ end
2298
+ attr_writer :other
2299
+
2300
+ # Information about the passport used for identification. Required if `method` is
2301
+ # equal to `passport`.
2302
+ sig do
2303
+ returns(
2304
+ T.nilable(
2305
+ Increase::EntityCreateParams::NaturalPerson::Identification::Passport
2306
+ )
2307
+ )
2308
+ end
2309
+ attr_reader :passport
2310
+
2311
+ sig do
2312
+ params(
2313
+ passport:
2314
+ Increase::EntityCreateParams::NaturalPerson::Identification::Passport::OrHash
2315
+ ).void
2316
+ end
2317
+ attr_writer :passport
2318
+
2319
+ # A means of verifying the person's identity.
2320
+ sig do
2321
+ params(
2322
+ method_:
2323
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::OrSymbol,
2324
+ number: String,
2325
+ drivers_license:
2326
+ Increase::EntityCreateParams::NaturalPerson::Identification::DriversLicense::OrHash,
2327
+ other:
2328
+ Increase::EntityCreateParams::NaturalPerson::Identification::Other::OrHash,
2329
+ passport:
2330
+ Increase::EntityCreateParams::NaturalPerson::Identification::Passport::OrHash
2331
+ ).returns(T.attached_class)
2332
+ end
2333
+ def self.new(
2334
+ # A method that can be used to verify the individual's identity.
2335
+ method_:,
2336
+ # An identification number that can be used to verify the individual's identity,
2337
+ # such as a social security number.
2338
+ number:,
2339
+ # Information about the United States driver's license used for identification.
2340
+ # Required if `method` is equal to `drivers_license`.
2341
+ drivers_license: nil,
2342
+ # Information about the identification document provided. Required if `method` is
2343
+ # equal to `other`.
2344
+ other: nil,
2345
+ # Information about the passport used for identification. Required if `method` is
2346
+ # equal to `passport`.
2347
+ passport: nil
2348
+ )
2349
+ end
2350
+
2351
+ sig do
2352
+ override.returns(
2353
+ {
2354
+ method_:
2355
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::OrSymbol,
2356
+ number: String,
2357
+ drivers_license:
2358
+ Increase::EntityCreateParams::NaturalPerson::Identification::DriversLicense,
2359
+ other:
2360
+ Increase::EntityCreateParams::NaturalPerson::Identification::Other,
2361
+ passport:
2362
+ Increase::EntityCreateParams::NaturalPerson::Identification::Passport
2363
+ }
2364
+ )
2365
+ end
2366
+ def to_hash
2367
+ end
2368
+
2369
+ # A method that can be used to verify the individual's identity.
2370
+ module Method
2371
+ extend Increase::Internal::Type::Enum
2372
+
2373
+ TaggedSymbol =
2374
+ T.type_alias do
2375
+ T.all(
2376
+ Symbol,
2377
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method
2378
+ )
2379
+ end
2380
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2381
+
2382
+ # A social security number.
2383
+ SOCIAL_SECURITY_NUMBER =
2384
+ T.let(
2385
+ :social_security_number,
2386
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::TaggedSymbol
2387
+ )
2388
+
2389
+ # An individual taxpayer identification number (ITIN).
2390
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
2391
+ T.let(
2392
+ :individual_taxpayer_identification_number,
2393
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::TaggedSymbol
2394
+ )
2395
+
2396
+ # A passport number.
2397
+ PASSPORT =
2398
+ T.let(
2399
+ :passport,
2400
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::TaggedSymbol
2401
+ )
2402
+
2403
+ # A driver's license number.
2404
+ DRIVERS_LICENSE =
2405
+ T.let(
2406
+ :drivers_license,
2407
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::TaggedSymbol
2408
+ )
2409
+
2410
+ # Another identifying document.
2411
+ OTHER =
2412
+ T.let(
2413
+ :other,
2414
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::TaggedSymbol
2415
+ )
2416
+
2417
+ sig do
2418
+ override.returns(
2419
+ T::Array[
2420
+ Increase::EntityCreateParams::NaturalPerson::Identification::Method::TaggedSymbol
2421
+ ]
2422
+ )
2423
+ end
2424
+ def self.values
2425
+ end
2426
+ end
2427
+
2428
+ class DriversLicense < Increase::Internal::Type::BaseModel
2429
+ OrHash =
2430
+ T.type_alias do
2431
+ T.any(
2432
+ Increase::EntityCreateParams::NaturalPerson::Identification::DriversLicense,
2433
+ Increase::Internal::AnyHash
2434
+ )
2435
+ end
2436
+
2437
+ # The driver's license's expiration date in YYYY-MM-DD format.
2438
+ sig { returns(Date) }
2439
+ attr_accessor :expiration_date
2440
+
2441
+ # The identifier of the File containing the front of the driver's license.
2442
+ sig { returns(String) }
2443
+ attr_accessor :file_id
2444
+
2445
+ # The state that issued the provided driver's license.
2446
+ sig { returns(String) }
2447
+ attr_accessor :state
2448
+
2449
+ # The identifier of the File containing the back of the driver's license.
2450
+ sig { returns(T.nilable(String)) }
2451
+ attr_reader :back_file_id
2452
+
2453
+ sig { params(back_file_id: String).void }
2454
+ attr_writer :back_file_id
2455
+
2456
+ # Information about the United States driver's license used for identification.
2457
+ # Required if `method` is equal to `drivers_license`.
2458
+ sig do
2459
+ params(
2460
+ expiration_date: Date,
2461
+ file_id: String,
2462
+ state: String,
2463
+ back_file_id: String
2464
+ ).returns(T.attached_class)
2465
+ end
2466
+ def self.new(
2467
+ # The driver's license's expiration date in YYYY-MM-DD format.
2468
+ expiration_date:,
2469
+ # The identifier of the File containing the front of the driver's license.
2470
+ file_id:,
2471
+ # The state that issued the provided driver's license.
2472
+ state:,
2473
+ # The identifier of the File containing the back of the driver's license.
2474
+ back_file_id: nil
2475
+ )
2476
+ end
2477
+
2478
+ sig do
2479
+ override.returns(
2480
+ {
2481
+ expiration_date: Date,
2482
+ file_id: String,
2483
+ state: String,
2484
+ back_file_id: String
2485
+ }
2486
+ )
2487
+ end
2488
+ def to_hash
2489
+ end
2490
+ end
2491
+
2492
+ class Other < Increase::Internal::Type::BaseModel
2493
+ OrHash =
2494
+ T.type_alias do
2495
+ T.any(
2496
+ Increase::EntityCreateParams::NaturalPerson::Identification::Other,
2497
+ Increase::Internal::AnyHash
2498
+ )
2499
+ end
2500
+
2501
+ # The two-character ISO 3166-1 code representing the country that issued the
2502
+ # document.
2503
+ sig { returns(String) }
2504
+ attr_accessor :country
2505
+
2506
+ # A description of the document submitted.
2507
+ sig { returns(String) }
2508
+ attr_accessor :description
2509
+
2510
+ # The identifier of the File containing the front of the document.
2511
+ sig { returns(String) }
2512
+ attr_accessor :file_id
2513
+
2514
+ # The identifier of the File containing the back of the document. Not every
2515
+ # document has a reverse side.
2516
+ sig { returns(T.nilable(String)) }
2517
+ attr_reader :back_file_id
2518
+
2519
+ sig { params(back_file_id: String).void }
2520
+ attr_writer :back_file_id
2521
+
2522
+ # The document's expiration date in YYYY-MM-DD format.
2523
+ sig { returns(T.nilable(Date)) }
2524
+ attr_reader :expiration_date
2525
+
2526
+ sig { params(expiration_date: Date).void }
2527
+ attr_writer :expiration_date
2528
+
2529
+ # Information about the identification document provided. Required if `method` is
2530
+ # equal to `other`.
2531
+ sig do
2532
+ params(
2533
+ country: String,
2534
+ description: String,
2535
+ file_id: String,
2536
+ back_file_id: String,
2537
+ expiration_date: Date
2538
+ ).returns(T.attached_class)
2539
+ end
2540
+ def self.new(
2541
+ # The two-character ISO 3166-1 code representing the country that issued the
2542
+ # document.
2543
+ country:,
2544
+ # A description of the document submitted.
2545
+ description:,
2546
+ # The identifier of the File containing the front of the document.
2547
+ file_id:,
2548
+ # The identifier of the File containing the back of the document. Not every
2549
+ # document has a reverse side.
2550
+ back_file_id: nil,
2551
+ # The document's expiration date in YYYY-MM-DD format.
2552
+ expiration_date: nil
2553
+ )
2554
+ end
2555
+
2556
+ sig do
2557
+ override.returns(
2558
+ {
2559
+ country: String,
2560
+ description: String,
2561
+ file_id: String,
2562
+ back_file_id: String,
2563
+ expiration_date: Date
2564
+ }
2565
+ )
2566
+ end
2567
+ def to_hash
2568
+ end
2569
+ end
2570
+
2571
+ class Passport < Increase::Internal::Type::BaseModel
2572
+ OrHash =
2573
+ T.type_alias do
2574
+ T.any(
2575
+ Increase::EntityCreateParams::NaturalPerson::Identification::Passport,
2576
+ Increase::Internal::AnyHash
2577
+ )
2578
+ end
2579
+
2580
+ # The country that issued the passport.
2581
+ sig { returns(String) }
2582
+ attr_accessor :country
2583
+
2584
+ # The passport's expiration date in YYYY-MM-DD format.
2585
+ sig { returns(Date) }
2586
+ attr_accessor :expiration_date
2587
+
2588
+ # The identifier of the File containing the passport.
2589
+ sig { returns(String) }
2590
+ attr_accessor :file_id
2591
+
2592
+ # Information about the passport used for identification. Required if `method` is
2593
+ # equal to `passport`.
2594
+ sig do
2595
+ params(
2596
+ country: String,
2597
+ expiration_date: Date,
2598
+ file_id: String
2599
+ ).returns(T.attached_class)
2600
+ end
2601
+ def self.new(
2602
+ # The country that issued the passport.
2603
+ country:,
2604
+ # The passport's expiration date in YYYY-MM-DD format.
2605
+ expiration_date:,
2606
+ # The identifier of the File containing the passport.
2607
+ file_id:
2608
+ )
2609
+ end
2610
+
2611
+ sig do
2612
+ override.returns(
2613
+ { country: String, expiration_date: Date, file_id: String }
2614
+ )
2615
+ end
2616
+ def to_hash
2617
+ end
2618
+ end
2619
+ end
2620
+ end
2621
+
2622
+ class SupplementalDocument < Increase::Internal::Type::BaseModel
2623
+ OrHash =
2624
+ T.type_alias do
2625
+ T.any(
2626
+ Increase::EntityCreateParams::SupplementalDocument,
2627
+ Increase::Internal::AnyHash
2628
+ )
2629
+ end
2630
+
2631
+ # The identifier of the File containing the document.
2632
+ sig { returns(String) }
2633
+ attr_accessor :file_id
2634
+
2635
+ sig { params(file_id: String).returns(T.attached_class) }
2636
+ def self.new(
2637
+ # The identifier of the File containing the document.
2638
+ file_id:
2639
+ )
2640
+ end
2641
+
2642
+ sig { override.returns({ file_id: String }) }
2643
+ def to_hash
2644
+ end
2645
+ end
2646
+
2647
+ class ThirdPartyVerification < Increase::Internal::Type::BaseModel
2648
+ OrHash =
2649
+ T.type_alias do
2650
+ T.any(
2651
+ Increase::EntityCreateParams::ThirdPartyVerification,
2652
+ Increase::Internal::AnyHash
2653
+ )
2654
+ end
2655
+
2656
+ # The reference identifier for the third party verification.
2657
+ sig { returns(String) }
2658
+ attr_accessor :reference
2659
+
2660
+ # The vendor that was used to perform the verification.
2661
+ sig do
2662
+ returns(
2663
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor::OrSymbol
2664
+ )
2665
+ end
2666
+ attr_accessor :vendor
2667
+
2668
+ # A reference to data stored in a third-party verification service. Your
2669
+ # integration may or may not use this field.
2670
+ sig do
2671
+ params(
2672
+ reference: String,
2673
+ vendor:
2674
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor::OrSymbol
2675
+ ).returns(T.attached_class)
2676
+ end
2677
+ def self.new(
2678
+ # The reference identifier for the third party verification.
2679
+ reference:,
2680
+ # The vendor that was used to perform the verification.
2681
+ vendor:
2682
+ )
2683
+ end
2684
+
2685
+ sig do
2686
+ override.returns(
2687
+ {
2688
+ reference: String,
2689
+ vendor:
2690
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor::OrSymbol
2691
+ }
2692
+ )
2693
+ end
2694
+ def to_hash
2695
+ end
2696
+
2697
+ # The vendor that was used to perform the verification.
2698
+ module Vendor
2699
+ extend Increase::Internal::Type::Enum
2700
+
2701
+ TaggedSymbol =
2702
+ T.type_alias do
2703
+ T.all(
2704
+ Symbol,
2705
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor
2706
+ )
2707
+ end
2708
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2709
+
2710
+ # Alloy. See https://alloy.com for more information.
2711
+ ALLOY =
2712
+ T.let(
2713
+ :alloy,
2714
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor::TaggedSymbol
2715
+ )
2716
+
2717
+ # Middesk. See https://middesk.com for more information.
2718
+ MIDDESK =
2719
+ T.let(
2720
+ :middesk,
2721
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor::TaggedSymbol
2722
+ )
2723
+
2724
+ # Oscilar. See https://oscilar.com for more information.
2725
+ OSCILAR =
2726
+ T.let(
2727
+ :oscilar,
2728
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor::TaggedSymbol
2729
+ )
2730
+
2731
+ sig do
2732
+ override.returns(
2733
+ T::Array[
2734
+ Increase::EntityCreateParams::ThirdPartyVerification::Vendor::TaggedSymbol
2735
+ ]
2736
+ )
2737
+ end
2738
+ def self.values
2739
+ end
2740
+ end
2741
+ end
2742
+
2743
+ class Trust < Increase::Internal::Type::BaseModel
2744
+ OrHash =
2745
+ T.type_alias do
2746
+ T.any(
2747
+ Increase::EntityCreateParams::Trust,
2748
+ Increase::Internal::AnyHash
2749
+ )
2750
+ end
2751
+
2752
+ # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
2753
+ # are disallowed.
2754
+ sig { returns(Increase::EntityCreateParams::Trust::Address) }
2755
+ attr_reader :address
2756
+
2757
+ sig do
2758
+ params(
2759
+ address: Increase::EntityCreateParams::Trust::Address::OrHash
2760
+ ).void
2761
+ end
2762
+ attr_writer :address
2763
+
2764
+ # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
2765
+ # their own Employer Identification Number. Revocable trusts require information
2766
+ # about the individual `grantor` who created the trust.
2767
+ sig { returns(Increase::EntityCreateParams::Trust::Category::OrSymbol) }
2768
+ attr_accessor :category
2769
+
2770
+ # The legal name of the trust.
2771
+ sig { returns(String) }
2772
+ attr_accessor :name
2773
+
2774
+ # The trustees of the trust.
2775
+ sig { returns(T::Array[Increase::EntityCreateParams::Trust::Trustee]) }
2776
+ attr_accessor :trustees
2777
+
2778
+ # The identifier of the File containing the formation document of the trust.
2779
+ sig { returns(T.nilable(String)) }
2780
+ attr_reader :formation_document_file_id
2781
+
2782
+ sig { params(formation_document_file_id: String).void }
2783
+ attr_writer :formation_document_file_id
2784
+
2785
+ # The two-letter United States Postal Service (USPS) abbreviation for the state in
2786
+ # which the trust was formed.
2787
+ sig { returns(T.nilable(String)) }
2788
+ attr_reader :formation_state
2789
+
2790
+ sig { params(formation_state: String).void }
2791
+ attr_writer :formation_state
2792
+
2793
+ # The grantor of the trust. Required if `category` is equal to `revocable`.
2794
+ sig { returns(T.nilable(Increase::EntityCreateParams::Trust::Grantor)) }
2795
+ attr_reader :grantor
2796
+
2797
+ sig do
2798
+ params(
2799
+ grantor: Increase::EntityCreateParams::Trust::Grantor::OrHash
2800
+ ).void
2801
+ end
2802
+ attr_writer :grantor
2803
+
2804
+ # The Employer Identification Number (EIN) for the trust. Required if `category`
2805
+ # is equal to `irrevocable`.
2806
+ sig { returns(T.nilable(String)) }
2807
+ attr_reader :tax_identifier
2808
+
2809
+ sig { params(tax_identifier: String).void }
2810
+ attr_writer :tax_identifier
2811
+
2812
+ # Details of the trust entity to create. Required if `structure` is equal to
2813
+ # `trust`.
2814
+ sig do
2815
+ params(
2816
+ address: Increase::EntityCreateParams::Trust::Address::OrHash,
2817
+ category: Increase::EntityCreateParams::Trust::Category::OrSymbol,
2818
+ name: String,
2819
+ trustees:
2820
+ T::Array[Increase::EntityCreateParams::Trust::Trustee::OrHash],
2821
+ formation_document_file_id: String,
2822
+ formation_state: String,
2823
+ grantor: Increase::EntityCreateParams::Trust::Grantor::OrHash,
2824
+ tax_identifier: String
2825
+ ).returns(T.attached_class)
2826
+ end
2827
+ def self.new(
2828
+ # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
2829
+ # are disallowed.
2830
+ address:,
2831
+ # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
2832
+ # their own Employer Identification Number. Revocable trusts require information
2833
+ # about the individual `grantor` who created the trust.
2834
+ category:,
2835
+ # The legal name of the trust.
2836
+ name:,
2837
+ # The trustees of the trust.
2838
+ trustees:,
2839
+ # The identifier of the File containing the formation document of the trust.
2840
+ formation_document_file_id: nil,
2841
+ # The two-letter United States Postal Service (USPS) abbreviation for the state in
2842
+ # which the trust was formed.
2843
+ formation_state: nil,
2844
+ # The grantor of the trust. Required if `category` is equal to `revocable`.
2845
+ grantor: nil,
2846
+ # The Employer Identification Number (EIN) for the trust. Required if `category`
2847
+ # is equal to `irrevocable`.
2848
+ tax_identifier: nil
2849
+ )
2850
+ end
2851
+
2852
+ sig do
2853
+ override.returns(
2854
+ {
2855
+ address: Increase::EntityCreateParams::Trust::Address,
2856
+ category: Increase::EntityCreateParams::Trust::Category::OrSymbol,
2857
+ name: String,
2858
+ trustees: T::Array[Increase::EntityCreateParams::Trust::Trustee],
2859
+ formation_document_file_id: String,
2860
+ formation_state: String,
2861
+ grantor: Increase::EntityCreateParams::Trust::Grantor,
2862
+ tax_identifier: String
2863
+ }
2864
+ )
2865
+ end
2866
+ def to_hash
2867
+ end
2868
+
2869
+ class Address < Increase::Internal::Type::BaseModel
2870
+ OrHash =
2871
+ T.type_alias do
2872
+ T.any(
2873
+ Increase::EntityCreateParams::Trust::Address,
2874
+ Increase::Internal::AnyHash
2875
+ )
2876
+ end
2877
+
2878
+ # The city of the address.
2879
+ sig { returns(String) }
2880
+ attr_accessor :city
2881
+
2882
+ # The first line of the address. This is usually the street number and street.
2883
+ sig { returns(String) }
2884
+ attr_accessor :line1
2885
+
2886
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
2887
+ # the address.
2888
+ sig { returns(String) }
2889
+ attr_accessor :state
2890
+
2891
+ # The ZIP code of the address.
2892
+ sig { returns(String) }
2893
+ attr_accessor :zip
2894
+
2895
+ # The second line of the address. This might be the floor or room number.
2896
+ sig { returns(T.nilable(String)) }
2897
+ attr_reader :line2
2898
+
2899
+ sig { params(line2: String).void }
2900
+ attr_writer :line2
2901
+
2902
+ # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
2903
+ # are disallowed.
2904
+ sig do
2905
+ params(
2906
+ city: String,
2907
+ line1: String,
2908
+ state: String,
2909
+ zip: String,
2910
+ line2: String
2911
+ ).returns(T.attached_class)
2912
+ end
2913
+ def self.new(
2914
+ # The city of the address.
2915
+ city:,
2916
+ # The first line of the address. This is usually the street number and street.
2917
+ line1:,
2918
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
2919
+ # the address.
2920
+ state:,
2921
+ # The ZIP code of the address.
2922
+ zip:,
2923
+ # The second line of the address. This might be the floor or room number.
2924
+ line2: nil
2925
+ )
2926
+ end
2927
+
2928
+ sig do
2929
+ override.returns(
2930
+ {
2931
+ city: String,
2932
+ line1: String,
2933
+ state: String,
2934
+ zip: String,
2935
+ line2: String
2936
+ }
2937
+ )
2938
+ end
2939
+ def to_hash
2940
+ end
2941
+ end
2942
+
2943
+ # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
2944
+ # their own Employer Identification Number. Revocable trusts require information
2945
+ # about the individual `grantor` who created the trust.
2946
+ module Category
2947
+ extend Increase::Internal::Type::Enum
2948
+
2949
+ TaggedSymbol =
2950
+ T.type_alias do
2951
+ T.all(Symbol, Increase::EntityCreateParams::Trust::Category)
2952
+ end
2953
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2954
+
2955
+ # The trust is revocable by the grantor.
2956
+ REVOCABLE =
2957
+ T.let(
2958
+ :revocable,
2959
+ Increase::EntityCreateParams::Trust::Category::TaggedSymbol
2960
+ )
2961
+
2962
+ # The trust cannot be revoked.
2963
+ IRREVOCABLE =
2964
+ T.let(
2965
+ :irrevocable,
2966
+ Increase::EntityCreateParams::Trust::Category::TaggedSymbol
2967
+ )
2968
+
2969
+ sig do
2970
+ override.returns(
2971
+ T::Array[
2972
+ Increase::EntityCreateParams::Trust::Category::TaggedSymbol
2973
+ ]
2974
+ )
2975
+ end
2976
+ def self.values
2977
+ end
2978
+ end
2979
+
2980
+ class Trustee < Increase::Internal::Type::BaseModel
2981
+ OrHash =
2982
+ T.type_alias do
2983
+ T.any(
2984
+ Increase::EntityCreateParams::Trust::Trustee,
2985
+ Increase::Internal::AnyHash
2986
+ )
2987
+ end
2988
+
2989
+ # The structure of the trustee.
2990
+ sig do
2991
+ returns(
2992
+ Increase::EntityCreateParams::Trust::Trustee::Structure::OrSymbol
2993
+ )
2994
+ end
2995
+ attr_accessor :structure
2996
+
2997
+ # Details of the individual trustee. Required when the trustee `structure` is
2998
+ # equal to `individual`.
2999
+ sig do
3000
+ returns(
3001
+ T.nilable(
3002
+ Increase::EntityCreateParams::Trust::Trustee::Individual
3003
+ )
3004
+ )
3005
+ end
3006
+ attr_reader :individual
3007
+
3008
+ sig do
3009
+ params(
3010
+ individual:
3011
+ Increase::EntityCreateParams::Trust::Trustee::Individual::OrHash
3012
+ ).void
3013
+ end
3014
+ attr_writer :individual
3015
+
3016
+ sig do
3017
+ params(
3018
+ structure:
3019
+ Increase::EntityCreateParams::Trust::Trustee::Structure::OrSymbol,
3020
+ individual:
3021
+ Increase::EntityCreateParams::Trust::Trustee::Individual::OrHash
3022
+ ).returns(T.attached_class)
3023
+ end
3024
+ def self.new(
3025
+ # The structure of the trustee.
3026
+ structure:,
3027
+ # Details of the individual trustee. Required when the trustee `structure` is
3028
+ # equal to `individual`.
3029
+ individual: nil
3030
+ )
3031
+ end
3032
+
3033
+ sig do
3034
+ override.returns(
3035
+ {
3036
+ structure:
3037
+ Increase::EntityCreateParams::Trust::Trustee::Structure::OrSymbol,
3038
+ individual:
3039
+ Increase::EntityCreateParams::Trust::Trustee::Individual
3040
+ }
3041
+ )
3042
+ end
3043
+ def to_hash
3044
+ end
3045
+
3046
+ # The structure of the trustee.
3047
+ module Structure
3048
+ extend Increase::Internal::Type::Enum
3049
+
3050
+ TaggedSymbol =
3051
+ T.type_alias do
3052
+ T.all(
3053
+ Symbol,
3054
+ Increase::EntityCreateParams::Trust::Trustee::Structure
3055
+ )
3056
+ end
3057
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3058
+
3059
+ # The trustee is an individual.
3060
+ INDIVIDUAL =
3061
+ T.let(
3062
+ :individual,
3063
+ Increase::EntityCreateParams::Trust::Trustee::Structure::TaggedSymbol
3064
+ )
3065
+
3066
+ sig do
3067
+ override.returns(
3068
+ T::Array[
3069
+ Increase::EntityCreateParams::Trust::Trustee::Structure::TaggedSymbol
3070
+ ]
3071
+ )
3072
+ end
3073
+ def self.values
3074
+ end
3075
+ end
3076
+
3077
+ class Individual < Increase::Internal::Type::BaseModel
3078
+ OrHash =
3079
+ T.type_alias do
3080
+ T.any(
3081
+ Increase::EntityCreateParams::Trust::Trustee::Individual,
3082
+ Increase::Internal::AnyHash
3083
+ )
3084
+ end
3085
+
3086
+ # The individual's physical address. Mail receiving locations like PO Boxes and
3087
+ # PMB's are disallowed.
3088
+ sig do
3089
+ returns(
3090
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Address
3091
+ )
3092
+ end
3093
+ attr_reader :address
3094
+
3095
+ sig do
3096
+ params(
3097
+ address:
3098
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Address::OrHash
3099
+ ).void
3100
+ end
3101
+ attr_writer :address
3102
+
3103
+ # The person's date of birth in YYYY-MM-DD format.
3104
+ sig { returns(Date) }
3105
+ attr_accessor :date_of_birth
3106
+
3107
+ # A means of verifying the person's identity.
3108
+ sig do
3109
+ returns(
3110
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification
3111
+ )
3112
+ end
3113
+ attr_reader :identification
3114
+
3115
+ sig do
3116
+ params(
3117
+ identification:
3118
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::OrHash
3119
+ ).void
3120
+ end
3121
+ attr_writer :identification
3122
+
3123
+ # The person's legal name.
3124
+ sig { returns(String) }
3125
+ attr_accessor :name
3126
+
3127
+ # The identification method for an individual can only be a passport, driver's
3128
+ # license, or other document if you've confirmed the individual does not have a US
3129
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
3130
+ # Number).
3131
+ sig { returns(T.nilable(T::Boolean)) }
3132
+ attr_reader :confirmed_no_us_tax_id
3133
+
3134
+ sig { params(confirmed_no_us_tax_id: T::Boolean).void }
3135
+ attr_writer :confirmed_no_us_tax_id
3136
+
3137
+ # Details of the individual trustee. Required when the trustee `structure` is
3138
+ # equal to `individual`.
3139
+ sig do
3140
+ params(
3141
+ address:
3142
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Address::OrHash,
3143
+ date_of_birth: Date,
3144
+ identification:
3145
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::OrHash,
3146
+ name: String,
3147
+ confirmed_no_us_tax_id: T::Boolean
3148
+ ).returns(T.attached_class)
3149
+ end
3150
+ def self.new(
3151
+ # The individual's physical address. Mail receiving locations like PO Boxes and
3152
+ # PMB's are disallowed.
3153
+ address:,
3154
+ # The person's date of birth in YYYY-MM-DD format.
3155
+ date_of_birth:,
3156
+ # A means of verifying the person's identity.
3157
+ identification:,
3158
+ # The person's legal name.
3159
+ name:,
3160
+ # The identification method for an individual can only be a passport, driver's
3161
+ # license, or other document if you've confirmed the individual does not have a US
3162
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
3163
+ # Number).
3164
+ confirmed_no_us_tax_id: nil
3165
+ )
3166
+ end
3167
+
3168
+ sig do
3169
+ override.returns(
3170
+ {
3171
+ address:
3172
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Address,
3173
+ date_of_birth: Date,
3174
+ identification:
3175
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification,
3176
+ name: String,
3177
+ confirmed_no_us_tax_id: T::Boolean
3178
+ }
3179
+ )
3180
+ end
3181
+ def to_hash
3182
+ end
3183
+
3184
+ class Address < Increase::Internal::Type::BaseModel
3185
+ OrHash =
3186
+ T.type_alias do
3187
+ T.any(
3188
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Address,
3189
+ Increase::Internal::AnyHash
3190
+ )
3191
+ end
3192
+
3193
+ # The city of the address.
3194
+ sig { returns(String) }
3195
+ attr_accessor :city
3196
+
3197
+ # The first line of the address. This is usually the street number and street.
3198
+ sig { returns(String) }
3199
+ attr_accessor :line1
3200
+
3201
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
3202
+ # the address.
3203
+ sig { returns(String) }
3204
+ attr_accessor :state
3205
+
3206
+ # The ZIP code of the address.
3207
+ sig { returns(String) }
3208
+ attr_accessor :zip
3209
+
3210
+ # The second line of the address. This might be the floor or room number.
3211
+ sig { returns(T.nilable(String)) }
3212
+ attr_reader :line2
3213
+
3214
+ sig { params(line2: String).void }
3215
+ attr_writer :line2
3216
+
3217
+ # The individual's physical address. Mail receiving locations like PO Boxes and
3218
+ # PMB's are disallowed.
3219
+ sig do
3220
+ params(
3221
+ city: String,
3222
+ line1: String,
3223
+ state: String,
3224
+ zip: String,
3225
+ line2: String
3226
+ ).returns(T.attached_class)
3227
+ end
3228
+ def self.new(
3229
+ # The city of the address.
3230
+ city:,
3231
+ # The first line of the address. This is usually the street number and street.
3232
+ line1:,
3233
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
3234
+ # the address.
3235
+ state:,
3236
+ # The ZIP code of the address.
3237
+ zip:,
3238
+ # The second line of the address. This might be the floor or room number.
3239
+ line2: nil
3240
+ )
3241
+ end
3242
+
3243
+ sig do
3244
+ override.returns(
3245
+ {
3246
+ city: String,
3247
+ line1: String,
3248
+ state: String,
3249
+ zip: String,
3250
+ line2: String
3251
+ }
3252
+ )
3253
+ end
3254
+ def to_hash
3255
+ end
3256
+ end
3257
+
3258
+ class Identification < Increase::Internal::Type::BaseModel
3259
+ OrHash =
3260
+ T.type_alias do
3261
+ T.any(
3262
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification,
3263
+ Increase::Internal::AnyHash
3264
+ )
3265
+ end
3266
+
3267
+ # A method that can be used to verify the individual's identity.
3268
+ sig do
3269
+ returns(
3270
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::OrSymbol
3271
+ )
3272
+ end
3273
+ attr_accessor :method_
3274
+
3275
+ # An identification number that can be used to verify the individual's identity,
3276
+ # such as a social security number.
3277
+ sig { returns(String) }
3278
+ attr_accessor :number
3279
+
3280
+ # Information about the United States driver's license used for identification.
3281
+ # Required if `method` is equal to `drivers_license`.
3282
+ sig do
3283
+ returns(
3284
+ T.nilable(
3285
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense
3286
+ )
3287
+ )
3288
+ end
3289
+ attr_reader :drivers_license
3290
+
3291
+ sig do
3292
+ params(
3293
+ drivers_license:
3294
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense::OrHash
3295
+ ).void
3296
+ end
3297
+ attr_writer :drivers_license
3298
+
3299
+ # Information about the identification document provided. Required if `method` is
3300
+ # equal to `other`.
3301
+ sig do
3302
+ returns(
3303
+ T.nilable(
3304
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Other
3305
+ )
3306
+ )
3307
+ end
3308
+ attr_reader :other
3309
+
3310
+ sig do
3311
+ params(
3312
+ other:
3313
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Other::OrHash
3314
+ ).void
3315
+ end
3316
+ attr_writer :other
3317
+
3318
+ # Information about the passport used for identification. Required if `method` is
3319
+ # equal to `passport`.
3320
+ sig do
3321
+ returns(
3322
+ T.nilable(
3323
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport
3324
+ )
3325
+ )
3326
+ end
3327
+ attr_reader :passport
3328
+
3329
+ sig do
3330
+ params(
3331
+ passport:
3332
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport::OrHash
3333
+ ).void
3334
+ end
3335
+ attr_writer :passport
3336
+
3337
+ # A means of verifying the person's identity.
3338
+ sig do
3339
+ params(
3340
+ method_:
3341
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::OrSymbol,
3342
+ number: String,
3343
+ drivers_license:
3344
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense::OrHash,
3345
+ other:
3346
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Other::OrHash,
3347
+ passport:
3348
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport::OrHash
3349
+ ).returns(T.attached_class)
3350
+ end
3351
+ def self.new(
3352
+ # A method that can be used to verify the individual's identity.
3353
+ method_:,
3354
+ # An identification number that can be used to verify the individual's identity,
3355
+ # such as a social security number.
3356
+ number:,
3357
+ # Information about the United States driver's license used for identification.
3358
+ # Required if `method` is equal to `drivers_license`.
3359
+ drivers_license: nil,
3360
+ # Information about the identification document provided. Required if `method` is
3361
+ # equal to `other`.
3362
+ other: nil,
3363
+ # Information about the passport used for identification. Required if `method` is
3364
+ # equal to `passport`.
3365
+ passport: nil
3366
+ )
3367
+ end
3368
+
3369
+ sig do
3370
+ override.returns(
3371
+ {
3372
+ method_:
3373
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::OrSymbol,
3374
+ number: String,
3375
+ drivers_license:
3376
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense,
3377
+ other:
3378
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Other,
3379
+ passport:
3380
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport
3381
+ }
3382
+ )
3383
+ end
3384
+ def to_hash
3385
+ end
3386
+
3387
+ # A method that can be used to verify the individual's identity.
3388
+ module Method
3389
+ extend Increase::Internal::Type::Enum
3390
+
3391
+ TaggedSymbol =
3392
+ T.type_alias do
3393
+ T.all(
3394
+ Symbol,
3395
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method
3396
+ )
3397
+ end
3398
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3399
+
3400
+ # A social security number.
3401
+ SOCIAL_SECURITY_NUMBER =
3402
+ T.let(
3403
+ :social_security_number,
3404
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3405
+ )
3406
+
3407
+ # An individual taxpayer identification number (ITIN).
3408
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
3409
+ T.let(
3410
+ :individual_taxpayer_identification_number,
3411
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3412
+ )
3413
+
3414
+ # A passport number.
3415
+ PASSPORT =
3416
+ T.let(
3417
+ :passport,
3418
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3419
+ )
3420
+
3421
+ # A driver's license number.
3422
+ DRIVERS_LICENSE =
3423
+ T.let(
3424
+ :drivers_license,
3425
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3426
+ )
3427
+
3428
+ # Another identifying document.
3429
+ OTHER =
3430
+ T.let(
3431
+ :other,
3432
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3433
+ )
3434
+
3435
+ sig do
3436
+ override.returns(
3437
+ T::Array[
3438
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Method::TaggedSymbol
3439
+ ]
3440
+ )
3441
+ end
3442
+ def self.values
3443
+ end
3444
+ end
3445
+
3446
+ class DriversLicense < Increase::Internal::Type::BaseModel
3447
+ OrHash =
3448
+ T.type_alias do
3449
+ T.any(
3450
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::DriversLicense,
3451
+ Increase::Internal::AnyHash
3452
+ )
3453
+ end
3454
+
3455
+ # The driver's license's expiration date in YYYY-MM-DD format.
3456
+ sig { returns(Date) }
3457
+ attr_accessor :expiration_date
3458
+
3459
+ # The identifier of the File containing the front of the driver's license.
3460
+ sig { returns(String) }
3461
+ attr_accessor :file_id
3462
+
3463
+ # The state that issued the provided driver's license.
3464
+ sig { returns(String) }
3465
+ attr_accessor :state
3466
+
3467
+ # The identifier of the File containing the back of the driver's license.
3468
+ sig { returns(T.nilable(String)) }
3469
+ attr_reader :back_file_id
3470
+
3471
+ sig { params(back_file_id: String).void }
3472
+ attr_writer :back_file_id
3473
+
3474
+ # Information about the United States driver's license used for identification.
3475
+ # Required if `method` is equal to `drivers_license`.
3476
+ sig do
3477
+ params(
3478
+ expiration_date: Date,
3479
+ file_id: String,
3480
+ state: String,
3481
+ back_file_id: String
3482
+ ).returns(T.attached_class)
3483
+ end
3484
+ def self.new(
3485
+ # The driver's license's expiration date in YYYY-MM-DD format.
3486
+ expiration_date:,
3487
+ # The identifier of the File containing the front of the driver's license.
3488
+ file_id:,
3489
+ # The state that issued the provided driver's license.
3490
+ state:,
3491
+ # The identifier of the File containing the back of the driver's license.
3492
+ back_file_id: nil
3493
+ )
3494
+ end
3495
+
3496
+ sig do
3497
+ override.returns(
3498
+ {
3499
+ expiration_date: Date,
3500
+ file_id: String,
3501
+ state: String,
3502
+ back_file_id: String
3503
+ }
3504
+ )
3505
+ end
3506
+ def to_hash
3507
+ end
3508
+ end
3509
+
3510
+ class Other < Increase::Internal::Type::BaseModel
3511
+ OrHash =
3512
+ T.type_alias do
3513
+ T.any(
3514
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Other,
3515
+ Increase::Internal::AnyHash
3516
+ )
3517
+ end
3518
+
3519
+ # The two-character ISO 3166-1 code representing the country that issued the
3520
+ # document.
3521
+ sig { returns(String) }
3522
+ attr_accessor :country
3523
+
3524
+ # A description of the document submitted.
3525
+ sig { returns(String) }
3526
+ attr_accessor :description
3527
+
3528
+ # The identifier of the File containing the front of the document.
3529
+ sig { returns(String) }
3530
+ attr_accessor :file_id
3531
+
3532
+ # The identifier of the File containing the back of the document. Not every
3533
+ # document has a reverse side.
3534
+ sig { returns(T.nilable(String)) }
3535
+ attr_reader :back_file_id
3536
+
3537
+ sig { params(back_file_id: String).void }
3538
+ attr_writer :back_file_id
3539
+
3540
+ # The document's expiration date in YYYY-MM-DD format.
3541
+ sig { returns(T.nilable(Date)) }
3542
+ attr_reader :expiration_date
3543
+
3544
+ sig { params(expiration_date: Date).void }
3545
+ attr_writer :expiration_date
3546
+
3547
+ # Information about the identification document provided. Required if `method` is
3548
+ # equal to `other`.
3549
+ sig do
3550
+ params(
3551
+ country: String,
3552
+ description: String,
3553
+ file_id: String,
3554
+ back_file_id: String,
3555
+ expiration_date: Date
3556
+ ).returns(T.attached_class)
3557
+ end
3558
+ def self.new(
3559
+ # The two-character ISO 3166-1 code representing the country that issued the
3560
+ # document.
3561
+ country:,
3562
+ # A description of the document submitted.
3563
+ description:,
3564
+ # The identifier of the File containing the front of the document.
3565
+ file_id:,
3566
+ # The identifier of the File containing the back of the document. Not every
3567
+ # document has a reverse side.
3568
+ back_file_id: nil,
3569
+ # The document's expiration date in YYYY-MM-DD format.
3570
+ expiration_date: nil
3571
+ )
3572
+ end
3573
+
3574
+ sig do
3575
+ override.returns(
3576
+ {
3577
+ country: String,
3578
+ description: String,
3579
+ file_id: String,
3580
+ back_file_id: String,
3581
+ expiration_date: Date
3582
+ }
3583
+ )
3584
+ end
3585
+ def to_hash
3586
+ end
3587
+ end
3588
+
3589
+ class Passport < Increase::Internal::Type::BaseModel
3590
+ OrHash =
3591
+ T.type_alias do
3592
+ T.any(
3593
+ Increase::EntityCreateParams::Trust::Trustee::Individual::Identification::Passport,
3594
+ Increase::Internal::AnyHash
3595
+ )
3596
+ end
3597
+
3598
+ # The country that issued the passport.
3599
+ sig { returns(String) }
3600
+ attr_accessor :country
3601
+
3602
+ # The passport's expiration date in YYYY-MM-DD format.
3603
+ sig { returns(Date) }
3604
+ attr_accessor :expiration_date
3605
+
3606
+ # The identifier of the File containing the passport.
3607
+ sig { returns(String) }
3608
+ attr_accessor :file_id
3609
+
3610
+ # Information about the passport used for identification. Required if `method` is
3611
+ # equal to `passport`.
3612
+ sig do
3613
+ params(
3614
+ country: String,
3615
+ expiration_date: Date,
3616
+ file_id: String
3617
+ ).returns(T.attached_class)
3618
+ end
3619
+ def self.new(
3620
+ # The country that issued the passport.
3621
+ country:,
3622
+ # The passport's expiration date in YYYY-MM-DD format.
3623
+ expiration_date:,
3624
+ # The identifier of the File containing the passport.
3625
+ file_id:
3626
+ )
3627
+ end
3628
+
3629
+ sig do
3630
+ override.returns(
3631
+ { country: String, expiration_date: Date, file_id: String }
3632
+ )
3633
+ end
3634
+ def to_hash
3635
+ end
3636
+ end
3637
+ end
3638
+ end
3639
+ end
3640
+
3641
+ class Grantor < Increase::Internal::Type::BaseModel
3642
+ OrHash =
3643
+ T.type_alias do
3644
+ T.any(
3645
+ Increase::EntityCreateParams::Trust::Grantor,
3646
+ Increase::Internal::AnyHash
3647
+ )
3648
+ end
3649
+
3650
+ # The individual's physical address. Mail receiving locations like PO Boxes and
3651
+ # PMB's are disallowed.
3652
+ sig { returns(Increase::EntityCreateParams::Trust::Grantor::Address) }
3653
+ attr_reader :address
3654
+
3655
+ sig do
3656
+ params(
3657
+ address:
3658
+ Increase::EntityCreateParams::Trust::Grantor::Address::OrHash
3659
+ ).void
3660
+ end
3661
+ attr_writer :address
3662
+
3663
+ # The person's date of birth in YYYY-MM-DD format.
3664
+ sig { returns(Date) }
3665
+ attr_accessor :date_of_birth
3666
+
3667
+ # A means of verifying the person's identity.
3668
+ sig do
3669
+ returns(
3670
+ Increase::EntityCreateParams::Trust::Grantor::Identification
3671
+ )
3672
+ end
3673
+ attr_reader :identification
3674
+
3675
+ sig do
3676
+ params(
3677
+ identification:
3678
+ Increase::EntityCreateParams::Trust::Grantor::Identification::OrHash
3679
+ ).void
3680
+ end
3681
+ attr_writer :identification
3682
+
3683
+ # The person's legal name.
3684
+ sig { returns(String) }
3685
+ attr_accessor :name
3686
+
3687
+ # The identification method for an individual can only be a passport, driver's
3688
+ # license, or other document if you've confirmed the individual does not have a US
3689
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
3690
+ # Number).
3691
+ sig { returns(T.nilable(T::Boolean)) }
3692
+ attr_reader :confirmed_no_us_tax_id
3693
+
3694
+ sig { params(confirmed_no_us_tax_id: T::Boolean).void }
3695
+ attr_writer :confirmed_no_us_tax_id
3696
+
3697
+ # The grantor of the trust. Required if `category` is equal to `revocable`.
3698
+ sig do
3699
+ params(
3700
+ address:
3701
+ Increase::EntityCreateParams::Trust::Grantor::Address::OrHash,
3702
+ date_of_birth: Date,
3703
+ identification:
3704
+ Increase::EntityCreateParams::Trust::Grantor::Identification::OrHash,
3705
+ name: String,
3706
+ confirmed_no_us_tax_id: T::Boolean
3707
+ ).returns(T.attached_class)
3708
+ end
3709
+ def self.new(
3710
+ # The individual's physical address. Mail receiving locations like PO Boxes and
3711
+ # PMB's are disallowed.
3712
+ address:,
3713
+ # The person's date of birth in YYYY-MM-DD format.
3714
+ date_of_birth:,
3715
+ # A means of verifying the person's identity.
3716
+ identification:,
3717
+ # The person's legal name.
3718
+ name:,
3719
+ # The identification method for an individual can only be a passport, driver's
3720
+ # license, or other document if you've confirmed the individual does not have a US
3721
+ # tax id (either a Social Security Number or Individual Taxpayer Identification
3722
+ # Number).
3723
+ confirmed_no_us_tax_id: nil
3724
+ )
3725
+ end
3726
+
3727
+ sig do
3728
+ override.returns(
3729
+ {
3730
+ address: Increase::EntityCreateParams::Trust::Grantor::Address,
3731
+ date_of_birth: Date,
3732
+ identification:
3733
+ Increase::EntityCreateParams::Trust::Grantor::Identification,
3734
+ name: String,
3735
+ confirmed_no_us_tax_id: T::Boolean
3736
+ }
3737
+ )
3738
+ end
3739
+ def to_hash
3740
+ end
3741
+
3742
+ class Address < Increase::Internal::Type::BaseModel
3743
+ OrHash =
3744
+ T.type_alias do
3745
+ T.any(
3746
+ Increase::EntityCreateParams::Trust::Grantor::Address,
3747
+ Increase::Internal::AnyHash
3748
+ )
3749
+ end
3750
+
3751
+ # The city of the address.
3752
+ sig { returns(String) }
3753
+ attr_accessor :city
3754
+
3755
+ # The first line of the address. This is usually the street number and street.
3756
+ sig { returns(String) }
3757
+ attr_accessor :line1
3758
+
3759
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
3760
+ # the address.
3761
+ sig { returns(String) }
3762
+ attr_accessor :state
3763
+
3764
+ # The ZIP code of the address.
3765
+ sig { returns(String) }
3766
+ attr_accessor :zip
3767
+
3768
+ # The second line of the address. This might be the floor or room number.
3769
+ sig { returns(T.nilable(String)) }
3770
+ attr_reader :line2
3771
+
3772
+ sig { params(line2: String).void }
3773
+ attr_writer :line2
3774
+
3775
+ # The individual's physical address. Mail receiving locations like PO Boxes and
3776
+ # PMB's are disallowed.
3777
+ sig do
3778
+ params(
3779
+ city: String,
3780
+ line1: String,
3781
+ state: String,
3782
+ zip: String,
3783
+ line2: String
3784
+ ).returns(T.attached_class)
3785
+ end
3786
+ def self.new(
3787
+ # The city of the address.
3788
+ city:,
3789
+ # The first line of the address. This is usually the street number and street.
3790
+ line1:,
3791
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
3792
+ # the address.
3793
+ state:,
3794
+ # The ZIP code of the address.
3795
+ zip:,
3796
+ # The second line of the address. This might be the floor or room number.
3797
+ line2: nil
3798
+ )
3799
+ end
3800
+
3801
+ sig do
3802
+ override.returns(
3803
+ {
3804
+ city: String,
3805
+ line1: String,
3806
+ state: String,
3807
+ zip: String,
3808
+ line2: String
3809
+ }
3810
+ )
3811
+ end
3812
+ def to_hash
3813
+ end
3814
+ end
3815
+
3816
+ class Identification < Increase::Internal::Type::BaseModel
3817
+ OrHash =
3818
+ T.type_alias do
3819
+ T.any(
3820
+ Increase::EntityCreateParams::Trust::Grantor::Identification,
3821
+ Increase::Internal::AnyHash
3822
+ )
3823
+ end
3824
+
3825
+ # A method that can be used to verify the individual's identity.
3826
+ sig do
3827
+ returns(
3828
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::OrSymbol
3829
+ )
3830
+ end
3831
+ attr_accessor :method_
3832
+
3833
+ # An identification number that can be used to verify the individual's identity,
3834
+ # such as a social security number.
3835
+ sig { returns(String) }
3836
+ attr_accessor :number
3837
+
3838
+ # Information about the United States driver's license used for identification.
3839
+ # Required if `method` is equal to `drivers_license`.
3840
+ sig do
3841
+ returns(
3842
+ T.nilable(
3843
+ Increase::EntityCreateParams::Trust::Grantor::Identification::DriversLicense
3844
+ )
3845
+ )
3846
+ end
3847
+ attr_reader :drivers_license
3848
+
3849
+ sig do
3850
+ params(
3851
+ drivers_license:
3852
+ Increase::EntityCreateParams::Trust::Grantor::Identification::DriversLicense::OrHash
3853
+ ).void
3854
+ end
3855
+ attr_writer :drivers_license
3856
+
3857
+ # Information about the identification document provided. Required if `method` is
3858
+ # equal to `other`.
3859
+ sig do
3860
+ returns(
3861
+ T.nilable(
3862
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Other
3863
+ )
3864
+ )
3865
+ end
3866
+ attr_reader :other
3867
+
3868
+ sig do
3869
+ params(
3870
+ other:
3871
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Other::OrHash
3872
+ ).void
3873
+ end
3874
+ attr_writer :other
3875
+
3876
+ # Information about the passport used for identification. Required if `method` is
3877
+ # equal to `passport`.
3878
+ sig do
3879
+ returns(
3880
+ T.nilable(
3881
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Passport
3882
+ )
3883
+ )
3884
+ end
3885
+ attr_reader :passport
3886
+
3887
+ sig do
3888
+ params(
3889
+ passport:
3890
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Passport::OrHash
3891
+ ).void
3892
+ end
3893
+ attr_writer :passport
3894
+
3895
+ # A means of verifying the person's identity.
3896
+ sig do
3897
+ params(
3898
+ method_:
3899
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::OrSymbol,
3900
+ number: String,
3901
+ drivers_license:
3902
+ Increase::EntityCreateParams::Trust::Grantor::Identification::DriversLicense::OrHash,
3903
+ other:
3904
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Other::OrHash,
3905
+ passport:
3906
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Passport::OrHash
3907
+ ).returns(T.attached_class)
3908
+ end
3909
+ def self.new(
3910
+ # A method that can be used to verify the individual's identity.
3911
+ method_:,
3912
+ # An identification number that can be used to verify the individual's identity,
3913
+ # such as a social security number.
3914
+ number:,
3915
+ # Information about the United States driver's license used for identification.
3916
+ # Required if `method` is equal to `drivers_license`.
3917
+ drivers_license: nil,
3918
+ # Information about the identification document provided. Required if `method` is
3919
+ # equal to `other`.
3920
+ other: nil,
3921
+ # Information about the passport used for identification. Required if `method` is
3922
+ # equal to `passport`.
3923
+ passport: nil
3924
+ )
3925
+ end
3926
+
3927
+ sig do
3928
+ override.returns(
3929
+ {
3930
+ method_:
3931
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::OrSymbol,
3932
+ number: String,
3933
+ drivers_license:
3934
+ Increase::EntityCreateParams::Trust::Grantor::Identification::DriversLicense,
3935
+ other:
3936
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Other,
3937
+ passport:
3938
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Passport
3939
+ }
3940
+ )
3941
+ end
3942
+ def to_hash
3943
+ end
3944
+
3945
+ # A method that can be used to verify the individual's identity.
3946
+ module Method
3947
+ extend Increase::Internal::Type::Enum
3948
+
3949
+ TaggedSymbol =
3950
+ T.type_alias do
3951
+ T.all(
3952
+ Symbol,
3953
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method
3954
+ )
3955
+ end
3956
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3957
+
3958
+ # A social security number.
3959
+ SOCIAL_SECURITY_NUMBER =
3960
+ T.let(
3961
+ :social_security_number,
3962
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::TaggedSymbol
3963
+ )
3964
+
3965
+ # An individual taxpayer identification number (ITIN).
3966
+ INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
3967
+ T.let(
3968
+ :individual_taxpayer_identification_number,
3969
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::TaggedSymbol
3970
+ )
3971
+
3972
+ # A passport number.
3973
+ PASSPORT =
3974
+ T.let(
3975
+ :passport,
3976
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::TaggedSymbol
3977
+ )
3978
+
3979
+ # A driver's license number.
3980
+ DRIVERS_LICENSE =
3981
+ T.let(
3982
+ :drivers_license,
3983
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::TaggedSymbol
3984
+ )
3985
+
3986
+ # Another identifying document.
3987
+ OTHER =
3988
+ T.let(
3989
+ :other,
3990
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::TaggedSymbol
3991
+ )
3992
+
3993
+ sig do
3994
+ override.returns(
3995
+ T::Array[
3996
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Method::TaggedSymbol
3997
+ ]
3998
+ )
3999
+ end
4000
+ def self.values
4001
+ end
4002
+ end
4003
+
4004
+ class DriversLicense < Increase::Internal::Type::BaseModel
4005
+ OrHash =
4006
+ T.type_alias do
4007
+ T.any(
4008
+ Increase::EntityCreateParams::Trust::Grantor::Identification::DriversLicense,
4009
+ Increase::Internal::AnyHash
4010
+ )
4011
+ end
4012
+
4013
+ # The driver's license's expiration date in YYYY-MM-DD format.
4014
+ sig { returns(Date) }
4015
+ attr_accessor :expiration_date
4016
+
4017
+ # The identifier of the File containing the front of the driver's license.
4018
+ sig { returns(String) }
4019
+ attr_accessor :file_id
4020
+
4021
+ # The state that issued the provided driver's license.
4022
+ sig { returns(String) }
4023
+ attr_accessor :state
4024
+
4025
+ # The identifier of the File containing the back of the driver's license.
4026
+ sig { returns(T.nilable(String)) }
4027
+ attr_reader :back_file_id
4028
+
4029
+ sig { params(back_file_id: String).void }
4030
+ attr_writer :back_file_id
4031
+
4032
+ # Information about the United States driver's license used for identification.
4033
+ # Required if `method` is equal to `drivers_license`.
4034
+ sig do
4035
+ params(
4036
+ expiration_date: Date,
4037
+ file_id: String,
4038
+ state: String,
4039
+ back_file_id: String
4040
+ ).returns(T.attached_class)
4041
+ end
4042
+ def self.new(
4043
+ # The driver's license's expiration date in YYYY-MM-DD format.
4044
+ expiration_date:,
4045
+ # The identifier of the File containing the front of the driver's license.
4046
+ file_id:,
4047
+ # The state that issued the provided driver's license.
4048
+ state:,
4049
+ # The identifier of the File containing the back of the driver's license.
4050
+ back_file_id: nil
4051
+ )
4052
+ end
4053
+
4054
+ sig do
4055
+ override.returns(
4056
+ {
4057
+ expiration_date: Date,
4058
+ file_id: String,
4059
+ state: String,
4060
+ back_file_id: String
4061
+ }
4062
+ )
4063
+ end
4064
+ def to_hash
4065
+ end
4066
+ end
4067
+
4068
+ class Other < Increase::Internal::Type::BaseModel
4069
+ OrHash =
4070
+ T.type_alias do
4071
+ T.any(
4072
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Other,
4073
+ Increase::Internal::AnyHash
4074
+ )
4075
+ end
4076
+
4077
+ # The two-character ISO 3166-1 code representing the country that issued the
4078
+ # document.
4079
+ sig { returns(String) }
4080
+ attr_accessor :country
4081
+
4082
+ # A description of the document submitted.
4083
+ sig { returns(String) }
4084
+ attr_accessor :description
4085
+
4086
+ # The identifier of the File containing the front of the document.
4087
+ sig { returns(String) }
4088
+ attr_accessor :file_id
4089
+
4090
+ # The identifier of the File containing the back of the document. Not every
4091
+ # document has a reverse side.
4092
+ sig { returns(T.nilable(String)) }
4093
+ attr_reader :back_file_id
4094
+
4095
+ sig { params(back_file_id: String).void }
4096
+ attr_writer :back_file_id
4097
+
4098
+ # The document's expiration date in YYYY-MM-DD format.
4099
+ sig { returns(T.nilable(Date)) }
4100
+ attr_reader :expiration_date
4101
+
4102
+ sig { params(expiration_date: Date).void }
4103
+ attr_writer :expiration_date
4104
+
4105
+ # Information about the identification document provided. Required if `method` is
4106
+ # equal to `other`.
4107
+ sig do
4108
+ params(
4109
+ country: String,
4110
+ description: String,
4111
+ file_id: String,
4112
+ back_file_id: String,
4113
+ expiration_date: Date
4114
+ ).returns(T.attached_class)
4115
+ end
4116
+ def self.new(
4117
+ # The two-character ISO 3166-1 code representing the country that issued the
4118
+ # document.
4119
+ country:,
4120
+ # A description of the document submitted.
4121
+ description:,
4122
+ # The identifier of the File containing the front of the document.
4123
+ file_id:,
4124
+ # The identifier of the File containing the back of the document. Not every
4125
+ # document has a reverse side.
4126
+ back_file_id: nil,
4127
+ # The document's expiration date in YYYY-MM-DD format.
4128
+ expiration_date: nil
4129
+ )
4130
+ end
4131
+
4132
+ sig do
4133
+ override.returns(
4134
+ {
4135
+ country: String,
4136
+ description: String,
4137
+ file_id: String,
4138
+ back_file_id: String,
4139
+ expiration_date: Date
4140
+ }
4141
+ )
4142
+ end
4143
+ def to_hash
4144
+ end
4145
+ end
4146
+
4147
+ class Passport < Increase::Internal::Type::BaseModel
4148
+ OrHash =
4149
+ T.type_alias do
4150
+ T.any(
4151
+ Increase::EntityCreateParams::Trust::Grantor::Identification::Passport,
4152
+ Increase::Internal::AnyHash
4153
+ )
4154
+ end
4155
+
4156
+ # The country that issued the passport.
4157
+ sig { returns(String) }
4158
+ attr_accessor :country
4159
+
4160
+ # The passport's expiration date in YYYY-MM-DD format.
4161
+ sig { returns(Date) }
4162
+ attr_accessor :expiration_date
4163
+
4164
+ # The identifier of the File containing the passport.
4165
+ sig { returns(String) }
4166
+ attr_accessor :file_id
4167
+
4168
+ # Information about the passport used for identification. Required if `method` is
4169
+ # equal to `passport`.
4170
+ sig do
4171
+ params(
4172
+ country: String,
4173
+ expiration_date: Date,
4174
+ file_id: String
4175
+ ).returns(T.attached_class)
4176
+ end
4177
+ def self.new(
4178
+ # The country that issued the passport.
4179
+ country:,
4180
+ # The passport's expiration date in YYYY-MM-DD format.
4181
+ expiration_date:,
4182
+ # The identifier of the File containing the passport.
4183
+ file_id:
4184
+ )
4185
+ end
4186
+
4187
+ sig do
4188
+ override.returns(
4189
+ { country: String, expiration_date: Date, file_id: String }
4190
+ )
4191
+ end
4192
+ def to_hash
4193
+ end
4194
+ end
4195
+ end
4196
+ end
4197
+ end
4198
+ end
4199
+ end
4200
+ end