increase 1.363.0 → 1.365.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 (115) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -0
  4. data/lib/increase/models/account_number.rb +51 -81
  5. data/lib/increase/models/account_number_create_params.rb +41 -75
  6. data/lib/increase/models/account_number_list_params.rb +39 -39
  7. data/lib/increase/models/account_number_update_params.rb +48 -79
  8. data/lib/increase/models/ach_transfer.rb +9 -2
  9. data/lib/increase/models/ach_transfer_create_params.rb +31 -50
  10. data/lib/increase/models/card_create_params.rb +10 -3
  11. data/lib/increase/models/card_payment.rb +6 -0
  12. data/lib/increase/models/card_update_params.rb +21 -11
  13. data/lib/increase/models/checkbook.rb +352 -0
  14. data/lib/increase/models/checkbook_check.rb +100 -0
  15. data/lib/increase/models/checkbook_check_list_params.rb +61 -0
  16. data/lib/increase/models/checkbook_check_retrieve_params.rb +22 -0
  17. data/lib/increase/models/checkbook_check_stop_params.rb +22 -0
  18. data/lib/increase/models/checkbook_create_params.rb +111 -0
  19. data/lib/increase/models/checkbook_list_params.rb +104 -0
  20. data/lib/increase/models/checkbook_retrieve_params.rb +22 -0
  21. data/lib/increase/models/checkbook_stop_params.rb +22 -0
  22. data/lib/increase/models/declined_transaction.rb +10 -1
  23. data/lib/increase/models/entity.rb +1 -65
  24. data/lib/increase/models/entity_create_params.rb +1 -65
  25. data/lib/increase/models/entity_update_params.rb +1 -57
  26. data/lib/increase/models/fednow_transfer.rb +10 -1
  27. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  28. data/lib/increase/models/inbound_check_deposit.rb +12 -1
  29. data/lib/increase/models/real_time_decision.rb +65 -1
  30. data/lib/increase/models/simulations/checkbook_mail_params.rb +24 -0
  31. data/lib/increase/models/transaction.rb +24 -2
  32. data/lib/increase/models.rb +18 -0
  33. data/lib/increase/resources/account_numbers.rb +19 -16
  34. data/lib/increase/resources/ach_transfers.rb +14 -22
  35. data/lib/increase/resources/cards.rb +7 -2
  36. data/lib/increase/resources/checkbook_checks.rb +90 -0
  37. data/lib/increase/resources/checkbooks.rb +127 -0
  38. data/lib/increase/resources/entities.rb +2 -12
  39. data/lib/increase/resources/simulations/checkbooks.rb +38 -0
  40. data/lib/increase/resources/simulations.rb +4 -0
  41. data/lib/increase/version.rb +1 -1
  42. data/lib/increase.rb +13 -0
  43. data/rbi/increase/client.rbi +6 -0
  44. data/rbi/increase/models/account_number.rbi +86 -173
  45. data/rbi/increase/models/account_number_create_params.rbi +87 -165
  46. data/rbi/increase/models/account_number_list_params.rbi +106 -105
  47. data/rbi/increase/models/account_number_update_params.rbi +105 -190
  48. data/rbi/increase/models/ach_transfer.rbi +8 -2
  49. data/rbi/increase/models/ach_transfer_create_params.rbi +30 -54
  50. data/rbi/increase/models/card_create_params.rbi +9 -3
  51. data/rbi/increase/models/card_payment.rbi +14 -0
  52. data/rbi/increase/models/card_update_params.rbi +26 -18
  53. data/rbi/increase/models/checkbook.rbi +507 -0
  54. data/rbi/increase/models/checkbook_check.rbi +142 -0
  55. data/rbi/increase/models/checkbook_check_list_params.rbi +96 -0
  56. data/rbi/increase/models/checkbook_check_retrieve_params.rbi +46 -0
  57. data/rbi/increase/models/checkbook_check_stop_params.rbi +43 -0
  58. data/rbi/increase/models/checkbook_create_params.rbi +178 -0
  59. data/rbi/increase/models/checkbook_list_params.rbi +198 -0
  60. data/rbi/increase/models/checkbook_retrieve_params.rbi +40 -0
  61. data/rbi/increase/models/checkbook_stop_params.rbi +40 -0
  62. data/rbi/increase/models/declined_transaction.rbi +8 -0
  63. data/rbi/increase/models/entity.rbi +0 -97
  64. data/rbi/increase/models/entity_create_params.rbi +0 -119
  65. data/rbi/increase/models/entity_update_params.rbi +0 -108
  66. data/rbi/increase/models/fednow_transfer.rbi +8 -0
  67. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  68. data/rbi/increase/models/inbound_check_deposit.rbi +10 -0
  69. data/rbi/increase/models/real_time_decision.rbi +134 -3
  70. data/rbi/increase/models/simulations/checkbook_mail_params.rbi +45 -0
  71. data/rbi/increase/models/transaction.rbi +30 -0
  72. data/rbi/increase/models.rbi +18 -0
  73. data/rbi/increase/resources/account_numbers.rbi +24 -19
  74. data/rbi/increase/resources/ach_transfers.rbi +14 -22
  75. data/rbi/increase/resources/cards.rbi +6 -2
  76. data/rbi/increase/resources/checkbook_checks.rbi +69 -0
  77. data/rbi/increase/resources/checkbooks.rbi +96 -0
  78. data/rbi/increase/resources/entities.rbi +0 -11
  79. data/rbi/increase/resources/simulations/checkbooks.rbi +30 -0
  80. data/rbi/increase/resources/simulations.rbi +3 -0
  81. data/sig/increase/client.rbs +4 -0
  82. data/sig/increase/models/account_number.rbs +34 -66
  83. data/sig/increase/models/account_number_create_params.rbs +30 -64
  84. data/sig/increase/models/account_number_list_params.rbs +44 -44
  85. data/sig/increase/models/account_number_update_params.rbs +39 -77
  86. data/sig/increase/models/ach_transfer_create_params.rbs +9 -18
  87. data/sig/increase/models/card_payment.rbs +8 -0
  88. data/sig/increase/models/card_update_params.rbs +7 -11
  89. data/sig/increase/models/checkbook.rbs +272 -0
  90. data/sig/increase/models/checkbook_check.rbs +76 -0
  91. data/sig/increase/models/checkbook_check_list_params.rbs +56 -0
  92. data/sig/increase/models/checkbook_check_retrieve_params.rbs +24 -0
  93. data/sig/increase/models/checkbook_check_stop_params.rbs +24 -0
  94. data/sig/increase/models/checkbook_create_params.rbs +90 -0
  95. data/sig/increase/models/checkbook_list_params.rbs +97 -0
  96. data/sig/increase/models/checkbook_retrieve_params.rbs +23 -0
  97. data/sig/increase/models/checkbook_stop_params.rbs +23 -0
  98. data/sig/increase/models/declined_transaction.rbs +5 -0
  99. data/sig/increase/models/entity.rbs +0 -46
  100. data/sig/increase/models/entity_create_params.rbs +0 -55
  101. data/sig/increase/models/entity_update_params.rbs +0 -48
  102. data/sig/increase/models/fednow_transfer.rbs +5 -0
  103. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  104. data/sig/increase/models/real_time_decision.rbs +69 -3
  105. data/sig/increase/models/simulations/checkbook_mail_params.rbs +25 -0
  106. data/sig/increase/models/transaction.rbs +22 -1
  107. data/sig/increase/models.rbs +18 -0
  108. data/sig/increase/resources/account_numbers.rbs +5 -5
  109. data/sig/increase/resources/ach_transfers.rbs +2 -3
  110. data/sig/increase/resources/checkbook_checks.rbs +26 -0
  111. data/sig/increase/resources/checkbooks.rbs +33 -0
  112. data/sig/increase/resources/entities.rbs +0 -3
  113. data/sig/increase/resources/simulations/checkbooks.rbs +14 -0
  114. data/sig/increase/resources/simulations.rbs +2 -0
  115. metadata +41 -2
@@ -20,12 +20,6 @@ module Increase
20
20
  # @return [Increase::Models::EntityCreateParams::Corporation, nil]
21
21
  optional :corporation, -> { Increase::EntityCreateParams::Corporation }
22
22
 
23
- # @!attribute description
24
- # The description you choose to give the entity.
25
- #
26
- # @return [String, nil]
27
- optional :description, String
28
-
29
23
  # @!attribute government_authority
30
24
  # Details of the Government Authority entity to create. Required if `structure` is
31
25
  # equal to `government_authority`.
@@ -49,13 +43,6 @@ module Increase
49
43
  # @return [Increase::Models::EntityCreateParams::NaturalPerson, nil]
50
44
  optional :natural_person, -> { Increase::EntityCreateParams::NaturalPerson }
51
45
 
52
- # @!attribute risk_rating
53
- # An assessment of the entity's potential risk of involvement in financial crimes,
54
- # such as money laundering.
55
- #
56
- # @return [Increase::Models::EntityCreateParams::RiskRating, nil]
57
- optional :risk_rating, -> { Increase::EntityCreateParams::RiskRating }
58
-
59
46
  # @!attribute sole_proprietorship
60
47
  # Details of the sole proprietorship entity to create. Required if `structure` is
61
48
  # equal to `sole_proprietorship`.
@@ -93,15 +80,13 @@ module Increase
93
80
  # @return [Increase::Models::EntityCreateParams::Trust, nil]
94
81
  optional :trust, -> { Increase::EntityCreateParams::Trust }
95
82
 
96
- # @!method initialize(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: {})
83
+ # @!method initialize(structure:, corporation: nil, government_authority: nil, joint: nil, natural_person: nil, sole_proprietorship: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
97
84
  # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
98
85
  #
99
86
  # @param corporation [Increase::Models::EntityCreateParams::Corporation]
100
87
  # Details of the corporation entity to create. Required if `structure` is equal to
101
88
  # `corporation`.
102
89
  #
103
- # @param description [String] The description you choose to give the entity.
104
- #
105
90
  # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
106
91
  # Details of the Government Authority entity to create. Required if `structure` is
107
92
  # equal to `government_authority`.
@@ -116,10 +101,6 @@ module Increase
116
101
  # `social_security_number` or `individual_taxpayer_identification_number`
117
102
  # identification methods.
118
103
  #
119
- # @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
120
- # An assessment of the entity's potential risk of involvement in financial crimes,
121
- # such as money laundering.
122
- #
123
104
  # @param sole_proprietorship [Increase::Models::EntityCreateParams::SoleProprietorship]
124
105
  # Details of the sole proprietorship entity to create. Required if `structure` is
125
106
  # equal to `sole_proprietorship`.
@@ -1675,51 +1656,6 @@ module Increase
1675
1656
  end
1676
1657
  end
1677
1658
 
1678
- class RiskRating < Increase::Internal::Type::BaseModel
1679
- # @!attribute rated_at
1680
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1681
- # rating was performed.
1682
- #
1683
- # @return [Time]
1684
- required :rated_at, Time
1685
-
1686
- # @!attribute rating
1687
- # The rating given to this entity.
1688
- #
1689
- # @return [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating]
1690
- required :rating, enum: -> { Increase::EntityCreateParams::RiskRating::Rating }
1691
-
1692
- # @!method initialize(rated_at:, rating:)
1693
- # An assessment of the entity's potential risk of involvement in financial crimes,
1694
- # such as money laundering.
1695
- #
1696
- # @param rated_at [Time]
1697
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1698
- # rating was performed.
1699
- #
1700
- # @param rating [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating]
1701
- # The rating given to this entity.
1702
-
1703
- # The rating given to this entity.
1704
- #
1705
- # @see Increase::Models::EntityCreateParams::RiskRating#rating
1706
- module Rating
1707
- extend Increase::Internal::Type::Enum
1708
-
1709
- # Minimal risk of involvement in financial crime.
1710
- LOW = :low
1711
-
1712
- # Moderate risk of involvement in financial crime.
1713
- MEDIUM = :medium
1714
-
1715
- # Elevated risk of involvement in financial crime.
1716
- HIGH = :high
1717
-
1718
- # @!method self.values
1719
- # @return [Array<Symbol>]
1720
- end
1721
- end
1722
-
1723
1659
  class SoleProprietorship < Increase::Internal::Type::BaseModel
1724
1660
  # @!attribute address
1725
1661
  # The sole proprietorship's business address. Mail receiving locations like PO
@@ -42,13 +42,6 @@ module Increase
42
42
  # @return [Increase::Models::EntityUpdateParams::NaturalPerson, nil]
43
43
  optional :natural_person, -> { Increase::EntityUpdateParams::NaturalPerson }
44
44
 
45
- # @!attribute risk_rating
46
- # An assessment of the entity’s potential risk of involvement in financial crimes,
47
- # such as money laundering.
48
- #
49
- # @return [Increase::Models::EntityUpdateParams::RiskRating, nil]
50
- optional :risk_rating, -> { Increase::EntityUpdateParams::RiskRating }
51
-
52
45
  # @!attribute sole_proprietorship
53
46
  # Details of the sole proprietorship entity to update. If you specify this
54
47
  # parameter and the entity is not a sole proprietorship, the request will fail.
@@ -79,7 +72,7 @@ module Increase
79
72
  # @return [Increase::Models::EntityUpdateParams::Trust, nil]
80
73
  optional :trust, -> { Increase::EntityUpdateParams::Trust }
81
74
 
82
- # @!method initialize(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: {})
75
+ # @!method initialize(entity_id:, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, sole_proprietorship: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
83
76
  # @param entity_id [String] The entity identifier.
84
77
  #
85
78
  # @param corporation [Increase::Models::EntityUpdateParams::Corporation]
@@ -99,10 +92,6 @@ module Increase
99
92
  # Details of the natural person entity to update. If you specify this parameter
100
93
  # and the entity is not a natural person, the request will fail.
101
94
  #
102
- # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
103
- # An assessment of the entity’s potential risk of involvement in financial crimes,
104
- # such as money laundering.
105
- #
106
95
  # @param sole_proprietorship [Increase::Models::EntityUpdateParams::SoleProprietorship]
107
96
  # Details of the sole proprietorship entity to update. If you specify this
108
97
  # parameter and the entity is not a sole proprietorship, the request will fail.
@@ -730,51 +719,6 @@ module Increase
730
719
  end
731
720
  end
732
721
 
733
- class RiskRating < Increase::Internal::Type::BaseModel
734
- # @!attribute rated_at
735
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
736
- # rating was performed.
737
- #
738
- # @return [Time]
739
- required :rated_at, Time
740
-
741
- # @!attribute rating
742
- # The rating given to this entity.
743
- #
744
- # @return [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating]
745
- required :rating, enum: -> { Increase::EntityUpdateParams::RiskRating::Rating }
746
-
747
- # @!method initialize(rated_at:, rating:)
748
- # An assessment of the entity’s potential risk of involvement in financial crimes,
749
- # such as money laundering.
750
- #
751
- # @param rated_at [Time]
752
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
753
- # rating was performed.
754
- #
755
- # @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating]
756
- # The rating given to this entity.
757
-
758
- # The rating given to this entity.
759
- #
760
- # @see Increase::Models::EntityUpdateParams::RiskRating#rating
761
- module Rating
762
- extend Increase::Internal::Type::Enum
763
-
764
- # Minimal risk of involvement in financial crime.
765
- LOW = :low
766
-
767
- # Moderate risk of involvement in financial crime.
768
- MEDIUM = :medium
769
-
770
- # Elevated risk of involvement in financial crime.
771
- HIGH = :high
772
-
773
- # @!method self.values
774
- # @return [Array<Symbol>]
775
- end
776
- end
777
-
778
722
  class SoleProprietorship < Increase::Internal::Type::BaseModel
779
723
  # @!attribute address
780
724
  # The sole proprietorship's business address. Mail receiving locations like PO
@@ -81,6 +81,12 @@ module Increase
81
81
  # @return [String]
82
82
  required :debtor_name, String
83
83
 
84
+ # @!attribute end_to_end_identification
85
+ # A free-form reference string set by the sender, to help identify the transfer.
86
+ #
87
+ # @return [String, nil]
88
+ required :end_to_end_identification, String, nil?: true
89
+
84
90
  # @!attribute external_account_id
85
91
  # The identifier of the External Account the transfer was made to, if any.
86
92
  #
@@ -169,7 +175,7 @@ module Increase
169
175
  # @return [String]
170
176
  required :unstructured_remittance_information, String
171
177
 
172
- # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, returns:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
178
+ # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, end_to_end_identification:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, returns:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
173
179
  # FedNow transfers move funds, within seconds, between your Increase account and
174
180
  # any other account supporting FedNow.
175
181
  #
@@ -208,6 +214,9 @@ module Increase
208
214
  # The name of the transfer's sender. If not provided, defaults to the name of the
209
215
  # account's entity.
210
216
  #
217
+ # @param end_to_end_identification [String, nil]
218
+ # A free-form reference string set by the sender, to help identify the transfer.
219
+ #
211
220
  # @param external_account_id [String, nil]
212
221
  # The identifier of the External Account the transfer was made to, if any.
213
222
  #
@@ -136,8 +136,8 @@ module Increase
136
136
  required :receiver_name, String, nil?: true
137
137
 
138
138
  # @!attribute settlement
139
- # A subhash containing information about when and how the transfer settled at the
140
- # Federal Reserve.
139
+ # A subhash containing information about when the transfer settled (or will
140
+ # settle) at the Federal Reserve.
141
141
  #
142
142
  # @return [Increase::Models::InboundACHTransfer::Settlement]
143
143
  required :settlement, -> { Increase::InboundACHTransfer::Settlement }
@@ -237,8 +237,8 @@ module Increase
237
237
  # @param receiver_name [String, nil] The name of the receiver of the transfer.
238
238
  #
239
239
  # @param settlement [Increase::Models::InboundACHTransfer::Settlement]
240
- # A subhash containing information about when and how the transfer settled at the
241
- # Federal Reserve.
240
+ # A subhash containing information about when the transfer settled (or will
241
+ # settle) at the Federal Reserve.
242
242
  #
243
243
  # @param standard_entry_class_code [Symbol, Increase::Models::InboundACHTransfer::StandardEntryClassCode]
244
244
  # The Standard Entry Class (SEC) code of the transfer.
@@ -979,8 +979,8 @@ module Increase
979
979
  required :settlement_schedule, enum: -> { Increase::InboundACHTransfer::Settlement::SettlementSchedule }
980
980
 
981
981
  # @!method initialize(settled_at:, settlement_schedule:)
982
- # A subhash containing information about when and how the transfer settled at the
983
- # Federal Reserve.
982
+ # A subhash containing information about when the transfer settled (or will
983
+ # settle) at the Federal Reserve.
984
984
  #
985
985
  # @param settled_at [Time]
986
986
  # When the funds for this transfer settle at the recipient bank at the Federal
@@ -78,6 +78,13 @@ module Increase
78
78
  # @return [String, nil]
79
79
  required :check_transfer_id, String, nil?: true
80
80
 
81
+ # @!attribute checkbook_check_id
82
+ # If this deposit is for an existing Checkbook Check, the identifier of that
83
+ # Checkbook Check.
84
+ #
85
+ # @return [String, nil]
86
+ required :checkbook_check_id, String, nil?: true
87
+
81
88
  # @!attribute created_at
82
89
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
83
90
  # the deposit was attempted.
@@ -146,7 +153,7 @@ module Increase
146
153
  # @return [Symbol, Increase::Models::InboundCheckDeposit::Type]
147
154
  required :type, enum: -> { Increase::InboundCheckDeposit::Type }
148
155
 
149
- # @!method initialize(id:, accepted_at:, account_id:, account_number_id:, adjustments:, amount:, automatically_resolves_at:, back_image_file_id:, bank_of_first_deposit_routing_number:, check_number:, check_transfer_id:, created_at:, currency:, declined_at:, declined_transaction_id:, deposit_return:, front_image_file_id:, payee_name_analysis:, status:, transaction_id:, type:)
156
+ # @!method initialize(id:, accepted_at:, account_id:, account_number_id:, adjustments:, amount:, automatically_resolves_at:, back_image_file_id:, bank_of_first_deposit_routing_number:, check_number:, check_transfer_id:, checkbook_check_id:, created_at:, currency:, declined_at:, declined_transaction_id:, deposit_return:, front_image_file_id:, payee_name_analysis:, status:, transaction_id:, type:)
150
157
  # Inbound Check Deposits are records of third-parties attempting to deposit checks
151
158
  # against your account.
152
159
  #
@@ -185,6 +192,10 @@ module Increase
185
192
  # If this deposit is for an existing Check Transfer, the identifier of that Check
186
193
  # Transfer.
187
194
  #
195
+ # @param checkbook_check_id [String, nil]
196
+ # If this deposit is for an existing Checkbook Check, the identifier of that
197
+ # Checkbook Check.
198
+ #
188
199
  # @param created_at [Time]
189
200
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
190
201
  # the deposit was attempted.
@@ -3945,16 +3945,80 @@ module Increase
3945
3945
 
3946
3946
  # @see Increase::Models::RealTimeDecision::DigitalWalletToken#device
3947
3947
  class Device < Increase::Internal::Type::BaseModel
3948
+ # @!attribute device_type
3949
+ # Device type.
3950
+ #
3951
+ # @return [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Device::DeviceType, nil]
3952
+ required :device_type,
3953
+ enum: -> { Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType },
3954
+ nil?: true
3955
+
3948
3956
  # @!attribute identifier
3949
3957
  # ID assigned to the device by the digital wallet provider.
3950
3958
  #
3951
3959
  # @return [String, nil]
3952
3960
  required :identifier, String, nil?: true
3953
3961
 
3954
- # @!method initialize(identifier:)
3962
+ # @!attribute ip_address
3963
+ # IP address of the device.
3964
+ #
3965
+ # @return [String, nil]
3966
+ required :ip_address, String, nil?: true
3967
+
3968
+ # @!attribute name
3969
+ # Name of the device, for example "My Work Phone".
3970
+ #
3971
+ # @return [String, nil]
3972
+ required :name, String, nil?: true
3973
+
3974
+ # @!method initialize(device_type:, identifier:, ip_address:, name:)
3955
3975
  # Device that is being used to provision the digital wallet token.
3956
3976
  #
3977
+ # @param device_type [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Device::DeviceType, nil]
3978
+ # Device type.
3979
+ #
3957
3980
  # @param identifier [String, nil] ID assigned to the device by the digital wallet provider.
3981
+ #
3982
+ # @param ip_address [String, nil] IP address of the device.
3983
+ #
3984
+ # @param name [String, nil] Name of the device, for example "My Work Phone".
3985
+
3986
+ # Device type.
3987
+ #
3988
+ # @see Increase::Models::RealTimeDecision::DigitalWalletToken::Device#device_type
3989
+ module DeviceType
3990
+ extend Increase::Internal::Type::Enum
3991
+
3992
+ # Unknown
3993
+ UNKNOWN = :unknown
3994
+
3995
+ # Mobile Phone
3996
+ MOBILE_PHONE = :mobile_phone
3997
+
3998
+ # Tablet
3999
+ TABLET = :tablet
4000
+
4001
+ # Watch
4002
+ WATCH = :watch
4003
+
4004
+ # Mobile Phone or Tablet
4005
+ MOBILEPHONE_OR_TABLET = :mobilephone_or_tablet
4006
+
4007
+ # PC
4008
+ PC = :pc
4009
+
4010
+ # Household Device
4011
+ HOUSEHOLD_DEVICE = :household_device
4012
+
4013
+ # Wearable Device
4014
+ WEARABLE_DEVICE = :wearable_device
4015
+
4016
+ # Automobile Device
4017
+ AUTOMOBILE_DEVICE = :automobile_device
4018
+
4019
+ # @!method self.values
4020
+ # @return [Array<Symbol>]
4021
+ end
3958
4022
  end
3959
4023
 
3960
4024
  # The digital wallet app being used.
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::Checkbooks#mail
7
+ class CheckbookMailParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute checkbook_id
12
+ # The identifier of the Checkbook you wish to mail.
13
+ #
14
+ # @return [String]
15
+ required :checkbook_id, String
16
+
17
+ # @!method initialize(checkbook_id:, request_options: {})
18
+ # @param checkbook_id [String] The identifier of the Checkbook you wish to mail.
19
+ #
20
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
21
+ end
22
+ end
23
+ end
24
+ end
@@ -4472,6 +4472,9 @@ module Increase
4472
4472
  # Electric vehicle charging level 3 480 volt
4473
4473
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
4474
4474
 
4475
+ # Diesel 1 off-road non-taxable
4476
+ DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
4477
+
4475
4478
  # Renewable diesel R95 or greater off-road non-taxable
4476
4479
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
4477
4480
  :renewable_diesel_r95_or_greater_off_road_non_taxable
@@ -6752,6 +6755,9 @@ module Increase
6752
6755
  # Electric vehicle charging level 3 480 volt
6753
6756
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
6754
6757
 
6758
+ # Diesel 1 off-road non-taxable
6759
+ DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
6760
+
6755
6761
  # Renewable diesel R95 or greater off-road non-taxable
6756
6762
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
6757
6763
  :renewable_diesel_r95_or_greater_off_road_non_taxable
@@ -8144,6 +8150,12 @@ module Increase
8144
8150
  # @return [String, nil]
8145
8151
  required :bank_of_first_deposit_routing_number, String, nil?: true
8146
8152
 
8153
+ # @!attribute checkbook_check_id
8154
+ # The identifier of the Checkbook Check object that was deposited.
8155
+ #
8156
+ # @return [String, nil]
8157
+ required :checkbook_check_id, String, nil?: true
8158
+
8147
8159
  # @!attribute deposited_at
8148
8160
  # When the check was deposited.
8149
8161
  #
@@ -8183,7 +8195,7 @@ module Increase
8183
8195
  # @return [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type]
8184
8196
  required :type, enum: -> { Increase::Transaction::Source::CheckTransferDeposit::Type }
8185
8197
 
8186
- # @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:)
8198
+ # @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, checkbook_check_id:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:)
8187
8199
  # A Check Transfer Deposit object. This field will be present in the JSON response
8188
8200
  # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
8189
8201
  # is a check drawn on an Increase account that has been deposited by an external
@@ -8198,6 +8210,8 @@ module Increase
8198
8210
  # bank depositing this check. In some rare cases, this is not transmitted via
8199
8211
  # Check 21 and the value will be null.
8200
8212
  #
8213
+ # @param checkbook_check_id [String, nil] The identifier of the Checkbook Check object that was deposited.
8214
+ #
8201
8215
  # @param deposited_at [Time] When the check was deposited.
8202
8216
  #
8203
8217
  # @param front_image_file_id [String, nil]
@@ -8675,6 +8689,12 @@ module Increase
8675
8689
 
8676
8690
  # @see Increase::Models::Transaction::Source#inbound_check_deposit_return_intention
8677
8691
  class InboundCheckDepositReturnIntention < Increase::Internal::Type::BaseModel
8692
+ # @!attribute checkbook_check_id
8693
+ # The identifier of the Checkbook Check object that was deposited.
8694
+ #
8695
+ # @return [String, nil]
8696
+ required :checkbook_check_id, String, nil?: true
8697
+
8678
8698
  # @!attribute inbound_check_deposit_id
8679
8699
  # The ID of the Inbound Check Deposit that is being returned.
8680
8700
  #
@@ -8687,13 +8707,15 @@ module Increase
8687
8707
  # @return [String, nil]
8688
8708
  required :transfer_id, String, nil?: true
8689
8709
 
8690
- # @!method initialize(inbound_check_deposit_id:, transfer_id:)
8710
+ # @!method initialize(checkbook_check_id:, inbound_check_deposit_id:, transfer_id:)
8691
8711
  # An Inbound Check Deposit Return Intention object. This field will be present in
8692
8712
  # the JSON response if and only if `category` is equal to
8693
8713
  # `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
8694
8714
  # Intention is created when Increase receives an Inbound Check and the User
8695
8715
  # requests that it be returned.
8696
8716
  #
8717
+ # @param checkbook_check_id [String, nil] The identifier of the Checkbook Check object that was deposited.
8718
+ #
8697
8719
  # @param inbound_check_deposit_id [String] The ID of the Inbound Check Deposit that is being returned.
8698
8720
  #
8699
8721
  # @param transfer_id [String, nil] The identifier of the Check Transfer object that was deposited.
@@ -193,6 +193,24 @@ module Increase
193
193
 
194
194
  CardValidationRetrieveParams = Increase::Models::CardValidationRetrieveParams
195
195
 
196
+ Checkbook = Increase::Models::Checkbook
197
+
198
+ CheckbookCheck = Increase::Models::CheckbookCheck
199
+
200
+ CheckbookCheckListParams = Increase::Models::CheckbookCheckListParams
201
+
202
+ CheckbookCheckRetrieveParams = Increase::Models::CheckbookCheckRetrieveParams
203
+
204
+ CheckbookCheckStopParams = Increase::Models::CheckbookCheckStopParams
205
+
206
+ CheckbookCreateParams = Increase::Models::CheckbookCreateParams
207
+
208
+ CheckbookListParams = Increase::Models::CheckbookListParams
209
+
210
+ CheckbookRetrieveParams = Increase::Models::CheckbookRetrieveParams
211
+
212
+ CheckbookStopParams = Increase::Models::CheckbookStopParams
213
+
196
214
  CheckDeposit = Increase::Models::CheckDeposit
197
215
 
198
216
  CheckDepositCreateParams = Increase::Models::CheckDepositCreateParams
@@ -5,18 +5,20 @@ module Increase
5
5
  class AccountNumbers
6
6
  # Create an Account Number
7
7
  #
8
- # @overload create(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {})
8
+ # @overload create(account_id:, name:, inbound_ach_debits: nil, unregistered_inbound_checks: nil, request_options: {})
9
9
  #
10
10
  # @param account_id [String] The Account the Account Number should belong to.
11
11
  #
12
12
  # @param name [String] The name you choose for the Account Number.
13
13
  #
14
- # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH]
15
- # Options related to how this Account Number should handle inbound ACH transfers.
14
+ # @param inbound_ach_debits [Symbol, Increase::Models::AccountNumberCreateParams::InboundACHDebits]
15
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
16
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
17
+ # active. If you do not specify this field, the default is `allowed`.
16
18
  #
17
- # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks]
18
- # Options related to how this Account Number should handle inbound check
19
- # withdrawals.
19
+ # @param unregistered_inbound_checks [Symbol, Increase::Models::AccountNumberCreateParams::UnregisteredInboundChecks]
20
+ # Whether unregistered inbound checks for this Account Number can be deposited. If
21
+ # you do not specify this field, the default is `blocked`.
20
22
  #
21
23
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
22
24
  #
@@ -56,22 +58,23 @@ module Increase
56
58
 
57
59
  # Update an Account Number
58
60
  #
59
- # @overload update(account_number_id, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {})
61
+ # @overload update(account_number_id, inbound_ach_debits: nil, name: nil, status: nil, unregistered_inbound_checks: nil, request_options: {})
60
62
  #
61
63
  # @param account_number_id [String] The identifier of the Account Number.
62
64
  #
63
- # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH]
64
- # Options related to how this Account Number handles inbound ACH transfers.
65
- #
66
- # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks]
67
- # Options related to how this Account Number should handle inbound check
68
- # withdrawals.
65
+ # @param inbound_ach_debits [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACHDebits]
66
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
67
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
68
+ # active.
69
69
  #
70
70
  # @param name [String] The name you choose for the Account Number.
71
71
  #
72
72
  # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status]
73
73
  # This indicates if transfers can be made to the Account Number.
74
74
  #
75
+ # @param unregistered_inbound_checks [Symbol, Increase::Models::AccountNumberUpdateParams::UnregisteredInboundChecks]
76
+ # Whether unregistered inbound checks for this Account Number can be deposited.
77
+ #
75
78
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
76
79
  #
77
80
  # @return [Increase::Models::AccountNumber]
@@ -90,12 +93,10 @@ module Increase
90
93
 
91
94
  # List Account Numbers
92
95
  #
93
- # @overload list(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
96
+ # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, inbound_ach_debits: nil, limit: nil, status: nil, request_options: {})
94
97
  #
95
98
  # @param account_id [String] Filter Account Numbers to those belonging to the specified Account.
96
99
  #
97
- # @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus]
98
- #
99
100
  # @param created_at [Increase::Models::AccountNumberListParams::CreatedAt]
100
101
  #
101
102
  # @param cursor [String] Return the page of entries after this one.
@@ -106,6 +107,8 @@ module Increase
106
107
  # request is only processed once. Learn more about
107
108
  # [idempotency](https://increase.com/documentation/idempotency-keys).
108
109
  #
110
+ # @param inbound_ach_debits [Increase::Models::AccountNumberListParams::InboundACHDebits]
111
+ #
109
112
  # @param limit [Integer]
110
113
  # Limit the size of the list that is returned. The default (and maximum) is 100
111
114
  # objects.
@@ -10,7 +10,7 @@ module Increase
10
10
  # You should set both of these, in addition to the required amount and account
11
11
  # fields.
12
12
  #
13
- # @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
13
+ # @overload create(account_id:, amount:, company_name:, individual_name:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
14
14
  #
15
15
  # @param account_id [String]
16
16
  # The Increase identifier for the account that will originate the transfer. For
@@ -25,13 +25,19 @@ module Increase
25
25
  # into Increase. Debit transfers
26
26
  # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
27
27
  #
28
- # @param statement_descriptor [String]
29
- # A description you choose to give the transfer. This will be saved with the
30
- # transfer details, displayed in the dashboard, and returned by the API. If
31
- # `individual_name` and `company_name` are not explicitly set by this API, the
32
- # `statement_descriptor` will be sent in those fields to the receiving bank to
33
- # help the customer recognize the transfer. You are highly encouraged to pass
34
- # `individual_name` and `company_name` instead of relying on this fallback.
28
+ # @param company_name [String]
29
+ # The name by which the recipient knows the counterparty of this transaction. If
30
+ # you're processing payments on behalf of another party, use their name, not your
31
+ # own, so that it's more likely the recipient understands the context of the
32
+ # payment. This value is usually displayed to the recipient on their bank
33
+ # statement. We recommend setting this on every transfer; if you do not, we fall
34
+ # back to the `statement_descriptor`.
35
+ #
36
+ # @param individual_name [String]
37
+ # The name of the transfer recipient. This value is informational and generally
38
+ # not verified by the recipient's bank. This value is usually displayed to the
39
+ # recipient on their bank statement. We recommend setting this on every transfer;
40
+ # if you do not, we fall back to the `statement_descriptor`.
35
41
  #
36
42
  # @param account_number [String]
37
43
  # The receiver's account number. For credit transfers (transfers with a positive
@@ -64,14 +70,6 @@ module Increase
64
70
  # code and use case. For example, some use cases require constants like
65
71
  # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
66
72
  #
67
- # @param company_name [String]
68
- # The name by which the recipient knows the counterparty of this transaction. If
69
- # you're processing payments on behalf of another party, use their name, not your
70
- # own, so that it's more likely the recipient understands the context of the
71
- # payment. This value is usually displayed to the recipient on their bank
72
- # statement. We recommend setting this on every transfer; if you do not, we fall
73
- # back to the `statement_descriptor`.
74
- #
75
73
  # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
76
74
  # The type of entity that owns the receiver's account.
77
75
  #
@@ -90,12 +88,6 @@ module Increase
90
88
  # unset. For the specific case of person-to-person credits with the WEB standard
91
89
  # entry class code, this must include the name of the payer.
92
90
  #
93
- # @param individual_name [String]
94
- # The name of the transfer recipient. This value is informational and generally
95
- # not verified by the recipient's bank. This value is usually displayed to the
96
- # recipient on their bank statement. We recommend setting this on every transfer;
97
- # if you do not, we fall back to the `statement_descriptor`.
98
- #
99
91
  # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
100
92
  # Configuration for how the effective date of the transfer will be set. This
101
93
  # determines same-day vs future-dated settlement timing. If not set, defaults to a