increase 1.362.0 → 1.364.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 (165) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -16
  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 +38 -23
  9. data/lib/increase/models/card_payment.rb +6 -0
  10. data/lib/increase/models/card_update_params.rb +12 -8
  11. data/lib/increase/models/check_transfer.rb +58 -44
  12. data/lib/increase/models/check_transfer_create_params.rb +35 -21
  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/export.rb +12 -1
  27. data/lib/increase/models/export_create_params.rb +26 -4
  28. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  29. data/lib/increase/models/inbound_check_deposit.rb +12 -1
  30. data/lib/increase/models/inbound_real_time_payments_transfer.rb +10 -1
  31. data/lib/increase/models/inbound_real_time_payments_transfer_return_params.rb +36 -0
  32. data/lib/increase/models/real_time_decision.rb +65 -1
  33. data/lib/increase/models/real_time_payments_transfer.rb +21 -1
  34. data/lib/increase/models/simulations/checkbook_mail_params.rb +24 -0
  35. data/lib/increase/models/transaction.rb +27 -5
  36. data/lib/increase/models.rb +21 -20
  37. data/lib/increase/resources/account_numbers.rb +19 -16
  38. data/lib/increase/resources/checkbook_checks.rb +90 -0
  39. data/lib/increase/resources/checkbooks.rb +127 -0
  40. data/lib/increase/resources/entities.rb +2 -12
  41. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +28 -0
  42. data/lib/increase/resources/simulations/checkbooks.rb +38 -0
  43. data/lib/increase/resources/simulations.rb +4 -0
  44. data/lib/increase/version.rb +1 -1
  45. data/lib/increase.rb +14 -14
  46. data/rbi/increase/client.rbi +6 -12
  47. data/rbi/increase/models/account_number.rbi +86 -173
  48. data/rbi/increase/models/account_number_create_params.rbi +87 -165
  49. data/rbi/increase/models/account_number_list_params.rbi +106 -105
  50. data/rbi/increase/models/account_number_update_params.rbi +105 -190
  51. data/rbi/increase/models/ach_transfer.rbi +35 -23
  52. data/rbi/increase/models/card_payment.rbi +14 -0
  53. data/rbi/increase/models/card_update_params.rbi +17 -15
  54. data/rbi/increase/models/check_transfer.rbi +72 -54
  55. data/rbi/increase/models/check_transfer_create_params.rbi +55 -21
  56. data/rbi/increase/models/checkbook.rbi +507 -0
  57. data/rbi/increase/models/checkbook_check.rbi +142 -0
  58. data/rbi/increase/models/checkbook_check_list_params.rbi +96 -0
  59. data/rbi/increase/models/{oauth_connection_retrieve_params.rbi → checkbook_check_retrieve_params.rbi} +8 -8
  60. data/rbi/increase/models/{oauth_application_retrieve_params.rbi → checkbook_check_stop_params.rbi} +8 -11
  61. data/rbi/increase/models/checkbook_create_params.rbi +178 -0
  62. data/rbi/increase/models/checkbook_list_params.rbi +198 -0
  63. data/rbi/increase/models/checkbook_retrieve_params.rbi +40 -0
  64. data/rbi/increase/models/checkbook_stop_params.rbi +40 -0
  65. data/rbi/increase/models/declined_transaction.rbi +8 -0
  66. data/rbi/increase/models/entity.rbi +0 -97
  67. data/rbi/increase/models/entity_create_params.rbi +0 -119
  68. data/rbi/increase/models/entity_update_params.rbi +0 -108
  69. data/rbi/increase/models/export.rbi +15 -3
  70. data/rbi/increase/models/export_create_params.rbi +27 -3
  71. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  72. data/rbi/increase/models/inbound_check_deposit.rbi +10 -0
  73. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +8 -0
  74. data/rbi/increase/models/inbound_real_time_payments_transfer_return_params.rbi +61 -0
  75. data/rbi/increase/models/real_time_decision.rbi +134 -3
  76. data/rbi/increase/models/real_time_payments_transfer.rbi +18 -0
  77. data/rbi/increase/models/simulations/checkbook_mail_params.rbi +45 -0
  78. data/rbi/increase/models/transaction.rbi +33 -3
  79. data/rbi/increase/models.rbi +21 -22
  80. data/rbi/increase/resources/account_numbers.rbi +24 -19
  81. data/rbi/increase/resources/checkbook_checks.rbi +69 -0
  82. data/rbi/increase/resources/checkbooks.rbi +96 -0
  83. data/rbi/increase/resources/entities.rbi +0 -11
  84. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +19 -0
  85. data/rbi/increase/resources/simulations/checkbooks.rbi +30 -0
  86. data/rbi/increase/resources/simulations.rbi +3 -0
  87. data/sig/increase/client.rbs +4 -8
  88. data/sig/increase/models/account_number.rbs +34 -66
  89. data/sig/increase/models/account_number_create_params.rbs +30 -64
  90. data/sig/increase/models/account_number_list_params.rbs +44 -44
  91. data/sig/increase/models/account_number_update_params.rbs +39 -77
  92. data/sig/increase/models/ach_transfer.rbs +4 -4
  93. data/sig/increase/models/card_payment.rbs +8 -0
  94. data/sig/increase/models/card_update_params.rbs +7 -11
  95. data/sig/increase/models/check_transfer.rbs +59 -49
  96. data/sig/increase/models/check_transfer_create_params.rbs +20 -12
  97. data/sig/increase/models/checkbook.rbs +272 -0
  98. data/sig/increase/models/checkbook_check.rbs +76 -0
  99. data/sig/increase/models/checkbook_check_list_params.rbs +56 -0
  100. data/sig/increase/models/{oauth_connection_retrieve_params.rbs → checkbook_check_retrieve_params.rbs} +6 -6
  101. data/sig/increase/models/{oauth_application_retrieve_params.rbs → checkbook_check_stop_params.rbs} +6 -6
  102. data/sig/increase/models/checkbook_create_params.rbs +90 -0
  103. data/sig/increase/models/checkbook_list_params.rbs +97 -0
  104. data/sig/increase/models/checkbook_retrieve_params.rbs +23 -0
  105. data/sig/increase/models/checkbook_stop_params.rbs +23 -0
  106. data/sig/increase/models/declined_transaction.rbs +5 -0
  107. data/sig/increase/models/entity.rbs +0 -46
  108. data/sig/increase/models/entity_create_params.rbs +0 -55
  109. data/sig/increase/models/entity_update_params.rbs +0 -48
  110. data/sig/increase/models/export.rbs +13 -3
  111. data/sig/increase/models/export_create_params.rbs +7 -0
  112. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  113. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +5 -0
  114. data/sig/increase/models/inbound_real_time_payments_transfer_return_params.rbs +30 -0
  115. data/sig/increase/models/real_time_decision.rbs +69 -3
  116. data/sig/increase/models/real_time_payments_transfer.rbs +10 -0
  117. data/sig/increase/models/simulations/checkbook_mail_params.rbs +25 -0
  118. data/sig/increase/models/transaction.rbs +26 -5
  119. data/sig/increase/models.rbs +20 -20
  120. data/sig/increase/resources/account_numbers.rbs +5 -5
  121. data/sig/increase/resources/checkbook_checks.rbs +26 -0
  122. data/sig/increase/resources/checkbooks.rbs +33 -0
  123. data/sig/increase/resources/entities.rbs +0 -3
  124. data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +6 -0
  125. data/sig/increase/resources/simulations/checkbooks.rbs +14 -0
  126. data/sig/increase/resources/simulations.rbs +2 -0
  127. metadata +45 -45
  128. data/lib/increase/models/group.rb +0 -57
  129. data/lib/increase/models/group_retrieve_params.rb +0 -14
  130. data/lib/increase/models/oauth_application.rb +0 -111
  131. data/lib/increase/models/oauth_application_list_params.rb +0 -129
  132. data/lib/increase/models/oauth_application_retrieve_params.rb +0 -22
  133. data/lib/increase/models/oauth_connection.rb +0 -107
  134. data/lib/increase/models/oauth_connection_list_params.rb +0 -88
  135. data/lib/increase/models/oauth_connection_retrieve_params.rb +0 -22
  136. data/lib/increase/models/oauth_token.rb +0 -76
  137. data/lib/increase/models/oauth_token_create_params.rb +0 -85
  138. data/lib/increase/resources/groups.rb +0 -32
  139. data/lib/increase/resources/oauth_applications.rb +0 -68
  140. data/lib/increase/resources/oauth_connections.rb +0 -70
  141. data/lib/increase/resources/oauth_tokens.rb +0 -54
  142. data/rbi/increase/models/group.rbi +0 -74
  143. data/rbi/increase/models/group_retrieve_params.rbi +0 -27
  144. data/rbi/increase/models/oauth_application.rbi +0 -146
  145. data/rbi/increase/models/oauth_application_list_params.rbi +0 -263
  146. data/rbi/increase/models/oauth_connection.rbi +0 -142
  147. data/rbi/increase/models/oauth_connection_list_params.rbi +0 -187
  148. data/rbi/increase/models/oauth_token.rbi +0 -106
  149. data/rbi/increase/models/oauth_token_create_params.rbi +0 -133
  150. data/rbi/increase/resources/groups.rbi +0 -21
  151. data/rbi/increase/resources/oauth_applications.rbi +0 -50
  152. data/rbi/increase/resources/oauth_connections.rbi +0 -52
  153. data/rbi/increase/resources/oauth_tokens.rbi +0 -44
  154. data/sig/increase/models/group.rbs +0 -36
  155. data/sig/increase/models/group_retrieve_params.rbs +0 -15
  156. data/sig/increase/models/oauth_application.rbs +0 -74
  157. data/sig/increase/models/oauth_application_list_params.rbs +0 -123
  158. data/sig/increase/models/oauth_connection.rbs +0 -74
  159. data/sig/increase/models/oauth_connection_list_params.rbs +0 -86
  160. data/sig/increase/models/oauth_token.rbs +0 -55
  161. data/sig/increase/models/oauth_token_create_params.rbs +0 -68
  162. data/sig/increase/resources/groups.rbs +0 -11
  163. data/sig/increase/resources/oauth_applications.rbs +0 -20
  164. data/sig/increase/resources/oauth_connections.rbs +0 -20
  165. data/sig/increase/resources/oauth_tokens.rbs +0 -16
@@ -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.
@@ -84,6 +84,12 @@ module Increase
84
84
  # @return [String, nil]
85
85
  required :end_to_end_identification, String, nil?: true
86
86
 
87
+ # @!attribute return_of_real_time_payments_transfer_id
88
+ # The identifier of the Real-Time Payments Transfer this transfer returns, if any.
89
+ #
90
+ # @return [String, nil]
91
+ required :return_of_real_time_payments_transfer_id, String, nil?: true
92
+
87
93
  # @!attribute status
88
94
  # The lifecycle status of the transfer.
89
95
  #
@@ -109,7 +115,7 @@ module Increase
109
115
  # @return [String, nil]
110
116
  required :unstructured_remittance_information, String, nil?: true
111
117
 
112
- # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, status:, transaction_identification:, type:, unstructured_remittance_information:)
118
+ # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, return_of_real_time_payments_transfer_id:, status:, transaction_identification:, type:, unstructured_remittance_information:)
113
119
  # An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer
114
120
  # initiated outside of Increase to your account.
115
121
  #
@@ -147,6 +153,9 @@ module Increase
147
153
  # @param end_to_end_identification [String, nil]
148
154
  # A free-form reference string set by the sender, to help identify the transfer.
149
155
  #
156
+ # @param return_of_real_time_payments_transfer_id [String, nil]
157
+ # The identifier of the Real-Time Payments Transfer this transfer returns, if any.
158
+ #
150
159
  # @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status]
151
160
  # The lifecycle status of the transfer.
152
161
  #
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::InboundRealTimePaymentsTransfers#return_
6
+ class InboundRealTimePaymentsTransferReturnParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute inbound_real_time_payments_transfer_id
11
+ # The identifier of the Inbound Real-Time Payments Transfer to return to its
12
+ # sender.
13
+ #
14
+ # @return [String]
15
+ required :inbound_real_time_payments_transfer_id, String
16
+
17
+ # @!attribute amount
18
+ # The amount to return, in USD cents. Defaults to the full amount of the Inbound
19
+ # Real-Time Payments Transfer, and can't be higher than it.
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :amount, Integer
23
+
24
+ # @!method initialize(inbound_real_time_payments_transfer_id:, amount: nil, request_options: {})
25
+ # @param inbound_real_time_payments_transfer_id [String]
26
+ # The identifier of the Inbound Real-Time Payments Transfer to return to its
27
+ # sender.
28
+ #
29
+ # @param amount [Integer]
30
+ # The amount to return, in USD cents. Defaults to the full amount of the Inbound
31
+ # Real-Time Payments Transfer, and can't be higher than it.
32
+ #
33
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
34
+ end
35
+ end
36
+ end
@@ -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.
@@ -83,6 +83,12 @@ module Increase
83
83
  # @return [String, nil]
84
84
  required :debtor_name, String, nil?: true
85
85
 
86
+ # @!attribute end_to_end_identification
87
+ # A free-form reference string set by the sender, to help identify the transfer.
88
+ #
89
+ # @return [String, nil]
90
+ required :end_to_end_identification, String, nil?: true
91
+
86
92
  # @!attribute external_account_id
87
93
  # The identifier of the External Account the transfer was made to, if any.
88
94
  #
@@ -120,6 +126,13 @@ module Increase
120
126
  # @return [Increase::Models::RealTimePaymentsTransfer::Rejection, nil]
121
127
  required :rejection, -> { Increase::RealTimePaymentsTransfer::Rejection }, nil?: true
122
128
 
129
+ # @!attribute return_of_inbound_real_time_payments_transfer_id
130
+ # The identifier of the Inbound Real-Time Payments Transfer this transfer returns,
131
+ # if any.
132
+ #
133
+ # @return [String, nil]
134
+ required :return_of_inbound_real_time_payments_transfer_id, String, nil?: true
135
+
123
136
  # @!attribute routing_number
124
137
  # The destination American Bankers' Association (ABA) Routing Transit Number
125
138
  # (RTN).
@@ -179,7 +192,7 @@ module Increase
179
192
  # @return [String]
180
193
  required :unstructured_remittance_information, String
181
194
 
182
- # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, inbound_real_time_payments_request_for_payment_id:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
195
+ # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, end_to_end_identification:, external_account_id:, idempotency_key:, inbound_real_time_payments_request_for_payment_id:, pending_transaction_id:, rejection:, return_of_inbound_real_time_payments_transfer_id:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
183
196
  # Real-Time Payments transfers move funds, within seconds, between your Increase
184
197
  # account and any other account on the Real-Time Payments network.
185
198
  #
@@ -222,6 +235,9 @@ module Increase
222
235
  # The name of the transfer's sender. If not provided, defaults to the name of the
223
236
  # account's entity.
224
237
  #
238
+ # @param end_to_end_identification [String, nil]
239
+ # A free-form reference string set by the sender, to help identify the transfer.
240
+ #
225
241
  # @param external_account_id [String, nil]
226
242
  # The identifier of the External Account the transfer was made to, if any.
227
243
  #
@@ -244,6 +260,10 @@ module Increase
244
260
  # If the transfer is rejected by Real-Time Payments or the destination financial
245
261
  # institution, this will contain supplemental details.
246
262
  #
263
+ # @param return_of_inbound_real_time_payments_transfer_id [String, nil]
264
+ # The identifier of the Inbound Real-Time Payments Transfer this transfer returns,
265
+ # if any.
266
+ #
247
267
  # @param routing_number [String]
248
268
  # The destination American Bankers' Association (ABA) Routing Transit Number
249
269
  # (RTN).
@@ -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
@@ -1129,8 +1129,8 @@ module Increase
1129
1129
  # @!attribute statement_descriptor
1130
1130
  # A description set when the ACH Transfer was created.
1131
1131
  #
1132
- # @return [String]
1133
- required :statement_descriptor, String
1132
+ # @return [String, nil]
1133
+ required :statement_descriptor, String, nil?: true
1134
1134
 
1135
1135
  # @!attribute transfer_id
1136
1136
  # The identifier of the ACH Transfer that led to this Transaction.
@@ -1154,7 +1154,7 @@ module Increase
1154
1154
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
1155
1155
  # destination account.
1156
1156
  #
1157
- # @param statement_descriptor [String] A description set when the ACH Transfer was created.
1157
+ # @param statement_descriptor [String, nil] A description set when the ACH Transfer was created.
1158
1158
  #
1159
1159
  # @param transfer_id [String] The identifier of the ACH Transfer that led to this Transaction.
1160
1160
  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
@@ -335,10 +353,6 @@ module Increase
335
353
 
336
354
  FileRetrieveParams = Increase::Models::FileRetrieveParams
337
355
 
338
- Group = Increase::Models::Group
339
-
340
- GroupRetrieveParams = Increase::Models::GroupRetrieveParams
341
-
342
356
  InboundACHTransfer = Increase::Models::InboundACHTransfer
343
357
 
344
358
  InboundACHTransferCreateNotificationOfChangeParams =
@@ -391,6 +405,9 @@ module Increase
391
405
  InboundRealTimePaymentsTransferRetrieveParams =
392
406
  Increase::Models::InboundRealTimePaymentsTransferRetrieveParams
393
407
 
408
+ InboundRealTimePaymentsTransferReturnParams =
409
+ Increase::Models::InboundRealTimePaymentsTransferReturnParams
410
+
394
411
  InboundWireDrawdownRequest = Increase::Models::InboundWireDrawdownRequest
395
412
 
396
413
  InboundWireDrawdownRequestListParams = Increase::Models::InboundWireDrawdownRequestListParams
@@ -449,22 +466,6 @@ module Increase
449
466
 
450
467
  LockboxRecipientUpdateParams = Increase::Models::LockboxRecipientUpdateParams
451
468
 
452
- OAuthApplication = Increase::Models::OAuthApplication
453
-
454
- OAuthApplicationListParams = Increase::Models::OAuthApplicationListParams
455
-
456
- OAuthApplicationRetrieveParams = Increase::Models::OAuthApplicationRetrieveParams
457
-
458
- OAuthConnection = Increase::Models::OAuthConnection
459
-
460
- OAuthConnectionListParams = Increase::Models::OAuthConnectionListParams
461
-
462
- OAuthConnectionRetrieveParams = Increase::Models::OAuthConnectionRetrieveParams
463
-
464
- OAuthToken = Increase::Models::OAuthToken
465
-
466
- OAuthTokenCreateParams = Increase::Models::OAuthTokenCreateParams
467
-
468
469
  PendingTransaction = Increase::Models::PendingTransaction
469
470
 
470
471
  PendingTransactionCreateParams = Increase::Models::PendingTransactionCreateParams
@@ -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.
@@ -0,0 +1,90 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class CheckbookChecks
6
+ # Retrieve a Checkbook Check
7
+ #
8
+ # @overload retrieve(checkbook_check_id, request_options: {})
9
+ #
10
+ # @param checkbook_check_id [String] The identifier of the Checkbook Check.
11
+ #
12
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
13
+ #
14
+ # @return [Increase::Models::CheckbookCheck]
15
+ #
16
+ # @see Increase::Models::CheckbookCheckRetrieveParams
17
+ def retrieve(checkbook_check_id, params = {})
18
+ @client.request(
19
+ method: :get,
20
+ path: ["checkbook_checks/%1$s", checkbook_check_id],
21
+ model: Increase::CheckbookCheck,
22
+ options: params[:request_options]
23
+ )
24
+ end
25
+
26
+ # List Checkbook Checks
27
+ #
28
+ # @overload list(account_number_id: nil, check_number: nil, checkbook_id: nil, cursor: nil, limit: nil, request_options: {})
29
+ #
30
+ # @param account_number_id [String] Filter Checkbook Checks to those drawn on the specified Account Number.
31
+ #
32
+ # @param check_number [Integer] Filter Checkbook Checks to the one with the specified check number.
33
+ #
34
+ # @param checkbook_id [String] Filter Checkbook Checks to those belonging to the specified Checkbook.
35
+ #
36
+ # @param cursor [String] Return the page of entries after this one.
37
+ #
38
+ # @param limit [Integer]
39
+ # Limit the size of the list that is returned. The default (and maximum) is 100
40
+ # objects.
41
+ #
42
+ # Defaults to `100`.
43
+ #
44
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
45
+ #
46
+ # @return [Increase::Internal::Page<Increase::Models::CheckbookCheck>]
47
+ #
48
+ # @see Increase::Models::CheckbookCheckListParams
49
+ def list(params = {})
50
+ parsed, options = Increase::CheckbookCheckListParams.dump_request(params)
51
+ query = Increase::Internal::Util.encode_query_params(parsed)
52
+ @client.request(
53
+ method: :get,
54
+ path: "checkbook_checks",
55
+ query: query,
56
+ page: Increase::Internal::Page,
57
+ model: Increase::CheckbookCheck,
58
+ options: options
59
+ )
60
+ end
61
+
62
+ # Stop a Checkbook Check. A stopped check cannot be deposited.
63
+ #
64
+ # @overload stop(checkbook_check_id, request_options: {})
65
+ #
66
+ # @param checkbook_check_id [String] The identifier of the Checkbook Check to stop.
67
+ #
68
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
69
+ #
70
+ # @return [Increase::Models::CheckbookCheck]
71
+ #
72
+ # @see Increase::Models::CheckbookCheckStopParams
73
+ def stop(checkbook_check_id, params = {})
74
+ @client.request(
75
+ method: :post,
76
+ path: ["checkbook_checks/%1$s/stop", checkbook_check_id],
77
+ model: Increase::CheckbookCheck,
78
+ options: params[:request_options]
79
+ )
80
+ end
81
+
82
+ # @api private
83
+ #
84
+ # @param client [Increase::Client]
85
+ def initialize(client:)
86
+ @client = client
87
+ end
88
+ end
89
+ end
90
+ end