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,1670 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ class CheckTransfer < Increase::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Increase::CheckTransfer, Increase::Internal::AnyHash)
9
+ end
10
+
11
+ # The Check transfer's identifier.
12
+ sig { returns(String) }
13
+ attr_accessor :id
14
+
15
+ # The identifier of the Account from which funds will be transferred.
16
+ sig { returns(String) }
17
+ attr_accessor :account_id
18
+
19
+ # The account number printed on the check.
20
+ sig { returns(String) }
21
+ attr_accessor :account_number
22
+
23
+ # The transfer amount in USD cents.
24
+ sig { returns(Integer) }
25
+ attr_accessor :amount
26
+
27
+ # If your account requires approvals for transfers and the transfer was approved,
28
+ # this will contain details of the approval.
29
+ sig { returns(T.nilable(Increase::CheckTransfer::Approval)) }
30
+ attr_reader :approval
31
+
32
+ sig do
33
+ params(
34
+ approval: T.nilable(Increase::CheckTransfer::Approval::OrHash)
35
+ ).void
36
+ end
37
+ attr_writer :approval
38
+
39
+ # If the Check Transfer was successfully deposited, this will contain the
40
+ # identifier of the Inbound Check Deposit object with details of the deposit.
41
+ sig { returns(T.nilable(String)) }
42
+ attr_accessor :approved_inbound_check_deposit_id
43
+
44
+ # If your account requires approvals for transfers and the transfer was not
45
+ # approved, this will contain details of the cancellation.
46
+ sig { returns(T.nilable(Increase::CheckTransfer::Cancellation)) }
47
+ attr_reader :cancellation
48
+
49
+ sig do
50
+ params(
51
+ cancellation: T.nilable(Increase::CheckTransfer::Cancellation::OrHash)
52
+ ).void
53
+ end
54
+ attr_writer :cancellation
55
+
56
+ # The check number printed on the check.
57
+ sig { returns(String) }
58
+ attr_accessor :check_number
59
+
60
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
61
+ # the transfer was created.
62
+ sig { returns(Time) }
63
+ attr_accessor :created_at
64
+
65
+ # What object created the transfer, either via the API or the dashboard.
66
+ sig { returns(T.nilable(Increase::CheckTransfer::CreatedBy)) }
67
+ attr_reader :created_by
68
+
69
+ sig do
70
+ params(
71
+ created_by: T.nilable(Increase::CheckTransfer::CreatedBy::OrHash)
72
+ ).void
73
+ end
74
+ attr_writer :created_by
75
+
76
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
77
+ # currency.
78
+ sig { returns(Increase::CheckTransfer::Currency::TaggedSymbol) }
79
+ attr_accessor :currency
80
+
81
+ # Whether Increase will print and mail the check or if you will do it yourself.
82
+ sig { returns(Increase::CheckTransfer::FulfillmentMethod::TaggedSymbol) }
83
+ attr_accessor :fulfillment_method
84
+
85
+ # The idempotency key you chose for this object. This value is unique across
86
+ # Increase and is used to ensure that a request is only processed once. Learn more
87
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
88
+ sig { returns(T.nilable(String)) }
89
+ attr_accessor :idempotency_key
90
+
91
+ # If the check has been mailed by Increase, this will contain details of the
92
+ # shipment.
93
+ sig { returns(T.nilable(Increase::CheckTransfer::Mailing)) }
94
+ attr_reader :mailing
95
+
96
+ sig do
97
+ params(
98
+ mailing: T.nilable(Increase::CheckTransfer::Mailing::OrHash)
99
+ ).void
100
+ end
101
+ attr_writer :mailing
102
+
103
+ # The ID for the pending transaction representing the transfer. A pending
104
+ # transaction is created when the transfer
105
+ # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
106
+ # by someone else in your organization.
107
+ sig { returns(T.nilable(String)) }
108
+ attr_accessor :pending_transaction_id
109
+
110
+ # Details relating to the physical check that Increase will print and mail. Will
111
+ # be present if and only if `fulfillment_method` is equal to `physical_check`.
112
+ sig { returns(T.nilable(Increase::CheckTransfer::PhysicalCheck)) }
113
+ attr_reader :physical_check
114
+
115
+ sig do
116
+ params(
117
+ physical_check:
118
+ T.nilable(Increase::CheckTransfer::PhysicalCheck::OrHash)
119
+ ).void
120
+ end
121
+ attr_writer :physical_check
122
+
123
+ # The routing number printed on the check.
124
+ sig { returns(String) }
125
+ attr_accessor :routing_number
126
+
127
+ # The identifier of the Account Number from which to send the transfer and print
128
+ # on the check.
129
+ sig { returns(T.nilable(String)) }
130
+ attr_accessor :source_account_number_id
131
+
132
+ # The lifecycle status of the transfer.
133
+ sig { returns(Increase::CheckTransfer::Status::TaggedSymbol) }
134
+ attr_accessor :status
135
+
136
+ # After a stop-payment is requested on the check, this will contain supplemental
137
+ # details.
138
+ sig { returns(T.nilable(Increase::CheckTransfer::StopPaymentRequest)) }
139
+ attr_reader :stop_payment_request
140
+
141
+ sig do
142
+ params(
143
+ stop_payment_request:
144
+ T.nilable(Increase::CheckTransfer::StopPaymentRequest::OrHash)
145
+ ).void
146
+ end
147
+ attr_writer :stop_payment_request
148
+
149
+ # After the transfer is submitted, this will contain supplemental details.
150
+ sig { returns(T.nilable(Increase::CheckTransfer::Submission)) }
151
+ attr_reader :submission
152
+
153
+ sig do
154
+ params(
155
+ submission: T.nilable(Increase::CheckTransfer::Submission::OrHash)
156
+ ).void
157
+ end
158
+ attr_writer :submission
159
+
160
+ # Details relating to the custom fulfillment you will perform. Will be present if
161
+ # and only if `fulfillment_method` is equal to `third_party`.
162
+ sig { returns(T.nilable(Increase::CheckTransfer::ThirdParty)) }
163
+ attr_reader :third_party
164
+
165
+ sig do
166
+ params(
167
+ third_party: T.nilable(Increase::CheckTransfer::ThirdParty::OrHash)
168
+ ).void
169
+ end
170
+ attr_writer :third_party
171
+
172
+ # A constant representing the object's type. For this resource it will always be
173
+ # `check_transfer`.
174
+ sig { returns(Increase::CheckTransfer::Type::TaggedSymbol) }
175
+ attr_accessor :type
176
+
177
+ # Check Transfers move funds from your Increase account by mailing a physical
178
+ # check.
179
+ sig do
180
+ params(
181
+ id: String,
182
+ account_id: String,
183
+ account_number: String,
184
+ amount: Integer,
185
+ approval: T.nilable(Increase::CheckTransfer::Approval::OrHash),
186
+ approved_inbound_check_deposit_id: T.nilable(String),
187
+ cancellation:
188
+ T.nilable(Increase::CheckTransfer::Cancellation::OrHash),
189
+ check_number: String,
190
+ created_at: Time,
191
+ created_by: T.nilable(Increase::CheckTransfer::CreatedBy::OrHash),
192
+ currency: Increase::CheckTransfer::Currency::OrSymbol,
193
+ fulfillment_method:
194
+ Increase::CheckTransfer::FulfillmentMethod::OrSymbol,
195
+ idempotency_key: T.nilable(String),
196
+ mailing: T.nilable(Increase::CheckTransfer::Mailing::OrHash),
197
+ pending_transaction_id: T.nilable(String),
198
+ physical_check:
199
+ T.nilable(Increase::CheckTransfer::PhysicalCheck::OrHash),
200
+ routing_number: String,
201
+ source_account_number_id: T.nilable(String),
202
+ status: Increase::CheckTransfer::Status::OrSymbol,
203
+ stop_payment_request:
204
+ T.nilable(Increase::CheckTransfer::StopPaymentRequest::OrHash),
205
+ submission: T.nilable(Increase::CheckTransfer::Submission::OrHash),
206
+ third_party: T.nilable(Increase::CheckTransfer::ThirdParty::OrHash),
207
+ type: Increase::CheckTransfer::Type::OrSymbol
208
+ ).returns(T.attached_class)
209
+ end
210
+ def self.new(
211
+ # The Check transfer's identifier.
212
+ id:,
213
+ # The identifier of the Account from which funds will be transferred.
214
+ account_id:,
215
+ # The account number printed on the check.
216
+ account_number:,
217
+ # The transfer amount in USD cents.
218
+ amount:,
219
+ # If your account requires approvals for transfers and the transfer was approved,
220
+ # this will contain details of the approval.
221
+ approval:,
222
+ # If the Check Transfer was successfully deposited, this will contain the
223
+ # identifier of the Inbound Check Deposit object with details of the deposit.
224
+ approved_inbound_check_deposit_id:,
225
+ # If your account requires approvals for transfers and the transfer was not
226
+ # approved, this will contain details of the cancellation.
227
+ cancellation:,
228
+ # The check number printed on the check.
229
+ check_number:,
230
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
231
+ # the transfer was created.
232
+ created_at:,
233
+ # What object created the transfer, either via the API or the dashboard.
234
+ created_by:,
235
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
236
+ # currency.
237
+ currency:,
238
+ # Whether Increase will print and mail the check or if you will do it yourself.
239
+ fulfillment_method:,
240
+ # The idempotency key you chose for this object. This value is unique across
241
+ # Increase and is used to ensure that a request is only processed once. Learn more
242
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
243
+ idempotency_key:,
244
+ # If the check has been mailed by Increase, this will contain details of the
245
+ # shipment.
246
+ mailing:,
247
+ # The ID for the pending transaction representing the transfer. A pending
248
+ # transaction is created when the transfer
249
+ # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
250
+ # by someone else in your organization.
251
+ pending_transaction_id:,
252
+ # Details relating to the physical check that Increase will print and mail. Will
253
+ # be present if and only if `fulfillment_method` is equal to `physical_check`.
254
+ physical_check:,
255
+ # The routing number printed on the check.
256
+ routing_number:,
257
+ # The identifier of the Account Number from which to send the transfer and print
258
+ # on the check.
259
+ source_account_number_id:,
260
+ # The lifecycle status of the transfer.
261
+ status:,
262
+ # After a stop-payment is requested on the check, this will contain supplemental
263
+ # details.
264
+ stop_payment_request:,
265
+ # After the transfer is submitted, this will contain supplemental details.
266
+ submission:,
267
+ # Details relating to the custom fulfillment you will perform. Will be present if
268
+ # and only if `fulfillment_method` is equal to `third_party`.
269
+ third_party:,
270
+ # A constant representing the object's type. For this resource it will always be
271
+ # `check_transfer`.
272
+ type:
273
+ )
274
+ end
275
+
276
+ sig do
277
+ override.returns(
278
+ {
279
+ id: String,
280
+ account_id: String,
281
+ account_number: String,
282
+ amount: Integer,
283
+ approval: T.nilable(Increase::CheckTransfer::Approval),
284
+ approved_inbound_check_deposit_id: T.nilable(String),
285
+ cancellation: T.nilable(Increase::CheckTransfer::Cancellation),
286
+ check_number: String,
287
+ created_at: Time,
288
+ created_by: T.nilable(Increase::CheckTransfer::CreatedBy),
289
+ currency: Increase::CheckTransfer::Currency::TaggedSymbol,
290
+ fulfillment_method:
291
+ Increase::CheckTransfer::FulfillmentMethod::TaggedSymbol,
292
+ idempotency_key: T.nilable(String),
293
+ mailing: T.nilable(Increase::CheckTransfer::Mailing),
294
+ pending_transaction_id: T.nilable(String),
295
+ physical_check: T.nilable(Increase::CheckTransfer::PhysicalCheck),
296
+ routing_number: String,
297
+ source_account_number_id: T.nilable(String),
298
+ status: Increase::CheckTransfer::Status::TaggedSymbol,
299
+ stop_payment_request:
300
+ T.nilable(Increase::CheckTransfer::StopPaymentRequest),
301
+ submission: T.nilable(Increase::CheckTransfer::Submission),
302
+ third_party: T.nilable(Increase::CheckTransfer::ThirdParty),
303
+ type: Increase::CheckTransfer::Type::TaggedSymbol
304
+ }
305
+ )
306
+ end
307
+ def to_hash
308
+ end
309
+
310
+ class Approval < Increase::Internal::Type::BaseModel
311
+ OrHash =
312
+ T.type_alias do
313
+ T.any(
314
+ Increase::CheckTransfer::Approval,
315
+ Increase::Internal::AnyHash
316
+ )
317
+ end
318
+
319
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
320
+ # the transfer was approved.
321
+ sig { returns(Time) }
322
+ attr_accessor :approved_at
323
+
324
+ # If the Transfer was approved by a user in the dashboard, the email address of
325
+ # that user.
326
+ sig { returns(T.nilable(String)) }
327
+ attr_accessor :approved_by
328
+
329
+ # If your account requires approvals for transfers and the transfer was approved,
330
+ # this will contain details of the approval.
331
+ sig do
332
+ params(approved_at: Time, approved_by: T.nilable(String)).returns(
333
+ T.attached_class
334
+ )
335
+ end
336
+ def self.new(
337
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
338
+ # the transfer was approved.
339
+ approved_at:,
340
+ # If the Transfer was approved by a user in the dashboard, the email address of
341
+ # that user.
342
+ approved_by:
343
+ )
344
+ end
345
+
346
+ sig do
347
+ override.returns(
348
+ { approved_at: Time, approved_by: T.nilable(String) }
349
+ )
350
+ end
351
+ def to_hash
352
+ end
353
+ end
354
+
355
+ class Cancellation < Increase::Internal::Type::BaseModel
356
+ OrHash =
357
+ T.type_alias do
358
+ T.any(
359
+ Increase::CheckTransfer::Cancellation,
360
+ Increase::Internal::AnyHash
361
+ )
362
+ end
363
+
364
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
365
+ # the Transfer was canceled.
366
+ sig { returns(Time) }
367
+ attr_accessor :canceled_at
368
+
369
+ # If the Transfer was canceled by a user in the dashboard, the email address of
370
+ # that user.
371
+ sig { returns(T.nilable(String)) }
372
+ attr_accessor :canceled_by
373
+
374
+ # If your account requires approvals for transfers and the transfer was not
375
+ # approved, this will contain details of the cancellation.
376
+ sig do
377
+ params(canceled_at: Time, canceled_by: T.nilable(String)).returns(
378
+ T.attached_class
379
+ )
380
+ end
381
+ def self.new(
382
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
383
+ # the Transfer was canceled.
384
+ canceled_at:,
385
+ # If the Transfer was canceled by a user in the dashboard, the email address of
386
+ # that user.
387
+ canceled_by:
388
+ )
389
+ end
390
+
391
+ sig do
392
+ override.returns(
393
+ { canceled_at: Time, canceled_by: T.nilable(String) }
394
+ )
395
+ end
396
+ def to_hash
397
+ end
398
+ end
399
+
400
+ class CreatedBy < Increase::Internal::Type::BaseModel
401
+ OrHash =
402
+ T.type_alias do
403
+ T.any(
404
+ Increase::CheckTransfer::CreatedBy,
405
+ Increase::Internal::AnyHash
406
+ )
407
+ end
408
+
409
+ # If present, details about the API key that created the transfer.
410
+ sig { returns(T.nilable(Increase::CheckTransfer::CreatedBy::APIKey)) }
411
+ attr_reader :api_key
412
+
413
+ sig do
414
+ params(
415
+ api_key:
416
+ T.nilable(Increase::CheckTransfer::CreatedBy::APIKey::OrHash)
417
+ ).void
418
+ end
419
+ attr_writer :api_key
420
+
421
+ # The type of object that created this transfer.
422
+ sig do
423
+ returns(Increase::CheckTransfer::CreatedBy::Category::TaggedSymbol)
424
+ end
425
+ attr_accessor :category
426
+
427
+ # If present, details about the OAuth Application that created the transfer.
428
+ sig do
429
+ returns(
430
+ T.nilable(Increase::CheckTransfer::CreatedBy::OAuthApplication)
431
+ )
432
+ end
433
+ attr_reader :oauth_application
434
+
435
+ sig do
436
+ params(
437
+ oauth_application:
438
+ T.nilable(
439
+ Increase::CheckTransfer::CreatedBy::OAuthApplication::OrHash
440
+ )
441
+ ).void
442
+ end
443
+ attr_writer :oauth_application
444
+
445
+ # If present, details about the User that created the transfer.
446
+ sig { returns(T.nilable(Increase::CheckTransfer::CreatedBy::User)) }
447
+ attr_reader :user
448
+
449
+ sig do
450
+ params(
451
+ user: T.nilable(Increase::CheckTransfer::CreatedBy::User::OrHash)
452
+ ).void
453
+ end
454
+ attr_writer :user
455
+
456
+ # What object created the transfer, either via the API or the dashboard.
457
+ sig do
458
+ params(
459
+ api_key:
460
+ T.nilable(Increase::CheckTransfer::CreatedBy::APIKey::OrHash),
461
+ category: Increase::CheckTransfer::CreatedBy::Category::OrSymbol,
462
+ oauth_application:
463
+ T.nilable(
464
+ Increase::CheckTransfer::CreatedBy::OAuthApplication::OrHash
465
+ ),
466
+ user: T.nilable(Increase::CheckTransfer::CreatedBy::User::OrHash)
467
+ ).returns(T.attached_class)
468
+ end
469
+ def self.new(
470
+ # If present, details about the API key that created the transfer.
471
+ api_key:,
472
+ # The type of object that created this transfer.
473
+ category:,
474
+ # If present, details about the OAuth Application that created the transfer.
475
+ oauth_application:,
476
+ # If present, details about the User that created the transfer.
477
+ user:
478
+ )
479
+ end
480
+
481
+ sig do
482
+ override.returns(
483
+ {
484
+ api_key: T.nilable(Increase::CheckTransfer::CreatedBy::APIKey),
485
+ category:
486
+ Increase::CheckTransfer::CreatedBy::Category::TaggedSymbol,
487
+ oauth_application:
488
+ T.nilable(Increase::CheckTransfer::CreatedBy::OAuthApplication),
489
+ user: T.nilable(Increase::CheckTransfer::CreatedBy::User)
490
+ }
491
+ )
492
+ end
493
+ def to_hash
494
+ end
495
+
496
+ class APIKey < Increase::Internal::Type::BaseModel
497
+ OrHash =
498
+ T.type_alias do
499
+ T.any(
500
+ Increase::CheckTransfer::CreatedBy::APIKey,
501
+ Increase::Internal::AnyHash
502
+ )
503
+ end
504
+
505
+ # The description set for the API key when it was created.
506
+ sig { returns(T.nilable(String)) }
507
+ attr_accessor :description
508
+
509
+ # If present, details about the API key that created the transfer.
510
+ sig do
511
+ params(description: T.nilable(String)).returns(T.attached_class)
512
+ end
513
+ def self.new(
514
+ # The description set for the API key when it was created.
515
+ description:
516
+ )
517
+ end
518
+
519
+ sig { override.returns({ description: T.nilable(String) }) }
520
+ def to_hash
521
+ end
522
+ end
523
+
524
+ # The type of object that created this transfer.
525
+ module Category
526
+ extend Increase::Internal::Type::Enum
527
+
528
+ TaggedSymbol =
529
+ T.type_alias do
530
+ T.all(Symbol, Increase::CheckTransfer::CreatedBy::Category)
531
+ end
532
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
533
+
534
+ # An API key. Details will be under the `api_key` object.
535
+ API_KEY =
536
+ T.let(
537
+ :api_key,
538
+ Increase::CheckTransfer::CreatedBy::Category::TaggedSymbol
539
+ )
540
+
541
+ # An OAuth application you connected to Increase. Details will be under the `oauth_application` object.
542
+ OAUTH_APPLICATION =
543
+ T.let(
544
+ :oauth_application,
545
+ Increase::CheckTransfer::CreatedBy::Category::TaggedSymbol
546
+ )
547
+
548
+ # A User in the Increase dashboard. Details will be under the `user` object.
549
+ USER =
550
+ T.let(
551
+ :user,
552
+ Increase::CheckTransfer::CreatedBy::Category::TaggedSymbol
553
+ )
554
+
555
+ sig do
556
+ override.returns(
557
+ T::Array[
558
+ Increase::CheckTransfer::CreatedBy::Category::TaggedSymbol
559
+ ]
560
+ )
561
+ end
562
+ def self.values
563
+ end
564
+ end
565
+
566
+ class OAuthApplication < Increase::Internal::Type::BaseModel
567
+ OrHash =
568
+ T.type_alias do
569
+ T.any(
570
+ Increase::CheckTransfer::CreatedBy::OAuthApplication,
571
+ Increase::Internal::AnyHash
572
+ )
573
+ end
574
+
575
+ # The name of the OAuth Application.
576
+ sig { returns(String) }
577
+ attr_accessor :name
578
+
579
+ # If present, details about the OAuth Application that created the transfer.
580
+ sig { params(name: String).returns(T.attached_class) }
581
+ def self.new(
582
+ # The name of the OAuth Application.
583
+ name:
584
+ )
585
+ end
586
+
587
+ sig { override.returns({ name: String }) }
588
+ def to_hash
589
+ end
590
+ end
591
+
592
+ class User < Increase::Internal::Type::BaseModel
593
+ OrHash =
594
+ T.type_alias do
595
+ T.any(
596
+ Increase::CheckTransfer::CreatedBy::User,
597
+ Increase::Internal::AnyHash
598
+ )
599
+ end
600
+
601
+ # The email address of the User.
602
+ sig { returns(String) }
603
+ attr_accessor :email
604
+
605
+ # If present, details about the User that created the transfer.
606
+ sig { params(email: String).returns(T.attached_class) }
607
+ def self.new(
608
+ # The email address of the User.
609
+ email:
610
+ )
611
+ end
612
+
613
+ sig { override.returns({ email: String }) }
614
+ def to_hash
615
+ end
616
+ end
617
+ end
618
+
619
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
620
+ # currency.
621
+ module Currency
622
+ extend Increase::Internal::Type::Enum
623
+
624
+ TaggedSymbol =
625
+ T.type_alias { T.all(Symbol, Increase::CheckTransfer::Currency) }
626
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
627
+
628
+ # Canadian Dollar (CAD)
629
+ CAD = T.let(:CAD, Increase::CheckTransfer::Currency::TaggedSymbol)
630
+
631
+ # Swiss Franc (CHF)
632
+ CHF = T.let(:CHF, Increase::CheckTransfer::Currency::TaggedSymbol)
633
+
634
+ # Euro (EUR)
635
+ EUR = T.let(:EUR, Increase::CheckTransfer::Currency::TaggedSymbol)
636
+
637
+ # British Pound (GBP)
638
+ GBP = T.let(:GBP, Increase::CheckTransfer::Currency::TaggedSymbol)
639
+
640
+ # Japanese Yen (JPY)
641
+ JPY = T.let(:JPY, Increase::CheckTransfer::Currency::TaggedSymbol)
642
+
643
+ # US Dollar (USD)
644
+ USD = T.let(:USD, Increase::CheckTransfer::Currency::TaggedSymbol)
645
+
646
+ sig do
647
+ override.returns(
648
+ T::Array[Increase::CheckTransfer::Currency::TaggedSymbol]
649
+ )
650
+ end
651
+ def self.values
652
+ end
653
+ end
654
+
655
+ # Whether Increase will print and mail the check or if you will do it yourself.
656
+ module FulfillmentMethod
657
+ extend Increase::Internal::Type::Enum
658
+
659
+ TaggedSymbol =
660
+ T.type_alias do
661
+ T.all(Symbol, Increase::CheckTransfer::FulfillmentMethod)
662
+ end
663
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
664
+
665
+ # Increase will print and mail a physical check.
666
+ PHYSICAL_CHECK =
667
+ T.let(
668
+ :physical_check,
669
+ Increase::CheckTransfer::FulfillmentMethod::TaggedSymbol
670
+ )
671
+
672
+ # Increase will not print a check; you are responsible for printing and mailing a check with the provided account number, routing number, check number, and amount.
673
+ THIRD_PARTY =
674
+ T.let(
675
+ :third_party,
676
+ Increase::CheckTransfer::FulfillmentMethod::TaggedSymbol
677
+ )
678
+
679
+ sig do
680
+ override.returns(
681
+ T::Array[Increase::CheckTransfer::FulfillmentMethod::TaggedSymbol]
682
+ )
683
+ end
684
+ def self.values
685
+ end
686
+ end
687
+
688
+ class Mailing < Increase::Internal::Type::BaseModel
689
+ OrHash =
690
+ T.type_alias do
691
+ T.any(Increase::CheckTransfer::Mailing, Increase::Internal::AnyHash)
692
+ end
693
+
694
+ # The ID of the file corresponding to an image of the check that was mailed, if
695
+ # available.
696
+ sig { returns(T.nilable(String)) }
697
+ attr_accessor :image_id
698
+
699
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
700
+ # the check was mailed.
701
+ sig { returns(Time) }
702
+ attr_accessor :mailed_at
703
+
704
+ # The tracking number of the shipment, if available for the shipping method.
705
+ sig { returns(T.nilable(String)) }
706
+ attr_accessor :tracking_number
707
+
708
+ # If the check has been mailed by Increase, this will contain details of the
709
+ # shipment.
710
+ sig do
711
+ params(
712
+ image_id: T.nilable(String),
713
+ mailed_at: Time,
714
+ tracking_number: T.nilable(String)
715
+ ).returns(T.attached_class)
716
+ end
717
+ def self.new(
718
+ # The ID of the file corresponding to an image of the check that was mailed, if
719
+ # available.
720
+ image_id:,
721
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
722
+ # the check was mailed.
723
+ mailed_at:,
724
+ # The tracking number of the shipment, if available for the shipping method.
725
+ tracking_number:
726
+ )
727
+ end
728
+
729
+ sig do
730
+ override.returns(
731
+ {
732
+ image_id: T.nilable(String),
733
+ mailed_at: Time,
734
+ tracking_number: T.nilable(String)
735
+ }
736
+ )
737
+ end
738
+ def to_hash
739
+ end
740
+ end
741
+
742
+ class PhysicalCheck < Increase::Internal::Type::BaseModel
743
+ OrHash =
744
+ T.type_alias do
745
+ T.any(
746
+ Increase::CheckTransfer::PhysicalCheck,
747
+ Increase::Internal::AnyHash
748
+ )
749
+ end
750
+
751
+ # The ID of the file for the check attachment.
752
+ sig { returns(T.nilable(String)) }
753
+ attr_accessor :attachment_file_id
754
+
755
+ # Details for where Increase will mail the check.
756
+ sig { returns(Increase::CheckTransfer::PhysicalCheck::MailingAddress) }
757
+ attr_reader :mailing_address
758
+
759
+ sig do
760
+ params(
761
+ mailing_address:
762
+ Increase::CheckTransfer::PhysicalCheck::MailingAddress::OrHash
763
+ ).void
764
+ end
765
+ attr_writer :mailing_address
766
+
767
+ # The descriptor that will be printed on the memo field on the check.
768
+ sig { returns(T.nilable(String)) }
769
+ attr_accessor :memo
770
+
771
+ # The descriptor that will be printed on the letter included with the check.
772
+ sig { returns(T.nilable(String)) }
773
+ attr_accessor :note
774
+
775
+ # The name that will be printed on the check.
776
+ sig { returns(String) }
777
+ attr_accessor :recipient_name
778
+
779
+ # The return address to be printed on the check.
780
+ sig do
781
+ returns(
782
+ T.nilable(Increase::CheckTransfer::PhysicalCheck::ReturnAddress)
783
+ )
784
+ end
785
+ attr_reader :return_address
786
+
787
+ sig do
788
+ params(
789
+ return_address:
790
+ T.nilable(
791
+ Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
792
+ )
793
+ ).void
794
+ end
795
+ attr_writer :return_address
796
+
797
+ # The shipping method for the check.
798
+ sig do
799
+ returns(
800
+ T.nilable(
801
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol
802
+ )
803
+ )
804
+ end
805
+ attr_accessor :shipping_method
806
+
807
+ # The text that will appear as the signature on the check in cursive font. If
808
+ # blank, the check will be printed with 'No signature required'.
809
+ sig { returns(T.nilable(String)) }
810
+ attr_accessor :signature_text
811
+
812
+ # Tracking updates relating to the physical check's delivery.
813
+ sig do
814
+ returns(
815
+ T::Array[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
816
+ )
817
+ end
818
+ attr_accessor :tracking_updates
819
+
820
+ # Details relating to the physical check that Increase will print and mail. Will
821
+ # be present if and only if `fulfillment_method` is equal to `physical_check`.
822
+ sig do
823
+ params(
824
+ attachment_file_id: T.nilable(String),
825
+ mailing_address:
826
+ Increase::CheckTransfer::PhysicalCheck::MailingAddress::OrHash,
827
+ memo: T.nilable(String),
828
+ note: T.nilable(String),
829
+ recipient_name: String,
830
+ return_address:
831
+ T.nilable(
832
+ Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
833
+ ),
834
+ shipping_method:
835
+ T.nilable(
836
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod::OrSymbol
837
+ ),
838
+ signature_text: T.nilable(String),
839
+ tracking_updates:
840
+ T::Array[
841
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::OrHash
842
+ ]
843
+ ).returns(T.attached_class)
844
+ end
845
+ def self.new(
846
+ # The ID of the file for the check attachment.
847
+ attachment_file_id:,
848
+ # Details for where Increase will mail the check.
849
+ mailing_address:,
850
+ # The descriptor that will be printed on the memo field on the check.
851
+ memo:,
852
+ # The descriptor that will be printed on the letter included with the check.
853
+ note:,
854
+ # The name that will be printed on the check.
855
+ recipient_name:,
856
+ # The return address to be printed on the check.
857
+ return_address:,
858
+ # The shipping method for the check.
859
+ shipping_method:,
860
+ # The text that will appear as the signature on the check in cursive font. If
861
+ # blank, the check will be printed with 'No signature required'.
862
+ signature_text:,
863
+ # Tracking updates relating to the physical check's delivery.
864
+ tracking_updates:
865
+ )
866
+ end
867
+
868
+ sig do
869
+ override.returns(
870
+ {
871
+ attachment_file_id: T.nilable(String),
872
+ mailing_address:
873
+ Increase::CheckTransfer::PhysicalCheck::MailingAddress,
874
+ memo: T.nilable(String),
875
+ note: T.nilable(String),
876
+ recipient_name: String,
877
+ return_address:
878
+ T.nilable(
879
+ Increase::CheckTransfer::PhysicalCheck::ReturnAddress
880
+ ),
881
+ shipping_method:
882
+ T.nilable(
883
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol
884
+ ),
885
+ signature_text: T.nilable(String),
886
+ tracking_updates:
887
+ T::Array[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
888
+ }
889
+ )
890
+ end
891
+ def to_hash
892
+ end
893
+
894
+ class MailingAddress < Increase::Internal::Type::BaseModel
895
+ OrHash =
896
+ T.type_alias do
897
+ T.any(
898
+ Increase::CheckTransfer::PhysicalCheck::MailingAddress,
899
+ Increase::Internal::AnyHash
900
+ )
901
+ end
902
+
903
+ # The city of the check's destination.
904
+ sig { returns(T.nilable(String)) }
905
+ attr_accessor :city
906
+
907
+ # The street address of the check's destination.
908
+ sig { returns(T.nilable(String)) }
909
+ attr_accessor :line1
910
+
911
+ # The second line of the address of the check's destination.
912
+ sig { returns(T.nilable(String)) }
913
+ attr_accessor :line2
914
+
915
+ # The name component of the check's mailing address.
916
+ sig { returns(T.nilable(String)) }
917
+ attr_accessor :name
918
+
919
+ # The postal code of the check's destination.
920
+ sig { returns(T.nilable(String)) }
921
+ attr_accessor :postal_code
922
+
923
+ # The state of the check's destination.
924
+ sig { returns(T.nilable(String)) }
925
+ attr_accessor :state
926
+
927
+ # Details for where Increase will mail the check.
928
+ sig do
929
+ params(
930
+ city: T.nilable(String),
931
+ line1: T.nilable(String),
932
+ line2: T.nilable(String),
933
+ name: T.nilable(String),
934
+ postal_code: T.nilable(String),
935
+ state: T.nilable(String)
936
+ ).returns(T.attached_class)
937
+ end
938
+ def self.new(
939
+ # The city of the check's destination.
940
+ city:,
941
+ # The street address of the check's destination.
942
+ line1:,
943
+ # The second line of the address of the check's destination.
944
+ line2:,
945
+ # The name component of the check's mailing address.
946
+ name:,
947
+ # The postal code of the check's destination.
948
+ postal_code:,
949
+ # The state of the check's destination.
950
+ state:
951
+ )
952
+ end
953
+
954
+ sig do
955
+ override.returns(
956
+ {
957
+ city: T.nilable(String),
958
+ line1: T.nilable(String),
959
+ line2: T.nilable(String),
960
+ name: T.nilable(String),
961
+ postal_code: T.nilable(String),
962
+ state: T.nilable(String)
963
+ }
964
+ )
965
+ end
966
+ def to_hash
967
+ end
968
+ end
969
+
970
+ class ReturnAddress < Increase::Internal::Type::BaseModel
971
+ OrHash =
972
+ T.type_alias do
973
+ T.any(
974
+ Increase::CheckTransfer::PhysicalCheck::ReturnAddress,
975
+ Increase::Internal::AnyHash
976
+ )
977
+ end
978
+
979
+ # The city of the check's destination.
980
+ sig { returns(T.nilable(String)) }
981
+ attr_accessor :city
982
+
983
+ # The street address of the check's destination.
984
+ sig { returns(T.nilable(String)) }
985
+ attr_accessor :line1
986
+
987
+ # The second line of the address of the check's destination.
988
+ sig { returns(T.nilable(String)) }
989
+ attr_accessor :line2
990
+
991
+ # The name component of the check's return address.
992
+ sig { returns(T.nilable(String)) }
993
+ attr_accessor :name
994
+
995
+ # The postal code of the check's destination.
996
+ sig { returns(T.nilable(String)) }
997
+ attr_accessor :postal_code
998
+
999
+ # The state of the check's destination.
1000
+ sig { returns(T.nilable(String)) }
1001
+ attr_accessor :state
1002
+
1003
+ # The return address to be printed on the check.
1004
+ sig do
1005
+ params(
1006
+ city: T.nilable(String),
1007
+ line1: T.nilable(String),
1008
+ line2: T.nilable(String),
1009
+ name: T.nilable(String),
1010
+ postal_code: T.nilable(String),
1011
+ state: T.nilable(String)
1012
+ ).returns(T.attached_class)
1013
+ end
1014
+ def self.new(
1015
+ # The city of the check's destination.
1016
+ city:,
1017
+ # The street address of the check's destination.
1018
+ line1:,
1019
+ # The second line of the address of the check's destination.
1020
+ line2:,
1021
+ # The name component of the check's return address.
1022
+ name:,
1023
+ # The postal code of the check's destination.
1024
+ postal_code:,
1025
+ # The state of the check's destination.
1026
+ state:
1027
+ )
1028
+ end
1029
+
1030
+ sig do
1031
+ override.returns(
1032
+ {
1033
+ city: T.nilable(String),
1034
+ line1: T.nilable(String),
1035
+ line2: T.nilable(String),
1036
+ name: T.nilable(String),
1037
+ postal_code: T.nilable(String),
1038
+ state: T.nilable(String)
1039
+ }
1040
+ )
1041
+ end
1042
+ def to_hash
1043
+ end
1044
+ end
1045
+
1046
+ # The shipping method for the check.
1047
+ module ShippingMethod
1048
+ extend Increase::Internal::Type::Enum
1049
+
1050
+ TaggedSymbol =
1051
+ T.type_alias do
1052
+ T.all(
1053
+ Symbol,
1054
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod
1055
+ )
1056
+ end
1057
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1058
+
1059
+ # USPS First Class
1060
+ USPS_FIRST_CLASS =
1061
+ T.let(
1062
+ :usps_first_class,
1063
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol
1064
+ )
1065
+
1066
+ # FedEx Overnight
1067
+ FEDEX_OVERNIGHT =
1068
+ T.let(
1069
+ :fedex_overnight,
1070
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol
1071
+ )
1072
+
1073
+ sig do
1074
+ override.returns(
1075
+ T::Array[
1076
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol
1077
+ ]
1078
+ )
1079
+ end
1080
+ def self.values
1081
+ end
1082
+ end
1083
+
1084
+ class TrackingUpdate < Increase::Internal::Type::BaseModel
1085
+ OrHash =
1086
+ T.type_alias do
1087
+ T.any(
1088
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate,
1089
+ Increase::Internal::AnyHash
1090
+ )
1091
+ end
1092
+
1093
+ # The type of tracking event.
1094
+ sig do
1095
+ returns(
1096
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1097
+ )
1098
+ end
1099
+ attr_accessor :category
1100
+
1101
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1102
+ # the tracking event took place.
1103
+ sig { returns(Time) }
1104
+ attr_accessor :created_at
1105
+
1106
+ # The postal code where the event took place.
1107
+ sig { returns(String) }
1108
+ attr_accessor :postal_code
1109
+
1110
+ sig do
1111
+ params(
1112
+ category:
1113
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::OrSymbol,
1114
+ created_at: Time,
1115
+ postal_code: String
1116
+ ).returns(T.attached_class)
1117
+ end
1118
+ def self.new(
1119
+ # The type of tracking event.
1120
+ category:,
1121
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1122
+ # the tracking event took place.
1123
+ created_at:,
1124
+ # The postal code where the event took place.
1125
+ postal_code:
1126
+ )
1127
+ end
1128
+
1129
+ sig do
1130
+ override.returns(
1131
+ {
1132
+ category:
1133
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol,
1134
+ created_at: Time,
1135
+ postal_code: String
1136
+ }
1137
+ )
1138
+ end
1139
+ def to_hash
1140
+ end
1141
+
1142
+ # The type of tracking event.
1143
+ module Category
1144
+ extend Increase::Internal::Type::Enum
1145
+
1146
+ TaggedSymbol =
1147
+ T.type_alias do
1148
+ T.all(
1149
+ Symbol,
1150
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category
1151
+ )
1152
+ end
1153
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1154
+
1155
+ # The check is in transit.
1156
+ IN_TRANSIT =
1157
+ T.let(
1158
+ :in_transit,
1159
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1160
+ )
1161
+
1162
+ # The check has been processed for delivery.
1163
+ PROCESSED_FOR_DELIVERY =
1164
+ T.let(
1165
+ :processed_for_delivery,
1166
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1167
+ )
1168
+
1169
+ # The check has been delivered.
1170
+ DELIVERED =
1171
+ T.let(
1172
+ :delivered,
1173
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1174
+ )
1175
+
1176
+ # Delivery failed and the check was returned to sender.
1177
+ RETURNED_TO_SENDER =
1178
+ T.let(
1179
+ :returned_to_sender,
1180
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1181
+ )
1182
+
1183
+ sig do
1184
+ override.returns(
1185
+ T::Array[
1186
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1187
+ ]
1188
+ )
1189
+ end
1190
+ def self.values
1191
+ end
1192
+ end
1193
+ end
1194
+ end
1195
+
1196
+ # The lifecycle status of the transfer.
1197
+ module Status
1198
+ extend Increase::Internal::Type::Enum
1199
+
1200
+ TaggedSymbol =
1201
+ T.type_alias { T.all(Symbol, Increase::CheckTransfer::Status) }
1202
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1203
+
1204
+ # The transfer is awaiting approval.
1205
+ PENDING_APPROVAL =
1206
+ T.let(
1207
+ :pending_approval,
1208
+ Increase::CheckTransfer::Status::TaggedSymbol
1209
+ )
1210
+
1211
+ # The transfer has been canceled.
1212
+ CANCELED =
1213
+ T.let(:canceled, Increase::CheckTransfer::Status::TaggedSymbol)
1214
+
1215
+ # The transfer is pending submission.
1216
+ PENDING_SUBMISSION =
1217
+ T.let(
1218
+ :pending_submission,
1219
+ Increase::CheckTransfer::Status::TaggedSymbol
1220
+ )
1221
+
1222
+ # The transfer requires attention from an Increase operator.
1223
+ REQUIRES_ATTENTION =
1224
+ T.let(
1225
+ :requires_attention,
1226
+ Increase::CheckTransfer::Status::TaggedSymbol
1227
+ )
1228
+
1229
+ # The transfer has been rejected.
1230
+ REJECTED =
1231
+ T.let(:rejected, Increase::CheckTransfer::Status::TaggedSymbol)
1232
+
1233
+ # The check is queued for mailing.
1234
+ PENDING_MAILING =
1235
+ T.let(:pending_mailing, Increase::CheckTransfer::Status::TaggedSymbol)
1236
+
1237
+ # The check has been mailed.
1238
+ MAILED = T.let(:mailed, Increase::CheckTransfer::Status::TaggedSymbol)
1239
+
1240
+ # The check has been deposited.
1241
+ DEPOSITED =
1242
+ T.let(:deposited, Increase::CheckTransfer::Status::TaggedSymbol)
1243
+
1244
+ # A stop-payment was requested for this check.
1245
+ STOPPED = T.let(:stopped, Increase::CheckTransfer::Status::TaggedSymbol)
1246
+
1247
+ # The transfer has been returned.
1248
+ RETURNED =
1249
+ T.let(:returned, Increase::CheckTransfer::Status::TaggedSymbol)
1250
+
1251
+ sig do
1252
+ override.returns(
1253
+ T::Array[Increase::CheckTransfer::Status::TaggedSymbol]
1254
+ )
1255
+ end
1256
+ def self.values
1257
+ end
1258
+ end
1259
+
1260
+ class StopPaymentRequest < Increase::Internal::Type::BaseModel
1261
+ OrHash =
1262
+ T.type_alias do
1263
+ T.any(
1264
+ Increase::CheckTransfer::StopPaymentRequest,
1265
+ Increase::Internal::AnyHash
1266
+ )
1267
+ end
1268
+
1269
+ # The reason why this transfer was stopped.
1270
+ sig do
1271
+ returns(
1272
+ Increase::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol
1273
+ )
1274
+ end
1275
+ attr_accessor :reason
1276
+
1277
+ # The time the stop-payment was requested.
1278
+ sig { returns(Time) }
1279
+ attr_accessor :requested_at
1280
+
1281
+ # The ID of the check transfer that was stopped.
1282
+ sig { returns(String) }
1283
+ attr_accessor :transfer_id
1284
+
1285
+ # A constant representing the object's type. For this resource it will always be
1286
+ # `check_transfer_stop_payment_request`.
1287
+ sig do
1288
+ returns(
1289
+ Increase::CheckTransfer::StopPaymentRequest::Type::TaggedSymbol
1290
+ )
1291
+ end
1292
+ attr_accessor :type
1293
+
1294
+ # After a stop-payment is requested on the check, this will contain supplemental
1295
+ # details.
1296
+ sig do
1297
+ params(
1298
+ reason:
1299
+ Increase::CheckTransfer::StopPaymentRequest::Reason::OrSymbol,
1300
+ requested_at: Time,
1301
+ transfer_id: String,
1302
+ type: Increase::CheckTransfer::StopPaymentRequest::Type::OrSymbol
1303
+ ).returns(T.attached_class)
1304
+ end
1305
+ def self.new(
1306
+ # The reason why this transfer was stopped.
1307
+ reason:,
1308
+ # The time the stop-payment was requested.
1309
+ requested_at:,
1310
+ # The ID of the check transfer that was stopped.
1311
+ transfer_id:,
1312
+ # A constant representing the object's type. For this resource it will always be
1313
+ # `check_transfer_stop_payment_request`.
1314
+ type:
1315
+ )
1316
+ end
1317
+
1318
+ sig do
1319
+ override.returns(
1320
+ {
1321
+ reason:
1322
+ Increase::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol,
1323
+ requested_at: Time,
1324
+ transfer_id: String,
1325
+ type:
1326
+ Increase::CheckTransfer::StopPaymentRequest::Type::TaggedSymbol
1327
+ }
1328
+ )
1329
+ end
1330
+ def to_hash
1331
+ end
1332
+
1333
+ # The reason why this transfer was stopped.
1334
+ module Reason
1335
+ extend Increase::Internal::Type::Enum
1336
+
1337
+ TaggedSymbol =
1338
+ T.type_alias do
1339
+ T.all(Symbol, Increase::CheckTransfer::StopPaymentRequest::Reason)
1340
+ end
1341
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1342
+
1343
+ # The check could not be delivered.
1344
+ MAIL_DELIVERY_FAILED =
1345
+ T.let(
1346
+ :mail_delivery_failed,
1347
+ Increase::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol
1348
+ )
1349
+
1350
+ # The check was canceled by an Increase operator who will provide details out-of-band.
1351
+ REJECTED_BY_INCREASE =
1352
+ T.let(
1353
+ :rejected_by_increase,
1354
+ Increase::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol
1355
+ )
1356
+
1357
+ # The check was not authorized.
1358
+ NOT_AUTHORIZED =
1359
+ T.let(
1360
+ :not_authorized,
1361
+ Increase::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol
1362
+ )
1363
+
1364
+ # The check was stopped for another reason.
1365
+ UNKNOWN =
1366
+ T.let(
1367
+ :unknown,
1368
+ Increase::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol
1369
+ )
1370
+
1371
+ sig do
1372
+ override.returns(
1373
+ T::Array[
1374
+ Increase::CheckTransfer::StopPaymentRequest::Reason::TaggedSymbol
1375
+ ]
1376
+ )
1377
+ end
1378
+ def self.values
1379
+ end
1380
+ end
1381
+
1382
+ # A constant representing the object's type. For this resource it will always be
1383
+ # `check_transfer_stop_payment_request`.
1384
+ module Type
1385
+ extend Increase::Internal::Type::Enum
1386
+
1387
+ TaggedSymbol =
1388
+ T.type_alias do
1389
+ T.all(Symbol, Increase::CheckTransfer::StopPaymentRequest::Type)
1390
+ end
1391
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1392
+
1393
+ CHECK_TRANSFER_STOP_PAYMENT_REQUEST =
1394
+ T.let(
1395
+ :check_transfer_stop_payment_request,
1396
+ Increase::CheckTransfer::StopPaymentRequest::Type::TaggedSymbol
1397
+ )
1398
+
1399
+ sig do
1400
+ override.returns(
1401
+ T::Array[
1402
+ Increase::CheckTransfer::StopPaymentRequest::Type::TaggedSymbol
1403
+ ]
1404
+ )
1405
+ end
1406
+ def self.values
1407
+ end
1408
+ end
1409
+ end
1410
+
1411
+ class Submission < Increase::Internal::Type::BaseModel
1412
+ OrHash =
1413
+ T.type_alias do
1414
+ T.any(
1415
+ Increase::CheckTransfer::Submission,
1416
+ Increase::Internal::AnyHash
1417
+ )
1418
+ end
1419
+
1420
+ # Per USPS requirements, Increase will standardize the address to USPS standards
1421
+ # and check it against the USPS National Change of Address (NCOA) database before
1422
+ # mailing it. This indicates what modifications, if any, were made to the address
1423
+ # before printing and mailing the check.
1424
+ sig do
1425
+ returns(
1426
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol
1427
+ )
1428
+ end
1429
+ attr_accessor :address_correction_action
1430
+
1431
+ # The address we submitted to the printer. This is what is physically printed on
1432
+ # the check.
1433
+ sig { returns(Increase::CheckTransfer::Submission::SubmittedAddress) }
1434
+ attr_reader :submitted_address
1435
+
1436
+ sig do
1437
+ params(
1438
+ submitted_address:
1439
+ Increase::CheckTransfer::Submission::SubmittedAddress::OrHash
1440
+ ).void
1441
+ end
1442
+ attr_writer :submitted_address
1443
+
1444
+ # When this check transfer was submitted to our check printer.
1445
+ sig { returns(Time) }
1446
+ attr_accessor :submitted_at
1447
+
1448
+ # After the transfer is submitted, this will contain supplemental details.
1449
+ sig do
1450
+ params(
1451
+ address_correction_action:
1452
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::OrSymbol,
1453
+ submitted_address:
1454
+ Increase::CheckTransfer::Submission::SubmittedAddress::OrHash,
1455
+ submitted_at: Time
1456
+ ).returns(T.attached_class)
1457
+ end
1458
+ def self.new(
1459
+ # Per USPS requirements, Increase will standardize the address to USPS standards
1460
+ # and check it against the USPS National Change of Address (NCOA) database before
1461
+ # mailing it. This indicates what modifications, if any, were made to the address
1462
+ # before printing and mailing the check.
1463
+ address_correction_action:,
1464
+ # The address we submitted to the printer. This is what is physically printed on
1465
+ # the check.
1466
+ submitted_address:,
1467
+ # When this check transfer was submitted to our check printer.
1468
+ submitted_at:
1469
+ )
1470
+ end
1471
+
1472
+ sig do
1473
+ override.returns(
1474
+ {
1475
+ address_correction_action:
1476
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol,
1477
+ submitted_address:
1478
+ Increase::CheckTransfer::Submission::SubmittedAddress,
1479
+ submitted_at: Time
1480
+ }
1481
+ )
1482
+ end
1483
+ def to_hash
1484
+ end
1485
+
1486
+ # Per USPS requirements, Increase will standardize the address to USPS standards
1487
+ # and check it against the USPS National Change of Address (NCOA) database before
1488
+ # mailing it. This indicates what modifications, if any, were made to the address
1489
+ # before printing and mailing the check.
1490
+ module AddressCorrectionAction
1491
+ extend Increase::Internal::Type::Enum
1492
+
1493
+ TaggedSymbol =
1494
+ T.type_alias do
1495
+ T.all(
1496
+ Symbol,
1497
+ Increase::CheckTransfer::Submission::AddressCorrectionAction
1498
+ )
1499
+ end
1500
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1501
+
1502
+ # No address correction took place.
1503
+ NONE =
1504
+ T.let(
1505
+ :none,
1506
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol
1507
+ )
1508
+
1509
+ # The address was standardized.
1510
+ STANDARDIZATION =
1511
+ T.let(
1512
+ :standardization,
1513
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol
1514
+ )
1515
+
1516
+ # The address was first standardized and then changed because the recipient moved.
1517
+ STANDARDIZATION_WITH_ADDRESS_CHANGE =
1518
+ T.let(
1519
+ :standardization_with_address_change,
1520
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol
1521
+ )
1522
+
1523
+ # An error occurred while correcting the address. This typically means the USPS could not find that address. The address was not changed.
1524
+ ERROR =
1525
+ T.let(
1526
+ :error,
1527
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol
1528
+ )
1529
+
1530
+ sig do
1531
+ override.returns(
1532
+ T::Array[
1533
+ Increase::CheckTransfer::Submission::AddressCorrectionAction::TaggedSymbol
1534
+ ]
1535
+ )
1536
+ end
1537
+ def self.values
1538
+ end
1539
+ end
1540
+
1541
+ class SubmittedAddress < Increase::Internal::Type::BaseModel
1542
+ OrHash =
1543
+ T.type_alias do
1544
+ T.any(
1545
+ Increase::CheckTransfer::Submission::SubmittedAddress,
1546
+ Increase::Internal::AnyHash
1547
+ )
1548
+ end
1549
+
1550
+ # The submitted address city.
1551
+ sig { returns(String) }
1552
+ attr_accessor :city
1553
+
1554
+ # The submitted address line 1.
1555
+ sig { returns(String) }
1556
+ attr_accessor :line1
1557
+
1558
+ # The submitted address line 2.
1559
+ sig { returns(T.nilable(String)) }
1560
+ attr_accessor :line2
1561
+
1562
+ # The submitted recipient name.
1563
+ sig { returns(String) }
1564
+ attr_accessor :recipient_name
1565
+
1566
+ # The submitted address state.
1567
+ sig { returns(String) }
1568
+ attr_accessor :state
1569
+
1570
+ # The submitted address zip.
1571
+ sig { returns(String) }
1572
+ attr_accessor :zip
1573
+
1574
+ # The address we submitted to the printer. This is what is physically printed on
1575
+ # the check.
1576
+ sig do
1577
+ params(
1578
+ city: String,
1579
+ line1: String,
1580
+ line2: T.nilable(String),
1581
+ recipient_name: String,
1582
+ state: String,
1583
+ zip: String
1584
+ ).returns(T.attached_class)
1585
+ end
1586
+ def self.new(
1587
+ # The submitted address city.
1588
+ city:,
1589
+ # The submitted address line 1.
1590
+ line1:,
1591
+ # The submitted address line 2.
1592
+ line2:,
1593
+ # The submitted recipient name.
1594
+ recipient_name:,
1595
+ # The submitted address state.
1596
+ state:,
1597
+ # The submitted address zip.
1598
+ zip:
1599
+ )
1600
+ end
1601
+
1602
+ sig do
1603
+ override.returns(
1604
+ {
1605
+ city: String,
1606
+ line1: String,
1607
+ line2: T.nilable(String),
1608
+ recipient_name: String,
1609
+ state: String,
1610
+ zip: String
1611
+ }
1612
+ )
1613
+ end
1614
+ def to_hash
1615
+ end
1616
+ end
1617
+ end
1618
+
1619
+ class ThirdParty < Increase::Internal::Type::BaseModel
1620
+ OrHash =
1621
+ T.type_alias do
1622
+ T.any(
1623
+ Increase::CheckTransfer::ThirdParty,
1624
+ Increase::Internal::AnyHash
1625
+ )
1626
+ end
1627
+
1628
+ # The name that you will print on the check.
1629
+ sig { returns(T.nilable(String)) }
1630
+ attr_accessor :recipient_name
1631
+
1632
+ # Details relating to the custom fulfillment you will perform. Will be present if
1633
+ # and only if `fulfillment_method` is equal to `third_party`.
1634
+ sig do
1635
+ params(recipient_name: T.nilable(String)).returns(T.attached_class)
1636
+ end
1637
+ def self.new(
1638
+ # The name that you will print on the check.
1639
+ recipient_name:
1640
+ )
1641
+ end
1642
+
1643
+ sig { override.returns({ recipient_name: T.nilable(String) }) }
1644
+ def to_hash
1645
+ end
1646
+ end
1647
+
1648
+ # A constant representing the object's type. For this resource it will always be
1649
+ # `check_transfer`.
1650
+ module Type
1651
+ extend Increase::Internal::Type::Enum
1652
+
1653
+ TaggedSymbol =
1654
+ T.type_alias { T.all(Symbol, Increase::CheckTransfer::Type) }
1655
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1656
+
1657
+ CHECK_TRANSFER =
1658
+ T.let(:check_transfer, Increase::CheckTransfer::Type::TaggedSymbol)
1659
+
1660
+ sig do
1661
+ override.returns(
1662
+ T::Array[Increase::CheckTransfer::Type::TaggedSymbol]
1663
+ )
1664
+ end
1665
+ def self.values
1666
+ end
1667
+ end
1668
+ end
1669
+ end
1670
+ end