increase 1.349.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 (134) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_number.rb +3 -3
  4. data/lib/increase/models/ach_transfer.rb +12 -12
  5. data/lib/increase/models/balance_lookup.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_create_params.rb +2 -4
  7. data/lib/increase/models/beneficial_owner_update_params.rb +2 -4
  8. data/lib/increase/models/card_dispute.rb +9 -1
  9. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +4 -0
  10. data/lib/increase/models/card_payment.rb +58 -58
  11. data/lib/increase/models/card_purchase_supplement.rb +9 -1
  12. data/lib/increase/models/card_token_capabilities.rb +2 -2
  13. data/lib/increase/models/check_deposit.rb +9 -9
  14. data/lib/increase/models/check_transfer.rb +2 -2
  15. data/lib/increase/models/check_transfer_create_params.rb +9 -4
  16. data/lib/increase/models/declined_transaction.rb +12 -9
  17. data/lib/increase/models/digital_wallet_token.rb +9 -1
  18. data/lib/increase/models/entity.rb +5 -5
  19. data/lib/increase/models/entity_create_params.rb +332 -29
  20. data/lib/increase/models/entity_onboarding_session_list_params.rb +2 -2
  21. data/lib/increase/models/entity_update_params.rb +472 -15
  22. data/lib/increase/models/fednow_transfer.rb +115 -4
  23. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  24. data/lib/increase/models/inbound_ach_transfer.rb +2 -2
  25. data/lib/increase/models/inbound_check_deposit.rb +2 -2
  26. data/lib/increase/models/inbound_fednow_transfer.rb +3 -0
  27. data/lib/increase/models/inbound_mail_item.rb +14 -1
  28. data/lib/increase/models/inbound_wire_drawdown_request.rb +12 -1
  29. data/lib/increase/models/inbound_wire_transfer.rb +4 -4
  30. data/lib/increase/models/intrafi_exclusion.rb +4 -4
  31. data/lib/increase/models/lockbox_recipient_create_params.rb +2 -2
  32. data/lib/increase/models/pending_transaction.rb +13 -13
  33. data/lib/increase/models/pending_transaction_list_params.rb +4 -6
  34. data/lib/increase/models/physical_card.rb +9 -1
  35. data/lib/increase/models/real_time_decision.rb +18 -18
  36. data/lib/increase/models/simulations/card_authentication_create_params.rb +2 -2
  37. data/lib/increase/models/simulations/card_dispute_action_params.rb +6 -6
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -3
  39. data/lib/increase/models/simulations/interest_payment_create_params.rb +2 -2
  40. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +2 -2
  41. data/lib/increase/models/simulations/program_create_params.rb +14 -3
  42. data/lib/increase/models/transaction.rb +141 -17
  43. data/lib/increase/models/transaction_list_params.rb +3 -0
  44. data/lib/increase/models/wire_drawdown_request.rb +12 -1
  45. data/lib/increase/models/wire_transfer_create_params.rb +2 -2
  46. data/lib/increase/resources/cards.rb +2 -2
  47. data/lib/increase/resources/check_transfers.rb +1 -1
  48. data/lib/increase/resources/entities.rb +10 -2
  49. data/lib/increase/resources/entity_onboarding_sessions.rb +1 -1
  50. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  51. data/lib/increase/resources/simulations/card_authentications.rb +1 -1
  52. data/lib/increase/resources/simulations/card_disputes.rb +2 -2
  53. data/lib/increase/resources/simulations/interest_payments.rb +1 -1
  54. data/lib/increase/resources/simulations/pending_transactions.rb +1 -1
  55. data/lib/increase/resources/simulations/physical_cards.rb +2 -2
  56. data/lib/increase/resources/simulations/programs.rb +6 -2
  57. data/lib/increase/resources/wire_transfers.rb +1 -1
  58. data/lib/increase/version.rb +1 -1
  59. data/rbi/increase/models/account_number.rbi +3 -3
  60. data/rbi/increase/models/ach_transfer.rbi +12 -12
  61. data/rbi/increase/models/balance_lookup.rbi +1 -1
  62. data/rbi/increase/models/beneficial_owner_create_params.rbi +2 -4
  63. data/rbi/increase/models/beneficial_owner_update_params.rbi +2 -4
  64. data/rbi/increase/models/card_dispute.rbi +8 -0
  65. data/rbi/increase/models/card_dispute_submit_user_submission_params.rbi +3 -0
  66. data/rbi/increase/models/card_payment.rbi +58 -58
  67. data/rbi/increase/models/card_purchase_supplement.rbi +8 -0
  68. data/rbi/increase/models/card_token_capabilities.rbi +2 -2
  69. data/rbi/increase/models/check_deposit.rbi +9 -9
  70. data/rbi/increase/models/check_transfer.rbi +2 -2
  71. data/rbi/increase/models/check_transfer_create_params.rbi +8 -4
  72. data/rbi/increase/models/declined_transaction.rbi +16 -9
  73. data/rbi/increase/models/digital_wallet_token.rbi +8 -0
  74. data/rbi/increase/models/entity.rbi +5 -5
  75. data/rbi/increase/models/entity_create_params.rbi +547 -28
  76. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +2 -2
  77. data/rbi/increase/models/entity_update_params.rbi +814 -14
  78. data/rbi/increase/models/fednow_transfer.rbi +213 -7
  79. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  80. data/rbi/increase/models/inbound_ach_transfer.rbi +2 -2
  81. data/rbi/increase/models/inbound_check_deposit.rbi +2 -2
  82. data/rbi/increase/models/inbound_fednow_transfer.rbi +7 -0
  83. data/rbi/increase/models/inbound_mail_item.rbi +12 -0
  84. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +10 -0
  85. data/rbi/increase/models/inbound_wire_transfer.rbi +4 -4
  86. data/rbi/increase/models/intrafi_exclusion.rbi +4 -4
  87. data/rbi/increase/models/lockbox_recipient_create_params.rbi +2 -2
  88. data/rbi/increase/models/pending_transaction.rbi +13 -13
  89. data/rbi/increase/models/pending_transaction_list_params.rbi +4 -6
  90. data/rbi/increase/models/physical_card.rbi +8 -0
  91. data/rbi/increase/models/real_time_decision.rbi +18 -18
  92. data/rbi/increase/models/simulations/card_authentication_create_params.rbi +2 -2
  93. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +6 -6
  94. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +3 -3
  95. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +2 -2
  96. data/rbi/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rbi +2 -2
  97. data/rbi/increase/models/simulations/program_create_params.rbi +15 -2
  98. data/rbi/increase/models/transaction.rbi +260 -16
  99. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  100. data/rbi/increase/models/wire_drawdown_request.rbi +10 -0
  101. data/rbi/increase/models/wire_transfer_create_params.rbi +2 -2
  102. data/rbi/increase/resources/cards.rbi +2 -2
  103. data/rbi/increase/resources/check_transfers.rbi +1 -1
  104. data/rbi/increase/resources/entities.rbi +10 -0
  105. data/rbi/increase/resources/entity_onboarding_sessions.rbi +1 -1
  106. data/rbi/increase/resources/lockbox_recipients.rbi +1 -1
  107. data/rbi/increase/resources/simulations/card_authentications.rbi +1 -1
  108. data/rbi/increase/resources/simulations/card_disputes.rbi +2 -2
  109. data/rbi/increase/resources/simulations/interest_payments.rbi +1 -1
  110. data/rbi/increase/resources/simulations/pending_transactions.rbi +1 -1
  111. data/rbi/increase/resources/simulations/physical_cards.rbi +2 -2
  112. data/rbi/increase/resources/simulations/programs.rbi +5 -1
  113. data/rbi/increase/resources/wire_transfers.rbi +1 -1
  114. data/sig/increase/models/card_dispute.rbs +5 -0
  115. data/sig/increase/models/card_purchase_supplement.rbs +5 -0
  116. data/sig/increase/models/declined_transaction.rbs +4 -0
  117. data/sig/increase/models/digital_wallet_token.rbs +5 -0
  118. data/sig/increase/models/entity.rbs +3 -3
  119. data/sig/increase/models/entity_create_params.rbs +232 -1
  120. data/sig/increase/models/entity_update_params.rbs +366 -0
  121. data/sig/increase/models/fednow_transfer.rbs +113 -4
  122. data/sig/increase/models/fednow_transfer_list_params.rbs +4 -4
  123. data/sig/increase/models/inbound_fednow_transfer.rbs +4 -0
  124. data/sig/increase/models/inbound_mail_item.rbs +5 -0
  125. data/sig/increase/models/inbound_wire_drawdown_request.rbs +5 -0
  126. data/sig/increase/models/physical_card.rbs +5 -0
  127. data/sig/increase/models/simulations/entity_update_validation_params.rbs +3 -3
  128. data/sig/increase/models/simulations/program_create_params.rbs +7 -0
  129. data/sig/increase/models/transaction.rbs +113 -0
  130. data/sig/increase/models/transaction_list_params.rbs +4 -0
  131. data/sig/increase/models/wire_drawdown_request.rbs +5 -0
  132. data/sig/increase/resources/entities.rbs +2 -0
  133. data/sig/increase/resources/simulations/programs.rbs +1 -0
  134. metadata +2 -2
@@ -48,13 +48,13 @@ module Increase
48
48
  module Category
49
49
  extend Increase::Internal::Type::Enum
50
50
 
51
- # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
51
+ # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity).
52
52
  ENTITY_TAX_IDENTIFIER = :entity_tax_identifier
53
53
 
54
- # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
54
+ # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity).
55
55
  ENTITY_ADDRESS = :entity_address
56
56
 
57
- # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
57
+ # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity).
58
58
  ENTITY_IDENTITY = :entity_identity
59
59
 
60
60
  # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
@@ -9,7 +9,7 @@ module Increase
9
9
  include Increase::Internal::Type::RequestParameters
10
10
 
11
11
  # @!attribute account_id
12
- # The identifier of the Account the Interest Payment should be paid to is for.
12
+ # The identifier of the Account the Interest Payment should be paid to.
13
13
  #
14
14
  # @return [String]
15
15
  required :account_id, String
@@ -39,7 +39,7 @@ module Increase
39
39
  optional :period_start, Time
40
40
 
41
41
  # @!method initialize(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {})
42
- # @param account_id [String] The identifier of the Account the Interest Payment should be paid to is for.
42
+ # @param account_id [String] The identifier of the Account the Interest Payment should be paid to.
43
43
  #
44
44
  # @param amount [Integer] The interest amount in cents. Must be positive.
45
45
  #
@@ -9,7 +9,7 @@ module Increase
9
9
  include Increase::Internal::Type::RequestParameters
10
10
 
11
11
  # @!attribute pending_transaction_id
12
- # The pending transaction to release. The pending transaction must have a
12
+ # The pending transaction to release. The pending transaction must have an
13
13
  # `inbound_funds_hold` source.
14
14
  #
15
15
  # @return [String]
@@ -17,7 +17,7 @@ module Increase
17
17
 
18
18
  # @!method initialize(pending_transaction_id:, request_options: {})
19
19
  # @param pending_transaction_id [String]
20
- # The pending transaction to release. The pending transaction must have a
20
+ # The pending transaction to release. The pending transaction must have an
21
21
  # `inbound_funds_hold` source.
22
22
  #
23
23
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
@@ -26,13 +26,20 @@ module Increase
26
26
  # @return [Integer, nil]
27
27
  optional :lending_maximum_extendable_credit, Integer
28
28
 
29
+ # @!attribute loan_accounts_require_loan_offers
30
+ # Whether opening a loan Account under this Program requires an accepted Loan
31
+ # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
32
+ #
33
+ # @return [Boolean, nil]
34
+ optional :loan_accounts_require_loan_offers, Increase::Internal::Type::Boolean
35
+
29
36
  # @!attribute reserve_account_id
30
- # The identifier of the Account the Program should be added to is for.
37
+ # The identifier of the Account the Program should be added to.
31
38
  #
32
39
  # @return [String, nil]
33
40
  optional :reserve_account_id, String
34
41
 
35
- # @!method initialize(name:, bank: nil, lending_maximum_extendable_credit: nil, reserve_account_id: nil, request_options: {})
42
+ # @!method initialize(name:, bank: nil, lending_maximum_extendable_credit: nil, loan_accounts_require_loan_offers: nil, reserve_account_id: nil, request_options: {})
36
43
  # @param name [String] The name of the program being added.
37
44
  #
38
45
  # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank]
@@ -41,7 +48,11 @@ module Increase
41
48
  # @param lending_maximum_extendable_credit [Integer]
42
49
  # The maximum extendable credit of the program being added.
43
50
  #
44
- # @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
51
+ # @param loan_accounts_require_loan_offers [Boolean]
52
+ # Whether opening a loan Account under this Program requires an accepted Loan
53
+ # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
54
+ #
55
+ # @param reserve_account_id [String] The identifier of the Account the Program should be added to.
45
56
  #
46
57
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
47
58
 
@@ -381,6 +381,19 @@ module Increase
381
381
  -> { Increase::Transaction::Source::FednowTransferAcknowledgement },
382
382
  nil?: true
383
383
 
384
+ # @!attribute fednow_transfer_return
385
+ # A FedNow Transfer Return object. This field will be present in the JSON response
386
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
387
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
388
+ # by the recipient's bank.
389
+ #
390
+ # @return [Increase::Models::Transaction::Source::FednowTransferReturn, nil]
391
+ optional :fednow_transfer_return,
392
+ -> {
393
+ Increase::Transaction::Source::FednowTransferReturn
394
+ },
395
+ nil?: true
396
+
384
397
  # @!attribute fee_payment
385
398
  # A Fee Payment object. This field will be present in the JSON response if and
386
399
  # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
@@ -414,7 +427,7 @@ module Increase
414
427
  # An Inbound Check Adjustment object. This field will be present in the JSON
415
428
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
416
429
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
417
- # check or return deposited through Check21.
430
+ # check or return deposited through Check 21.
418
431
  #
419
432
  # @return [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil]
420
433
  optional :inbound_check_adjustment,
@@ -562,7 +575,7 @@ module Increase
562
575
  },
563
576
  nil?: true
564
577
 
565
- # @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, swift_transfer_intention: nil, swift_transfer_return: nil, wire_transfer_intention: nil)
578
+ # @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fednow_transfer_return: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, swift_transfer_intention: nil, swift_transfer_return: nil, wire_transfer_intention: nil)
566
579
  # This is an object giving more details on the network-level event that caused the
567
580
  # Transaction. Note that for backwards compatibility reasons, additional
568
581
  # undocumented keys may appear in this object. These should be treated as
@@ -695,6 +708,12 @@ module Increase
695
708
  # `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
696
709
  # when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
697
710
  #
711
+ # @param fednow_transfer_return [Increase::Models::Transaction::Source::FednowTransferReturn, nil]
712
+ # A FedNow Transfer Return object. This field will be present in the JSON response
713
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
714
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
715
+ # by the recipient's bank.
716
+ #
698
717
  # @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil]
699
718
  # A Fee Payment object. This field will be present in the JSON response if and
700
719
  # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
@@ -717,7 +736,7 @@ module Increase
717
736
  # An Inbound Check Adjustment object. This field will be present in the JSON
718
737
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
719
738
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
720
- # check or return deposited through Check21.
739
+ # check or return deposited through Check 21.
721
740
  #
722
741
  # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil]
723
742
  # An Inbound Check Deposit Return Intention object. This field will be present in
@@ -854,6 +873,9 @@ module Increase
854
873
  # FedNow Transfer Acknowledgement: details will be under the `fednow_transfer_acknowledgement` object.
855
874
  FEDNOW_TRANSFER_ACKNOWLEDGEMENT = :fednow_transfer_acknowledgement
856
875
 
876
+ # FedNow Transfer Return: details will be under the `fednow_transfer_return` object.
877
+ FEDNOW_TRANSFER_RETURN = :fednow_transfer_return
878
+
857
879
  # Check Transfer Deposit: details will be under the `check_transfer_deposit` object.
858
880
  CHECK_TRANSFER_DEPOSIT = :check_transfer_deposit
859
881
 
@@ -1678,9 +1700,9 @@ module Increase
1678
1700
  required :actioner, enum: -> { Increase::Transaction::Source::CardFinancial::Actioner }
1679
1701
 
1680
1702
  # @!attribute additional_amounts
1681
- # Additional amounts associated with the card authorization, such as ATM
1682
- # surcharges fees. These are usually a subset of the `amount` field and are used
1683
- # to provide more detailed information about the transaction.
1703
+ # Additional amounts associated with the card authorization, such as ATM surcharge
1704
+ # fees. These are usually a subset of the `amount` field and are used to provide
1705
+ # more detailed information about the transaction.
1684
1706
  #
1685
1707
  # @return [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts]
1686
1708
  required :additional_amounts, -> { Increase::Transaction::Source::CardFinancial::AdditionalAmounts }
@@ -1866,9 +1888,9 @@ module Increase
1866
1888
  # stand-in processing, or the user through a real-time decision.
1867
1889
  #
1868
1890
  # @param additional_amounts [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts]
1869
- # Additional amounts associated with the card authorization, such as ATM
1870
- # surcharges fees. These are usually a subset of the `amount` field and are used
1871
- # to provide more detailed information about the transaction.
1891
+ # Additional amounts associated with the card authorization, such as ATM surcharge
1892
+ # fees. These are usually a subset of the `amount` field and are used to provide
1893
+ # more detailed information about the transaction.
1872
1894
  #
1873
1895
  # @param amount [Integer]
1874
1896
  # The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -2057,9 +2079,9 @@ module Increase
2057
2079
  nil?: true
2058
2080
 
2059
2081
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
2060
- # Additional amounts associated with the card authorization, such as ATM
2061
- # surcharges fees. These are usually a subset of the `amount` field and are used
2062
- # to provide more detailed information about the transaction.
2082
+ # Additional amounts associated with the card authorization, such as ATM surcharge
2083
+ # fees. These are usually a subset of the `amount` field and are used to provide
2084
+ # more detailed information about the transaction.
2063
2085
  #
2064
2086
  # @param clinic [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic, nil]
2065
2087
  # The part of this transaction amount that was for clinic-related services.
@@ -6855,7 +6877,7 @@ module Increase
6855
6877
  # @!attribute bank_of_first_deposit_routing_number
6856
6878
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
6857
6879
  # bank depositing this check. In some rare cases, this is not transmitted via
6858
- # Check21 and the value will be null.
6880
+ # Check 21 and the value will be null.
6859
6881
  #
6860
6882
  # @return [String, nil]
6861
6883
  required :bank_of_first_deposit_routing_number, String, nil?: true
@@ -6912,7 +6934,7 @@ module Increase
6912
6934
  # @param bank_of_first_deposit_routing_number [String, nil]
6913
6935
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
6914
6936
  # bank depositing this check. In some rare cases, this is not transmitted via
6915
- # Check21 and the value will be null.
6937
+ # Check 21 and the value will be null.
6916
6938
  #
6917
6939
  # @param deposited_at [Time] When the check was deposited.
6918
6940
  #
@@ -6964,6 +6986,108 @@ module Increase
6964
6986
  # @param transfer_id [String] The identifier of the FedNow Transfer that led to this Transaction.
6965
6987
  end
6966
6988
 
6989
+ # @see Increase::Models::Transaction::Source#fednow_transfer_return
6990
+ class FednowTransferReturn < Increase::Internal::Type::BaseModel
6991
+ # @!attribute amount
6992
+ # The returned amount in USD cents. This is always a positive number.
6993
+ #
6994
+ # @return [Integer]
6995
+ required :amount, Integer
6996
+
6997
+ # @!attribute return_reason_additional_information
6998
+ # Additional information about the return provided by the recipient's bank.
6999
+ #
7000
+ # @return [String, nil]
7001
+ required :return_reason_additional_information, String, nil?: true
7002
+
7003
+ # @!attribute return_reason_code
7004
+ # The reason the transfer was returned as provided by the recipient's bank.
7005
+ #
7006
+ # @return [Symbol, Increase::Models::Transaction::Source::FednowTransferReturn::ReturnReasonCode]
7007
+ required :return_reason_code,
7008
+ enum: -> { Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode }
7009
+
7010
+ # @!attribute transfer_id
7011
+ # The identifier of the FedNow Transfer that led to this Transaction.
7012
+ #
7013
+ # @return [String]
7014
+ required :transfer_id, String
7015
+
7016
+ # @!method initialize(amount:, return_reason_additional_information:, return_reason_code:, transfer_id:)
7017
+ # A FedNow Transfer Return object. This field will be present in the JSON response
7018
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
7019
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
7020
+ # by the recipient's bank.
7021
+ #
7022
+ # @param amount [Integer] The returned amount in USD cents. This is always a positive number.
7023
+ #
7024
+ # @param return_reason_additional_information [String, nil]
7025
+ # Additional information about the return provided by the recipient's bank.
7026
+ #
7027
+ # @param return_reason_code [Symbol, Increase::Models::Transaction::Source::FednowTransferReturn::ReturnReasonCode]
7028
+ # The reason the transfer was returned as provided by the recipient's bank.
7029
+ #
7030
+ # @param transfer_id [String] The identifier of the FedNow Transfer that led to this Transaction.
7031
+
7032
+ # The reason the transfer was returned as provided by the recipient's bank.
7033
+ #
7034
+ # @see Increase::Models::Transaction::Source::FednowTransferReturn#return_reason_code
7035
+ module ReturnReasonCode
7036
+ extend Increase::Internal::Type::Enum
7037
+
7038
+ # The destination account is closed. Corresponds to the FedNow reason codes `AC04` and `AC07`.
7039
+ ACCOUNT_CLOSED = :account_closed
7040
+
7041
+ # The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.
7042
+ ACCOUNT_BLOCKED = :account_blocked
7043
+
7044
+ # The recipient's bank was not a valid agent for this transfer. Corresponds to the FedNow reason codes `AC14` and `AGNT`.
7045
+ INVALID_AGENT = :invalid_agent
7046
+
7047
+ # The destination account does not exist. Corresponds to the FedNow reason code `AC03`.
7048
+ INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number
7049
+
7050
+ # The destination account number was incorrect. Corresponds to the FedNow reason code `AC01`.
7051
+ INCORRECT_ACCOUNT_NUMBER = :incorrect_account_number
7052
+
7053
+ # The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.
7054
+ END_CUSTOMER_DECEASED = :end_customer_deceased
7055
+
7056
+ # The transfer was not permitted by the recipient's bank. Corresponds to the FedNow reason code `AG01`.
7057
+ TRANSACTION_FORBIDDEN = :transaction_forbidden
7058
+
7059
+ # The transfer was returned for a regulatory reason at the recipient's bank. Corresponds to the FedNow reason code `RR04`.
7060
+ REGULATORY_REASON = :regulatory_reason
7061
+
7062
+ # The transfer was reported as fraudulent. Corresponds to the FedNow reason code `FR01`.
7063
+ FRAUD = :fraud
7064
+
7065
+ # The transfer duplicated another transfer. Corresponds to the FedNow reason codes `AM05` and `DUPL`.
7066
+ DUPLICATION = :duplication
7067
+
7068
+ # The transfer amount was incorrect. Corresponds to the FedNow reason code `AM09`.
7069
+ WRONG_AMOUNT = :wrong_amount
7070
+
7071
+ # The transfer was returned at the request of the recipient's customer. Corresponds to the FedNow reason code `CUST`.
7072
+ REQUESTED_BY_CUSTOMER = :requested_by_customer
7073
+
7074
+ # The recipient's bank could not apply the funds. Corresponds to the FedNow reason code `RUTA`.
7075
+ UNABLE_TO_APPLY = :unable_to_apply
7076
+
7077
+ # The recipient's bank did not specify a reason. Corresponds to the FedNow reason codes `MS02` and `MS03`.
7078
+ NOT_SPECIFIED = :not_specified
7079
+
7080
+ # The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.
7081
+ NARRATIVE = :narrative
7082
+
7083
+ # The transfer was returned for some other reason.
7084
+ OTHER = :other
7085
+
7086
+ # @!method self.values
7087
+ # @return [Array<Symbol>]
7088
+ end
7089
+ end
7090
+
6967
7091
  # @see Increase::Models::Transaction::Source#fee_payment
6968
7092
  class FeePayment < Increase::Internal::Type::BaseModel
6969
7093
  # @!attribute amount
@@ -7247,7 +7371,7 @@ module Increase
7247
7371
  # An Inbound Check Adjustment object. This field will be present in the JSON
7248
7372
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
7249
7373
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
7250
- # check or return deposited through Check21.
7374
+ # check or return deposited through Check 21.
7251
7375
  #
7252
7376
  # @param adjusted_transaction_id [String] The ID of the transaction that was adjusted.
7253
7377
  #
@@ -7647,7 +7771,7 @@ module Increase
7647
7771
  required :input_message_accountability_data, String, nil?: true
7648
7772
 
7649
7773
  # @!attribute instructing_agent_routing_number
7650
- # The American Banking Association (ABA) routing number of the bank that sent the
7774
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
7651
7775
  # wire.
7652
7776
  #
7653
7777
  # @return [String, nil]
@@ -7720,7 +7844,7 @@ module Increase
7720
7844
  # service and is helpful when debugging wires with the originating bank.
7721
7845
  #
7722
7846
  # @param instructing_agent_routing_number [String, nil]
7723
- # The American Banking Association (ABA) routing number of the bank that sent the
7847
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
7724
7848
  # wire.
7725
7849
  #
7726
7850
  # @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
@@ -131,6 +131,9 @@ module Increase
131
131
  # FedNow Transfer Acknowledgement: details will be under the `fednow_transfer_acknowledgement` object.
132
132
  FEDNOW_TRANSFER_ACKNOWLEDGEMENT = :fednow_transfer_acknowledgement
133
133
 
134
+ # FedNow Transfer Return: details will be under the `fednow_transfer_return` object.
135
+ FEDNOW_TRANSFER_RETURN = :fednow_transfer_return
136
+
134
137
  # Check Transfer Deposit: details will be under the `check_transfer_deposit` object.
135
138
  CHECK_TRANSFER_DEPOSIT = :check_transfer_deposit
136
139
 
@@ -10,6 +10,13 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The Account to which the debtor—the recipient of this request—is being requested
15
+ # to send funds.
16
+ #
17
+ # @return [String]
18
+ required :account_id, String
19
+
13
20
  # @!attribute account_number_id
14
21
  # The Account Number to which the debtor—the recipient of this request—is being
15
22
  # requested to send funds.
@@ -135,7 +142,7 @@ module Increase
135
142
  # @return [String]
136
143
  required :unstructured_remittance_information, String
137
144
 
138
- # @!method initialize(id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
145
+ # @!method initialize(id:, account_id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
139
146
  # Wire drawdown requests enable you to request that someone else send you a wire.
140
147
  # Because there is nuance to making sure your counterparty's bank processes these
141
148
  # correctly, we ask that you reach out to
@@ -145,6 +152,10 @@ module Increase
145
152
  #
146
153
  # @param id [String] The Wire drawdown request identifier.
147
154
  #
155
+ # @param account_id [String]
156
+ # The Account to which the debtor—the recipient of this request—is being requested
157
+ # to send funds.
158
+ #
148
159
  # @param account_number_id [String]
149
160
  # The Account Number to which the debtor—the recipient of this request—is being
150
161
  # requested to send funds.
@@ -73,7 +73,7 @@ module Increase
73
73
  optional :routing_number, String
74
74
 
75
75
  # @!attribute source_account_number_id
76
- # The ID of an Account Number that will be passed to the wire's recipient
76
+ # The ID of an Account Number that will be passed to the wire's recipient.
77
77
  #
78
78
  # @return [String, nil]
79
79
  optional :source_account_number_id, String
@@ -112,7 +112,7 @@ module Increase
112
112
  # destination account.
113
113
  #
114
114
  # @param source_account_number_id [String]
115
- # The ID of an Account Number that will be passed to the wire's recipient
115
+ # The ID of an Account Number that will be passed to the wire's recipient.
116
116
  #
117
117
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
118
118
 
@@ -172,8 +172,8 @@ module Increase
172
172
  )
173
173
  end
174
174
 
175
- # Sensitive details for a Card include the primary account number, expiry, card
176
- # verification code, and PIN.
175
+ # Sensitive details for a Card include the primary account number, expiration,
176
+ # card verification code, and PIN.
177
177
  #
178
178
  # @overload details(card_id, request_options: {})
179
179
  #
@@ -44,7 +44,7 @@ module Increase
44
44
  # If provided, the check will be valid on or before this date. After this date,
45
45
  # the check transfer will be automatically stopped and deposits will not be
46
46
  # accepted. For checks printed by Increase, this date is included on the check as
47
- # its expiry.
47
+ # its expiration.
48
48
  #
49
49
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
50
50
  #
@@ -5,7 +5,7 @@ module Increase
5
5
  class Entities
6
6
  # Create an Entity
7
7
  #
8
- # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
8
+ # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, sole_proprietorship: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
9
9
  #
10
10
  # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
11
11
  #
@@ -33,6 +33,10 @@ module Increase
33
33
  # An assessment of the entity's potential risk of involvement in financial crimes,
34
34
  # such as money laundering.
35
35
  #
36
+ # @param sole_proprietorship [Increase::Models::EntityCreateParams::SoleProprietorship]
37
+ # Details of the sole proprietorship entity to create. Required if `structure` is
38
+ # equal to `sole_proprietorship`.
39
+ #
36
40
  # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>]
37
41
  # Additional documentation associated with the entity.
38
42
  #
@@ -87,7 +91,7 @@ module Increase
87
91
 
88
92
  # Update an Entity
89
93
  #
90
- # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
94
+ # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, sole_proprietorship: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
91
95
  #
92
96
  # @param entity_id [String] The entity identifier.
93
97
  #
@@ -112,6 +116,10 @@ module Increase
112
116
  # An assessment of the entity’s potential risk of involvement in financial crimes,
113
117
  # such as money laundering.
114
118
  #
119
+ # @param sole_proprietorship [Increase::Models::EntityUpdateParams::SoleProprietorship]
120
+ # Details of the sole proprietorship entity to update. If you specify this
121
+ # parameter and the entity is not a sole proprietorship, the request will fail.
122
+ #
115
123
  # @param terms_agreements [Array<Increase::Models::EntityUpdateParams::TermsAgreement>]
116
124
  # New terms that the Entity agreed to. Not all programs are required to submit
117
125
  # this data. This will not archive previously submitted terms.
@@ -55,7 +55,7 @@ module Increase
55
55
  )
56
56
  end
57
57
 
58
- # List Entity Onboarding Session
58
+ # List Entity Onboarding Sessions
59
59
  #
60
60
  # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
61
61
  #
@@ -16,7 +16,7 @@ module Increase
16
16
  #
17
17
  # @param description [String] The description you choose for the Lockbox Recipient.
18
18
  #
19
- # @param recipient_name [String] The name of the Lockbox Recipient
19
+ # @param recipient_name [String] The name of the Lockbox Recipient.
20
20
  #
21
21
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
22
22
  #
@@ -28,7 +28,7 @@ module Increase
28
28
  #
29
29
  # @param merchant_country [String] The country the merchant resides in.
30
30
  #
31
- # @param merchant_name [String] The name of the merchant
31
+ # @param merchant_name [String] The name of the merchant.
32
32
  #
33
33
  # @param purchase_amount [Integer] The purchase amount in cents.
34
34
  #
@@ -18,8 +18,8 @@ module Increase
18
18
  # under the sub-object with the same identifier as the network.
19
19
  #
20
20
  # @param visa [Increase::Models::Simulations::CardDisputeActionParams::Visa]
21
- # The Visa-specific parameters for the taking action on the dispute. Required if
22
- # and only if `network` is `visa`.
21
+ # The Visa-specific parameters for taking action on the dispute. Required if and
22
+ # only if `network` is `visa`.
23
23
  #
24
24
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
25
25
  #
@@ -9,7 +9,7 @@ module Increase
9
9
  #
10
10
  # @overload create(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {})
11
11
  #
12
- # @param account_id [String] The identifier of the Account the Interest Payment should be paid to is for.
12
+ # @param account_id [String] The identifier of the Account the Interest Payment should be paid to.
13
13
  #
14
14
  # @param amount [Integer] The interest amount in cents. Must be positive.
15
15
  #
@@ -10,7 +10,7 @@ module Increase
10
10
  # @overload release_inbound_funds_hold(pending_transaction_id, request_options: {})
11
11
  #
12
12
  # @param pending_transaction_id [String]
13
- # The pending transaction to release. The pending transaction must have a
13
+ # The pending transaction to release. The pending transaction must have an
14
14
  # `inbound_funds_hold` source.
15
15
  #
16
16
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -41,8 +41,8 @@ module Increase
41
41
  end
42
42
 
43
43
  # This endpoint allows you to simulate advancing the shipment status of a Physical
44
- # Card, to simulate e.g., that a physical card was attempted shipped but then
45
- # failed delivery.
44
+ # Card, to simulate e.g., that a physical card was attempted to be shipped but
45
+ # then failed delivery.
46
46
  #
47
47
  # @overload advance_shipment(physical_card_id, shipment_status:, request_options: {})
48
48
  #
@@ -9,7 +9,7 @@ module Increase
9
9
  # operates more than one program, `program_id` is a required field when creating
10
10
  # accounts.
11
11
  #
12
- # @overload create(name:, bank: nil, lending_maximum_extendable_credit: nil, reserve_account_id: nil, request_options: {})
12
+ # @overload create(name:, bank: nil, lending_maximum_extendable_credit: nil, loan_accounts_require_loan_offers: nil, reserve_account_id: nil, request_options: {})
13
13
  #
14
14
  # @param name [String] The name of the program being added.
15
15
  #
@@ -19,7 +19,11 @@ module Increase
19
19
  # @param lending_maximum_extendable_credit [Integer]
20
20
  # The maximum extendable credit of the program being added.
21
21
  #
22
- # @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
22
+ # @param loan_accounts_require_loan_offers [Boolean]
23
+ # Whether opening a loan Account under this Program requires an accepted Loan
24
+ # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
25
+ #
26
+ # @param reserve_account_id [String] The identifier of the Account the Program should be added to.
23
27
  #
24
28
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
25
29
  #
@@ -40,7 +40,7 @@ module Increase
40
40
  # destination account.
41
41
  #
42
42
  # @param source_account_number_id [String]
43
- # The ID of an Account Number that will be passed to the wire's recipient
43
+ # The ID of an Account Number that will be passed to the wire's recipient.
44
44
  #
45
45
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
46
46
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.349.0"
4
+ VERSION = "1.350.0"
5
5
  end
@@ -150,7 +150,7 @@ module Increase
150
150
  end
151
151
 
152
152
  # Whether ACH debits are allowed against this Account Number. Note that they will
153
- # still be declined if this is `allowed` if the Account Number is not active.
153
+ # still be declined if this is `allowed` but the Account Number is not active.
154
154
  sig do
155
155
  returns(
156
156
  Increase::AccountNumber::InboundACH::DebitStatus::TaggedSymbol
@@ -167,7 +167,7 @@ module Increase
167
167
  end
168
168
  def self.new(
169
169
  # Whether ACH debits are allowed against this Account Number. Note that they will
170
- # still be declined if this is `allowed` if the Account Number is not active.
170
+ # still be declined if this is `allowed` but the Account Number is not active.
171
171
  debit_status:
172
172
  )
173
173
  end
@@ -184,7 +184,7 @@ module Increase
184
184
  end
185
185
 
186
186
  # Whether ACH debits are allowed against this Account Number. Note that they will
187
- # still be declined if this is `allowed` if the Account Number is not active.
187
+ # still be declined if this is `allowed` but the Account Number is not active.
188
188
  module DebitStatus
189
189
  extend Increase::Internal::Type::Enum
190
190