increase 1.346.1 → 1.347.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 (284) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account.rb +3 -0
  4. data/lib/increase/models/account_list_params.rb +4 -0
  5. data/lib/increase/models/account_number_list_params.rb +4 -0
  6. data/lib/increase/models/account_statement_list_params.rb +4 -0
  7. data/lib/increase/models/account_transfer_list_params.rb +4 -0
  8. data/lib/increase/models/ach_prenotification_create_params.rb +12 -0
  9. data/lib/increase/models/ach_prenotification_list_params.rb +4 -0
  10. data/lib/increase/models/ach_transfer_create_params.rb +6 -0
  11. data/lib/increase/models/ach_transfer_list_params.rb +4 -0
  12. data/lib/increase/models/beneficial_owner_create_params.rb +12 -1
  13. data/lib/increase/models/beneficial_owner_list_params.rb +4 -0
  14. data/lib/increase/models/beneficial_owner_update_params.rb +12 -1
  15. data/lib/increase/models/card_dispute_list_params.rb +4 -0
  16. data/lib/increase/models/card_list_params.rb +4 -0
  17. data/lib/increase/models/card_payment_list_params.rb +4 -0
  18. data/lib/increase/models/card_purchase_supplement_list_params.rb +4 -0
  19. data/lib/increase/models/card_push_transfer_list_params.rb +4 -0
  20. data/lib/increase/models/card_token_list_params.rb +4 -0
  21. data/lib/increase/models/card_validation_list_params.rb +4 -0
  22. data/lib/increase/models/check_deposit_list_params.rb +4 -0
  23. data/lib/increase/models/check_transfer.rb +2 -2
  24. data/lib/increase/models/check_transfer_create_params.rb +2 -2
  25. data/lib/increase/models/check_transfer_list_params.rb +4 -0
  26. data/lib/increase/models/declined_transaction_list_params.rb +4 -0
  27. data/lib/increase/models/digital_card_profile_list_params.rb +4 -0
  28. data/lib/increase/models/digital_wallet_token_list_params.rb +4 -0
  29. data/lib/increase/models/entity_create_params.rb +75 -12
  30. data/lib/increase/models/entity_list_params.rb +4 -0
  31. data/lib/increase/models/entity_onboarding_session_list_params.rb +4 -0
  32. data/lib/increase/models/entity_update_params.rb +24 -2
  33. data/lib/increase/models/event.rb +6 -0
  34. data/lib/increase/models/event_list_params.rb +16 -0
  35. data/lib/increase/models/event_subscription.rb +6 -0
  36. data/lib/increase/models/event_subscription_create_params.rb +6 -0
  37. data/lib/increase/models/event_subscription_list_params.rb +4 -0
  38. data/lib/increase/models/export_list_params.rb +4 -0
  39. data/lib/increase/models/external_account_create_params.rb +9 -3
  40. data/lib/increase/models/external_account_list_params.rb +4 -0
  41. data/lib/increase/models/fednow_transfer_list_params.rb +4 -0
  42. data/lib/increase/models/file.rb +2 -2
  43. data/lib/increase/models/file_create_params.rb +8 -2
  44. data/lib/increase/models/file_list_params.rb +6 -2
  45. data/lib/increase/models/inbound_ach_transfer_list_params.rb +4 -0
  46. data/lib/increase/models/inbound_check_deposit.rb +14 -1
  47. data/lib/increase/models/inbound_check_deposit_list_params.rb +4 -0
  48. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +4 -0
  49. data/lib/increase/models/inbound_mail_item_list_params.rb +4 -0
  50. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +4 -0
  51. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +4 -0
  52. data/lib/increase/models/inbound_wire_transfer_list_params.rb +4 -0
  53. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +4 -0
  54. data/lib/increase/models/intrafi_exclusion_list_params.rb +4 -0
  55. data/lib/increase/models/lockbox_address_list_params.rb +4 -0
  56. data/lib/increase/models/lockbox_recipient_list_params.rb +4 -0
  57. data/lib/increase/models/oauth_application_list_params.rb +4 -0
  58. data/lib/increase/models/oauth_connection_list_params.rb +4 -0
  59. data/lib/increase/models/pending_transaction_list_params.rb +4 -0
  60. data/lib/increase/models/physical_card_list_params.rb +4 -0
  61. data/lib/increase/models/physical_card_profile_create_params.rb +13 -4
  62. data/lib/increase/models/physical_card_profile_list_params.rb +4 -0
  63. data/lib/increase/models/program.rb +3 -0
  64. data/lib/increase/models/program_list_params.rb +4 -0
  65. data/lib/increase/models/real_time_payments_transfer_list_params.rb +4 -0
  66. data/lib/increase/models/routing_number_list_params.rb +4 -0
  67. data/lib/increase/models/routing_number_list_response.rb +27 -1
  68. data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -0
  69. data/lib/increase/models/simulations/card_token_create_params.rb +6 -0
  70. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +9 -6
  71. data/lib/increase/models/simulations/program_create_params.rb +3 -0
  72. data/lib/increase/models/supplemental_document_list_params.rb +4 -0
  73. data/lib/increase/models/swift_transfer_list_params.rb +4 -0
  74. data/lib/increase/models/transaction_list_params.rb +4 -0
  75. data/lib/increase/models/unwrap_webhook_event.rb +6 -0
  76. data/lib/increase/models/wire_drawdown_request.rb +4 -4
  77. data/lib/increase/models/wire_drawdown_request_create_params.rb +4 -4
  78. data/lib/increase/models/wire_drawdown_request_list_params.rb +4 -0
  79. data/lib/increase/models/wire_transfer_create_params.rb +6 -6
  80. data/lib/increase/models/wire_transfer_list_params.rb +4 -0
  81. data/lib/increase/resources/account_numbers.rb +2 -0
  82. data/lib/increase/resources/account_statements.rb +2 -0
  83. data/lib/increase/resources/account_transfers.rb +2 -0
  84. data/lib/increase/resources/accounts.rb +2 -0
  85. data/lib/increase/resources/ach_prenotifications.rb +6 -0
  86. data/lib/increase/resources/ach_transfers.rb +4 -0
  87. data/lib/increase/resources/beneficial_owners.rb +2 -0
  88. data/lib/increase/resources/card_disputes.rb +2 -0
  89. data/lib/increase/resources/card_payments.rb +2 -0
  90. data/lib/increase/resources/card_purchase_supplements.rb +2 -0
  91. data/lib/increase/resources/card_push_transfers.rb +2 -0
  92. data/lib/increase/resources/card_tokens.rb +2 -0
  93. data/lib/increase/resources/card_validations.rb +2 -0
  94. data/lib/increase/resources/cards.rb +2 -0
  95. data/lib/increase/resources/check_deposits.rb +2 -0
  96. data/lib/increase/resources/check_transfers.rb +6 -1
  97. data/lib/increase/resources/declined_transactions.rb +2 -0
  98. data/lib/increase/resources/digital_card_profiles.rb +2 -0
  99. data/lib/increase/resources/digital_wallet_tokens.rb +2 -0
  100. data/lib/increase/resources/entities.rb +2 -0
  101. data/lib/increase/resources/entity_onboarding_sessions.rb +2 -0
  102. data/lib/increase/resources/event_subscriptions.rb +2 -0
  103. data/lib/increase/resources/events.rb +2 -0
  104. data/lib/increase/resources/exports.rb +2 -0
  105. data/lib/increase/resources/external_accounts.rb +5 -1
  106. data/lib/increase/resources/fednow_transfers.rb +2 -0
  107. data/lib/increase/resources/files.rb +4 -0
  108. data/lib/increase/resources/inbound_ach_transfers.rb +2 -0
  109. data/lib/increase/resources/inbound_check_deposits.rb +2 -0
  110. data/lib/increase/resources/inbound_fednow_transfers.rb +2 -0
  111. data/lib/increase/resources/inbound_mail_items.rb +2 -0
  112. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +2 -0
  113. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +2 -0
  114. data/lib/increase/resources/inbound_wire_transfers.rb +2 -0
  115. data/lib/increase/resources/intrafi_account_enrollments.rb +2 -0
  116. data/lib/increase/resources/intrafi_exclusions.rb +2 -0
  117. data/lib/increase/resources/lockbox_addresses.rb +2 -0
  118. data/lib/increase/resources/lockbox_recipients.rb +2 -0
  119. data/lib/increase/resources/oauth_applications.rb +2 -0
  120. data/lib/increase/resources/oauth_connections.rb +2 -0
  121. data/lib/increase/resources/pending_transactions.rb +2 -0
  122. data/lib/increase/resources/physical_card_profiles.rb +9 -2
  123. data/lib/increase/resources/physical_cards.rb +2 -0
  124. data/lib/increase/resources/programs.rb +2 -0
  125. data/lib/increase/resources/real_time_payments_transfers.rb +2 -0
  126. data/lib/increase/resources/routing_numbers.rb +2 -0
  127. data/lib/increase/resources/simulations/ach_transfers.rb +1 -0
  128. data/lib/increase/resources/simulations/check_deposits.rb +3 -2
  129. data/lib/increase/resources/simulations/inbound_check_deposits.rb +5 -4
  130. data/lib/increase/resources/supplemental_documents.rb +2 -0
  131. data/lib/increase/resources/swift_transfers.rb +2 -0
  132. data/lib/increase/resources/transactions.rb +2 -0
  133. data/lib/increase/resources/wire_drawdown_requests.rb +2 -0
  134. data/lib/increase/resources/wire_transfers.rb +2 -0
  135. data/lib/increase/version.rb +1 -1
  136. data/rbi/increase/models/account.rbi +4 -0
  137. data/rbi/increase/models/account_list_params.rbi +4 -0
  138. data/rbi/increase/models/account_number_list_params.rbi +4 -0
  139. data/rbi/increase/models/account_statement_list_params.rbi +4 -0
  140. data/rbi/increase/models/account_transfer_list_params.rbi +4 -0
  141. data/rbi/increase/models/ach_prenotification_create_params.rbi +12 -0
  142. data/rbi/increase/models/ach_prenotification_list_params.rbi +4 -0
  143. data/rbi/increase/models/ach_transfer_create_params.rbi +6 -0
  144. data/rbi/increase/models/ach_transfer_list_params.rbi +4 -0
  145. data/rbi/increase/models/beneficial_owner_create_params.rbi +10 -0
  146. data/rbi/increase/models/beneficial_owner_list_params.rbi +4 -0
  147. data/rbi/increase/models/beneficial_owner_update_params.rbi +10 -0
  148. data/rbi/increase/models/card_dispute_list_params.rbi +4 -0
  149. data/rbi/increase/models/card_list_params.rbi +4 -0
  150. data/rbi/increase/models/card_payment_list_params.rbi +4 -0
  151. data/rbi/increase/models/card_purchase_supplement_list_params.rbi +4 -0
  152. data/rbi/increase/models/card_push_transfer_list_params.rbi +4 -0
  153. data/rbi/increase/models/card_token_list_params.rbi +4 -0
  154. data/rbi/increase/models/card_validation_list_params.rbi +4 -0
  155. data/rbi/increase/models/check_deposit_list_params.rbi +4 -0
  156. data/rbi/increase/models/check_transfer.rbi +2 -2
  157. data/rbi/increase/models/check_transfer_create_params.rbi +2 -2
  158. data/rbi/increase/models/check_transfer_list_params.rbi +4 -0
  159. data/rbi/increase/models/declined_transaction_list_params.rbi +4 -0
  160. data/rbi/increase/models/digital_card_profile_list_params.rbi +4 -0
  161. data/rbi/increase/models/digital_wallet_token_list_params.rbi +4 -0
  162. data/rbi/increase/models/entity_create_params.rbi +63 -6
  163. data/rbi/increase/models/entity_list_params.rbi +4 -0
  164. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +4 -0
  165. data/rbi/increase/models/entity_update_params.rbi +20 -0
  166. data/rbi/increase/models/event.rbi +14 -0
  167. data/rbi/increase/models/event_list_params.rbi +24 -0
  168. data/rbi/increase/models/event_subscription.rbi +14 -0
  169. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  170. data/rbi/increase/models/event_subscription_list_params.rbi +4 -0
  171. data/rbi/increase/models/export_list_params.rbi +4 -0
  172. data/rbi/increase/models/external_account_create_params.rbi +9 -3
  173. data/rbi/increase/models/external_account_list_params.rbi +4 -0
  174. data/rbi/increase/models/fednow_transfer_list_params.rbi +4 -0
  175. data/rbi/increase/models/file.rbi +2 -2
  176. data/rbi/increase/models/file_create_params.rbi +8 -2
  177. data/rbi/increase/models/file_list_params.rbi +6 -2
  178. data/rbi/increase/models/inbound_ach_transfer_list_params.rbi +4 -0
  179. data/rbi/increase/models/inbound_check_deposit.rbi +12 -0
  180. data/rbi/increase/models/inbound_check_deposit_list_params.rbi +4 -0
  181. data/rbi/increase/models/inbound_fednow_transfer_list_params.rbi +4 -0
  182. data/rbi/increase/models/inbound_mail_item_list_params.rbi +4 -0
  183. data/rbi/increase/models/inbound_real_time_payments_transfer_list_params.rbi +4 -0
  184. data/rbi/increase/models/inbound_wire_drawdown_request_list_params.rbi +4 -0
  185. data/rbi/increase/models/inbound_wire_transfer_list_params.rbi +4 -0
  186. data/rbi/increase/models/intrafi_account_enrollment_list_params.rbi +4 -0
  187. data/rbi/increase/models/intrafi_exclusion_list_params.rbi +4 -0
  188. data/rbi/increase/models/lockbox_address_list_params.rbi +4 -0
  189. data/rbi/increase/models/lockbox_recipient_list_params.rbi +4 -0
  190. data/rbi/increase/models/oauth_application_list_params.rbi +4 -0
  191. data/rbi/increase/models/oauth_connection_list_params.rbi +4 -0
  192. data/rbi/increase/models/pending_transaction_list_params.rbi +4 -0
  193. data/rbi/increase/models/physical_card_list_params.rbi +4 -0
  194. data/rbi/increase/models/physical_card_profile_create_params.rbi +12 -4
  195. data/rbi/increase/models/physical_card_profile_list_params.rbi +4 -0
  196. data/rbi/increase/models/program.rbi +4 -0
  197. data/rbi/increase/models/program_list_params.rbi +4 -0
  198. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +4 -0
  199. data/rbi/increase/models/routing_number_list_params.rbi +4 -0
  200. data/rbi/increase/models/routing_number_list_response.rbi +52 -0
  201. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +3 -0
  202. data/rbi/increase/models/simulations/card_token_create_params.rbi +6 -0
  203. data/rbi/increase/models/simulations/check_deposit_adjustment_params.rbi +9 -6
  204. data/rbi/increase/models/simulations/program_create_params.rbi +7 -0
  205. data/rbi/increase/models/supplemental_document_list_params.rbi +4 -0
  206. data/rbi/increase/models/swift_transfer_list_params.rbi +4 -0
  207. data/rbi/increase/models/transaction_list_params.rbi +4 -0
  208. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  209. data/rbi/increase/models/wire_drawdown_request.rbi +4 -4
  210. data/rbi/increase/models/wire_drawdown_request_create_params.rbi +4 -4
  211. data/rbi/increase/models/wire_drawdown_request_list_params.rbi +4 -0
  212. data/rbi/increase/models/wire_transfer_create_params.rbi +8 -4
  213. data/rbi/increase/models/wire_transfer_list_params.rbi +4 -0
  214. data/rbi/increase/resources/account_numbers.rbi +2 -0
  215. data/rbi/increase/resources/account_statements.rbi +2 -0
  216. data/rbi/increase/resources/account_transfers.rbi +2 -0
  217. data/rbi/increase/resources/accounts.rbi +2 -0
  218. data/rbi/increase/resources/ach_prenotifications.rbi +6 -0
  219. data/rbi/increase/resources/ach_transfers.rbi +4 -0
  220. data/rbi/increase/resources/beneficial_owners.rbi +2 -0
  221. data/rbi/increase/resources/card_disputes.rbi +2 -0
  222. data/rbi/increase/resources/card_payments.rbi +2 -0
  223. data/rbi/increase/resources/card_purchase_supplements.rbi +2 -0
  224. data/rbi/increase/resources/card_push_transfers.rbi +2 -0
  225. data/rbi/increase/resources/card_tokens.rbi +2 -0
  226. data/rbi/increase/resources/card_validations.rbi +2 -0
  227. data/rbi/increase/resources/cards.rbi +2 -0
  228. data/rbi/increase/resources/check_deposits.rbi +2 -0
  229. data/rbi/increase/resources/check_transfers.rbi +6 -1
  230. data/rbi/increase/resources/declined_transactions.rbi +2 -0
  231. data/rbi/increase/resources/digital_card_profiles.rbi +2 -0
  232. data/rbi/increase/resources/digital_wallet_tokens.rbi +2 -0
  233. data/rbi/increase/resources/entities.rbi +2 -0
  234. data/rbi/increase/resources/entity_onboarding_sessions.rbi +2 -0
  235. data/rbi/increase/resources/event_subscriptions.rbi +2 -0
  236. data/rbi/increase/resources/events.rbi +2 -0
  237. data/rbi/increase/resources/exports.rbi +2 -0
  238. data/rbi/increase/resources/external_accounts.rbi +5 -1
  239. data/rbi/increase/resources/fednow_transfers.rbi +2 -0
  240. data/rbi/increase/resources/files.rbi +4 -0
  241. data/rbi/increase/resources/inbound_ach_transfers.rbi +2 -0
  242. data/rbi/increase/resources/inbound_check_deposits.rbi +2 -0
  243. data/rbi/increase/resources/inbound_fednow_transfers.rbi +2 -0
  244. data/rbi/increase/resources/inbound_mail_items.rbi +2 -0
  245. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +2 -0
  246. data/rbi/increase/resources/inbound_wire_drawdown_requests.rbi +2 -0
  247. data/rbi/increase/resources/inbound_wire_transfers.rbi +2 -0
  248. data/rbi/increase/resources/intrafi_account_enrollments.rbi +2 -0
  249. data/rbi/increase/resources/intrafi_exclusions.rbi +2 -0
  250. data/rbi/increase/resources/lockbox_addresses.rbi +2 -0
  251. data/rbi/increase/resources/lockbox_recipients.rbi +2 -0
  252. data/rbi/increase/resources/oauth_applications.rbi +2 -0
  253. data/rbi/increase/resources/oauth_connections.rbi +2 -0
  254. data/rbi/increase/resources/pending_transactions.rbi +2 -0
  255. data/rbi/increase/resources/physical_card_profiles.rbi +8 -2
  256. data/rbi/increase/resources/physical_cards.rbi +2 -0
  257. data/rbi/increase/resources/programs.rbi +2 -0
  258. data/rbi/increase/resources/real_time_payments_transfers.rbi +2 -0
  259. data/rbi/increase/resources/routing_numbers.rbi +2 -0
  260. data/rbi/increase/resources/simulations/ach_transfers.rbi +1 -0
  261. data/rbi/increase/resources/simulations/check_deposits.rbi +3 -2
  262. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +5 -4
  263. data/rbi/increase/resources/supplemental_documents.rbi +2 -0
  264. data/rbi/increase/resources/swift_transfers.rbi +2 -0
  265. data/rbi/increase/resources/transactions.rbi +2 -0
  266. data/rbi/increase/resources/wire_drawdown_requests.rbi +2 -0
  267. data/rbi/increase/resources/wire_transfers.rbi +2 -0
  268. data/sig/increase/models/account.rbs +5 -1
  269. data/sig/increase/models/check_transfer.rbs +2 -2
  270. data/sig/increase/models/check_transfer_create_params.rbs +2 -2
  271. data/sig/increase/models/event.rbs +8 -0
  272. data/sig/increase/models/event_list_params.rbs +8 -0
  273. data/sig/increase/models/event_subscription.rbs +8 -0
  274. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  275. data/sig/increase/models/file.rbs +2 -2
  276. data/sig/increase/models/file_create_params.rbs +2 -2
  277. data/sig/increase/models/file_list_params.rbs +2 -2
  278. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  279. data/sig/increase/models/program.rbs +5 -1
  280. data/sig/increase/models/routing_number_list_response.rbs +19 -0
  281. data/sig/increase/models/simulations/program_create_params.rbs +5 -1
  282. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  283. data/sig/increase/models/wire_transfer_create_params.rbs +12 -4
  284. metadata +2 -2
@@ -433,6 +433,8 @@ module Increase
433
433
  end
434
434
 
435
435
  # The reason for the decline.
436
+ #
437
+ # Defaults to `do_not_honor`.
436
438
  sig do
437
439
  returns(
438
440
  T.nilable(
@@ -459,6 +461,8 @@ module Increase
459
461
  end
460
462
  def self.new(
461
463
  # The reason for the decline.
464
+ #
465
+ # Defaults to `do_not_honor`.
462
466
  reason: nil
463
467
  )
464
468
  end
@@ -475,6 +479,8 @@ module Increase
475
479
  end
476
480
 
477
481
  # The reason for the decline.
482
+ #
483
+ # Defaults to `do_not_honor`.
478
484
  module Reason
479
485
  extend Increase::Internal::Type::Enum
480
486
 
@@ -29,8 +29,9 @@ module Increase
29
29
  sig { params(amount: Integer).void }
30
30
  attr_writer :amount
31
31
 
32
- # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
33
- # used for a low quality image that the recipient wasn't able to handle.
32
+ # The reason for the adjustment.
33
+ #
34
+ # Defaults to `non_conforming_item`.
34
35
  sig do
35
36
  returns(
36
37
  T.nilable(
@@ -65,8 +66,9 @@ module Increase
65
66
  # other bank and is a debit to your account. Defaults to the negative of the Check
66
67
  # Deposit amount.
67
68
  amount: nil,
68
- # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
69
- # used for a low quality image that the recipient wasn't able to handle.
69
+ # The reason for the adjustment.
70
+ #
71
+ # Defaults to `non_conforming_item`.
70
72
  reason: nil,
71
73
  request_options: {}
72
74
  )
@@ -86,8 +88,9 @@ module Increase
86
88
  def to_hash
87
89
  end
88
90
 
89
- # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
90
- # used for a low quality image that the recipient wasn't able to handle.
91
+ # The reason for the adjustment.
92
+ #
93
+ # Defaults to `non_conforming_item`.
91
94
  module Reason
92
95
  extend Increase::Internal::Type::Enum
93
96
 
@@ -117,6 +117,13 @@ module Increase
117
117
  Increase::Simulations::ProgramCreateParams::Bank::TaggedSymbol
118
118
  )
119
119
 
120
+ # Increase Bank
121
+ INCREASE_BANK =
122
+ T.let(
123
+ :increase_bank,
124
+ Increase::Simulations::ProgramCreateParams::Bank::TaggedSymbol
125
+ )
126
+
120
127
  sig do
121
128
  override.returns(
122
129
  T::Array[
@@ -37,6 +37,8 @@ module Increase
37
37
 
38
38
  # Limit the size of the list that is returned. The default (and maximum) is 100
39
39
  # objects.
40
+ #
41
+ # Defaults to `100`.
40
42
  sig { returns(T.nilable(Integer)) }
41
43
  attr_reader :limit
42
44
 
@@ -64,6 +66,8 @@ module Increase
64
66
  idempotency_key: nil,
65
67
  # Limit the size of the list that is returned. The default (and maximum) is 100
66
68
  # objects.
69
+ #
70
+ # Defaults to `100`.
67
71
  limit: nil,
68
72
  request_options: {}
69
73
  )
@@ -47,6 +47,8 @@ module Increase
47
47
 
48
48
  # Limit the size of the list that is returned. The default (and maximum) is 100
49
49
  # objects.
50
+ #
51
+ # Defaults to `100`.
50
52
  sig { returns(T.nilable(Integer)) }
51
53
  attr_reader :limit
52
54
 
@@ -85,6 +87,8 @@ module Increase
85
87
  idempotency_key: nil,
86
88
  # Limit the size of the list that is returned. The default (and maximum) is 100
87
89
  # objects.
90
+ #
91
+ # Defaults to `100`.
88
92
  limit: nil,
89
93
  status: nil,
90
94
  request_options: {}
@@ -45,6 +45,8 @@ module Increase
45
45
 
46
46
  # Limit the size of the list that is returned. The default (and maximum) is 100
47
47
  # objects.
48
+ #
49
+ # Defaults to `100`.
48
50
  sig { returns(T.nilable(Integer)) }
49
51
  attr_reader :limit
50
52
 
@@ -79,6 +81,8 @@ module Increase
79
81
  cursor: nil,
80
82
  # Limit the size of the list that is returned. The default (and maximum) is 100
81
83
  # objects.
84
+ #
85
+ # Defaults to `100`.
82
86
  limit: nil,
83
87
  # Filter Transactions for those belonging to the specified route. This could be a
84
88
  # Card ID or an Account Number ID.
@@ -566,6 +566,20 @@ module Increase
566
566
  Increase::UnwrapWebhookEvent::Category::TaggedSymbol
567
567
  )
568
568
 
569
+ # Occurs whenever an Interest Rate Plan is created.
570
+ INTEREST_RATE_PLAN_CREATED =
571
+ T.let(
572
+ :"interest_rate_plan.created",
573
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
574
+ )
575
+
576
+ # Occurs whenever an Interest Rate Plan is updated.
577
+ INTEREST_RATE_PLAN_UPDATED =
578
+ T.let(
579
+ :"interest_rate_plan.updated",
580
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
581
+ )
582
+
569
583
  # Occurs whenever an IntraFi Account Enrollment is created.
570
584
  INTRAFI_ACCOUNT_ENROLLMENT_CREATED =
571
585
  T.let(
@@ -265,7 +265,7 @@ module Increase
265
265
  sig { returns(T.nilable(String)) }
266
266
  attr_accessor :line2
267
267
 
268
- # The ZIP code of the address.
268
+ # The postal code of the address.
269
269
  sig { returns(T.nilable(String)) }
270
270
  attr_accessor :postal_code
271
271
 
@@ -295,7 +295,7 @@ module Increase
295
295
  line1:,
296
296
  # The second line of the address.
297
297
  line2:,
298
- # The ZIP code of the address.
298
+ # The postal code of the address.
299
299
  postal_code:,
300
300
  # The address state.
301
301
  state:
@@ -345,7 +345,7 @@ module Increase
345
345
  sig { returns(T.nilable(String)) }
346
346
  attr_accessor :line2
347
347
 
348
- # The ZIP code of the address.
348
+ # The postal code of the address.
349
349
  sig { returns(T.nilable(String)) }
350
350
  attr_accessor :postal_code
351
351
 
@@ -375,7 +375,7 @@ module Increase
375
375
  line1:,
376
376
  # The second line of the address.
377
377
  line2:,
378
- # The ZIP code of the address.
378
+ # The postal code of the address.
379
379
  postal_code:,
380
380
  # The address state.
381
381
  state:
@@ -216,7 +216,7 @@ module Increase
216
216
  sig { params(line2: String).void }
217
217
  attr_writer :line2
218
218
 
219
- # The ZIP code of the address.
219
+ # The postal code of the address.
220
220
  sig { returns(T.nilable(String)) }
221
221
  attr_reader :postal_code
222
222
 
@@ -252,7 +252,7 @@ module Increase
252
252
  line1:,
253
253
  # The second line of the address. This might be the floor or room number.
254
254
  line2: nil,
255
- # The ZIP code of the address.
255
+ # The postal code of the address.
256
256
  postal_code: nil,
257
257
  # The address state.
258
258
  state: nil
@@ -305,7 +305,7 @@ module Increase
305
305
  sig { params(line2: String).void }
306
306
  attr_writer :line2
307
307
 
308
- # The ZIP code of the address.
308
+ # The postal code of the address.
309
309
  sig { returns(T.nilable(String)) }
310
310
  attr_reader :postal_code
311
311
 
@@ -341,7 +341,7 @@ module Increase
341
341
  line1:,
342
342
  # The second line of the address. This might be the floor or room number.
343
343
  line2: nil,
344
- # The ZIP code of the address.
344
+ # The postal code of the address.
345
345
  postal_code: nil,
346
346
  # The address state.
347
347
  state: nil
@@ -33,6 +33,8 @@ module Increase
33
33
 
34
34
  # Limit the size of the list that is returned. The default (and maximum) is 100
35
35
  # objects.
36
+ #
37
+ # Defaults to `100`.
36
38
  sig { returns(T.nilable(Integer)) }
37
39
  attr_reader :limit
38
40
 
@@ -70,6 +72,8 @@ module Increase
70
72
  idempotency_key: nil,
71
73
  # Limit the size of the list that is returned. The default (and maximum) is 100
72
74
  # objects.
75
+ #
76
+ # Defaults to `100`.
73
77
  limit: nil,
74
78
  status: nil,
75
79
  request_options: {}
@@ -234,7 +234,9 @@ module Increase
234
234
  # Unstructured address lines.
235
235
  sig do
236
236
  returns(
237
- Increase::WireTransferCreateParams::Creditor::Address::Unstructured
237
+ T.nilable(
238
+ Increase::WireTransferCreateParams::Creditor::Address::Unstructured
239
+ )
238
240
  )
239
241
  end
240
242
  attr_reader :unstructured
@@ -256,7 +258,7 @@ module Increase
256
258
  end
257
259
  def self.new(
258
260
  # Unstructured address lines.
259
- unstructured:
261
+ unstructured: nil
260
262
  )
261
263
  end
262
264
 
@@ -598,7 +600,9 @@ module Increase
598
600
  # Unstructured address lines.
599
601
  sig do
600
602
  returns(
601
- Increase::WireTransferCreateParams::Debtor::Address::Unstructured
603
+ T.nilable(
604
+ Increase::WireTransferCreateParams::Debtor::Address::Unstructured
605
+ )
602
606
  )
603
607
  end
604
608
  attr_reader :unstructured
@@ -620,7 +624,7 @@ module Increase
620
624
  end
621
625
  def self.new(
622
626
  # Unstructured address lines.
623
- unstructured:
627
+ unstructured: nil
624
628
  )
625
629
  end
626
630
 
@@ -54,6 +54,8 @@ module Increase
54
54
 
55
55
  # Limit the size of the list that is returned. The default (and maximum) is 100
56
56
  # objects.
57
+ #
58
+ # Defaults to `100`.
57
59
  sig { returns(T.nilable(Integer)) }
58
60
  attr_reader :limit
59
61
 
@@ -95,6 +97,8 @@ module Increase
95
97
  idempotency_key: nil,
96
98
  # Limit the size of the list that is returned. The default (and maximum) is 100
97
99
  # objects.
100
+ #
101
+ # Defaults to `100`.
98
102
  limit: nil,
99
103
  status: nil,
100
104
  request_options: {}
@@ -98,6 +98,8 @@ module Increase
98
98
  idempotency_key: nil,
99
99
  # Limit the size of the list that is returned. The default (and maximum) is 100
100
100
  # objects.
101
+ #
102
+ # Defaults to `100`.
101
103
  limit: nil,
102
104
  status: nil,
103
105
  request_options: {}
@@ -35,6 +35,8 @@ module Increase
35
35
  cursor: nil,
36
36
  # Limit the size of the list that is returned. The default (and maximum) is 100
37
37
  # objects.
38
+ #
39
+ # Defaults to `100`.
38
40
  limit: nil,
39
41
  statement_period_start: nil,
40
42
  request_options: {}
@@ -71,6 +71,8 @@ module Increase
71
71
  idempotency_key: nil,
72
72
  # Limit the size of the list that is returned. The default (and maximum) is 100
73
73
  # objects.
74
+ #
75
+ # Defaults to `100`.
74
76
  limit: nil,
75
77
  request_options: {}
76
78
  )
@@ -98,6 +98,8 @@ module Increase
98
98
  informational_entity_id: nil,
99
99
  # Limit the size of the list that is returned. The default (and maximum) is 100
100
100
  # objects.
101
+ #
102
+ # Defaults to `100`.
101
103
  limit: nil,
102
104
  # Filter Accounts for those in a specific Program.
103
105
  program_id: nil,
@@ -43,6 +43,8 @@ module Increase
43
43
  # The name by which the recipient knows you.
44
44
  company_name: nil,
45
45
  # Whether the Prenotification is for a future debit or credit.
46
+ #
47
+ # Defaults to `debit`.
46
48
  credit_debit_indicator: nil,
47
49
  # The ACH Prenotification effective date in
48
50
  # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
@@ -55,6 +57,8 @@ module Increase
55
57
  # The
56
58
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
57
59
  # to use for the ACH Prenotification.
60
+ #
61
+ # Defaults to `corporate_credit_or_debit`.
58
62
  standard_entry_class_code: nil,
59
63
  request_options: {}
60
64
  )
@@ -95,6 +99,8 @@ module Increase
95
99
  idempotency_key: nil,
96
100
  # Limit the size of the list that is returned. The default (and maximum) is 100
97
101
  # objects.
102
+ #
103
+ # Defaults to `100`.
98
104
  limit: nil,
99
105
  request_options: {}
100
106
  )
@@ -79,6 +79,8 @@ module Increase
79
79
  # provided, `account_number`, `routing_number`, and `funding` must be absent.
80
80
  external_account_id: nil,
81
81
  # The type of the receiver's bank account.
82
+ #
83
+ # Defaults to `checking`.
82
84
  funding: nil,
83
85
  # Your internal identifier for the transfer recipient. This value is informational
84
86
  # and not verified by the recipient's bank. Most callers can leave this unset.
@@ -149,6 +151,8 @@ module Increase
149
151
  idempotency_key: nil,
150
152
  # Limit the size of the list that is returned. The default (and maximum) is 100
151
153
  # objects.
154
+ #
155
+ # Defaults to `100`.
152
156
  limit: nil,
153
157
  status: nil,
154
158
  request_options: {}
@@ -105,6 +105,8 @@ module Increase
105
105
  idempotency_key: nil,
106
106
  # Limit the size of the list that is returned. The default (and maximum) is 100
107
107
  # objects.
108
+ #
109
+ # Defaults to `100`.
108
110
  limit: nil,
109
111
  request_options: {}
110
112
  )
@@ -76,6 +76,8 @@ module Increase
76
76
  idempotency_key: nil,
77
77
  # Limit the size of the list that is returned. The default (and maximum) is 100
78
78
  # objects.
79
+ #
80
+ # Defaults to `100`.
79
81
  limit: nil,
80
82
  status: nil,
81
83
  request_options: {}
@@ -38,6 +38,8 @@ module Increase
38
38
  cursor: nil,
39
39
  # Limit the size of the list that is returned. The default (and maximum) is 100
40
40
  # objects.
41
+ #
42
+ # Defaults to `100`.
41
43
  limit: nil,
42
44
  request_options: {}
43
45
  )
@@ -37,6 +37,8 @@ module Increase
37
37
  cursor: nil,
38
38
  # Limit the size of the list that is returned. The default (and maximum) is 100
39
39
  # objects.
40
+ #
41
+ # Defaults to `100`.
40
42
  limit: nil,
41
43
  request_options: {}
42
44
  )
@@ -139,6 +139,8 @@ module Increase
139
139
  idempotency_key: nil,
140
140
  # Limit the size of the list that is returned. The default (and maximum) is 100
141
141
  # objects.
142
+ #
143
+ # Defaults to `100`.
142
144
  limit: nil,
143
145
  status: nil,
144
146
  request_options: {}
@@ -32,6 +32,8 @@ module Increase
32
32
  cursor: nil,
33
33
  # Limit the size of the list that is returned. The default (and maximum) is 100
34
34
  # objects.
35
+ #
36
+ # Defaults to `100`.
35
37
  limit: nil,
36
38
  request_options: {}
37
39
  )
@@ -92,6 +92,8 @@ module Increase
92
92
  idempotency_key: nil,
93
93
  # Limit the size of the list that is returned. The default (and maximum) is 100
94
94
  # objects.
95
+ #
96
+ # Defaults to `100`.
95
97
  limit: nil,
96
98
  status: nil,
97
99
  request_options: {}
@@ -113,6 +113,8 @@ module Increase
113
113
  idempotency_key: nil,
114
114
  # Limit the size of the list that is returned. The default (and maximum) is 100
115
115
  # objects.
116
+ #
117
+ # Defaults to `100`.
116
118
  limit: nil,
117
119
  status: nil,
118
120
  request_options: {}
@@ -67,6 +67,8 @@ module Increase
67
67
  idempotency_key: nil,
68
68
  # Limit the size of the list that is returned. The default (and maximum) is 100
69
69
  # objects.
70
+ #
71
+ # Defaults to `100`.
70
72
  limit: nil,
71
73
  request_options: {}
72
74
  )
@@ -97,6 +97,8 @@ module Increase
97
97
  idempotency_key: nil,
98
98
  # Limit the size of the list that is returned. The default (and maximum) is 100
99
99
  # objects.
100
+ #
101
+ # Defaults to `100`.
100
102
  limit: nil,
101
103
  status: nil,
102
104
  request_options: {}
@@ -132,7 +134,10 @@ module Increase
132
134
  )
133
135
  end
134
136
 
135
- # Stop payment on a Check Transfer
137
+ # Request a stop payment on a Check Transfer. This can be done any time before the
138
+ # check is deposited. A stopped check cannot be deposited and the funds held by
139
+ # the transfer's Pending Transaction are released back to the account's available
140
+ # balance.
136
141
  sig do
137
142
  params(
138
143
  check_transfer_id: String,
@@ -39,6 +39,8 @@ module Increase
39
39
  cursor: nil,
40
40
  # Limit the size of the list that is returned. The default (and maximum) is 100
41
41
  # objects.
42
+ #
43
+ # Defaults to `100`.
42
44
  limit: nil,
43
45
  # Filter Declined Transactions to those belonging to the specified route.
44
46
  route_id: nil,
@@ -76,6 +76,8 @@ module Increase
76
76
  idempotency_key: nil,
77
77
  # Limit the size of the list that is returned. The default (and maximum) is 100
78
78
  # objects.
79
+ #
80
+ # Defaults to `100`.
79
81
  limit: nil,
80
82
  status: nil,
81
83
  request_options: {}
@@ -35,6 +35,8 @@ module Increase
35
35
  cursor: nil,
36
36
  # Limit the size of the list that is returned. The default (and maximum) is 100
37
37
  # objects.
38
+ #
39
+ # Defaults to `100`.
38
40
  limit: nil,
39
41
  request_options: {}
40
42
  )
@@ -153,6 +153,8 @@ module Increase
153
153
  idempotency_key: nil,
154
154
  # Limit the size of the list that is returned. The default (and maximum) is 100
155
155
  # objects.
156
+ #
157
+ # Defaults to `100`.
156
158
  limit: nil,
157
159
  status: nil,
158
160
  validation_status: nil,
@@ -61,6 +61,8 @@ module Increase
61
61
  idempotency_key: nil,
62
62
  # Limit the size of the list that is returned. The default (and maximum) is 100
63
63
  # objects.
64
+ #
65
+ # Defaults to `100`.
64
66
  limit: nil,
65
67
  status: nil,
66
68
  request_options: {}
@@ -86,6 +86,8 @@ module Increase
86
86
  idempotency_key: nil,
87
87
  # Limit the size of the list that is returned. The default (and maximum) is 100
88
88
  # objects.
89
+ #
90
+ # Defaults to `100`.
89
91
  limit: nil,
90
92
  request_options: {}
91
93
  )
@@ -38,6 +38,8 @@ module Increase
38
38
  cursor: nil,
39
39
  # Limit the size of the list that is returned. The default (and maximum) is 100
40
40
  # objects.
41
+ #
42
+ # Defaults to `100`.
41
43
  limit: nil,
42
44
  order_by: nil,
43
45
  request_options: {}
@@ -107,6 +107,8 @@ module Increase
107
107
  idempotency_key: nil,
108
108
  # Limit the size of the list that is returned. The default (and maximum) is 100
109
109
  # objects.
110
+ #
111
+ # Defaults to `100`.
110
112
  limit: nil,
111
113
  status: nil,
112
114
  request_options: {}
@@ -25,7 +25,9 @@ module Increase
25
25
  routing_number:,
26
26
  # The type of entity that owns the External Account.
27
27
  account_holder: nil,
28
- # The type of the destination account. Defaults to `checking`.
28
+ # The type of the destination account.
29
+ #
30
+ # Defaults to `checking`.
29
31
  funding: nil,
30
32
  request_options: {}
31
33
  )
@@ -93,6 +95,8 @@ module Increase
93
95
  idempotency_key: nil,
94
96
  # Limit the size of the list that is returned. The default (and maximum) is 100
95
97
  # objects.
98
+ #
99
+ # Defaults to `100`.
96
100
  limit: nil,
97
101
  # Filter External Accounts to those with the specified Routing Number.
98
102
  routing_number: nil,
@@ -92,6 +92,8 @@ module Increase
92
92
  idempotency_key: nil,
93
93
  # Limit the size of the list that is returned. The default (and maximum) is 100
94
94
  # objects.
95
+ #
96
+ # Defaults to `100`.
95
97
  limit: nil,
96
98
  status: nil,
97
99
  request_options: {}
@@ -20,6 +20,8 @@ module Increase
20
20
  # transfers for the multipart/form-data protocol.
21
21
  file:,
22
22
  # What the File will be used for in Increase's systems.
23
+ #
24
+ # Defaults to `other`.
23
25
  purpose:,
24
26
  # The description you choose to give the File.
25
27
  description: nil,
@@ -63,6 +65,8 @@ module Increase
63
65
  idempotency_key: nil,
64
66
  # Limit the size of the list that is returned. The default (and maximum) is 100
65
67
  # objects.
68
+ #
69
+ # Defaults to `100`.
66
70
  limit: nil,
67
71
  purpose: nil,
68
72
  request_options: {}
@@ -39,6 +39,8 @@ module Increase
39
39
  cursor: nil,
40
40
  # Limit the size of the list that is returned. The default (and maximum) is 100
41
41
  # objects.
42
+ #
43
+ # Defaults to `100`.
42
44
  limit: nil,
43
45
  status: nil,
44
46
  request_options: {}
@@ -40,6 +40,8 @@ module Increase
40
40
  cursor: nil,
41
41
  # Limit the size of the list that is returned. The default (and maximum) is 100
42
42
  # objects.
43
+ #
44
+ # Defaults to `100`.
43
45
  limit: nil,
44
46
  request_options: {}
45
47
  )
@@ -40,6 +40,8 @@ module Increase
40
40
  cursor: nil,
41
41
  # Limit the size of the list that is returned. The default (and maximum) is 100
42
42
  # objects.
43
+ #
44
+ # Defaults to `100`.
43
45
  limit: nil,
44
46
  request_options: {}
45
47
  )