increase 1.348.0 → 1.350.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 (163) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_create_params.rb +15 -15
  4. data/lib/increase/models/account_number.rb +3 -3
  5. data/lib/increase/models/ach_transfer.rb +12 -12
  6. data/lib/increase/models/balance_lookup.rb +1 -1
  7. data/lib/increase/models/beneficial_owner_create_params.rb +2 -4
  8. data/lib/increase/models/beneficial_owner_update_params.rb +2 -4
  9. data/lib/increase/models/card_dispute.rb +9 -1
  10. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +4 -0
  11. data/lib/increase/models/card_payment.rb +58 -58
  12. data/lib/increase/models/card_purchase_supplement.rb +9 -1
  13. data/lib/increase/models/card_token_capabilities.rb +2 -2
  14. data/lib/increase/models/check_deposit.rb +9 -9
  15. data/lib/increase/models/check_transfer.rb +2 -2
  16. data/lib/increase/models/check_transfer_create_params.rb +9 -4
  17. data/lib/increase/models/declined_transaction.rb +12 -9
  18. data/lib/increase/models/digital_wallet_token.rb +9 -1
  19. data/lib/increase/models/entity.rb +298 -6
  20. data/lib/increase/models/entity_create_params.rb +332 -29
  21. data/lib/increase/models/entity_onboarding_session_list_params.rb +2 -2
  22. data/lib/increase/models/entity_update_params.rb +472 -15
  23. data/lib/increase/models/event.rb +3 -0
  24. data/lib/increase/models/event_list_params.rb +3 -0
  25. data/lib/increase/models/event_subscription.rb +3 -0
  26. data/lib/increase/models/event_subscription_create_params.rb +3 -0
  27. data/lib/increase/models/fednow_transfer.rb +115 -4
  28. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  29. data/lib/increase/models/inbound_ach_transfer.rb +2 -2
  30. data/lib/increase/models/inbound_check_deposit.rb +7 -4
  31. data/lib/increase/models/inbound_fednow_transfer.rb +21 -1
  32. data/lib/increase/models/inbound_mail_item.rb +14 -1
  33. data/lib/increase/models/inbound_wire_drawdown_request.rb +12 -1
  34. data/lib/increase/models/inbound_wire_transfer.rb +4 -4
  35. data/lib/increase/models/intrafi_exclusion.rb +4 -4
  36. data/lib/increase/models/lockbox_recipient_create_params.rb +2 -2
  37. data/lib/increase/models/pending_transaction.rb +20 -20
  38. data/lib/increase/models/pending_transaction_list_params.rb +5 -7
  39. data/lib/increase/models/physical_card.rb +9 -1
  40. data/lib/increase/models/physical_card_create_params.rb +6 -3
  41. data/lib/increase/models/real_time_decision.rb +18 -18
  42. data/lib/increase/models/simulations/card_authentication_create_params.rb +2 -2
  43. data/lib/increase/models/simulations/card_dispute_action_params.rb +6 -6
  44. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -3
  45. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +8 -11
  46. data/lib/increase/models/simulations/interest_payment_create_params.rb +2 -2
  47. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +2 -2
  48. data/lib/increase/models/simulations/program_create_params.rb +14 -3
  49. data/lib/increase/models/transaction.rb +146 -19
  50. data/lib/increase/models/transaction_list_params.rb +3 -0
  51. data/lib/increase/models/unwrap_webhook_event.rb +3 -0
  52. data/lib/increase/models/wire_drawdown_request.rb +12 -1
  53. data/lib/increase/models/wire_transfer_create_params.rb +2 -2
  54. data/lib/increase/resources/cards.rb +2 -2
  55. data/lib/increase/resources/check_transfers.rb +1 -1
  56. data/lib/increase/resources/entities.rb +10 -2
  57. data/lib/increase/resources/entity_onboarding_sessions.rb +1 -1
  58. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  59. data/lib/increase/resources/physical_cards.rb +2 -1
  60. data/lib/increase/resources/simulations/card_authentications.rb +1 -1
  61. data/lib/increase/resources/simulations/card_disputes.rb +2 -2
  62. data/lib/increase/resources/simulations/inbound_check_deposits.rb +4 -1
  63. data/lib/increase/resources/simulations/interest_payments.rb +1 -1
  64. data/lib/increase/resources/simulations/pending_transactions.rb +1 -1
  65. data/lib/increase/resources/simulations/physical_cards.rb +2 -2
  66. data/lib/increase/resources/simulations/programs.rb +6 -2
  67. data/lib/increase/resources/wire_transfers.rb +1 -1
  68. data/lib/increase/version.rb +1 -1
  69. data/rbi/increase/models/account_create_params.rbi +37 -21
  70. data/rbi/increase/models/account_number.rbi +3 -3
  71. data/rbi/increase/models/ach_transfer.rbi +12 -12
  72. data/rbi/increase/models/balance_lookup.rbi +1 -1
  73. data/rbi/increase/models/beneficial_owner_create_params.rbi +2 -4
  74. data/rbi/increase/models/beneficial_owner_update_params.rbi +2 -4
  75. data/rbi/increase/models/card_dispute.rbi +8 -0
  76. data/rbi/increase/models/card_dispute_submit_user_submission_params.rbi +3 -0
  77. data/rbi/increase/models/card_payment.rbi +58 -58
  78. data/rbi/increase/models/card_purchase_supplement.rbi +8 -0
  79. data/rbi/increase/models/card_token_capabilities.rbi +2 -2
  80. data/rbi/increase/models/check_deposit.rbi +9 -9
  81. data/rbi/increase/models/check_transfer.rbi +2 -2
  82. data/rbi/increase/models/check_transfer_create_params.rbi +8 -4
  83. data/rbi/increase/models/declined_transaction.rbi +16 -9
  84. data/rbi/increase/models/digital_wallet_token.rbi +8 -0
  85. data/rbi/increase/models/entity.rbi +496 -5
  86. data/rbi/increase/models/entity_create_params.rbi +547 -28
  87. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +2 -2
  88. data/rbi/increase/models/entity_update_params.rbi +814 -14
  89. data/rbi/increase/models/event.rbi +7 -0
  90. data/rbi/increase/models/event_list_params.rbi +7 -0
  91. data/rbi/increase/models/event_subscription.rbi +7 -0
  92. data/rbi/increase/models/event_subscription_create_params.rbi +7 -0
  93. data/rbi/increase/models/fednow_transfer.rbi +213 -7
  94. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  95. data/rbi/increase/models/inbound_ach_transfer.rbi +2 -2
  96. data/rbi/increase/models/inbound_check_deposit.rbi +6 -4
  97. data/rbi/increase/models/inbound_fednow_transfer.rbi +23 -0
  98. data/rbi/increase/models/inbound_mail_item.rbi +12 -0
  99. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +10 -0
  100. data/rbi/increase/models/inbound_wire_transfer.rbi +4 -4
  101. data/rbi/increase/models/intrafi_exclusion.rbi +4 -4
  102. data/rbi/increase/models/lockbox_recipient_create_params.rbi +2 -2
  103. data/rbi/increase/models/pending_transaction.rbi +20 -20
  104. data/rbi/increase/models/pending_transaction_list_params.rbi +5 -7
  105. data/rbi/increase/models/physical_card.rbi +8 -0
  106. data/rbi/increase/models/physical_card_create_params.rbi +6 -3
  107. data/rbi/increase/models/real_time_decision.rbi +18 -18
  108. data/rbi/increase/models/simulations/card_authentication_create_params.rbi +2 -2
  109. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +6 -6
  110. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +3 -3
  111. data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi +8 -23
  112. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +2 -2
  113. data/rbi/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rbi +2 -2
  114. data/rbi/increase/models/simulations/program_create_params.rbi +15 -2
  115. data/rbi/increase/models/transaction.rbi +264 -18
  116. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  117. data/rbi/increase/models/unwrap_webhook_event.rbi +7 -0
  118. data/rbi/increase/models/wire_drawdown_request.rbi +10 -0
  119. data/rbi/increase/models/wire_transfer_create_params.rbi +2 -2
  120. data/rbi/increase/resources/cards.rbi +2 -2
  121. data/rbi/increase/resources/check_transfers.rbi +1 -1
  122. data/rbi/increase/resources/entities.rbi +10 -0
  123. data/rbi/increase/resources/entity_onboarding_sessions.rbi +1 -1
  124. data/rbi/increase/resources/lockbox_recipients.rbi +1 -1
  125. data/rbi/increase/resources/physical_cards.rbi +2 -1
  126. data/rbi/increase/resources/simulations/card_authentications.rbi +1 -1
  127. data/rbi/increase/resources/simulations/card_disputes.rbi +2 -2
  128. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +4 -1
  129. data/rbi/increase/resources/simulations/interest_payments.rbi +1 -1
  130. data/rbi/increase/resources/simulations/pending_transactions.rbi +1 -1
  131. data/rbi/increase/resources/simulations/physical_cards.rbi +2 -2
  132. data/rbi/increase/resources/simulations/programs.rbi +5 -1
  133. data/rbi/increase/resources/wire_transfers.rbi +1 -1
  134. data/sig/increase/models/account_create_params.rbs +20 -12
  135. data/sig/increase/models/card_dispute.rbs +5 -0
  136. data/sig/increase/models/card_purchase_supplement.rbs +5 -0
  137. data/sig/increase/models/declined_transaction.rbs +4 -0
  138. data/sig/increase/models/digital_wallet_token.rbs +5 -0
  139. data/sig/increase/models/entity.rbs +230 -4
  140. data/sig/increase/models/entity_create_params.rbs +232 -1
  141. data/sig/increase/models/entity_update_params.rbs +366 -0
  142. data/sig/increase/models/event.rbs +4 -0
  143. data/sig/increase/models/event_list_params.rbs +4 -0
  144. data/sig/increase/models/event_subscription.rbs +4 -0
  145. data/sig/increase/models/event_subscription_create_params.rbs +4 -0
  146. data/sig/increase/models/fednow_transfer.rbs +113 -4
  147. data/sig/increase/models/fednow_transfer_list_params.rbs +4 -4
  148. data/sig/increase/models/inbound_fednow_transfer.rbs +14 -0
  149. data/sig/increase/models/inbound_mail_item.rbs +5 -0
  150. data/sig/increase/models/inbound_wire_drawdown_request.rbs +5 -0
  151. data/sig/increase/models/pending_transaction.rbs +1 -1
  152. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  153. data/sig/increase/models/physical_card.rbs +5 -0
  154. data/sig/increase/models/simulations/entity_update_validation_params.rbs +3 -3
  155. data/sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs +1 -15
  156. data/sig/increase/models/simulations/program_create_params.rbs +7 -0
  157. data/sig/increase/models/transaction.rbs +113 -0
  158. data/sig/increase/models/transaction_list_params.rbs +4 -0
  159. data/sig/increase/models/unwrap_webhook_event.rbs +4 -0
  160. data/sig/increase/models/wire_drawdown_request.rbs +5 -0
  161. data/sig/increase/resources/entities.rbs +2 -0
  162. data/sig/increase/resources/simulations/programs.rbs +1 -0
  163. metadata +2 -2
@@ -594,6 +594,27 @@ module Increase
594
594
  end
595
595
  attr_writer :fednow_transfer_acknowledgement
596
596
 
597
+ # A FedNow Transfer Return object. This field will be present in the JSON response
598
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
599
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
600
+ # by the recipient's bank.
601
+ sig do
602
+ returns(
603
+ T.nilable(Increase::Transaction::Source::FednowTransferReturn)
604
+ )
605
+ end
606
+ attr_reader :fednow_transfer_return
607
+
608
+ sig do
609
+ params(
610
+ fednow_transfer_return:
611
+ T.nilable(
612
+ Increase::Transaction::Source::FednowTransferReturn::OrHash
613
+ )
614
+ ).void
615
+ end
616
+ attr_writer :fednow_transfer_return
617
+
597
618
  # A Fee Payment object. This field will be present in the JSON response if and
598
619
  # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
599
620
  # made to Increase.
@@ -654,7 +675,7 @@ module Increase
654
675
  # An Inbound Check Adjustment object. This field will be present in the JSON
655
676
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
656
677
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
657
- # check or return deposited through Check21.
678
+ # check or return deposited through Check 21.
658
679
  sig do
659
680
  returns(
660
681
  T.nilable(Increase::Transaction::Source::InboundCheckAdjustment)
@@ -1025,6 +1046,10 @@ module Increase
1025
1046
  T.nilable(
1026
1047
  Increase::Transaction::Source::FednowTransferAcknowledgement::OrHash
1027
1048
  ),
1049
+ fednow_transfer_return:
1050
+ T.nilable(
1051
+ Increase::Transaction::Source::FednowTransferReturn::OrHash
1052
+ ),
1028
1053
  fee_payment:
1029
1054
  T.nilable(Increase::Transaction::Source::FeePayment::OrHash),
1030
1055
  inbound_ach_transfer:
@@ -1195,6 +1220,11 @@ module Increase
1195
1220
  # `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
1196
1221
  # when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
1197
1222
  fednow_transfer_acknowledgement: nil,
1223
+ # A FedNow Transfer Return object. This field will be present in the JSON response
1224
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
1225
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
1226
+ # by the recipient's bank.
1227
+ fednow_transfer_return: nil,
1198
1228
  # A Fee Payment object. This field will be present in the JSON response if and
1199
1229
  # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
1200
1230
  # made to Increase.
@@ -1213,7 +1243,7 @@ module Increase
1213
1243
  # An Inbound Check Adjustment object. This field will be present in the JSON
1214
1244
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
1215
1245
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
1216
- # check or return deposited through Check21.
1246
+ # check or return deposited through Check 21.
1217
1247
  inbound_check_adjustment: nil,
1218
1248
  # An Inbound Check Deposit Return Intention object. This field will be present in
1219
1249
  # the JSON response if and only if `category` is equal to
@@ -1342,6 +1372,8 @@ module Increase
1342
1372
  T.nilable(
1343
1373
  Increase::Transaction::Source::FednowTransferAcknowledgement
1344
1374
  ),
1375
+ fednow_transfer_return:
1376
+ T.nilable(Increase::Transaction::Source::FednowTransferReturn),
1345
1377
  fee_payment: T.nilable(Increase::Transaction::Source::FeePayment),
1346
1378
  inbound_ach_transfer:
1347
1379
  T.nilable(Increase::Transaction::Source::InboundACHTransfer),
@@ -1514,6 +1546,13 @@ module Increase
1514
1546
  Increase::Transaction::Source::Category::TaggedSymbol
1515
1547
  )
1516
1548
 
1549
+ # FedNow Transfer Return: details will be under the `fednow_transfer_return` object.
1550
+ FEDNOW_TRANSFER_RETURN =
1551
+ T.let(
1552
+ :fednow_transfer_return,
1553
+ Increase::Transaction::Source::Category::TaggedSymbol
1554
+ )
1555
+
1517
1556
  # Check Transfer Deposit: details will be under the `check_transfer_deposit` object.
1518
1557
  CHECK_TRANSFER_DEPOSIT =
1519
1558
  T.let(
@@ -3051,9 +3090,9 @@ module Increase
3051
3090
  end
3052
3091
  attr_accessor :actioner
3053
3092
 
3054
- # Additional amounts associated with the card authorization, such as ATM
3055
- # surcharges fees. These are usually a subset of the `amount` field and are used
3056
- # to provide more detailed information about the transaction.
3093
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3094
+ # fees. These are usually a subset of the `amount` field and are used to provide
3095
+ # more detailed information about the transaction.
3057
3096
  sig do
3058
3097
  returns(
3059
3098
  Increase::Transaction::Source::CardFinancial::AdditionalAmounts
@@ -3293,9 +3332,9 @@ module Increase
3293
3332
  # Whether this financial was approved by Increase, the card network through
3294
3333
  # stand-in processing, or the user through a real-time decision.
3295
3334
  actioner:,
3296
- # Additional amounts associated with the card authorization, such as ATM
3297
- # surcharges fees. These are usually a subset of the `amount` field and are used
3298
- # to provide more detailed information about the transaction.
3335
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3336
+ # fees. These are usually a subset of the `amount` field and are used to provide
3337
+ # more detailed information about the transaction.
3299
3338
  additional_amounts:,
3300
3339
  # The pending amount in the minor unit of the transaction's currency. For dollars,
3301
3340
  # for example, this is cents.
@@ -3669,9 +3708,9 @@ module Increase
3669
3708
  end
3670
3709
  attr_writer :vision
3671
3710
 
3672
- # Additional amounts associated with the card authorization, such as ATM
3673
- # surcharges fees. These are usually a subset of the `amount` field and are used
3674
- # to provide more detailed information about the transaction.
3711
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3712
+ # fees. These are usually a subset of the `amount` field and are used to provide
3713
+ # more detailed information about the transaction.
3675
3714
  sig do
3676
3715
  params(
3677
3716
  clinic:
@@ -12167,7 +12206,7 @@ module Increase
12167
12206
 
12168
12207
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
12169
12208
  # bank depositing this check. In some rare cases, this is not transmitted via
12170
- # Check21 and the value will be null.
12209
+ # Check 21 and the value will be null.
12171
12210
  sig { returns(T.nilable(String)) }
12172
12211
  attr_accessor :bank_of_first_deposit_routing_number
12173
12212
 
@@ -12225,7 +12264,7 @@ module Increase
12225
12264
  back_image_file_id:,
12226
12265
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
12227
12266
  # bank depositing this check. In some rare cases, this is not transmitted via
12228
- # Check21 and the value will be null.
12267
+ # Check 21 and the value will be null.
12229
12268
  bank_of_first_deposit_routing_number:,
12230
12269
  # When the check was deposited.
12231
12270
  deposited_at:,
@@ -12324,6 +12363,211 @@ module Increase
12324
12363
  end
12325
12364
  end
12326
12365
 
12366
+ class FednowTransferReturn < Increase::Internal::Type::BaseModel
12367
+ OrHash =
12368
+ T.type_alias do
12369
+ T.any(
12370
+ Increase::Transaction::Source::FednowTransferReturn,
12371
+ Increase::Internal::AnyHash
12372
+ )
12373
+ end
12374
+
12375
+ # The returned amount in USD cents. This is always a positive number.
12376
+ sig { returns(Integer) }
12377
+ attr_accessor :amount
12378
+
12379
+ # Additional information about the return provided by the recipient's bank.
12380
+ sig { returns(T.nilable(String)) }
12381
+ attr_accessor :return_reason_additional_information
12382
+
12383
+ # The reason the transfer was returned as provided by the recipient's bank.
12384
+ sig do
12385
+ returns(
12386
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12387
+ )
12388
+ end
12389
+ attr_accessor :return_reason_code
12390
+
12391
+ # The identifier of the FedNow Transfer that led to this Transaction.
12392
+ sig { returns(String) }
12393
+ attr_accessor :transfer_id
12394
+
12395
+ # A FedNow Transfer Return object. This field will be present in the JSON response
12396
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
12397
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
12398
+ # by the recipient's bank.
12399
+ sig do
12400
+ params(
12401
+ amount: Integer,
12402
+ return_reason_additional_information: T.nilable(String),
12403
+ return_reason_code:
12404
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::OrSymbol,
12405
+ transfer_id: String
12406
+ ).returns(T.attached_class)
12407
+ end
12408
+ def self.new(
12409
+ # The returned amount in USD cents. This is always a positive number.
12410
+ amount:,
12411
+ # Additional information about the return provided by the recipient's bank.
12412
+ return_reason_additional_information:,
12413
+ # The reason the transfer was returned as provided by the recipient's bank.
12414
+ return_reason_code:,
12415
+ # The identifier of the FedNow Transfer that led to this Transaction.
12416
+ transfer_id:
12417
+ )
12418
+ end
12419
+
12420
+ sig do
12421
+ override.returns(
12422
+ {
12423
+ amount: Integer,
12424
+ return_reason_additional_information: T.nilable(String),
12425
+ return_reason_code:
12426
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol,
12427
+ transfer_id: String
12428
+ }
12429
+ )
12430
+ end
12431
+ def to_hash
12432
+ end
12433
+
12434
+ # The reason the transfer was returned as provided by the recipient's bank.
12435
+ module ReturnReasonCode
12436
+ extend Increase::Internal::Type::Enum
12437
+
12438
+ TaggedSymbol =
12439
+ T.type_alias do
12440
+ T.all(
12441
+ Symbol,
12442
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode
12443
+ )
12444
+ end
12445
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
12446
+
12447
+ # The destination account is closed. Corresponds to the FedNow reason codes `AC04` and `AC07`.
12448
+ ACCOUNT_CLOSED =
12449
+ T.let(
12450
+ :account_closed,
12451
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12452
+ )
12453
+
12454
+ # The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.
12455
+ ACCOUNT_BLOCKED =
12456
+ T.let(
12457
+ :account_blocked,
12458
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12459
+ )
12460
+
12461
+ # The recipient's bank was not a valid agent for this transfer. Corresponds to the FedNow reason codes `AC14` and `AGNT`.
12462
+ INVALID_AGENT =
12463
+ T.let(
12464
+ :invalid_agent,
12465
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12466
+ )
12467
+
12468
+ # The destination account does not exist. Corresponds to the FedNow reason code `AC03`.
12469
+ INVALID_CREDITOR_ACCOUNT_NUMBER =
12470
+ T.let(
12471
+ :invalid_creditor_account_number,
12472
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12473
+ )
12474
+
12475
+ # The destination account number was incorrect. Corresponds to the FedNow reason code `AC01`.
12476
+ INCORRECT_ACCOUNT_NUMBER =
12477
+ T.let(
12478
+ :incorrect_account_number,
12479
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12480
+ )
12481
+
12482
+ # The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.
12483
+ END_CUSTOMER_DECEASED =
12484
+ T.let(
12485
+ :end_customer_deceased,
12486
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12487
+ )
12488
+
12489
+ # The transfer was not permitted by the recipient's bank. Corresponds to the FedNow reason code `AG01`.
12490
+ TRANSACTION_FORBIDDEN =
12491
+ T.let(
12492
+ :transaction_forbidden,
12493
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12494
+ )
12495
+
12496
+ # The transfer was returned for a regulatory reason at the recipient's bank. Corresponds to the FedNow reason code `RR04`.
12497
+ REGULATORY_REASON =
12498
+ T.let(
12499
+ :regulatory_reason,
12500
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12501
+ )
12502
+
12503
+ # The transfer was reported as fraudulent. Corresponds to the FedNow reason code `FR01`.
12504
+ FRAUD =
12505
+ T.let(
12506
+ :fraud,
12507
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12508
+ )
12509
+
12510
+ # The transfer duplicated another transfer. Corresponds to the FedNow reason codes `AM05` and `DUPL`.
12511
+ DUPLICATION =
12512
+ T.let(
12513
+ :duplication,
12514
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12515
+ )
12516
+
12517
+ # The transfer amount was incorrect. Corresponds to the FedNow reason code `AM09`.
12518
+ WRONG_AMOUNT =
12519
+ T.let(
12520
+ :wrong_amount,
12521
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12522
+ )
12523
+
12524
+ # The transfer was returned at the request of the recipient's customer. Corresponds to the FedNow reason code `CUST`.
12525
+ REQUESTED_BY_CUSTOMER =
12526
+ T.let(
12527
+ :requested_by_customer,
12528
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12529
+ )
12530
+
12531
+ # The recipient's bank could not apply the funds. Corresponds to the FedNow reason code `RUTA`.
12532
+ UNABLE_TO_APPLY =
12533
+ T.let(
12534
+ :unable_to_apply,
12535
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12536
+ )
12537
+
12538
+ # The recipient's bank did not specify a reason. Corresponds to the FedNow reason codes `MS02` and `MS03`.
12539
+ NOT_SPECIFIED =
12540
+ T.let(
12541
+ :not_specified,
12542
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12543
+ )
12544
+
12545
+ # The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.
12546
+ NARRATIVE =
12547
+ T.let(
12548
+ :narrative,
12549
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12550
+ )
12551
+
12552
+ # The transfer was returned for some other reason.
12553
+ OTHER =
12554
+ T.let(
12555
+ :other,
12556
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12557
+ )
12558
+
12559
+ sig do
12560
+ override.returns(
12561
+ T::Array[
12562
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12563
+ ]
12564
+ )
12565
+ end
12566
+ def self.values
12567
+ end
12568
+ end
12569
+ end
12570
+
12327
12571
  class FeePayment < Increase::Internal::Type::BaseModel
12328
12572
  OrHash =
12329
12573
  T.type_alias do
@@ -12808,7 +13052,8 @@ module Increase
12808
13052
  sig { returns(String) }
12809
13053
  attr_accessor :adjusted_transaction_id
12810
13054
 
12811
- # The amount of the check adjustment.
13055
+ # The amount of the check adjustment in USD cents. A positive amount is a credit
13056
+ # to your account and a negative amount is a debit.
12812
13057
  sig { returns(Integer) }
12813
13058
  attr_accessor :amount
12814
13059
 
@@ -12823,7 +13068,7 @@ module Increase
12823
13068
  # An Inbound Check Adjustment object. This field will be present in the JSON
12824
13069
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
12825
13070
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
12826
- # check or return deposited through Check21.
13071
+ # check or return deposited through Check 21.
12827
13072
  sig do
12828
13073
  params(
12829
13074
  adjusted_transaction_id: String,
@@ -12835,7 +13080,8 @@ module Increase
12835
13080
  def self.new(
12836
13081
  # The ID of the transaction that was adjusted.
12837
13082
  adjusted_transaction_id:,
12838
- # The amount of the check adjustment.
13083
+ # The amount of the check adjustment in USD cents. A positive amount is a credit
13084
+ # to your account and a negative amount is a debit.
12839
13085
  amount:,
12840
13086
  # The reason for the adjustment.
12841
13087
  reason:
@@ -13350,7 +13596,7 @@ module Increase
13350
13596
  sig { returns(T.nilable(String)) }
13351
13597
  attr_accessor :input_message_accountability_data
13352
13598
 
13353
- # The American Banking Association (ABA) routing number of the bank that sent the
13599
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
13354
13600
  # wire.
13355
13601
  sig { returns(T.nilable(String)) }
13356
13602
  attr_accessor :instructing_agent_routing_number
@@ -13430,7 +13676,7 @@ module Increase
13430
13676
  # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
13431
13677
  # service and is helpful when debugging wires with the originating bank.
13432
13678
  input_message_accountability_data:,
13433
- # The American Banking Association (ABA) routing number of the bank that sent the
13679
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
13434
13680
  # wire.
13435
13681
  instructing_agent_routing_number:,
13436
13682
  # The sending bank's identifier for the wire transfer.
@@ -275,6 +275,13 @@ module Increase
275
275
  Increase::TransactionListParams::Category::In::TaggedSymbol
276
276
  )
277
277
 
278
+ # FedNow Transfer Return: details will be under the `fednow_transfer_return` object.
279
+ FEDNOW_TRANSFER_RETURN =
280
+ T.let(
281
+ :fednow_transfer_return,
282
+ Increase::TransactionListParams::Category::In::TaggedSymbol
283
+ )
284
+
278
285
  # Check Transfer Deposit: details will be under the `check_transfer_deposit` object.
279
286
  CHECK_TRANSFER_DEPOSIT =
280
287
  T.let(
@@ -783,6 +783,13 @@ module Increase
783
783
  Increase::UnwrapWebhookEvent::Category::TaggedSymbol
784
784
  )
785
785
 
786
+ # Occurs whenever a Plaid Processor Token is created.
787
+ PLAID_PROCESSOR_TOKEN_CREATED =
788
+ T.let(
789
+ :"plaid_processor_token.created",
790
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
791
+ )
792
+
786
793
  # Occurs whenever a Checkbook is created.
787
794
  CHECKBOOK_CREATED =
788
795
  T.let(
@@ -12,6 +12,11 @@ module Increase
12
12
  sig { returns(String) }
13
13
  attr_accessor :id
14
14
 
15
+ # The Account to which the debtor—the recipient of this request—is being requested
16
+ # to send funds.
17
+ sig { returns(String) }
18
+ attr_accessor :account_id
19
+
15
20
  # The Account Number to which the debtor—the recipient of this request—is being
16
21
  # requested to send funds.
17
22
  sig { returns(String) }
@@ -131,6 +136,7 @@ module Increase
131
136
  sig do
132
137
  params(
133
138
  id: String,
139
+ account_id: String,
134
140
  account_number_id: String,
135
141
  amount: Integer,
136
142
  created_at: Time,
@@ -157,6 +163,9 @@ module Increase
157
163
  def self.new(
158
164
  # The Wire drawdown request identifier.
159
165
  id:,
166
+ # The Account to which the debtor—the recipient of this request—is being requested
167
+ # to send funds.
168
+ account_id:,
160
169
  # The Account Number to which the debtor—the recipient of this request—is being
161
170
  # requested to send funds.
162
171
  account_number_id:,
@@ -213,6 +222,7 @@ module Increase
213
222
  override.returns(
214
223
  {
215
224
  id: String,
225
+ account_id: String,
216
226
  account_number_id: String,
217
227
  amount: Integer,
218
228
  created_at: Time,
@@ -90,7 +90,7 @@ module Increase
90
90
  sig { params(routing_number: String).void }
91
91
  attr_writer :routing_number
92
92
 
93
- # The ID of an Account Number that will be passed to the wire's recipient
93
+ # The ID of an Account Number that will be passed to the wire's recipient.
94
94
  sig { returns(T.nilable(String)) }
95
95
  attr_reader :source_account_number_id
96
96
 
@@ -139,7 +139,7 @@ module Increase
139
139
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
140
140
  # destination account.
141
141
  routing_number: nil,
142
- # The ID of an Account Number that will be passed to the wire's recipient
142
+ # The ID of an Account Number that will be passed to the wire's recipient.
143
143
  source_account_number_id: nil,
144
144
  request_options: {}
145
145
  )
@@ -145,8 +145,8 @@ module Increase
145
145
  )
146
146
  end
147
147
 
148
- # Sensitive details for a Card include the primary account number, expiry, card
149
- # verification code, and PIN.
148
+ # Sensitive details for a Card include the primary account number, expiration,
149
+ # card verification code, and PIN.
150
150
  sig do
151
151
  params(
152
152
  card_id: String,
@@ -52,7 +52,7 @@ module Increase
52
52
  # If provided, the check will be valid on or before this date. After this date,
53
53
  # the check transfer will be automatically stopped and deposits will not be
54
54
  # accepted. For checks printed by Increase, this date is included on the check as
55
- # its expiry.
55
+ # its expiration.
56
56
  valid_until_date: nil,
57
57
  request_options: {}
58
58
  )
@@ -14,6 +14,8 @@ module Increase
14
14
  joint: Increase::EntityCreateParams::Joint::OrHash,
15
15
  natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
16
16
  risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
17
+ sole_proprietorship:
18
+ Increase::EntityCreateParams::SoleProprietorship::OrHash,
17
19
  supplemental_documents:
18
20
  T::Array[
19
21
  Increase::EntityCreateParams::SupplementalDocument::OrHash
@@ -48,6 +50,9 @@ module Increase
48
50
  # An assessment of the entity's potential risk of involvement in financial crimes,
49
51
  # such as money laundering.
50
52
  risk_rating: nil,
53
+ # Details of the sole proprietorship entity to create. Required if `structure` is
54
+ # equal to `sole_proprietorship`.
55
+ sole_proprietorship: nil,
51
56
  # Additional documentation associated with the entity.
52
57
  supplemental_documents: nil,
53
58
  # The terms that the Entity agreed to. Not all programs are required to submit
@@ -88,6 +93,8 @@ module Increase
88
93
  Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
89
94
  natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
90
95
  risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
96
+ sole_proprietorship:
97
+ Increase::EntityUpdateParams::SoleProprietorship::OrHash,
91
98
  terms_agreements:
92
99
  T::Array[Increase::EntityUpdateParams::TermsAgreement::OrHash],
93
100
  third_party_verification:
@@ -115,6 +122,9 @@ module Increase
115
122
  # An assessment of the entity’s potential risk of involvement in financial crimes,
116
123
  # such as money laundering.
117
124
  risk_rating: nil,
125
+ # Details of the sole proprietorship entity to update. If you specify this
126
+ # parameter and the entity is not a sole proprietorship, the request will fail.
127
+ sole_proprietorship: nil,
118
128
  # New terms that the Entity agreed to. Not all programs are required to submit
119
129
  # this data. This will not archive previously submitted terms.
120
130
  terms_agreements: nil,
@@ -41,7 +41,7 @@ module Increase
41
41
  )
42
42
  end
43
43
 
44
- # List Entity Onboarding Session
44
+ # List Entity Onboarding Sessions
45
45
  sig do
46
46
  params(
47
47
  cursor: String,
@@ -21,7 +21,7 @@ module Increase
21
21
  lockbox_address_id:,
22
22
  # The description you choose for the Lockbox Recipient.
23
23
  description: nil,
24
- # The name of the Lockbox Recipient
24
+ # The name of the Lockbox Recipient.
25
25
  recipient_name: nil,
26
26
  request_options: {}
27
27
  )
@@ -16,7 +16,8 @@ module Increase
16
16
  def create(
17
17
  # The underlying card representing this physical card.
18
18
  card_id:,
19
- # Details about the cardholder, as it will appear on the physical card.
19
+ # Details about the cardholder, as it will appear on the physical card. The
20
+ # combined first name and last name cannot exceed 25 characters.
20
21
  cardholder:,
21
22
  # The details used to ship this physical card.
22
23
  shipment:,
@@ -37,7 +37,7 @@ module Increase
37
37
  merchant_category_code: nil,
38
38
  # The country the merchant resides in.
39
39
  merchant_country: nil,
40
- # The name of the merchant
40
+ # The name of the merchant.
41
41
  merchant_name: nil,
42
42
  # The purchase amount in cents.
43
43
  purchase_amount: nil,
@@ -23,8 +23,8 @@ module Increase
23
23
  # The network of the Card Dispute. Details specific to the network are required
24
24
  # under the sub-object with the same identifier as the network.
25
25
  network:,
26
- # The Visa-specific parameters for the taking action on the dispute. Required if
27
- # and only if `network` is `visa`.
26
+ # The Visa-specific parameters for taking action on the dispute. Required if and
27
+ # only if `network` is `visa`.
28
28
  visa: nil,
29
29
  request_options: {}
30
30
  )
@@ -50,7 +50,10 @@ module Increase
50
50
  def adjustment(
51
51
  # The identifier of the Inbound Check Deposit to adjust.
52
52
  inbound_check_deposit_id,
53
- # The adjustment amount in cents. Defaults to the amount of the Inbound Check
53
+ # The adjustment amount in cents. A positive amount means that the funds are being
54
+ # returned to you by the other bank and is a credit to your account, as happens
55
+ # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
56
+ # happens for a `late_return`. Defaults to the amount of the Inbound Check
54
57
  # Deposit.
55
58
  amount: nil,
56
59
  # The reason for the adjustment. Defaults to `wrong_payee_credit`.
@@ -17,7 +17,7 @@ module Increase
17
17
  ).returns(Increase::Transaction)
18
18
  end
19
19
  def create(
20
- # The identifier of the Account the Interest Payment should be paid to is for.
20
+ # The identifier of the Account the Interest Payment should be paid to.
21
21
  account_id:,
22
22
  # The interest amount in cents. Must be positive.
23
23
  amount:,
@@ -13,7 +13,7 @@ module Increase
13
13
  ).returns(Increase::PendingTransaction)
14
14
  end
15
15
  def release_inbound_funds_hold(
16
- # The pending transaction to release. The pending transaction must have a
16
+ # The pending transaction to release. The pending transaction must have an
17
17
  # `inbound_funds_hold` source.
18
18
  pending_transaction_id,
19
19
  request_options: {}
@@ -37,8 +37,8 @@ module Increase
37
37
  end
38
38
 
39
39
  # This endpoint allows you to simulate advancing the shipment status of a Physical
40
- # Card, to simulate e.g., that a physical card was attempted shipped but then
41
- # failed delivery.
40
+ # Card, to simulate e.g., that a physical card was attempted to be shipped but
41
+ # then failed delivery.
42
42
  sig do
43
43
  params(
44
44
  physical_card_id: String,
@@ -13,6 +13,7 @@ module Increase
13
13
  name: String,
14
14
  bank: Increase::Simulations::ProgramCreateParams::Bank::OrSymbol,
15
15
  lending_maximum_extendable_credit: Integer,
16
+ loan_accounts_require_loan_offers: T::Boolean,
16
17
  reserve_account_id: String,
17
18
  request_options: Increase::RequestOptions::OrHash
18
19
  ).returns(Increase::Program)
@@ -24,7 +25,10 @@ module Increase
24
25
  bank: nil,
25
26
  # The maximum extendable credit of the program being added.
26
27
  lending_maximum_extendable_credit: nil,
27
- # The identifier of the Account the Program should be added to is for.
28
+ # Whether opening a loan Account under this Program requires an accepted Loan
29
+ # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
30
+ loan_accounts_require_loan_offers: nil,
31
+ # The identifier of the Account the Program should be added to.
28
32
  reserve_account_id: nil,
29
33
  request_options: {}
30
34
  )