increase 0.3.3 → 1.1.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 +832 -56
  4. data/README.md +209 -254
  5. data/SECURITY.md +3 -0
  6. data/lib/increase/client.rb +287 -43
  7. data/lib/increase/errors.rb +245 -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 +167 -0
  13. data/lib/increase/internal/type/base_model.rb +536 -0
  14. data/lib/increase/internal/type/base_page.rb +55 -0
  15. data/lib/increase/internal/type/boolean.rb +77 -0
  16. data/lib/increase/internal/type/converter.rb +300 -0
  17. data/lib/increase/internal/type/enum.rb +131 -0
  18. data/lib/increase/internal/type/file_input.rb +108 -0
  19. data/lib/increase/internal/type/hash_of.rb +187 -0
  20. data/lib/increase/internal/type/request_parameters.rb +42 -0
  21. data/lib/increase/internal/type/union.rb +235 -0
  22. data/lib/increase/internal/type/unknown.rb +81 -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 +1006 -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 +348 -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 +381 -0
  127. data/lib/increase/models/event_list_params.rb +413 -0
  128. data/lib/increase/models/event_retrieve_params.rb +14 -0
  129. data/lib/increase/models/event_subscription.rb +426 -0
  130. data/lib/increase/models/event_subscription_create_params.rb +352 -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 +1125 -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 +169 -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 +1740 -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 +5821 -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 +222 -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 +58 -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 +121 -0
  383. data/rbi/increase/internal/type/unknown.rbi +58 -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 +1706 -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 +634 -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 +740 -0
  488. data/rbi/increase/models/event_list_params.rbi +904 -0
  489. data/rbi/increase/models/event_retrieve_params.rbi +27 -0
  490. data/rbi/increase/models/event_subscription.rbi +875 -0
  491. data/rbi/increase/models/event_subscription_create_params.rbi +795 -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 +1954 -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 +258 -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 +3215 -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 +10451 -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 +154 -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 +62 -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 +744 -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 +281 -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 +447 -0
  847. data/sig/increase/models/event_list_params.rbs +506 -0
  848. data/sig/increase/models/event_retrieve_params.rbs +15 -0
  849. data/sig/increase/models/event_subscription.rbs +477 -0
  850. data/sig/increase/models/event_subscription_create_params.rbs +441 -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 +908 -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 +128 -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,1006 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::CheckTransfers#create
6
+ class CheckTransfer < Increase::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The Check transfer's identifier.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute account_id
14
+ # The identifier of the Account from which funds will be transferred.
15
+ #
16
+ # @return [String]
17
+ required :account_id, String
18
+
19
+ # @!attribute account_number
20
+ # The account number printed on the check.
21
+ #
22
+ # @return [String]
23
+ required :account_number, String
24
+
25
+ # @!attribute amount
26
+ # The transfer amount in USD cents.
27
+ #
28
+ # @return [Integer]
29
+ required :amount, Integer
30
+
31
+ # @!attribute approval
32
+ # If your account requires approvals for transfers and the transfer was approved,
33
+ # this will contain details of the approval.
34
+ #
35
+ # @return [Increase::Models::CheckTransfer::Approval, nil]
36
+ required :approval, -> { Increase::CheckTransfer::Approval }, nil?: true
37
+
38
+ # @!attribute approved_inbound_check_deposit_id
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
+ #
42
+ # @return [String, nil]
43
+ required :approved_inbound_check_deposit_id, String, nil?: true
44
+
45
+ # @!attribute cancellation
46
+ # If your account requires approvals for transfers and the transfer was not
47
+ # approved, this will contain details of the cancellation.
48
+ #
49
+ # @return [Increase::Models::CheckTransfer::Cancellation, nil]
50
+ required :cancellation, -> { Increase::CheckTransfer::Cancellation }, nil?: true
51
+
52
+ # @!attribute check_number
53
+ # The check number printed on the check.
54
+ #
55
+ # @return [String]
56
+ required :check_number, String
57
+
58
+ # @!attribute created_at
59
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
60
+ # the transfer was created.
61
+ #
62
+ # @return [Time]
63
+ required :created_at, Time
64
+
65
+ # @!attribute created_by
66
+ # What object created the transfer, either via the API or the dashboard.
67
+ #
68
+ # @return [Increase::Models::CheckTransfer::CreatedBy, nil]
69
+ required :created_by, -> { Increase::CheckTransfer::CreatedBy }, nil?: true
70
+
71
+ # @!attribute currency
72
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
73
+ # currency.
74
+ #
75
+ # @return [Symbol, Increase::Models::CheckTransfer::Currency]
76
+ required :currency, enum: -> { Increase::CheckTransfer::Currency }
77
+
78
+ # @!attribute fulfillment_method
79
+ # Whether Increase will print and mail the check or if you will do it yourself.
80
+ #
81
+ # @return [Symbol, Increase::Models::CheckTransfer::FulfillmentMethod]
82
+ required :fulfillment_method, enum: -> { Increase::CheckTransfer::FulfillmentMethod }
83
+
84
+ # @!attribute idempotency_key
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
+ #
89
+ # @return [String, nil]
90
+ required :idempotency_key, String, nil?: true
91
+
92
+ # @!attribute mailing
93
+ # If the check has been mailed by Increase, this will contain details of the
94
+ # shipment.
95
+ #
96
+ # @return [Increase::Models::CheckTransfer::Mailing, nil]
97
+ required :mailing, -> { Increase::CheckTransfer::Mailing }, nil?: true
98
+
99
+ # @!attribute pending_transaction_id
100
+ # The ID for the pending transaction representing the transfer. A pending
101
+ # transaction is created when the transfer
102
+ # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
103
+ # by someone else in your organization.
104
+ #
105
+ # @return [String, nil]
106
+ required :pending_transaction_id, String, nil?: true
107
+
108
+ # @!attribute physical_check
109
+ # Details relating to the physical check that Increase will print and mail. Will
110
+ # be present if and only if `fulfillment_method` is equal to `physical_check`.
111
+ #
112
+ # @return [Increase::Models::CheckTransfer::PhysicalCheck, nil]
113
+ required :physical_check, -> { Increase::CheckTransfer::PhysicalCheck }, nil?: true
114
+
115
+ # @!attribute routing_number
116
+ # The routing number printed on the check.
117
+ #
118
+ # @return [String]
119
+ required :routing_number, String
120
+
121
+ # @!attribute source_account_number_id
122
+ # The identifier of the Account Number from which to send the transfer and print
123
+ # on the check.
124
+ #
125
+ # @return [String, nil]
126
+ required :source_account_number_id, String, nil?: true
127
+
128
+ # @!attribute status
129
+ # The lifecycle status of the transfer.
130
+ #
131
+ # @return [Symbol, Increase::Models::CheckTransfer::Status]
132
+ required :status, enum: -> { Increase::CheckTransfer::Status }
133
+
134
+ # @!attribute stop_payment_request
135
+ # After a stop-payment is requested on the check, this will contain supplemental
136
+ # details.
137
+ #
138
+ # @return [Increase::Models::CheckTransfer::StopPaymentRequest, nil]
139
+ required :stop_payment_request, -> { Increase::CheckTransfer::StopPaymentRequest }, nil?: true
140
+
141
+ # @!attribute submission
142
+ # After the transfer is submitted, this will contain supplemental details.
143
+ #
144
+ # @return [Increase::Models::CheckTransfer::Submission, nil]
145
+ required :submission, -> { Increase::CheckTransfer::Submission }, nil?: true
146
+
147
+ # @!attribute third_party
148
+ # Details relating to the custom fulfillment you will perform. Will be present if
149
+ # and only if `fulfillment_method` is equal to `third_party`.
150
+ #
151
+ # @return [Increase::Models::CheckTransfer::ThirdParty, nil]
152
+ required :third_party, -> { Increase::CheckTransfer::ThirdParty }, nil?: true
153
+
154
+ # @!attribute type
155
+ # A constant representing the object's type. For this resource it will always be
156
+ # `check_transfer`.
157
+ #
158
+ # @return [Symbol, Increase::Models::CheckTransfer::Type]
159
+ required :type, enum: -> { Increase::CheckTransfer::Type }
160
+
161
+ # @!method initialize(id:, account_id:, account_number:, amount:, approval:, approved_inbound_check_deposit_id:, cancellation:, check_number:, created_at:, created_by:, currency:, fulfillment_method:, idempotency_key:, mailing:, pending_transaction_id:, physical_check:, routing_number:, source_account_number_id:, status:, stop_payment_request:, submission:, third_party:, type:)
162
+ # Some parameter documentations has been truncated, see
163
+ # {Increase::Models::CheckTransfer} for more details.
164
+ #
165
+ # Check Transfers move funds from your Increase account by mailing a physical
166
+ # check.
167
+ #
168
+ # @param id [String] The Check transfer's identifier.
169
+ #
170
+ # @param account_id [String] The identifier of the Account from which funds will be transferred.
171
+ #
172
+ # @param account_number [String] The account number printed on the check.
173
+ #
174
+ # @param amount [Integer] The transfer amount in USD cents.
175
+ #
176
+ # @param approval [Increase::Models::CheckTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
177
+ #
178
+ # @param approved_inbound_check_deposit_id [String, nil] If the Check Transfer was successfully deposited, this will contain the identifi
179
+ #
180
+ # @param cancellation [Increase::Models::CheckTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
181
+ #
182
+ # @param check_number [String] The check number printed on the check.
183
+ #
184
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
185
+ #
186
+ # @param created_by [Increase::Models::CheckTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
187
+ #
188
+ # @param currency [Symbol, Increase::Models::CheckTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr
189
+ #
190
+ # @param fulfillment_method [Symbol, Increase::Models::CheckTransfer::FulfillmentMethod] Whether Increase will print and mail the check or if you will do it yourself.
191
+ #
192
+ # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
193
+ #
194
+ # @param mailing [Increase::Models::CheckTransfer::Mailing, nil] If the check has been mailed by Increase, this will contain details of the shipm
195
+ #
196
+ # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
197
+ #
198
+ # @param physical_check [Increase::Models::CheckTransfer::PhysicalCheck, nil] Details relating to the physical check that Increase will print and mail. Will b
199
+ #
200
+ # @param routing_number [String] The routing number printed on the check.
201
+ #
202
+ # @param source_account_number_id [String, nil] The identifier of the Account Number from which to send the transfer and print o
203
+ #
204
+ # @param status [Symbol, Increase::Models::CheckTransfer::Status] The lifecycle status of the transfer.
205
+ #
206
+ # @param stop_payment_request [Increase::Models::CheckTransfer::StopPaymentRequest, nil] After a stop-payment is requested on the check, this will contain supplemental d
207
+ #
208
+ # @param submission [Increase::Models::CheckTransfer::Submission, nil] After the transfer is submitted, this will contain supplemental details.
209
+ #
210
+ # @param third_party [Increase::Models::CheckTransfer::ThirdParty, nil] Details relating to the custom fulfillment you will perform. Will be present if
211
+ #
212
+ # @param type [Symbol, Increase::Models::CheckTransfer::Type] A constant representing the object's type. For this resource it will always be `
213
+
214
+ # @see Increase::Models::CheckTransfer#approval
215
+ class Approval < Increase::Internal::Type::BaseModel
216
+ # @!attribute approved_at
217
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
218
+ # the transfer was approved.
219
+ #
220
+ # @return [Time]
221
+ required :approved_at, Time
222
+
223
+ # @!attribute approved_by
224
+ # If the Transfer was approved by a user in the dashboard, the email address of
225
+ # that user.
226
+ #
227
+ # @return [String, nil]
228
+ required :approved_by, String, nil?: true
229
+
230
+ # @!method initialize(approved_at:, approved_by:)
231
+ # Some parameter documentations has been truncated, see
232
+ # {Increase::Models::CheckTransfer::Approval} for more details.
233
+ #
234
+ # If your account requires approvals for transfers and the transfer was approved,
235
+ # this will contain details of the approval.
236
+ #
237
+ # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
238
+ #
239
+ # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
240
+ end
241
+
242
+ # @see Increase::Models::CheckTransfer#cancellation
243
+ class Cancellation < Increase::Internal::Type::BaseModel
244
+ # @!attribute canceled_at
245
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
246
+ # the Transfer was canceled.
247
+ #
248
+ # @return [Time]
249
+ required :canceled_at, Time
250
+
251
+ # @!attribute canceled_by
252
+ # If the Transfer was canceled by a user in the dashboard, the email address of
253
+ # that user.
254
+ #
255
+ # @return [String, nil]
256
+ required :canceled_by, String, nil?: true
257
+
258
+ # @!method initialize(canceled_at:, canceled_by:)
259
+ # Some parameter documentations has been truncated, see
260
+ # {Increase::Models::CheckTransfer::Cancellation} for more details.
261
+ #
262
+ # If your account requires approvals for transfers and the transfer was not
263
+ # approved, this will contain details of the cancellation.
264
+ #
265
+ # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
266
+ #
267
+ # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th
268
+ end
269
+
270
+ # @see Increase::Models::CheckTransfer#created_by
271
+ class CreatedBy < Increase::Internal::Type::BaseModel
272
+ # @!attribute api_key
273
+ # If present, details about the API key that created the transfer.
274
+ #
275
+ # @return [Increase::Models::CheckTransfer::CreatedBy::APIKey, nil]
276
+ required :api_key, -> { Increase::CheckTransfer::CreatedBy::APIKey }, nil?: true
277
+
278
+ # @!attribute category
279
+ # The type of object that created this transfer.
280
+ #
281
+ # @return [Symbol, Increase::Models::CheckTransfer::CreatedBy::Category]
282
+ required :category, enum: -> { Increase::CheckTransfer::CreatedBy::Category }
283
+
284
+ # @!attribute oauth_application
285
+ # If present, details about the OAuth Application that created the transfer.
286
+ #
287
+ # @return [Increase::Models::CheckTransfer::CreatedBy::OAuthApplication, nil]
288
+ required :oauth_application, -> { Increase::CheckTransfer::CreatedBy::OAuthApplication }, nil?: true
289
+
290
+ # @!attribute user
291
+ # If present, details about the User that created the transfer.
292
+ #
293
+ # @return [Increase::Models::CheckTransfer::CreatedBy::User, nil]
294
+ required :user, -> { Increase::CheckTransfer::CreatedBy::User }, nil?: true
295
+
296
+ # @!method initialize(api_key:, category:, oauth_application:, user:)
297
+ # What object created the transfer, either via the API or the dashboard.
298
+ #
299
+ # @param api_key [Increase::Models::CheckTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
300
+ #
301
+ # @param category [Symbol, Increase::Models::CheckTransfer::CreatedBy::Category] The type of object that created this transfer.
302
+ #
303
+ # @param oauth_application [Increase::Models::CheckTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
304
+ #
305
+ # @param user [Increase::Models::CheckTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
306
+
307
+ # @see Increase::Models::CheckTransfer::CreatedBy#api_key
308
+ class APIKey < Increase::Internal::Type::BaseModel
309
+ # @!attribute description
310
+ # The description set for the API key when it was created.
311
+ #
312
+ # @return [String, nil]
313
+ required :description, String, nil?: true
314
+
315
+ # @!method initialize(description:)
316
+ # If present, details about the API key that created the transfer.
317
+ #
318
+ # @param description [String, nil] The description set for the API key when it was created.
319
+ end
320
+
321
+ # The type of object that created this transfer.
322
+ #
323
+ # @see Increase::Models::CheckTransfer::CreatedBy#category
324
+ module Category
325
+ extend Increase::Internal::Type::Enum
326
+
327
+ # An API key. Details will be under the `api_key` object.
328
+ API_KEY = :api_key
329
+
330
+ # An OAuth application you connected to Increase. Details will be under the `oauth_application` object.
331
+ OAUTH_APPLICATION = :oauth_application
332
+
333
+ # A User in the Increase dashboard. Details will be under the `user` object.
334
+ USER = :user
335
+
336
+ # @!method self.values
337
+ # @return [Array<Symbol>]
338
+ end
339
+
340
+ # @see Increase::Models::CheckTransfer::CreatedBy#oauth_application
341
+ class OAuthApplication < Increase::Internal::Type::BaseModel
342
+ # @!attribute name
343
+ # The name of the OAuth Application.
344
+ #
345
+ # @return [String]
346
+ required :name, String
347
+
348
+ # @!method initialize(name:)
349
+ # If present, details about the OAuth Application that created the transfer.
350
+ #
351
+ # @param name [String] The name of the OAuth Application.
352
+ end
353
+
354
+ # @see Increase::Models::CheckTransfer::CreatedBy#user
355
+ class User < Increase::Internal::Type::BaseModel
356
+ # @!attribute email
357
+ # The email address of the User.
358
+ #
359
+ # @return [String]
360
+ required :email, String
361
+
362
+ # @!method initialize(email:)
363
+ # If present, details about the User that created the transfer.
364
+ #
365
+ # @param email [String] The email address of the User.
366
+ end
367
+ end
368
+
369
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
370
+ # currency.
371
+ #
372
+ # @see Increase::Models::CheckTransfer#currency
373
+ module Currency
374
+ extend Increase::Internal::Type::Enum
375
+
376
+ # Canadian Dollar (CAD)
377
+ CAD = :CAD
378
+
379
+ # Swiss Franc (CHF)
380
+ CHF = :CHF
381
+
382
+ # Euro (EUR)
383
+ EUR = :EUR
384
+
385
+ # British Pound (GBP)
386
+ GBP = :GBP
387
+
388
+ # Japanese Yen (JPY)
389
+ JPY = :JPY
390
+
391
+ # US Dollar (USD)
392
+ USD = :USD
393
+
394
+ # @!method self.values
395
+ # @return [Array<Symbol>]
396
+ end
397
+
398
+ # Whether Increase will print and mail the check or if you will do it yourself.
399
+ #
400
+ # @see Increase::Models::CheckTransfer#fulfillment_method
401
+ module FulfillmentMethod
402
+ extend Increase::Internal::Type::Enum
403
+
404
+ # Increase will print and mail a physical check.
405
+ PHYSICAL_CHECK = :physical_check
406
+
407
+ # 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.
408
+ THIRD_PARTY = :third_party
409
+
410
+ # @!method self.values
411
+ # @return [Array<Symbol>]
412
+ end
413
+
414
+ # @see Increase::Models::CheckTransfer#mailing
415
+ class Mailing < Increase::Internal::Type::BaseModel
416
+ # @!attribute image_id
417
+ # The ID of the file corresponding to an image of the check that was mailed, if
418
+ # available.
419
+ #
420
+ # @return [String, nil]
421
+ required :image_id, String, nil?: true
422
+
423
+ # @!attribute mailed_at
424
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
425
+ # the check was mailed.
426
+ #
427
+ # @return [Time]
428
+ required :mailed_at, Time
429
+
430
+ # @!attribute tracking_number
431
+ # The tracking number of the shipment, if available for the shipping method.
432
+ #
433
+ # @return [String, nil]
434
+ required :tracking_number, String, nil?: true
435
+
436
+ # @!method initialize(image_id:, mailed_at:, tracking_number:)
437
+ # Some parameter documentations has been truncated, see
438
+ # {Increase::Models::CheckTransfer::Mailing} for more details.
439
+ #
440
+ # If the check has been mailed by Increase, this will contain details of the
441
+ # shipment.
442
+ #
443
+ # @param image_id [String, nil] The ID of the file corresponding to an image of the check that was mailed, if av
444
+ #
445
+ # @param mailed_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
446
+ #
447
+ # @param tracking_number [String, nil] The tracking number of the shipment, if available for the shipping method.
448
+ end
449
+
450
+ # @see Increase::Models::CheckTransfer#physical_check
451
+ class PhysicalCheck < Increase::Internal::Type::BaseModel
452
+ # @!attribute attachment_file_id
453
+ # The ID of the file for the check attachment.
454
+ #
455
+ # @return [String, nil]
456
+ required :attachment_file_id, String, nil?: true
457
+
458
+ # @!attribute mailing_address
459
+ # Details for where Increase will mail the check.
460
+ #
461
+ # @return [Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress]
462
+ required :mailing_address, -> { Increase::CheckTransfer::PhysicalCheck::MailingAddress }
463
+
464
+ # @!attribute memo
465
+ # The descriptor that will be printed on the memo field on the check.
466
+ #
467
+ # @return [String, nil]
468
+ required :memo, String, nil?: true
469
+
470
+ # @!attribute note
471
+ # The descriptor that will be printed on the letter included with the check.
472
+ #
473
+ # @return [String, nil]
474
+ required :note, String, nil?: true
475
+
476
+ # @!attribute payer
477
+ # The payer of the check. This will be printed on the top-left portion of the
478
+ # check and defaults to the return address if unspecified.
479
+ #
480
+ # @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
481
+ required :payer,
482
+ -> {
483
+ Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payer]
484
+ }
485
+
486
+ # @!attribute recipient_name
487
+ # The name that will be printed on the check.
488
+ #
489
+ # @return [String]
490
+ required :recipient_name, String
491
+
492
+ # @!attribute return_address
493
+ # The return address to be printed on the check.
494
+ #
495
+ # @return [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil]
496
+ required :return_address, -> { Increase::CheckTransfer::PhysicalCheck::ReturnAddress }, nil?: true
497
+
498
+ # @!attribute shipping_method
499
+ # The shipping method for the check.
500
+ #
501
+ # @return [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil]
502
+ required :shipping_method,
503
+ enum: -> {
504
+ Increase::CheckTransfer::PhysicalCheck::ShippingMethod
505
+ },
506
+ nil?: true
507
+
508
+ # @!attribute signature_text
509
+ # The text that will appear as the signature on the check in cursive font. If
510
+ # blank, the check will be printed with 'No signature required'.
511
+ #
512
+ # @return [String, nil]
513
+ required :signature_text, String, nil?: true
514
+
515
+ # @!attribute tracking_updates
516
+ # Tracking updates relating to the physical check's delivery.
517
+ #
518
+ # @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate>]
519
+ required :tracking_updates,
520
+ -> {
521
+ Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
522
+ }
523
+
524
+ # @!method initialize(attachment_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, shipping_method:, signature_text:, tracking_updates:)
525
+ # Some parameter documentations has been truncated, see
526
+ # {Increase::Models::CheckTransfer::PhysicalCheck} for more details.
527
+ #
528
+ # Details relating to the physical check that Increase will print and mail. Will
529
+ # be present if and only if `fulfillment_method` is equal to `physical_check`.
530
+ #
531
+ # @param attachment_file_id [String, nil] The ID of the file for the check attachment.
532
+ #
533
+ # @param mailing_address [Increase::Models::CheckTransfer::PhysicalCheck::MailingAddress] Details for where Increase will mail the check.
534
+ #
535
+ # @param memo [String, nil] The descriptor that will be printed on the memo field on the check.
536
+ #
537
+ # @param note [String, nil] The descriptor that will be printed on the letter included with the check.
538
+ #
539
+ # @param payer [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>] The payer of the check. This will be printed on the top-left portion of the chec
540
+ #
541
+ # @param recipient_name [String] The name that will be printed on the check.
542
+ #
543
+ # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil] The return address to be printed on the check.
544
+ #
545
+ # @param shipping_method [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::ShippingMethod, nil] The shipping method for the check.
546
+ #
547
+ # @param signature_text [String, nil] The text that will appear as the signature on the check in cursive font. If blan
548
+ #
549
+ # @param tracking_updates [Array<Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate>] Tracking updates relating to the physical check's delivery.
550
+
551
+ # @see Increase::Models::CheckTransfer::PhysicalCheck#mailing_address
552
+ class MailingAddress < Increase::Internal::Type::BaseModel
553
+ # @!attribute city
554
+ # The city of the check's destination.
555
+ #
556
+ # @return [String, nil]
557
+ required :city, String, nil?: true
558
+
559
+ # @!attribute line1
560
+ # The street address of the check's destination.
561
+ #
562
+ # @return [String, nil]
563
+ required :line1, String, nil?: true
564
+
565
+ # @!attribute line2
566
+ # The second line of the address of the check's destination.
567
+ #
568
+ # @return [String, nil]
569
+ required :line2, String, nil?: true
570
+
571
+ # @!attribute name
572
+ # The name component of the check's mailing address.
573
+ #
574
+ # @return [String, nil]
575
+ required :name, String, nil?: true
576
+
577
+ # @!attribute postal_code
578
+ # The postal code of the check's destination.
579
+ #
580
+ # @return [String, nil]
581
+ required :postal_code, String, nil?: true
582
+
583
+ # @!attribute state
584
+ # The state of the check's destination.
585
+ #
586
+ # @return [String, nil]
587
+ required :state, String, nil?: true
588
+
589
+ # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:)
590
+ # Details for where Increase will mail the check.
591
+ #
592
+ # @param city [String, nil] The city of the check's destination.
593
+ #
594
+ # @param line1 [String, nil] The street address of the check's destination.
595
+ #
596
+ # @param line2 [String, nil] The second line of the address of the check's destination.
597
+ #
598
+ # @param name [String, nil] The name component of the check's mailing address.
599
+ #
600
+ # @param postal_code [String, nil] The postal code of the check's destination.
601
+ #
602
+ # @param state [String, nil] The state of the check's destination.
603
+ end
604
+
605
+ class Payer < Increase::Internal::Type::BaseModel
606
+ # @!attribute contents
607
+ # The contents of the line.
608
+ #
609
+ # @return [String]
610
+ required :contents, String
611
+
612
+ # @!method initialize(contents:)
613
+ # @param contents [String] The contents of the line.
614
+ end
615
+
616
+ # @see Increase::Models::CheckTransfer::PhysicalCheck#return_address
617
+ class ReturnAddress < Increase::Internal::Type::BaseModel
618
+ # @!attribute city
619
+ # The city of the check's destination.
620
+ #
621
+ # @return [String, nil]
622
+ required :city, String, nil?: true
623
+
624
+ # @!attribute line1
625
+ # The street address of the check's destination.
626
+ #
627
+ # @return [String, nil]
628
+ required :line1, String, nil?: true
629
+
630
+ # @!attribute line2
631
+ # The second line of the address of the check's destination.
632
+ #
633
+ # @return [String, nil]
634
+ required :line2, String, nil?: true
635
+
636
+ # @!attribute name
637
+ # The name component of the check's return address.
638
+ #
639
+ # @return [String, nil]
640
+ required :name, String, nil?: true
641
+
642
+ # @!attribute postal_code
643
+ # The postal code of the check's destination.
644
+ #
645
+ # @return [String, nil]
646
+ required :postal_code, String, nil?: true
647
+
648
+ # @!attribute state
649
+ # The state of the check's destination.
650
+ #
651
+ # @return [String, nil]
652
+ required :state, String, nil?: true
653
+
654
+ # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:)
655
+ # The return address to be printed on the check.
656
+ #
657
+ # @param city [String, nil] The city of the check's destination.
658
+ #
659
+ # @param line1 [String, nil] The street address of the check's destination.
660
+ #
661
+ # @param line2 [String, nil] The second line of the address of the check's destination.
662
+ #
663
+ # @param name [String, nil] The name component of the check's return address.
664
+ #
665
+ # @param postal_code [String, nil] The postal code of the check's destination.
666
+ #
667
+ # @param state [String, nil] The state of the check's destination.
668
+ end
669
+
670
+ # The shipping method for the check.
671
+ #
672
+ # @see Increase::Models::CheckTransfer::PhysicalCheck#shipping_method
673
+ module ShippingMethod
674
+ extend Increase::Internal::Type::Enum
675
+
676
+ # USPS First Class
677
+ USPS_FIRST_CLASS = :usps_first_class
678
+
679
+ # FedEx Overnight
680
+ FEDEX_OVERNIGHT = :fedex_overnight
681
+
682
+ # @!method self.values
683
+ # @return [Array<Symbol>]
684
+ end
685
+
686
+ class TrackingUpdate < Increase::Internal::Type::BaseModel
687
+ # @!attribute category
688
+ # The type of tracking event.
689
+ #
690
+ # @return [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category]
691
+ required :category, enum: -> { Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category }
692
+
693
+ # @!attribute created_at
694
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
695
+ # the tracking event took place.
696
+ #
697
+ # @return [Time]
698
+ required :created_at, Time
699
+
700
+ # @!attribute postal_code
701
+ # The postal code where the event took place.
702
+ #
703
+ # @return [String]
704
+ required :postal_code, String
705
+
706
+ # @!method initialize(category:, created_at:, postal_code:)
707
+ # Some parameter documentations has been truncated, see
708
+ # {Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate} for more
709
+ # details.
710
+ #
711
+ # @param category [Symbol, Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate::Category] The type of tracking event.
712
+ #
713
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
714
+ #
715
+ # @param postal_code [String] The postal code where the event took place.
716
+
717
+ # The type of tracking event.
718
+ #
719
+ # @see Increase::Models::CheckTransfer::PhysicalCheck::TrackingUpdate#category
720
+ module Category
721
+ extend Increase::Internal::Type::Enum
722
+
723
+ # The check is in transit.
724
+ IN_TRANSIT = :in_transit
725
+
726
+ # The check has been processed for delivery.
727
+ PROCESSED_FOR_DELIVERY = :processed_for_delivery
728
+
729
+ # The check has been delivered.
730
+ DELIVERED = :delivered
731
+
732
+ # Delivery failed and the check was returned to sender.
733
+ RETURNED_TO_SENDER = :returned_to_sender
734
+
735
+ # @!method self.values
736
+ # @return [Array<Symbol>]
737
+ end
738
+ end
739
+ end
740
+
741
+ # The lifecycle status of the transfer.
742
+ #
743
+ # @see Increase::Models::CheckTransfer#status
744
+ module Status
745
+ extend Increase::Internal::Type::Enum
746
+
747
+ # The transfer is awaiting approval.
748
+ PENDING_APPROVAL = :pending_approval
749
+
750
+ # The transfer has been canceled.
751
+ CANCELED = :canceled
752
+
753
+ # The transfer is pending submission.
754
+ PENDING_SUBMISSION = :pending_submission
755
+
756
+ # The transfer requires attention from an Increase operator.
757
+ REQUIRES_ATTENTION = :requires_attention
758
+
759
+ # The transfer has been rejected.
760
+ REJECTED = :rejected
761
+
762
+ # The check is queued for mailing.
763
+ PENDING_MAILING = :pending_mailing
764
+
765
+ # The check has been mailed.
766
+ MAILED = :mailed
767
+
768
+ # The check has been deposited.
769
+ DEPOSITED = :deposited
770
+
771
+ # A stop-payment was requested for this check.
772
+ STOPPED = :stopped
773
+
774
+ # The transfer has been returned.
775
+ RETURNED = :returned
776
+
777
+ # @!method self.values
778
+ # @return [Array<Symbol>]
779
+ end
780
+
781
+ # @see Increase::Models::CheckTransfer#stop_payment_request
782
+ class StopPaymentRequest < Increase::Internal::Type::BaseModel
783
+ # @!attribute reason
784
+ # The reason why this transfer was stopped.
785
+ #
786
+ # @return [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Reason]
787
+ required :reason, enum: -> { Increase::CheckTransfer::StopPaymentRequest::Reason }
788
+
789
+ # @!attribute requested_at
790
+ # The time the stop-payment was requested.
791
+ #
792
+ # @return [Time]
793
+ required :requested_at, Time
794
+
795
+ # @!attribute transfer_id
796
+ # The ID of the check transfer that was stopped.
797
+ #
798
+ # @return [String]
799
+ required :transfer_id, String
800
+
801
+ # @!attribute type
802
+ # A constant representing the object's type. For this resource it will always be
803
+ # `check_transfer_stop_payment_request`.
804
+ #
805
+ # @return [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type]
806
+ required :type, enum: -> { Increase::CheckTransfer::StopPaymentRequest::Type }
807
+
808
+ # @!method initialize(reason:, requested_at:, transfer_id:, type:)
809
+ # Some parameter documentations has been truncated, see
810
+ # {Increase::Models::CheckTransfer::StopPaymentRequest} for more details.
811
+ #
812
+ # After a stop-payment is requested on the check, this will contain supplemental
813
+ # details.
814
+ #
815
+ # @param reason [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Reason] The reason why this transfer was stopped.
816
+ #
817
+ # @param requested_at [Time] The time the stop-payment was requested.
818
+ #
819
+ # @param transfer_id [String] The ID of the check transfer that was stopped.
820
+ #
821
+ # @param type [Symbol, Increase::Models::CheckTransfer::StopPaymentRequest::Type] A constant representing the object's type. For this resource it will always be `
822
+
823
+ # The reason why this transfer was stopped.
824
+ #
825
+ # @see Increase::Models::CheckTransfer::StopPaymentRequest#reason
826
+ module Reason
827
+ extend Increase::Internal::Type::Enum
828
+
829
+ # The check could not be delivered.
830
+ MAIL_DELIVERY_FAILED = :mail_delivery_failed
831
+
832
+ # The check was canceled by an Increase operator who will provide details out-of-band.
833
+ REJECTED_BY_INCREASE = :rejected_by_increase
834
+
835
+ # The check was not authorized.
836
+ NOT_AUTHORIZED = :not_authorized
837
+
838
+ # The check was stopped for another reason.
839
+ UNKNOWN = :unknown
840
+
841
+ # @!method self.values
842
+ # @return [Array<Symbol>]
843
+ end
844
+
845
+ # A constant representing the object's type. For this resource it will always be
846
+ # `check_transfer_stop_payment_request`.
847
+ #
848
+ # @see Increase::Models::CheckTransfer::StopPaymentRequest#type
849
+ module Type
850
+ extend Increase::Internal::Type::Enum
851
+
852
+ CHECK_TRANSFER_STOP_PAYMENT_REQUEST = :check_transfer_stop_payment_request
853
+
854
+ # @!method self.values
855
+ # @return [Array<Symbol>]
856
+ end
857
+ end
858
+
859
+ # @see Increase::Models::CheckTransfer#submission
860
+ class Submission < Increase::Internal::Type::BaseModel
861
+ # @!attribute address_correction_action
862
+ # Per USPS requirements, Increase will standardize the address to USPS standards
863
+ # and check it against the USPS National Change of Address (NCOA) database before
864
+ # mailing it. This indicates what modifications, if any, were made to the address
865
+ # before printing and mailing the check.
866
+ #
867
+ # @return [Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction]
868
+ required :address_correction_action,
869
+ enum: -> { Increase::CheckTransfer::Submission::AddressCorrectionAction }
870
+
871
+ # @!attribute submitted_address
872
+ # The address we submitted to the printer. This is what is physically printed on
873
+ # the check.
874
+ #
875
+ # @return [Increase::Models::CheckTransfer::Submission::SubmittedAddress]
876
+ required :submitted_address, -> { Increase::CheckTransfer::Submission::SubmittedAddress }
877
+
878
+ # @!attribute submitted_at
879
+ # When this check transfer was submitted to our check printer.
880
+ #
881
+ # @return [Time]
882
+ required :submitted_at, Time
883
+
884
+ # @!method initialize(address_correction_action:, submitted_address:, submitted_at:)
885
+ # Some parameter documentations has been truncated, see
886
+ # {Increase::Models::CheckTransfer::Submission} for more details.
887
+ #
888
+ # After the transfer is submitted, this will contain supplemental details.
889
+ #
890
+ # @param address_correction_action [Symbol, Increase::Models::CheckTransfer::Submission::AddressCorrectionAction] Per USPS requirements, Increase will standardize the address to USPS standards a
891
+ #
892
+ # @param submitted_address [Increase::Models::CheckTransfer::Submission::SubmittedAddress] The address we submitted to the printer. This is what is physically printed on t
893
+ #
894
+ # @param submitted_at [Time] When this check transfer was submitted to our check printer.
895
+
896
+ # Per USPS requirements, Increase will standardize the address to USPS standards
897
+ # and check it against the USPS National Change of Address (NCOA) database before
898
+ # mailing it. This indicates what modifications, if any, were made to the address
899
+ # before printing and mailing the check.
900
+ #
901
+ # @see Increase::Models::CheckTransfer::Submission#address_correction_action
902
+ module AddressCorrectionAction
903
+ extend Increase::Internal::Type::Enum
904
+
905
+ # No address correction took place.
906
+ NONE = :none
907
+
908
+ # The address was standardized.
909
+ STANDARDIZATION = :standardization
910
+
911
+ # The address was first standardized and then changed because the recipient moved.
912
+ STANDARDIZATION_WITH_ADDRESS_CHANGE = :standardization_with_address_change
913
+
914
+ # An error occurred while correcting the address. This typically means the USPS could not find that address. The address was not changed.
915
+ ERROR = :error
916
+
917
+ # @!method self.values
918
+ # @return [Array<Symbol>]
919
+ end
920
+
921
+ # @see Increase::Models::CheckTransfer::Submission#submitted_address
922
+ class SubmittedAddress < Increase::Internal::Type::BaseModel
923
+ # @!attribute city
924
+ # The submitted address city.
925
+ #
926
+ # @return [String]
927
+ required :city, String
928
+
929
+ # @!attribute line1
930
+ # The submitted address line 1.
931
+ #
932
+ # @return [String]
933
+ required :line1, String
934
+
935
+ # @!attribute line2
936
+ # The submitted address line 2.
937
+ #
938
+ # @return [String, nil]
939
+ required :line2, String, nil?: true
940
+
941
+ # @!attribute recipient_name
942
+ # The submitted recipient name.
943
+ #
944
+ # @return [String]
945
+ required :recipient_name, String
946
+
947
+ # @!attribute state
948
+ # The submitted address state.
949
+ #
950
+ # @return [String]
951
+ required :state, String
952
+
953
+ # @!attribute zip
954
+ # The submitted address zip.
955
+ #
956
+ # @return [String]
957
+ required :zip, String
958
+
959
+ # @!method initialize(city:, line1:, line2:, recipient_name:, state:, zip:)
960
+ # The address we submitted to the printer. This is what is physically printed on
961
+ # the check.
962
+ #
963
+ # @param city [String] The submitted address city.
964
+ #
965
+ # @param line1 [String] The submitted address line 1.
966
+ #
967
+ # @param line2 [String, nil] The submitted address line 2.
968
+ #
969
+ # @param recipient_name [String] The submitted recipient name.
970
+ #
971
+ # @param state [String] The submitted address state.
972
+ #
973
+ # @param zip [String] The submitted address zip.
974
+ end
975
+ end
976
+
977
+ # @see Increase::Models::CheckTransfer#third_party
978
+ class ThirdParty < Increase::Internal::Type::BaseModel
979
+ # @!attribute recipient_name
980
+ # The name that you will print on the check.
981
+ #
982
+ # @return [String, nil]
983
+ required :recipient_name, String, nil?: true
984
+
985
+ # @!method initialize(recipient_name:)
986
+ # Details relating to the custom fulfillment you will perform. Will be present if
987
+ # and only if `fulfillment_method` is equal to `third_party`.
988
+ #
989
+ # @param recipient_name [String, nil] The name that you will print on the check.
990
+ end
991
+
992
+ # A constant representing the object's type. For this resource it will always be
993
+ # `check_transfer`.
994
+ #
995
+ # @see Increase::Models::CheckTransfer#type
996
+ module Type
997
+ extend Increase::Internal::Type::Enum
998
+
999
+ CHECK_TRANSFER = :check_transfer
1000
+
1001
+ # @!method self.values
1002
+ # @return [Array<Symbol>]
1003
+ end
1004
+ end
1005
+ end
1006
+ end