increase 1.77.0 → 1.79.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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/models/declined_transaction.rb +68 -1
  5. data/lib/increase/models/declined_transaction_list_params.rb +3 -0
  6. data/lib/increase/models/event.rb +6 -0
  7. data/lib/increase/models/event_list_params.rb +6 -0
  8. data/lib/increase/models/event_subscription.rb +6 -0
  9. data/lib/increase/models/event_subscription_create_params.rb +6 -0
  10. data/lib/increase/models/transaction.rb +36 -1
  11. data/lib/increase/models/transaction_list_params.rb +3 -0
  12. data/lib/increase/models/wire_transfer.rb +114 -4
  13. data/lib/increase/models/wire_transfer_create_params.rb +110 -9
  14. data/lib/increase/resources/wire_transfers.rb +3 -3
  15. data/lib/increase/version.rb +1 -1
  16. data/rbi/increase/models/declined_transaction.rbi +159 -0
  17. data/rbi/increase/models/declined_transaction_list_params.rbi +7 -0
  18. data/rbi/increase/models/event.rbi +14 -0
  19. data/rbi/increase/models/event_list_params.rbi +14 -0
  20. data/rbi/increase/models/event_subscription.rbi +14 -0
  21. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  22. data/rbi/increase/models/transaction.rbi +75 -0
  23. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  24. data/rbi/increase/models/wire_transfer.rbi +215 -3
  25. data/rbi/increase/models/wire_transfer_create_params.rbi +222 -8
  26. data/rbi/increase/resources/wire_transfers.rbi +3 -3
  27. data/sig/increase/models/declined_transaction.rbs +63 -0
  28. data/sig/increase/models/declined_transaction_list_params.rbs +4 -0
  29. data/sig/increase/models/event.rbs +8 -0
  30. data/sig/increase/models/event_list_params.rbs +8 -0
  31. data/sig/increase/models/event_subscription.rbs +8 -0
  32. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  33. data/sig/increase/models/transaction.rbs +19 -0
  34. data/sig/increase/models/transaction_list_params.rbs +4 -0
  35. data/sig/increase/models/wire_transfer.rbs +83 -4
  36. data/sig/increase/models/wire_transfer_create_params.rbs +91 -5
  37. data/sig/increase/resources/wire_transfers.rbs +1 -1
  38. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8c813e5a546b3674e44faadd523d88575f10cfe4b937928713a0197d2cc13be7
4
- data.tar.gz: 7d25cbe0e2ba6279c2f4f19756fd5582981c83b5c3f6ba43ef9f0c38b5afa39a
3
+ metadata.gz: 6c5b92e73ba126ba3fd2e51f0daf32916eab2b8461cfb727d41c44ef527b849c
4
+ data.tar.gz: 259d27d9da40bcbdfc0ef8aa6e82ddbf5570b1c21934ef094897966c9b0651a3
5
5
  SHA512:
6
- metadata.gz: bb6301981f62b30333d649079819c9f2c98e7d64b35190ed514948fdaba6800f9c4f1953f26019f7b1cb17d703d8c8c37192514c0f29769c5de0b607b5c6f67b
7
- data.tar.gz: 3e2cd45eafd8353eda49f6a99dee8ad79e824c72a5c711c97660d7b44c64dfd87417d546c80095269ca3dd7f23360829239f1b0540365fed3582811d4afebbc8
6
+ metadata.gz: b00cbed7091b9fa5efc717f5bd45ea74d7e7aecd41faef7fe164e547894202301e5ae86790c36edfabc9a7fccaa72c147f5db42f78d0012f0eebcc5e40937261
7
+ data.tar.gz: 77489da2c3045abf788245c70f5e98d4a6b514c68fb2f93bc4f9a8f42b3d6e0b9ee3ea50826898d1cf6ad0d4327516fe2161b6f8b294af3af3b37c0ee32ea259
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.79.0 (2025-09-17)
4
+
5
+ Full Changelog: [v1.78.0...v1.79.0](https://github.com/Increase/increase-ruby/compare/v1.78.0...v1.79.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([c64de91](https://github.com/Increase/increase-ruby/commit/c64de918f9abb0fbe0eb7dfbaee91f3f773331c7))
10
+
11
+ ## 1.78.0 (2025-09-16)
12
+
13
+ Full Changelog: [v1.77.0...v1.78.0](https://github.com/Increase/increase-ruby/compare/v1.77.0...v1.78.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([a643e15](https://github.com/Increase/increase-ruby/commit/a643e1536b7cdfb7e311d9f6cfd18eaef9a4db7d))
18
+
3
19
  ## 1.77.0 (2025-09-16)
4
20
 
5
21
  Full Changelog: [v1.76.0...v1.77.0](https://github.com/Increase/increase-ruby/compare/v1.76.0...v1.77.0)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.77.0"
18
+ gem "increase", "~> 1.79.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -190,6 +190,16 @@ module Increase
190
190
  -> { Increase::DeclinedTransaction::Source::CheckDepositRejection },
191
191
  nil?: true
192
192
 
193
+ # @!attribute inbound_fednow_transfer_decline
194
+ # An Inbound FedNow Transfer Decline object. This field will be present in the
195
+ # JSON response if and only if `category` is equal to
196
+ # `inbound_fednow_transfer_decline`.
197
+ #
198
+ # @return [Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline, nil]
199
+ required :inbound_fednow_transfer_decline,
200
+ -> { Increase::DeclinedTransaction::Source::InboundFednowTransferDecline },
201
+ nil?: true
202
+
193
203
  # @!attribute inbound_real_time_payments_transfer_decline
194
204
  # An Inbound Real-Time Payments Transfer Decline object. This field will be
195
205
  # present in the JSON response if and only if `category` is equal to
@@ -214,7 +224,7 @@ module Increase
214
224
  # @return [Increase::Models::DeclinedTransaction::Source::WireDecline, nil]
215
225
  required :wire_decline, -> { Increase::DeclinedTransaction::Source::WireDecline }, nil?: true
216
226
 
217
- # @!method initialize(ach_decline:, card_decline:, category:, check_decline:, check_deposit_rejection:, inbound_real_time_payments_transfer_decline:, other:, wire_decline:)
227
+ # @!method initialize(ach_decline:, card_decline:, category:, check_decline:, check_deposit_rejection:, inbound_fednow_transfer_decline:, inbound_real_time_payments_transfer_decline:, other:, wire_decline:)
218
228
  # Some parameter documentations has been truncated, see
219
229
  # {Increase::Models::DeclinedTransaction::Source} for more details.
220
230
  #
@@ -234,6 +244,8 @@ module Increase
234
244
  #
235
245
  # @param check_deposit_rejection [Increase::Models::DeclinedTransaction::Source::CheckDepositRejection, nil] A Check Deposit Rejection object. This field will be present in the JSON respons
236
246
  #
247
+ # @param inbound_fednow_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline, nil] An Inbound FedNow Transfer Decline object. This field will be present in the JSO
248
+ #
237
249
  # @param inbound_real_time_payments_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, nil] An Inbound Real-Time Payments Transfer Decline object. This field will be presen
238
250
  #
239
251
  # @param other [Object, nil] If the category of this Transaction source is equal to `other`, this field will
@@ -1644,6 +1656,9 @@ module Increase
1644
1656
  # Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.
1645
1657
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_DECLINE = :inbound_real_time_payments_transfer_decline
1646
1658
 
1659
+ # Inbound FedNow Transfer Decline: details will be under the `inbound_fednow_transfer_decline` object.
1660
+ INBOUND_FEDNOW_TRANSFER_DECLINE = :inbound_fednow_transfer_decline
1661
+
1647
1662
  # Wire Decline: details will be under the `wire_decline` object.
1648
1663
  WIRE_DECLINE = :wire_decline
1649
1664
 
@@ -1925,6 +1940,58 @@ module Increase
1925
1940
  end
1926
1941
  end
1927
1942
 
1943
+ # @see Increase::Models::DeclinedTransaction::Source#inbound_fednow_transfer_decline
1944
+ class InboundFednowTransferDecline < Increase::Internal::Type::BaseModel
1945
+ # @!attribute reason
1946
+ # Why the transfer was declined.
1947
+ #
1948
+ # @return [Symbol, Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::Reason]
1949
+ required :reason, enum: -> { Increase::DeclinedTransaction::Source::InboundFednowTransferDecline::Reason }
1950
+
1951
+ # @!attribute transfer_id
1952
+ # The identifier of the FedNow Transfer that led to this declined transaction.
1953
+ #
1954
+ # @return [String]
1955
+ required :transfer_id, String
1956
+
1957
+ # @!method initialize(reason:, transfer_id:)
1958
+ # An Inbound FedNow Transfer Decline object. This field will be present in the
1959
+ # JSON response if and only if `category` is equal to
1960
+ # `inbound_fednow_transfer_decline`.
1961
+ #
1962
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::Reason] Why the transfer was declined.
1963
+ #
1964
+ # @param transfer_id [String] The identifier of the FedNow Transfer that led to this declined transaction.
1965
+
1966
+ # Why the transfer was declined.
1967
+ #
1968
+ # @see Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline#reason
1969
+ module Reason
1970
+ extend Increase::Internal::Type::Enum
1971
+
1972
+ # The account number is canceled.
1973
+ ACCOUNT_NUMBER_CANCELED = :account_number_canceled
1974
+
1975
+ # The account number is disabled.
1976
+ ACCOUNT_NUMBER_DISABLED = :account_number_disabled
1977
+
1978
+ # Your account is restricted.
1979
+ ACCOUNT_RESTRICTED = :account_restricted
1980
+
1981
+ # Your account is inactive.
1982
+ GROUP_LOCKED = :group_locked
1983
+
1984
+ # The account's entity is not active.
1985
+ ENTITY_NOT_ACTIVE = :entity_not_active
1986
+
1987
+ # Your account is not enabled to receive FedNow transfers.
1988
+ FEDNOW_NOT_ENABLED = :fednow_not_enabled
1989
+
1990
+ # @!method self.values
1991
+ # @return [Array<Symbol>]
1992
+ end
1993
+ end
1994
+
1928
1995
  # @see Increase::Models::DeclinedTransaction::Source#inbound_real_time_payments_transfer_decline
1929
1996
  class InboundRealTimePaymentsTransferDecline < Increase::Internal::Type::BaseModel
1930
1997
  # @!attribute amount
@@ -93,6 +93,9 @@ module Increase
93
93
  # Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.
94
94
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_DECLINE = :inbound_real_time_payments_transfer_decline
95
95
 
96
+ # Inbound FedNow Transfer Decline: details will be under the `inbound_fednow_transfer_decline` object.
97
+ INBOUND_FEDNOW_TRANSFER_DECLINE = :inbound_fednow_transfer_decline
98
+
96
99
  # Wire Decline: details will be under the `wire_decline` object.
97
100
  WIRE_DECLINE = :wire_decline
98
101
 
@@ -223,6 +223,12 @@ module Increase
223
223
  # Occurs whenever an Inbound Check Deposit is updated.
224
224
  INBOUND_CHECK_DEPOSIT_UPDATED = :"inbound_check_deposit.updated"
225
225
 
226
+ # Occurs whenever an Inbound FedNow Transfer is created.
227
+ INBOUND_FEDNOW_TRANSFER_CREATED = :"inbound_fednow_transfer.created"
228
+
229
+ # Occurs whenever an Inbound FedNow Transfer is updated.
230
+ INBOUND_FEDNOW_TRANSFER_UPDATED = :"inbound_fednow_transfer.updated"
231
+
226
232
  # Occurs whenever an Inbound Mail Item is created.
227
233
  INBOUND_MAIL_ITEM_CREATED = :"inbound_mail_item.created"
228
234
 
@@ -225,6 +225,12 @@ module Increase
225
225
  # Occurs whenever an Inbound Check Deposit is updated.
226
226
  INBOUND_CHECK_DEPOSIT_UPDATED = :"inbound_check_deposit.updated"
227
227
 
228
+ # Occurs whenever an Inbound FedNow Transfer is created.
229
+ INBOUND_FEDNOW_TRANSFER_CREATED = :"inbound_fednow_transfer.created"
230
+
231
+ # Occurs whenever an Inbound FedNow Transfer is updated.
232
+ INBOUND_FEDNOW_TRANSFER_UPDATED = :"inbound_fednow_transfer.updated"
233
+
228
234
  # Occurs whenever an Inbound Mail Item is created.
229
235
  INBOUND_MAIL_ITEM_CREATED = :"inbound_mail_item.created"
230
236
 
@@ -246,6 +246,12 @@ module Increase
246
246
  # Occurs whenever an Inbound Check Deposit is updated.
247
247
  INBOUND_CHECK_DEPOSIT_UPDATED = :"inbound_check_deposit.updated"
248
248
 
249
+ # Occurs whenever an Inbound FedNow Transfer is created.
250
+ INBOUND_FEDNOW_TRANSFER_CREATED = :"inbound_fednow_transfer.created"
251
+
252
+ # Occurs whenever an Inbound FedNow Transfer is updated.
253
+ INBOUND_FEDNOW_TRANSFER_UPDATED = :"inbound_fednow_transfer.updated"
254
+
249
255
  # Occurs whenever an Inbound Mail Item is created.
250
256
  INBOUND_MAIL_ITEM_CREATED = :"inbound_mail_item.created"
251
257
 
@@ -207,6 +207,12 @@ module Increase
207
207
  # Occurs whenever an Inbound Check Deposit is updated.
208
208
  INBOUND_CHECK_DEPOSIT_UPDATED = :"inbound_check_deposit.updated"
209
209
 
210
+ # Occurs whenever an Inbound FedNow Transfer is created.
211
+ INBOUND_FEDNOW_TRANSFER_CREATED = :"inbound_fednow_transfer.created"
212
+
213
+ # Occurs whenever an Inbound FedNow Transfer is updated.
214
+ INBOUND_FEDNOW_TRANSFER_UPDATED = :"inbound_fednow_transfer.updated"
215
+
210
216
  # Occurs whenever an Inbound Mail Item is created.
211
217
  INBOUND_MAIL_ITEM_CREATED = :"inbound_mail_item.created"
212
218
 
@@ -401,6 +401,18 @@ module Increase
401
401
  -> { Increase::Transaction::Source::InboundCheckDepositReturnIntention },
402
402
  nil?: true
403
403
 
404
+ # @!attribute inbound_fednow_transfer_confirmation
405
+ # An Inbound FedNow Transfer Confirmation object. This field will be present in
406
+ # the JSON response if and only if `category` is equal to
407
+ # `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation
408
+ # is created when a FedNow transfer is initiated at another bank and received by
409
+ # Increase.
410
+ #
411
+ # @return [Increase::Models::Transaction::Source::InboundFednowTransferConfirmation, nil]
412
+ required :inbound_fednow_transfer_confirmation,
413
+ -> { Increase::Transaction::Source::InboundFednowTransferConfirmation },
414
+ nil?: true
415
+
404
416
  # @!attribute inbound_real_time_payments_transfer_confirmation
405
417
  # An Inbound Real-Time Payments Transfer Confirmation object. This field will be
406
418
  # present in the JSON response if and only if `category` is equal to
@@ -518,7 +530,7 @@ module Increase
518
530
  },
519
531
  nil?: true
520
532
 
521
- # @!method initialize(account_revenue_payment:, account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_financial:, card_dispute_loss:, card_push_transfer_acceptance:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fednow_transfer_acknowledgement:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_real_time_payments_transfer_confirmation:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, swift_transfer_intention:, swift_transfer_return:, wire_transfer_intention:)
533
+ # @!method initialize(account_revenue_payment:, account_transfer_intention:, ach_transfer_intention:, ach_transfer_rejection:, ach_transfer_return:, card_dispute_acceptance:, card_dispute_financial:, card_dispute_loss:, card_push_transfer_acceptance:, card_refund:, card_revenue_payment:, card_settlement:, cashback_payment:, category:, check_deposit_acceptance:, check_deposit_return:, check_transfer_deposit:, fednow_transfer_acknowledgement:, fee_payment:, inbound_ach_transfer:, inbound_ach_transfer_return_intention:, inbound_check_adjustment:, inbound_check_deposit_return_intention:, inbound_fednow_transfer_confirmation:, inbound_real_time_payments_transfer_confirmation:, inbound_wire_reversal:, inbound_wire_transfer:, inbound_wire_transfer_reversal:, interest_payment:, internal_source:, other:, real_time_payments_transfer_acknowledgement:, sample_funds:, swift_transfer_intention:, swift_transfer_return:, wire_transfer_intention:)
522
534
  # Some parameter documentations has been truncated, see
523
535
  # {Increase::Models::Transaction::Source} for more details.
524
536
  #
@@ -573,6 +585,8 @@ module Increase
573
585
  #
574
586
  # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil] An Inbound Check Deposit Return Intention object. This field will be present in
575
587
  #
588
+ # @param inbound_fednow_transfer_confirmation [Increase::Models::Transaction::Source::InboundFednowTransferConfirmation, nil] An Inbound FedNow Transfer Confirmation object. This field will be present in th
589
+ #
576
590
  # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil] An Inbound Real-Time Payments Transfer Confirmation object. This field will be p
577
591
  #
578
592
  # @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil] An Inbound Wire Reversal object. This field will be present in the JSON response
@@ -4281,6 +4295,9 @@ module Increase
4281
4295
  # Inbound Check Adjustment: details will be under the `inbound_check_adjustment` object.
4282
4296
  INBOUND_CHECK_ADJUSTMENT = :inbound_check_adjustment
4283
4297
 
4298
+ # Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.
4299
+ INBOUND_FEDNOW_TRANSFER_CONFIRMATION = :inbound_fednow_transfer_confirmation
4300
+
4284
4301
  # Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.
4285
4302
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CONFIRMATION = :inbound_real_time_payments_transfer_confirmation
4286
4303
 
@@ -5068,6 +5085,24 @@ module Increase
5068
5085
  # @param transfer_id [String, nil] The identifier of the Check Transfer object that was deposited.
5069
5086
  end
5070
5087
 
5088
+ # @see Increase::Models::Transaction::Source#inbound_fednow_transfer_confirmation
5089
+ class InboundFednowTransferConfirmation < Increase::Internal::Type::BaseModel
5090
+ # @!attribute transfer_id
5091
+ # The identifier of the FedNow Transfer that led to this Transaction.
5092
+ #
5093
+ # @return [String]
5094
+ required :transfer_id, String
5095
+
5096
+ # @!method initialize(transfer_id:)
5097
+ # An Inbound FedNow Transfer Confirmation object. This field will be present in
5098
+ # the JSON response if and only if `category` is equal to
5099
+ # `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation
5100
+ # is created when a FedNow transfer is initiated at another bank and received by
5101
+ # Increase.
5102
+ #
5103
+ # @param transfer_id [String] The identifier of the FedNow Transfer that led to this Transaction.
5104
+ end
5105
+
5071
5106
  # @see Increase::Models::Transaction::Source#inbound_real_time_payments_transfer_confirmation
5072
5107
  class InboundRealTimePaymentsTransferConfirmation < Increase::Internal::Type::BaseModel
5073
5108
  # @!attribute amount
@@ -142,6 +142,9 @@ module Increase
142
142
  # Inbound Check Adjustment: details will be under the `inbound_check_adjustment` object.
143
143
  INBOUND_CHECK_ADJUSTMENT = :inbound_check_adjustment
144
144
 
145
+ # Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.
146
+ INBOUND_FEDNOW_TRANSFER_CONFIRMATION = :inbound_fednow_transfer_confirmation
147
+
145
148
  # Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.
146
149
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CONFIRMATION = :inbound_real_time_payments_transfer_confirmation
147
150
 
@@ -110,8 +110,8 @@ module Increase
110
110
  # @!attribute message_to_recipient
111
111
  # The message that will show on the recipient's bank statement.
112
112
  #
113
- # @return [String, nil]
114
- required :message_to_recipient, String, nil?: true
113
+ # @return [String]
114
+ required :message_to_recipient, String
115
115
 
116
116
  # @!attribute network
117
117
  # The transfer's network.
@@ -152,6 +152,12 @@ module Increase
152
152
  # @return [String, nil]
153
153
  required :pending_transaction_id, String, nil?: true
154
154
 
155
+ # @!attribute remittance
156
+ # Remittance information sent with the wire transfer.
157
+ #
158
+ # @return [Increase::Models::WireTransfer::Remittance, nil]
159
+ required :remittance, -> { Increase::WireTransfer::Remittance }, nil?: true
160
+
155
161
  # @!attribute reversal
156
162
  # If your transfer is reversed, this will contain details of the reversal.
157
163
  #
@@ -196,7 +202,7 @@ module Increase
196
202
  # @return [Symbol, Increase::Models::WireTransfer::Type]
197
203
  required :type, enum: -> { Increase::WireTransfer::Type }
198
204
 
199
- # @!method initialize(id:, account_id:, account_number:, amount:, approval:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, cancellation:, created_at:, created_by:, currency:, external_account_id:, idempotency_key:, inbound_wire_drawdown_request_id:, message_to_recipient:, network:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, pending_transaction_id:, reversal:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:)
205
+ # @!method initialize(id:, account_id:, account_number:, amount:, approval:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, cancellation:, created_at:, created_by:, currency:, external_account_id:, idempotency_key:, inbound_wire_drawdown_request_id:, message_to_recipient:, network:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, pending_transaction_id:, remittance:, reversal:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:)
200
206
  # Some parameter documentations has been truncated, see
201
207
  # {Increase::Models::WireTransfer} for more details.
202
208
  #
@@ -235,7 +241,7 @@ module Increase
235
241
  #
236
242
  # @param inbound_wire_drawdown_request_id [String, nil] The ID of an Inbound Wire Drawdown Request in response to which this transfer wa
237
243
  #
238
- # @param message_to_recipient [String, nil] The message that will show on the recipient's bank statement.
244
+ # @param message_to_recipient [String] The message that will show on the recipient's bank statement.
239
245
  #
240
246
  # @param network [Symbol, Increase::Models::WireTransfer::Network] The transfer's network.
241
247
  #
@@ -249,6 +255,8 @@ module Increase
249
255
  #
250
256
  # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
251
257
  #
258
+ # @param remittance [Increase::Models::WireTransfer::Remittance, nil] Remittance information sent with the wire transfer.
259
+ #
252
260
  # @param reversal [Increase::Models::WireTransfer::Reversal, nil] If your transfer is reversed, this will contain details of the reversal.
253
261
  #
254
262
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
@@ -459,6 +467,108 @@ module Increase
459
467
  # @return [Array<Symbol>]
460
468
  end
461
469
 
470
+ # @see Increase::Models::WireTransfer#remittance
471
+ class Remittance < Increase::Internal::Type::BaseModel
472
+ # @!attribute category
473
+ # The type of remittance information being passed.
474
+ #
475
+ # @return [Symbol, Increase::Models::WireTransfer::Remittance::Category]
476
+ required :category, enum: -> { Increase::WireTransfer::Remittance::Category }
477
+
478
+ # @!attribute tax
479
+ # Internal Revenue Service (IRS) tax repayment information. Required if `category`
480
+ # is equal to `tax`.
481
+ #
482
+ # @return [Increase::Models::WireTransfer::Remittance::Tax, nil]
483
+ required :tax, -> { Increase::WireTransfer::Remittance::Tax }, nil?: true
484
+
485
+ # @!attribute unstructured
486
+ # Unstructured remittance information. Required if `category` is equal to
487
+ # `unstructured`.
488
+ #
489
+ # @return [Increase::Models::WireTransfer::Remittance::Unstructured, nil]
490
+ required :unstructured, -> { Increase::WireTransfer::Remittance::Unstructured }, nil?: true
491
+
492
+ # @!method initialize(category:, tax:, unstructured:)
493
+ # Some parameter documentations has been truncated, see
494
+ # {Increase::Models::WireTransfer::Remittance} for more details.
495
+ #
496
+ # Remittance information sent with the wire transfer.
497
+ #
498
+ # @param category [Symbol, Increase::Models::WireTransfer::Remittance::Category] The type of remittance information being passed.
499
+ #
500
+ # @param tax [Increase::Models::WireTransfer::Remittance::Tax, nil] Internal Revenue Service (IRS) tax repayment information. Required if `category`
501
+ #
502
+ # @param unstructured [Increase::Models::WireTransfer::Remittance::Unstructured, nil] Unstructured remittance information. Required if `category` is equal to `unstruc
503
+
504
+ # The type of remittance information being passed.
505
+ #
506
+ # @see Increase::Models::WireTransfer::Remittance#category
507
+ module Category
508
+ extend Increase::Internal::Type::Enum
509
+
510
+ # The wire transfer contains unstructured remittance information.
511
+ UNSTRUCTURED = :unstructured
512
+
513
+ # The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS).
514
+ TAX = :tax
515
+
516
+ # @!method self.values
517
+ # @return [Array<Symbol>]
518
+ end
519
+
520
+ # @see Increase::Models::WireTransfer::Remittance#tax
521
+ class Tax < Increase::Internal::Type::BaseModel
522
+ # @!attribute date
523
+ # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
524
+ # ignored.
525
+ #
526
+ # @return [Date]
527
+ required :date, Date
528
+
529
+ # @!attribute identification_number
530
+ # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
531
+ # (EIN).
532
+ #
533
+ # @return [String]
534
+ required :identification_number, String
535
+
536
+ # @!attribute type_code
537
+ # The 5-character tax type code.
538
+ #
539
+ # @return [String]
540
+ required :type_code, String
541
+
542
+ # @!method initialize(date:, identification_number:, type_code:)
543
+ # Some parameter documentations has been truncated, see
544
+ # {Increase::Models::WireTransfer::Remittance::Tax} for more details.
545
+ #
546
+ # Internal Revenue Service (IRS) tax repayment information. Required if `category`
547
+ # is equal to `tax`.
548
+ #
549
+ # @param date [Date] The month and year the tax payment is for, in YYYY-MM-DD format. The day is igno
550
+ #
551
+ # @param identification_number [String] The 9-digit Tax Identification Number (TIN) or Employer Identification Number (E
552
+ #
553
+ # @param type_code [String] The 5-character tax type code.
554
+ end
555
+
556
+ # @see Increase::Models::WireTransfer::Remittance#unstructured
557
+ class Unstructured < Increase::Internal::Type::BaseModel
558
+ # @!attribute message
559
+ # The message to the beneficiary.
560
+ #
561
+ # @return [String]
562
+ required :message, String
563
+
564
+ # @!method initialize(message:)
565
+ # Unstructured remittance information. Required if `category` is equal to
566
+ # `unstructured`.
567
+ #
568
+ # @param message [String] The message to the beneficiary.
569
+ end
570
+ end
571
+
462
572
  # @see Increase::Models::WireTransfer#reversal
463
573
  class Reversal < Increase::Internal::Type::BaseModel
464
574
  # @!attribute amount
@@ -25,12 +25,6 @@ module Increase
25
25
  # @return [String]
26
26
  required :beneficiary_name, String
27
27
 
28
- # @!attribute message_to_recipient
29
- # The message that will show on the recipient's bank statement.
30
- #
31
- # @return [String]
32
- required :message_to_recipient, String
33
-
34
28
  # @!attribute account_number
35
29
  # The account number for the destination account.
36
30
  #
@@ -97,6 +91,12 @@ module Increase
97
91
  # @return [String, nil]
98
92
  optional :originator_name, String
99
93
 
94
+ # @!attribute remittance
95
+ # Additional remittance information related to the wire transfer.
96
+ #
97
+ # @return [Increase::Models::WireTransferCreateParams::Remittance, nil]
98
+ optional :remittance, -> { Increase::WireTransferCreateParams::Remittance }
99
+
100
100
  # @!attribute require_approval
101
101
  # Whether the transfer requires explicit approval via the dashboard or API.
102
102
  #
@@ -116,7 +116,7 @@ module Increase
116
116
  # @return [String, nil]
117
117
  optional :source_account_number_id, String
118
118
 
119
- # @!method initialize(account_id:, amount:, beneficiary_name:, message_to_recipient:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
119
+ # @!method initialize(account_id:, amount:, beneficiary_name:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, remittance: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
120
120
  # Some parameter documentations has been truncated, see
121
121
  # {Increase::Models::WireTransferCreateParams} for more details.
122
122
  #
@@ -126,8 +126,6 @@ module Increase
126
126
  #
127
127
  # @param beneficiary_name [String] The beneficiary's name.
128
128
  #
129
- # @param message_to_recipient [String] The message that will show on the recipient's bank statement.
130
- #
131
129
  # @param account_number [String] The account number for the destination account.
132
130
  #
133
131
  # @param beneficiary_address_line1 [String] The beneficiary's address line 1.
@@ -148,6 +146,8 @@ module Increase
148
146
  #
149
147
  # @param originator_name [String] The originator's name. This is only necessary if you're transferring from a comm
150
148
  #
149
+ # @param remittance [Increase::Models::WireTransferCreateParams::Remittance] Additional remittance information related to the wire transfer.
150
+ #
151
151
  # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
152
152
  #
153
153
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
@@ -155,6 +155,107 @@ module Increase
155
155
  # @param source_account_number_id [String] The ID of an Account Number that will be passed to the wire's recipient
156
156
  #
157
157
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
158
+
159
+ class Remittance < Increase::Internal::Type::BaseModel
160
+ # @!attribute category
161
+ # The type of remittance information being passed.
162
+ #
163
+ # @return [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category]
164
+ required :category, enum: -> { Increase::WireTransferCreateParams::Remittance::Category }
165
+
166
+ # @!attribute tax
167
+ # Internal Revenue Service (IRS) tax repayment information. Required if `category`
168
+ # is equal to `tax`.
169
+ #
170
+ # @return [Increase::Models::WireTransferCreateParams::Remittance::Tax, nil]
171
+ optional :tax, -> { Increase::WireTransferCreateParams::Remittance::Tax }
172
+
173
+ # @!attribute unstructured
174
+ # Unstructured remittance information. Required if `category` is equal to
175
+ # `unstructured`.
176
+ #
177
+ # @return [Increase::Models::WireTransferCreateParams::Remittance::Unstructured, nil]
178
+ optional :unstructured, -> { Increase::WireTransferCreateParams::Remittance::Unstructured }
179
+
180
+ # @!method initialize(category:, tax: nil, unstructured: nil)
181
+ # Some parameter documentations has been truncated, see
182
+ # {Increase::Models::WireTransferCreateParams::Remittance} for more details.
183
+ #
184
+ # Additional remittance information related to the wire transfer.
185
+ #
186
+ # @param category [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category] The type of remittance information being passed.
187
+ #
188
+ # @param tax [Increase::Models::WireTransferCreateParams::Remittance::Tax] Internal Revenue Service (IRS) tax repayment information. Required if `category`
189
+ #
190
+ # @param unstructured [Increase::Models::WireTransferCreateParams::Remittance::Unstructured] Unstructured remittance information. Required if `category` is equal to `unstruc
191
+
192
+ # The type of remittance information being passed.
193
+ #
194
+ # @see Increase::Models::WireTransferCreateParams::Remittance#category
195
+ module Category
196
+ extend Increase::Internal::Type::Enum
197
+
198
+ # The wire transfer contains unstructured remittance information.
199
+ UNSTRUCTURED = :unstructured
200
+
201
+ # The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS).
202
+ TAX = :tax
203
+
204
+ # @!method self.values
205
+ # @return [Array<Symbol>]
206
+ end
207
+
208
+ # @see Increase::Models::WireTransferCreateParams::Remittance#tax
209
+ class Tax < Increase::Internal::Type::BaseModel
210
+ # @!attribute date
211
+ # The month and year the tax payment is for, in YYYY-MM-DD format. The day is
212
+ # ignored.
213
+ #
214
+ # @return [Date]
215
+ required :date, Date
216
+
217
+ # @!attribute identification_number
218
+ # The 9-digit Tax Identification Number (TIN) or Employer Identification Number
219
+ # (EIN).
220
+ #
221
+ # @return [String]
222
+ required :identification_number, String
223
+
224
+ # @!attribute type_code
225
+ # The 5-character tax type code.
226
+ #
227
+ # @return [String]
228
+ required :type_code, String
229
+
230
+ # @!method initialize(date:, identification_number:, type_code:)
231
+ # Some parameter documentations has been truncated, see
232
+ # {Increase::Models::WireTransferCreateParams::Remittance::Tax} for more details.
233
+ #
234
+ # Internal Revenue Service (IRS) tax repayment information. Required if `category`
235
+ # is equal to `tax`.
236
+ #
237
+ # @param date [Date] The month and year the tax payment is for, in YYYY-MM-DD format. The day is igno
238
+ #
239
+ # @param identification_number [String] The 9-digit Tax Identification Number (TIN) or Employer Identification Number (E
240
+ #
241
+ # @param type_code [String] The 5-character tax type code.
242
+ end
243
+
244
+ # @see Increase::Models::WireTransferCreateParams::Remittance#unstructured
245
+ class Unstructured < Increase::Internal::Type::BaseModel
246
+ # @!attribute message
247
+ # The message to the beneficiary.
248
+ #
249
+ # @return [String]
250
+ required :message, String
251
+
252
+ # @!method initialize(message:)
253
+ # Unstructured remittance information. Required if `category` is equal to
254
+ # `unstructured`.
255
+ #
256
+ # @param message [String] The message to the beneficiary.
257
+ end
258
+ end
158
259
  end
159
260
  end
160
261
  end
@@ -8,7 +8,7 @@ module Increase
8
8
  #
9
9
  # Create a Wire Transfer
10
10
  #
11
- # @overload create(account_id:, amount:, beneficiary_name:, message_to_recipient:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
11
+ # @overload create(account_id:, amount:, beneficiary_name:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, remittance: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
12
12
  #
13
13
  # @param account_id [String] The identifier for the account that will send the transfer.
14
14
  #
@@ -16,8 +16,6 @@ module Increase
16
16
  #
17
17
  # @param beneficiary_name [String] The beneficiary's name.
18
18
  #
19
- # @param message_to_recipient [String] The message that will show on the recipient's bank statement.
20
- #
21
19
  # @param account_number [String] The account number for the destination account.
22
20
  #
23
21
  # @param beneficiary_address_line1 [String] The beneficiary's address line 1.
@@ -38,6 +36,8 @@ module Increase
38
36
  #
39
37
  # @param originator_name [String] The originator's name. This is only necessary if you're transferring from a comm
40
38
  #
39
+ # @param remittance [Increase::Models::WireTransferCreateParams::Remittance] Additional remittance information related to the wire transfer.
40
+ #
41
41
  # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
42
42
  #
43
43
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.77.0"
4
+ VERSION = "1.79.0"
5
5
  end