increase 1.346.0 → 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 (278) 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_list_params.rb +4 -0
  24. data/lib/increase/models/declined_transaction_list_params.rb +4 -0
  25. data/lib/increase/models/digital_card_profile_list_params.rb +4 -0
  26. data/lib/increase/models/digital_wallet_token_list_params.rb +4 -0
  27. data/lib/increase/models/entity_create_params.rb +75 -12
  28. data/lib/increase/models/entity_list_params.rb +4 -0
  29. data/lib/increase/models/entity_onboarding_session_list_params.rb +4 -0
  30. data/lib/increase/models/entity_update_params.rb +24 -2
  31. data/lib/increase/models/event.rb +6 -0
  32. data/lib/increase/models/event_list_params.rb +16 -0
  33. data/lib/increase/models/event_subscription.rb +6 -0
  34. data/lib/increase/models/event_subscription_create_params.rb +6 -0
  35. data/lib/increase/models/event_subscription_list_params.rb +4 -0
  36. data/lib/increase/models/export_list_params.rb +4 -0
  37. data/lib/increase/models/external_account_create_params.rb +9 -3
  38. data/lib/increase/models/external_account_list_params.rb +4 -0
  39. data/lib/increase/models/fednow_transfer_list_params.rb +4 -0
  40. data/lib/increase/models/file.rb +2 -2
  41. data/lib/increase/models/file_create_params.rb +8 -2
  42. data/lib/increase/models/file_list_params.rb +6 -2
  43. data/lib/increase/models/inbound_ach_transfer_list_params.rb +4 -0
  44. data/lib/increase/models/inbound_check_deposit.rb +14 -1
  45. data/lib/increase/models/inbound_check_deposit_list_params.rb +4 -0
  46. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +4 -0
  47. data/lib/increase/models/inbound_mail_item_list_params.rb +4 -0
  48. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +4 -0
  49. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +4 -0
  50. data/lib/increase/models/inbound_wire_transfer_list_params.rb +4 -0
  51. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +4 -0
  52. data/lib/increase/models/intrafi_exclusion_list_params.rb +4 -0
  53. data/lib/increase/models/lockbox_address_list_params.rb +4 -0
  54. data/lib/increase/models/lockbox_recipient_list_params.rb +4 -0
  55. data/lib/increase/models/oauth_application_list_params.rb +4 -0
  56. data/lib/increase/models/oauth_connection_list_params.rb +4 -0
  57. data/lib/increase/models/pending_transaction_list_params.rb +4 -0
  58. data/lib/increase/models/physical_card_list_params.rb +4 -0
  59. data/lib/increase/models/physical_card_profile_create_params.rb +13 -4
  60. data/lib/increase/models/physical_card_profile_list_params.rb +4 -0
  61. data/lib/increase/models/program.rb +3 -0
  62. data/lib/increase/models/program_list_params.rb +4 -0
  63. data/lib/increase/models/real_time_payments_transfer_list_params.rb +4 -0
  64. data/lib/increase/models/routing_number_list_params.rb +4 -0
  65. data/lib/increase/models/routing_number_list_response.rb +27 -1
  66. data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -0
  67. data/lib/increase/models/simulations/card_token_create_params.rb +6 -0
  68. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +9 -6
  69. data/lib/increase/models/simulations/program_create_params.rb +3 -0
  70. data/lib/increase/models/supplemental_document_list_params.rb +4 -0
  71. data/lib/increase/models/swift_transfer_list_params.rb +4 -0
  72. data/lib/increase/models/transaction_list_params.rb +4 -0
  73. data/lib/increase/models/unwrap_webhook_event.rb +6 -0
  74. data/lib/increase/models/wire_drawdown_request.rb +4 -4
  75. data/lib/increase/models/wire_drawdown_request_create_params.rb +4 -4
  76. data/lib/increase/models/wire_drawdown_request_list_params.rb +4 -0
  77. data/lib/increase/models/wire_transfer_create_params.rb +6 -6
  78. data/lib/increase/models/wire_transfer_list_params.rb +4 -0
  79. data/lib/increase/resources/account_numbers.rb +2 -0
  80. data/lib/increase/resources/account_statements.rb +2 -0
  81. data/lib/increase/resources/account_transfers.rb +2 -0
  82. data/lib/increase/resources/accounts.rb +2 -0
  83. data/lib/increase/resources/ach_prenotifications.rb +6 -0
  84. data/lib/increase/resources/ach_transfers.rb +4 -0
  85. data/lib/increase/resources/beneficial_owners.rb +2 -0
  86. data/lib/increase/resources/card_disputes.rb +2 -0
  87. data/lib/increase/resources/card_payments.rb +2 -0
  88. data/lib/increase/resources/card_purchase_supplements.rb +2 -0
  89. data/lib/increase/resources/card_push_transfers.rb +2 -0
  90. data/lib/increase/resources/card_tokens.rb +2 -0
  91. data/lib/increase/resources/card_validations.rb +2 -0
  92. data/lib/increase/resources/cards.rb +2 -0
  93. data/lib/increase/resources/check_deposits.rb +2 -0
  94. data/lib/increase/resources/check_transfers.rb +6 -1
  95. data/lib/increase/resources/declined_transactions.rb +2 -0
  96. data/lib/increase/resources/digital_card_profiles.rb +2 -0
  97. data/lib/increase/resources/digital_wallet_tokens.rb +2 -0
  98. data/lib/increase/resources/entities.rb +2 -0
  99. data/lib/increase/resources/entity_onboarding_sessions.rb +2 -0
  100. data/lib/increase/resources/event_subscriptions.rb +2 -0
  101. data/lib/increase/resources/events.rb +2 -0
  102. data/lib/increase/resources/exports.rb +2 -0
  103. data/lib/increase/resources/external_accounts.rb +5 -1
  104. data/lib/increase/resources/fednow_transfers.rb +2 -0
  105. data/lib/increase/resources/files.rb +4 -0
  106. data/lib/increase/resources/inbound_ach_transfers.rb +2 -0
  107. data/lib/increase/resources/inbound_check_deposits.rb +2 -0
  108. data/lib/increase/resources/inbound_fednow_transfers.rb +2 -0
  109. data/lib/increase/resources/inbound_mail_items.rb +2 -0
  110. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +2 -0
  111. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +2 -0
  112. data/lib/increase/resources/inbound_wire_transfers.rb +2 -0
  113. data/lib/increase/resources/intrafi_account_enrollments.rb +2 -0
  114. data/lib/increase/resources/intrafi_exclusions.rb +2 -0
  115. data/lib/increase/resources/lockbox_addresses.rb +2 -0
  116. data/lib/increase/resources/lockbox_recipients.rb +2 -0
  117. data/lib/increase/resources/oauth_applications.rb +2 -0
  118. data/lib/increase/resources/oauth_connections.rb +2 -0
  119. data/lib/increase/resources/pending_transactions.rb +2 -0
  120. data/lib/increase/resources/physical_card_profiles.rb +9 -2
  121. data/lib/increase/resources/physical_cards.rb +2 -0
  122. data/lib/increase/resources/programs.rb +2 -0
  123. data/lib/increase/resources/real_time_payments_transfers.rb +2 -0
  124. data/lib/increase/resources/routing_numbers.rb +2 -0
  125. data/lib/increase/resources/simulations/ach_transfers.rb +1 -0
  126. data/lib/increase/resources/simulations/check_deposits.rb +3 -2
  127. data/lib/increase/resources/simulations/inbound_check_deposits.rb +5 -4
  128. data/lib/increase/resources/supplemental_documents.rb +2 -0
  129. data/lib/increase/resources/swift_transfers.rb +2 -0
  130. data/lib/increase/resources/transactions.rb +2 -0
  131. data/lib/increase/resources/wire_drawdown_requests.rb +2 -0
  132. data/lib/increase/resources/wire_transfers.rb +2 -0
  133. data/lib/increase/version.rb +1 -1
  134. data/rbi/increase/models/account.rbi +4 -0
  135. data/rbi/increase/models/account_list_params.rbi +4 -0
  136. data/rbi/increase/models/account_number_list_params.rbi +4 -0
  137. data/rbi/increase/models/account_statement_list_params.rbi +4 -0
  138. data/rbi/increase/models/account_transfer_list_params.rbi +4 -0
  139. data/rbi/increase/models/ach_prenotification_create_params.rbi +12 -0
  140. data/rbi/increase/models/ach_prenotification_list_params.rbi +4 -0
  141. data/rbi/increase/models/ach_transfer_create_params.rbi +6 -0
  142. data/rbi/increase/models/ach_transfer_list_params.rbi +4 -0
  143. data/rbi/increase/models/beneficial_owner_create_params.rbi +10 -0
  144. data/rbi/increase/models/beneficial_owner_list_params.rbi +4 -0
  145. data/rbi/increase/models/beneficial_owner_update_params.rbi +10 -0
  146. data/rbi/increase/models/card_dispute_list_params.rbi +4 -0
  147. data/rbi/increase/models/card_list_params.rbi +4 -0
  148. data/rbi/increase/models/card_payment_list_params.rbi +4 -0
  149. data/rbi/increase/models/card_purchase_supplement_list_params.rbi +4 -0
  150. data/rbi/increase/models/card_push_transfer_list_params.rbi +4 -0
  151. data/rbi/increase/models/card_token_list_params.rbi +4 -0
  152. data/rbi/increase/models/card_validation_list_params.rbi +4 -0
  153. data/rbi/increase/models/check_deposit_list_params.rbi +4 -0
  154. data/rbi/increase/models/check_transfer_list_params.rbi +4 -0
  155. data/rbi/increase/models/declined_transaction_list_params.rbi +4 -0
  156. data/rbi/increase/models/digital_card_profile_list_params.rbi +4 -0
  157. data/rbi/increase/models/digital_wallet_token_list_params.rbi +4 -0
  158. data/rbi/increase/models/entity_create_params.rbi +63 -6
  159. data/rbi/increase/models/entity_list_params.rbi +4 -0
  160. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +4 -0
  161. data/rbi/increase/models/entity_update_params.rbi +20 -0
  162. data/rbi/increase/models/event.rbi +14 -0
  163. data/rbi/increase/models/event_list_params.rbi +24 -0
  164. data/rbi/increase/models/event_subscription.rbi +14 -0
  165. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  166. data/rbi/increase/models/event_subscription_list_params.rbi +4 -0
  167. data/rbi/increase/models/export_list_params.rbi +4 -0
  168. data/rbi/increase/models/external_account_create_params.rbi +9 -3
  169. data/rbi/increase/models/external_account_list_params.rbi +4 -0
  170. data/rbi/increase/models/fednow_transfer_list_params.rbi +4 -0
  171. data/rbi/increase/models/file.rbi +2 -2
  172. data/rbi/increase/models/file_create_params.rbi +8 -2
  173. data/rbi/increase/models/file_list_params.rbi +6 -2
  174. data/rbi/increase/models/inbound_ach_transfer_list_params.rbi +4 -0
  175. data/rbi/increase/models/inbound_check_deposit.rbi +12 -0
  176. data/rbi/increase/models/inbound_check_deposit_list_params.rbi +4 -0
  177. data/rbi/increase/models/inbound_fednow_transfer_list_params.rbi +4 -0
  178. data/rbi/increase/models/inbound_mail_item_list_params.rbi +4 -0
  179. data/rbi/increase/models/inbound_real_time_payments_transfer_list_params.rbi +4 -0
  180. data/rbi/increase/models/inbound_wire_drawdown_request_list_params.rbi +4 -0
  181. data/rbi/increase/models/inbound_wire_transfer_list_params.rbi +4 -0
  182. data/rbi/increase/models/intrafi_account_enrollment_list_params.rbi +4 -0
  183. data/rbi/increase/models/intrafi_exclusion_list_params.rbi +4 -0
  184. data/rbi/increase/models/lockbox_address_list_params.rbi +4 -0
  185. data/rbi/increase/models/lockbox_recipient_list_params.rbi +4 -0
  186. data/rbi/increase/models/oauth_application_list_params.rbi +4 -0
  187. data/rbi/increase/models/oauth_connection_list_params.rbi +4 -0
  188. data/rbi/increase/models/pending_transaction_list_params.rbi +4 -0
  189. data/rbi/increase/models/physical_card_list_params.rbi +4 -0
  190. data/rbi/increase/models/physical_card_profile_create_params.rbi +12 -4
  191. data/rbi/increase/models/physical_card_profile_list_params.rbi +4 -0
  192. data/rbi/increase/models/program.rbi +4 -0
  193. data/rbi/increase/models/program_list_params.rbi +4 -0
  194. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +4 -0
  195. data/rbi/increase/models/routing_number_list_params.rbi +4 -0
  196. data/rbi/increase/models/routing_number_list_response.rbi +52 -0
  197. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +3 -0
  198. data/rbi/increase/models/simulations/card_token_create_params.rbi +6 -0
  199. data/rbi/increase/models/simulations/check_deposit_adjustment_params.rbi +9 -6
  200. data/rbi/increase/models/simulations/program_create_params.rbi +7 -0
  201. data/rbi/increase/models/supplemental_document_list_params.rbi +4 -0
  202. data/rbi/increase/models/swift_transfer_list_params.rbi +4 -0
  203. data/rbi/increase/models/transaction_list_params.rbi +4 -0
  204. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  205. data/rbi/increase/models/wire_drawdown_request.rbi +4 -4
  206. data/rbi/increase/models/wire_drawdown_request_create_params.rbi +4 -4
  207. data/rbi/increase/models/wire_drawdown_request_list_params.rbi +4 -0
  208. data/rbi/increase/models/wire_transfer_create_params.rbi +8 -4
  209. data/rbi/increase/models/wire_transfer_list_params.rbi +4 -0
  210. data/rbi/increase/resources/account_numbers.rbi +2 -0
  211. data/rbi/increase/resources/account_statements.rbi +2 -0
  212. data/rbi/increase/resources/account_transfers.rbi +2 -0
  213. data/rbi/increase/resources/accounts.rbi +2 -0
  214. data/rbi/increase/resources/ach_prenotifications.rbi +6 -0
  215. data/rbi/increase/resources/ach_transfers.rbi +4 -0
  216. data/rbi/increase/resources/beneficial_owners.rbi +2 -0
  217. data/rbi/increase/resources/card_disputes.rbi +2 -0
  218. data/rbi/increase/resources/card_payments.rbi +2 -0
  219. data/rbi/increase/resources/card_purchase_supplements.rbi +2 -0
  220. data/rbi/increase/resources/card_push_transfers.rbi +2 -0
  221. data/rbi/increase/resources/card_tokens.rbi +2 -0
  222. data/rbi/increase/resources/card_validations.rbi +2 -0
  223. data/rbi/increase/resources/cards.rbi +2 -0
  224. data/rbi/increase/resources/check_deposits.rbi +2 -0
  225. data/rbi/increase/resources/check_transfers.rbi +6 -1
  226. data/rbi/increase/resources/declined_transactions.rbi +2 -0
  227. data/rbi/increase/resources/digital_card_profiles.rbi +2 -0
  228. data/rbi/increase/resources/digital_wallet_tokens.rbi +2 -0
  229. data/rbi/increase/resources/entities.rbi +2 -0
  230. data/rbi/increase/resources/entity_onboarding_sessions.rbi +2 -0
  231. data/rbi/increase/resources/event_subscriptions.rbi +2 -0
  232. data/rbi/increase/resources/events.rbi +2 -0
  233. data/rbi/increase/resources/exports.rbi +2 -0
  234. data/rbi/increase/resources/external_accounts.rbi +5 -1
  235. data/rbi/increase/resources/fednow_transfers.rbi +2 -0
  236. data/rbi/increase/resources/files.rbi +4 -0
  237. data/rbi/increase/resources/inbound_ach_transfers.rbi +2 -0
  238. data/rbi/increase/resources/inbound_check_deposits.rbi +2 -0
  239. data/rbi/increase/resources/inbound_fednow_transfers.rbi +2 -0
  240. data/rbi/increase/resources/inbound_mail_items.rbi +2 -0
  241. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +2 -0
  242. data/rbi/increase/resources/inbound_wire_drawdown_requests.rbi +2 -0
  243. data/rbi/increase/resources/inbound_wire_transfers.rbi +2 -0
  244. data/rbi/increase/resources/intrafi_account_enrollments.rbi +2 -0
  245. data/rbi/increase/resources/intrafi_exclusions.rbi +2 -0
  246. data/rbi/increase/resources/lockbox_addresses.rbi +2 -0
  247. data/rbi/increase/resources/lockbox_recipients.rbi +2 -0
  248. data/rbi/increase/resources/oauth_applications.rbi +2 -0
  249. data/rbi/increase/resources/oauth_connections.rbi +2 -0
  250. data/rbi/increase/resources/pending_transactions.rbi +2 -0
  251. data/rbi/increase/resources/physical_card_profiles.rbi +8 -2
  252. data/rbi/increase/resources/physical_cards.rbi +2 -0
  253. data/rbi/increase/resources/programs.rbi +2 -0
  254. data/rbi/increase/resources/real_time_payments_transfers.rbi +2 -0
  255. data/rbi/increase/resources/routing_numbers.rbi +2 -0
  256. data/rbi/increase/resources/simulations/ach_transfers.rbi +1 -0
  257. data/rbi/increase/resources/simulations/check_deposits.rbi +3 -2
  258. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +5 -4
  259. data/rbi/increase/resources/supplemental_documents.rbi +2 -0
  260. data/rbi/increase/resources/swift_transfers.rbi +2 -0
  261. data/rbi/increase/resources/transactions.rbi +2 -0
  262. data/rbi/increase/resources/wire_drawdown_requests.rbi +2 -0
  263. data/rbi/increase/resources/wire_transfers.rbi +2 -0
  264. data/sig/increase/models/account.rbs +5 -1
  265. data/sig/increase/models/event.rbs +8 -0
  266. data/sig/increase/models/event_list_params.rbs +8 -0
  267. data/sig/increase/models/event_subscription.rbs +8 -0
  268. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  269. data/sig/increase/models/file.rbs +2 -2
  270. data/sig/increase/models/file_create_params.rbs +2 -2
  271. data/sig/increase/models/file_list_params.rbs +2 -2
  272. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  273. data/sig/increase/models/program.rbs +5 -1
  274. data/sig/increase/models/routing_number_list_response.rbs +19 -0
  275. data/sig/increase/models/simulations/program_create_params.rbs +5 -1
  276. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  277. data/sig/increase/models/wire_transfer_create_params.rbs +12 -4
  278. metadata +2 -2
@@ -33,6 +33,8 @@ module Increase
33
33
  # Limit the size of the list that is returned. The default (and maximum) is 100
34
34
  # objects.
35
35
  #
36
+ # Defaults to `100`.
37
+ #
36
38
  # @return [Integer, nil]
37
39
  optional :limit, Integer
38
40
 
@@ -56,6 +58,8 @@ module Increase
56
58
  # Limit the size of the list that is returned. The default (and maximum) is 100
57
59
  # objects.
58
60
  #
61
+ # Defaults to `100`.
62
+ #
59
63
  # @param route_id [String]
60
64
  # Filter Transactions for those belonging to the specified route. This could be a
61
65
  # Card ID or an Account Number ID.
@@ -276,6 +276,12 @@ module Increase
276
276
  # Occurs whenever an Inbound Wire Transfer is updated.
277
277
  INBOUND_WIRE_TRANSFER_UPDATED = :"inbound_wire_transfer.updated"
278
278
 
279
+ # Occurs whenever an Interest Rate Plan is created.
280
+ INTEREST_RATE_PLAN_CREATED = :"interest_rate_plan.created"
281
+
282
+ # Occurs whenever an Interest Rate Plan is updated.
283
+ INTEREST_RATE_PLAN_UPDATED = :"interest_rate_plan.updated"
284
+
279
285
  # Occurs whenever an IntraFi Account Enrollment is created.
280
286
  INTRAFI_ACCOUNT_ENROLLMENT_CREATED = :"intrafi_account_enrollment.created"
281
287
 
@@ -234,7 +234,7 @@ module Increase
234
234
  required :line2, String, nil?: true
235
235
 
236
236
  # @!attribute postal_code
237
- # The ZIP code of the address.
237
+ # The postal code of the address.
238
238
  #
239
239
  # @return [String, nil]
240
240
  required :postal_code, String, nil?: true
@@ -259,7 +259,7 @@ module Increase
259
259
  #
260
260
  # @param line2 [String, nil] The second line of the address.
261
261
  #
262
- # @param postal_code [String, nil] The ZIP code of the address.
262
+ # @param postal_code [String, nil] The postal code of the address.
263
263
  #
264
264
  # @param state [String, nil] The address state.
265
265
  end
@@ -293,7 +293,7 @@ module Increase
293
293
  required :line2, String, nil?: true
294
294
 
295
295
  # @!attribute postal_code
296
- # The ZIP code of the address.
296
+ # The postal code of the address.
297
297
  #
298
298
  # @return [String, nil]
299
299
  required :postal_code, String, nil?: true
@@ -318,7 +318,7 @@ module Increase
318
318
  #
319
319
  # @param line2 [String, nil] The second line of the address.
320
320
  #
321
- # @param postal_code [String, nil] The ZIP code of the address.
321
+ # @param postal_code [String, nil] The postal code of the address.
322
322
  #
323
323
  # @param state [String, nil] The address state.
324
324
  end
@@ -146,7 +146,7 @@ module Increase
146
146
  optional :line2, String
147
147
 
148
148
  # @!attribute postal_code
149
- # The ZIP code of the address.
149
+ # The postal code of the address.
150
150
  #
151
151
  # @return [String, nil]
152
152
  optional :postal_code, String
@@ -171,7 +171,7 @@ module Increase
171
171
  #
172
172
  # @param line2 [String] The second line of the address. This might be the floor or room number.
173
173
  #
174
- # @param postal_code [String] The ZIP code of the address.
174
+ # @param postal_code [String] The postal code of the address.
175
175
  #
176
176
  # @param state [String] The address state.
177
177
  end
@@ -204,7 +204,7 @@ module Increase
204
204
  optional :line2, String
205
205
 
206
206
  # @!attribute postal_code
207
- # The ZIP code of the address.
207
+ # The postal code of the address.
208
208
  #
209
209
  # @return [String, nil]
210
210
  optional :postal_code, String
@@ -229,7 +229,7 @@ module Increase
229
229
  #
230
230
  # @param line2 [String] The second line of the address. This might be the floor or room number.
231
231
  #
232
- # @param postal_code [String] The ZIP code of the address.
232
+ # @param postal_code [String] The postal code of the address.
233
233
  #
234
234
  # @param state [String] The address state.
235
235
  end
@@ -26,6 +26,8 @@ module Increase
26
26
  # Limit the size of the list that is returned. The default (and maximum) is 100
27
27
  # objects.
28
28
  #
29
+ # Defaults to `100`.
30
+ #
29
31
  # @return [Integer, nil]
30
32
  optional :limit, Integer
31
33
 
@@ -47,6 +49,8 @@ module Increase
47
49
  # Limit the size of the list that is returned. The default (and maximum) is 100
48
50
  # objects.
49
51
  #
52
+ # Defaults to `100`.
53
+ #
50
54
  # @param status [Increase::Models::WireDrawdownRequestListParams::Status]
51
55
  #
52
56
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
@@ -142,10 +142,10 @@ module Increase
142
142
  # @!attribute unstructured
143
143
  # Unstructured address lines.
144
144
  #
145
- # @return [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured]
146
- required :unstructured, -> { Increase::WireTransferCreateParams::Creditor::Address::Unstructured }
145
+ # @return [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured, nil]
146
+ optional :unstructured, -> { Increase::WireTransferCreateParams::Creditor::Address::Unstructured }
147
147
 
148
- # @!method initialize(unstructured:)
148
+ # @!method initialize(unstructured: nil)
149
149
  # The person or business's address.
150
150
  #
151
151
  # @param unstructured [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured]
@@ -315,10 +315,10 @@ module Increase
315
315
  # @!attribute unstructured
316
316
  # Unstructured address lines.
317
317
  #
318
- # @return [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured]
319
- required :unstructured, -> { Increase::WireTransferCreateParams::Debtor::Address::Unstructured }
318
+ # @return [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured, nil]
319
+ optional :unstructured, -> { Increase::WireTransferCreateParams::Debtor::Address::Unstructured }
320
320
 
321
- # @!method initialize(unstructured:)
321
+ # @!method initialize(unstructured: nil)
322
322
  # The person or business's address.
323
323
  #
324
324
  # @param unstructured [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured]
@@ -43,6 +43,8 @@ module Increase
43
43
  # Limit the size of the list that is returned. The default (and maximum) is 100
44
44
  # objects.
45
45
  #
46
+ # Defaults to `100`.
47
+ #
46
48
  # @return [Integer, nil]
47
49
  optional :limit, Integer
48
50
 
@@ -70,6 +72,8 @@ module Increase
70
72
  # Limit the size of the list that is returned. The default (and maximum) is 100
71
73
  # objects.
72
74
  #
75
+ # Defaults to `100`.
76
+ #
73
77
  # @param status [Increase::Models::WireTransferListParams::Status]
74
78
  #
75
79
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
@@ -110,6 +110,8 @@ module Increase
110
110
  # Limit the size of the list that is returned. The default (and maximum) is 100
111
111
  # objects.
112
112
  #
113
+ # Defaults to `100`.
114
+ #
113
115
  # @param status [Increase::Models::AccountNumberListParams::Status]
114
116
  #
115
117
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -35,6 +35,8 @@ module Increase
35
35
  # Limit the size of the list that is returned. The default (and maximum) is 100
36
36
  # objects.
37
37
  #
38
+ # Defaults to `100`.
39
+ #
38
40
  # @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart]
39
41
  #
40
42
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -81,6 +81,8 @@ module Increase
81
81
  # Limit the size of the list that is returned. The default (and maximum) is 100
82
82
  # objects.
83
83
  #
84
+ # Defaults to `100`.
85
+ #
84
86
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
85
87
  #
86
88
  # @return [Increase::Internal::Page<Increase::Models::AccountTransfer>]
@@ -110,6 +110,8 @@ module Increase
110
110
  # Limit the size of the list that is returned. The default (and maximum) is 100
111
111
  # objects.
112
112
  #
113
+ # Defaults to `100`.
114
+ #
113
115
  # @param program_id [String] Filter Accounts for those in a specific Program.
114
116
  #
115
117
  # @param status [Increase::Models::AccountListParams::Status]
@@ -28,6 +28,8 @@ module Increase
28
28
  # @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator]
29
29
  # Whether the Prenotification is for a future debit or credit.
30
30
  #
31
+ # Defaults to `debit`.
32
+ #
31
33
  # @param effective_date [Date]
32
34
  # The ACH Prenotification effective date in
33
35
  # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
@@ -43,6 +45,8 @@ module Increase
43
45
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
44
46
  # to use for the ACH Prenotification.
45
47
  #
48
+ # Defaults to `corporate_credit_or_debit`.
49
+ #
46
50
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
47
51
  #
48
52
  # @return [Increase::Models::ACHPrenotification]
@@ -97,6 +101,8 @@ module Increase
97
101
  # Limit the size of the list that is returned. The default (and maximum) is 100
98
102
  # objects.
99
103
  #
104
+ # Defaults to `100`.
105
+ #
100
106
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
101
107
  #
102
108
  # @return [Increase::Internal::Page<Increase::Models::ACHPrenotification>]
@@ -65,6 +65,8 @@ module Increase
65
65
  # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding]
66
66
  # The type of the receiver's bank account.
67
67
  #
68
+ # Defaults to `checking`.
69
+ #
68
70
  # @param individual_id [String]
69
71
  # Your internal identifier for the transfer recipient. This value is informational
70
72
  # and not verified by the recipient's bank. Most callers can leave this unset.
@@ -153,6 +155,8 @@ module Increase
153
155
  # Limit the size of the list that is returned. The default (and maximum) is 100
154
156
  # objects.
155
157
  #
158
+ # Defaults to `100`.
159
+ #
156
160
  # @param status [Increase::Models::ACHTransferListParams::Status]
157
161
  #
158
162
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -120,6 +120,8 @@ module Increase
120
120
  # Limit the size of the list that is returned. The default (and maximum) is 100
121
121
  # objects.
122
122
  #
123
+ # Defaults to `100`.
124
+ #
123
125
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
124
126
  #
125
127
  # @return [Increase::Internal::Page<Increase::Models::EntityBeneficialOwner>]
@@ -86,6 +86,8 @@ module Increase
86
86
  # Limit the size of the list that is returned. The default (and maximum) is 100
87
87
  # objects.
88
88
  #
89
+ # Defaults to `100`.
90
+ #
89
91
  # @param status [Increase::Models::CardDisputeListParams::Status]
90
92
  #
91
93
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -39,6 +39,8 @@ module Increase
39
39
  # Limit the size of the list that is returned. The default (and maximum) is 100
40
40
  # objects.
41
41
  #
42
+ # Defaults to `100`.
43
+ #
42
44
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
43
45
  #
44
46
  # @return [Increase::Internal::Page<Increase::Models::CardPayment>]
@@ -39,6 +39,8 @@ module Increase
39
39
  # Limit the size of the list that is returned. The default (and maximum) is 100
40
40
  # objects.
41
41
  #
42
+ # Defaults to `100`.
43
+ #
42
44
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
43
45
  #
44
46
  # @return [Increase::Internal::Page<Increase::Models::CardPurchaseSupplement>]
@@ -140,6 +140,8 @@ module Increase
140
140
  # Limit the size of the list that is returned. The default (and maximum) is 100
141
141
  # objects.
142
142
  #
143
+ # Defaults to `100`.
144
+ #
143
145
  # @param status [Increase::Models::CardPushTransferListParams::Status]
144
146
  #
145
147
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -35,6 +35,8 @@ module Increase
35
35
  # Limit the size of the list that is returned. The default (and maximum) is 100
36
36
  # objects.
37
37
  #
38
+ # Defaults to `100`.
39
+ #
38
40
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
39
41
  #
40
42
  # @return [Increase::Internal::Page<Increase::Models::CardToken>]
@@ -94,6 +94,8 @@ module Increase
94
94
  # Limit the size of the list that is returned. The default (and maximum) is 100
95
95
  # objects.
96
96
  #
97
+ # Defaults to `100`.
98
+ #
97
99
  # @param status [Increase::Models::CardValidationListParams::Status]
98
100
  #
99
101
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -118,6 +118,8 @@ module Increase
118
118
  # Limit the size of the list that is returned. The default (and maximum) is 100
119
119
  # objects.
120
120
  #
121
+ # Defaults to `100`.
122
+ #
121
123
  # @param status [Increase::Models::CardListParams::Status]
122
124
  #
123
125
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -74,6 +74,8 @@ module Increase
74
74
  # Limit the size of the list that is returned. The default (and maximum) is 100
75
75
  # objects.
76
76
  #
77
+ # Defaults to `100`.
78
+ #
77
79
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
78
80
  #
79
81
  # @return [Increase::Internal::Page<Increase::Models::CheckDeposit>]
@@ -102,6 +102,8 @@ module Increase
102
102
  # Limit the size of the list that is returned. The default (and maximum) is 100
103
103
  # objects.
104
104
  #
105
+ # Defaults to `100`.
106
+ #
105
107
  # @param status [Increase::Models::CheckTransferListParams::Status]
106
108
  #
107
109
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -163,7 +165,10 @@ module Increase
163
165
  )
164
166
  end
165
167
 
166
- # Stop payment on a Check Transfer
168
+ # Request a stop payment on a Check Transfer. This can be done any time before the
169
+ # check is deposited. A stopped check cannot be deposited and the funds held by
170
+ # the transfer's Pending Transaction are released back to the account's available
171
+ # balance.
167
172
  #
168
173
  # @overload stop_payment(check_transfer_id, reason: nil, request_options: {})
169
174
  #
@@ -39,6 +39,8 @@ module Increase
39
39
  # Limit the size of the list that is returned. The default (and maximum) is 100
40
40
  # objects.
41
41
  #
42
+ # Defaults to `100`.
43
+ #
42
44
  # @param route_id [String] Filter Declined Transactions to those belonging to the specified route.
43
45
  #
44
46
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -78,6 +78,8 @@ module Increase
78
78
  # Limit the size of the list that is returned. The default (and maximum) is 100
79
79
  # objects.
80
80
  #
81
+ # Defaults to `100`.
82
+ #
81
83
  # @param status [Increase::Models::DigitalCardProfileListParams::Status]
82
84
  #
83
85
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -37,6 +37,8 @@ module Increase
37
37
  # Limit the size of the list that is returned. The default (and maximum) is 100
38
38
  # objects.
39
39
  #
40
+ # Defaults to `100`.
41
+ #
40
42
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
41
43
  #
42
44
  # @return [Increase::Internal::Page<Increase::Models::DigitalWalletToken>]
@@ -159,6 +159,8 @@ module Increase
159
159
  # Limit the size of the list that is returned. The default (and maximum) is 100
160
160
  # objects.
161
161
  #
162
+ # Defaults to `100`.
163
+ #
162
164
  # @param status [Increase::Models::EntityListParams::Status]
163
165
  #
164
166
  # @param validation_status [Increase::Models::EntityListParams::ValidationStatus]
@@ -71,6 +71,8 @@ module Increase
71
71
  # Limit the size of the list that is returned. The default (and maximum) is 100
72
72
  # objects.
73
73
  #
74
+ # Defaults to `100`.
75
+ #
74
76
  # @param status [Increase::Models::EntityOnboardingSessionListParams::Status]
75
77
  #
76
78
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -102,6 +102,8 @@ module Increase
102
102
  # Limit the size of the list that is returned. The default (and maximum) is 100
103
103
  # objects.
104
104
  #
105
+ # Defaults to `100`.
106
+ #
105
107
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
106
108
  #
107
109
  # @return [Increase::Internal::Page<Increase::Models::EventSubscription>]
@@ -40,6 +40,8 @@ module Increase
40
40
  # Limit the size of the list that is returned. The default (and maximum) is 100
41
41
  # objects.
42
42
  #
43
+ # Defaults to `100`.
44
+ #
43
45
  # @param order_by [Increase::Models::EventListParams::OrderBy]
44
46
  #
45
47
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -111,6 +111,8 @@ module Increase
111
111
  # Limit the size of the list that is returned. The default (and maximum) is 100
112
112
  # objects.
113
113
  #
114
+ # Defaults to `100`.
115
+ #
114
116
  # @param status [Increase::Models::ExportListParams::Status]
115
117
  #
116
118
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -19,7 +19,9 @@ module Increase
19
19
  # The type of entity that owns the External Account.
20
20
  #
21
21
  # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding]
22
- # The type of the destination account. Defaults to `checking`.
22
+ # The type of the destination account.
23
+ #
24
+ # Defaults to `checking`.
23
25
  #
24
26
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
25
27
  #
@@ -106,6 +108,8 @@ module Increase
106
108
  # Limit the size of the list that is returned. The default (and maximum) is 100
107
109
  # objects.
108
110
  #
111
+ # Defaults to `100`.
112
+ #
109
113
  # @param routing_number [String] Filter External Accounts to those with the specified Routing Number.
110
114
  #
111
115
  # @param status [Increase::Models::ExternalAccountListParams::Status]
@@ -94,6 +94,8 @@ module Increase
94
94
  # Limit the size of the list that is returned. The default (and maximum) is 100
95
95
  # objects.
96
96
  #
97
+ # Defaults to `100`.
98
+ #
97
99
  # @param status [Increase::Models::FednowTransferListParams::Status]
98
100
  #
99
101
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -17,6 +17,8 @@ module Increase
17
17
  # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose]
18
18
  # What the File will be used for in Increase's systems.
19
19
  #
20
+ # Defaults to `other`.
21
+ #
20
22
  # @param description [String] The description you choose to give the File.
21
23
  #
22
24
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -74,6 +76,8 @@ module Increase
74
76
  # Limit the size of the list that is returned. The default (and maximum) is 100
75
77
  # objects.
76
78
  #
79
+ # Defaults to `100`.
80
+ #
77
81
  # @param purpose [Increase::Models::FileListParams::Purpose]
78
82
  #
79
83
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -40,6 +40,8 @@ module Increase
40
40
  # Limit the size of the list that is returned. The default (and maximum) is 100
41
41
  # objects.
42
42
  #
43
+ # Defaults to `100`.
44
+ #
43
45
  # @param status [Increase::Models::InboundACHTransferListParams::Status]
44
46
  #
45
47
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -41,6 +41,8 @@ module Increase
41
41
  # Limit the size of the list that is returned. The default (and maximum) is 100
42
42
  # objects.
43
43
  #
44
+ # Defaults to `100`.
45
+ #
44
46
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
45
47
  #
46
48
  # @return [Increase::Internal::Page<Increase::Models::InboundCheckDeposit>]
@@ -42,6 +42,8 @@ module Increase
42
42
  # Limit the size of the list that is returned. The default (and maximum) is 100
43
43
  # objects.
44
44
  #
45
+ # Defaults to `100`.
46
+ #
45
47
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
46
48
  #
47
49
  # @return [Increase::Internal::Page<Increase::Models::InboundFednowTransfer>]
@@ -35,6 +35,8 @@ module Increase
35
35
  # Limit the size of the list that is returned. The default (and maximum) is 100
36
36
  # objects.
37
37
  #
38
+ # Defaults to `100`.
39
+ #
38
40
  # @param lockbox_address_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
39
41
  #
40
42
  # @param lockbox_recipient_id [String]
@@ -44,6 +44,8 @@ module Increase
44
44
  # Limit the size of the list that is returned. The default (and maximum) is 100
45
45
  # objects.
46
46
  #
47
+ # Defaults to `100`.
48
+ #
47
49
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
48
50
  #
49
51
  # @return [Increase::Internal::Page<Increase::Models::InboundRealTimePaymentsTransfer>]
@@ -34,6 +34,8 @@ module Increase
34
34
  # Limit the size of the list that is returned. The default (and maximum) is 100
35
35
  # objects.
36
36
  #
37
+ # Defaults to `100`.
38
+ #
37
39
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
38
40
  #
39
41
  # @return [Increase::Internal::Page<Increase::Models::InboundWireDrawdownRequest>]
@@ -40,6 +40,8 @@ module Increase
40
40
  # Limit the size of the list that is returned. The default (and maximum) is 100
41
41
  # objects.
42
42
  #
43
+ # Defaults to `100`.
44
+ #
43
45
  # @param status [Increase::Models::InboundWireTransferListParams::Status]
44
46
  #
45
47
  # @param wire_drawdown_request_id [String]
@@ -66,6 +66,8 @@ module Increase
66
66
  # Limit the size of the list that is returned. The default (and maximum) is 100
67
67
  # objects.
68
68
  #
69
+ # Defaults to `100`.
70
+ #
69
71
  # @param status [Increase::Models::IntrafiAccountEnrollmentListParams::Status]
70
72
  #
71
73
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -69,6 +69,8 @@ module Increase
69
69
  # Limit the size of the list that is returned. The default (and maximum) is 100
70
70
  # objects.
71
71
  #
72
+ # Defaults to `100`.
73
+ #
72
74
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
73
75
  #
74
76
  # @return [Increase::Internal::Page<Increase::Models::IntrafiExclusion>]
@@ -93,6 +93,8 @@ module Increase
93
93
  # Limit the size of the list that is returned. The default (and maximum) is 100
94
94
  # objects.
95
95
  #
96
+ # Defaults to `100`.
97
+ #
96
98
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
97
99
  #
98
100
  # @return [Increase::Internal::Page<Increase::Models::LockboxAddress>]
@@ -103,6 +103,8 @@ module Increase
103
103
  # Limit the size of the list that is returned. The default (and maximum) is 100
104
104
  # objects.
105
105
  #
106
+ # Defaults to `100`.
107
+ #
106
108
  # @param lockbox_address_id [String]
107
109
  # Filter Lockbox Recipients to those associated with the provided Lockbox Address.
108
110
  #
@@ -35,6 +35,8 @@ module Increase
35
35
  # Limit the size of the list that is returned. The default (and maximum) is 100
36
36
  # objects.
37
37
  #
38
+ # Defaults to `100`.
39
+ #
38
40
  # @param status [Increase::Models::OAuthApplicationListParams::Status]
39
41
  #
40
42
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -33,6 +33,8 @@ module Increase
33
33
  # Limit the size of the list that is returned. The default (and maximum) is 100
34
34
  # objects.
35
35
  #
36
+ # Defaults to `100`.
37
+ #
36
38
  # @param oauth_application_id [String]
37
39
  # Filter results to only include OAuth Connections for a specific OAuth
38
40
  # Application.
@@ -72,6 +72,8 @@ module Increase
72
72
  # Limit the size of the list that is returned. The default (and maximum) is 100
73
73
  # objects.
74
74
  #
75
+ # Defaults to `100`.
76
+ #
75
77
  # @param route_id [String] Filter pending transactions to those belonging to the specified Route.
76
78
  #
77
79
  # @param status [Increase::Models::PendingTransactionListParams::Status]