increase 1.341.0 → 1.342.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 (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/ach_prenotification.rb +1 -1
  4. data/lib/increase/models/ach_transfer.rb +21 -2
  5. data/lib/increase/models/beneficial_owner_create_params.rb +12 -9
  6. data/lib/increase/models/beneficial_owner_update_params.rb +12 -9
  7. data/lib/increase/models/check_transfer.rb +4 -2
  8. data/lib/increase/models/entity_create_params.rb +72 -54
  9. data/lib/increase/models/entity_update_params.rb +24 -18
  10. data/lib/increase/models/event.rb +8 -0
  11. data/lib/increase/models/event_list_params.rb +8 -0
  12. data/lib/increase/models/event_subscription.rb +8 -0
  13. data/lib/increase/models/event_subscription_create_params.rb +8 -0
  14. data/lib/increase/models/inbound_wire_transfer.rb +18 -1
  15. data/lib/increase/models/simulations/ach_transfer_return_params.rb +15 -2
  16. data/lib/increase/models/simulations/card_settlement_create_params.rb +16 -14
  17. data/lib/increase/models/simulations/program_create_params.rb +0 -3
  18. data/lib/increase/models/swift_transfer.rb +12 -1
  19. data/lib/increase/models/swift_transfer_create_params.rb +12 -1
  20. data/lib/increase/models/transaction.rb +21 -2
  21. data/lib/increase/models/unwrap_webhook_event.rb +8 -0
  22. data/lib/increase/resources/simulations/ach_transfers.rb +6 -1
  23. data/lib/increase/resources/simulations/card_settlements.rb +7 -6
  24. data/lib/increase/resources/swift_transfers.rb +5 -1
  25. data/lib/increase/version.rb +1 -1
  26. data/rbi/increase/models/ach_prenotification.rbi +1 -1
  27. data/rbi/increase/models/ach_transfer.rbi +19 -1
  28. data/rbi/increase/models/beneficial_owner_create_params.rbi +13 -8
  29. data/rbi/increase/models/beneficial_owner_update_params.rbi +13 -8
  30. data/rbi/increase/models/check_transfer.rbi +4 -2
  31. data/rbi/increase/models/entity_create_params.rbi +78 -48
  32. data/rbi/increase/models/entity_update_params.rbi +26 -16
  33. data/rbi/increase/models/event.rbi +14 -0
  34. data/rbi/increase/models/event_list_params.rbi +14 -0
  35. data/rbi/increase/models/event_subscription.rbi +14 -0
  36. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  37. data/rbi/increase/models/inbound_wire_transfer.rbi +16 -0
  38. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +16 -1
  39. data/rbi/increase/models/simulations/card_settlement_create_params.rbi +17 -12
  40. data/rbi/increase/models/simulations/program_create_params.rbi +0 -7
  41. data/rbi/increase/models/swift_transfer.rbi +10 -0
  42. data/rbi/increase/models/swift_transfer_create_params.rbi +13 -0
  43. data/rbi/increase/models/transaction.rbi +19 -1
  44. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  45. data/rbi/increase/resources/simulations/ach_transfers.rbi +5 -0
  46. data/rbi/increase/resources/simulations/card_settlements.rbi +6 -5
  47. data/rbi/increase/resources/swift_transfers.rbi +4 -0
  48. data/sig/increase/models/ach_prenotification.rbs +1 -1
  49. data/sig/increase/models/ach_transfer.rbs +6 -1
  50. data/sig/increase/models/beneficial_owner_create_params.rbs +7 -5
  51. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -5
  52. data/sig/increase/models/entity_create_params.rbs +42 -30
  53. data/sig/increase/models/entity_update_params.rbs +14 -10
  54. data/sig/increase/models/event.rbs +8 -0
  55. data/sig/increase/models/event_list_params.rbs +8 -0
  56. data/sig/increase/models/event_subscription.rbs +8 -0
  57. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  58. data/sig/increase/models/inbound_wire_transfer.rbs +10 -0
  59. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -1
  60. data/sig/increase/models/simulations/card_settlement_create_params.rbs +7 -5
  61. data/sig/increase/models/simulations/program_create_params.rbs +1 -8
  62. data/sig/increase/models/swift_transfer.rbs +5 -0
  63. data/sig/increase/models/swift_transfer_create_params.rbs +7 -0
  64. data/sig/increase/models/transaction.rbs +6 -1
  65. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  66. data/sig/increase/resources/simulations/ach_transfers.rbs +1 -0
  67. data/sig/increase/resources/simulations/card_settlements.rbs +1 -1
  68. data/sig/increase/resources/swift_transfers.rbs +1 -0
  69. metadata +2 -2
@@ -19,36 +19,41 @@ module Increase
19
19
  sig { returns(String) }
20
20
  attr_accessor :card_id
21
21
 
22
- # The identifier of the Pending Transaction for the Card Authorization you wish to
23
- # settle.
24
- sig { returns(String) }
25
- attr_accessor :pending_transaction_id
26
-
27
22
  # The amount to be settled. This defaults to the amount of the Pending Transaction
28
- # being settled.
23
+ # being settled, or a random amount if `pending_transaction_id` is not provided.
29
24
  sig { returns(T.nilable(Integer)) }
30
25
  attr_reader :amount
31
26
 
32
27
  sig { params(amount: Integer).void }
33
28
  attr_writer :amount
34
29
 
30
+ # The identifier of the Pending Transaction for the Card Authorization you wish to
31
+ # settle. If not provided, the settlement will be force posted without a Card
32
+ # Authorization.
33
+ sig { returns(T.nilable(String)) }
34
+ attr_reader :pending_transaction_id
35
+
36
+ sig { params(pending_transaction_id: String).void }
37
+ attr_writer :pending_transaction_id
38
+
35
39
  sig do
36
40
  params(
37
41
  card_id: String,
38
- pending_transaction_id: String,
39
42
  amount: Integer,
43
+ pending_transaction_id: String,
40
44
  request_options: Increase::RequestOptions::OrHash
41
45
  ).returns(T.attached_class)
42
46
  end
43
47
  def self.new(
44
48
  # The identifier of the Card to create a settlement on.
45
49
  card_id:,
46
- # The identifier of the Pending Transaction for the Card Authorization you wish to
47
- # settle.
48
- pending_transaction_id:,
49
50
  # The amount to be settled. This defaults to the amount of the Pending Transaction
50
- # being settled.
51
+ # being settled, or a random amount if `pending_transaction_id` is not provided.
51
52
  amount: nil,
53
+ # The identifier of the Pending Transaction for the Card Authorization you wish to
54
+ # settle. If not provided, the settlement will be force posted without a Card
55
+ # Authorization.
56
+ pending_transaction_id: nil,
52
57
  request_options: {}
53
58
  )
54
59
  end
@@ -57,8 +62,8 @@ module Increase
57
62
  override.returns(
58
63
  {
59
64
  card_id: String,
60
- pending_transaction_id: String,
61
65
  amount: Integer,
66
+ pending_transaction_id: String,
62
67
  request_options: Increase::RequestOptions
63
68
  }
64
69
  )
@@ -117,13 +117,6 @@ module Increase
117
117
  Increase::Simulations::ProgramCreateParams::Bank::TaggedSymbol
118
118
  )
119
119
 
120
- # Twin City Bank
121
- TWIN_CITY_BANK =
122
- T.let(
123
- :twin_city_bank,
124
- Increase::Simulations::ProgramCreateParams::Bank::TaggedSymbol
125
- )
126
-
127
120
  sig do
128
121
  override.returns(
129
122
  T::Array[
@@ -88,6 +88,11 @@ module Increase
88
88
  sig { returns(Increase::SwiftTransfer::InstructedCurrency::TaggedSymbol) }
89
89
  attr_accessor :instructed_currency
90
90
 
91
+ # The bank identification code (BIC) of the intermediary bank, if the transfer is
92
+ # routed through one.
93
+ sig { returns(T.nilable(String)) }
94
+ attr_accessor :intermediary_bank_identification_code
95
+
91
96
  # The ID for the pending transaction representing the transfer.
92
97
  sig { returns(T.nilable(String)) }
93
98
  attr_accessor :pending_transaction_id
@@ -143,6 +148,7 @@ module Increase
143
148
  instructed_amount: Integer,
144
149
  instructed_currency:
145
150
  Increase::SwiftTransfer::InstructedCurrency::OrSymbol,
151
+ intermediary_bank_identification_code: T.nilable(String),
146
152
  pending_transaction_id: T.nilable(String),
147
153
  routing_number: T.nilable(String),
148
154
  source_account_number_id: String,
@@ -187,6 +193,9 @@ module Increase
187
193
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
188
194
  # instructed amount.
189
195
  instructed_currency:,
196
+ # The bank identification code (BIC) of the intermediary bank, if the transfer is
197
+ # routed through one.
198
+ intermediary_bank_identification_code:,
190
199
  # The ID for the pending transaction representing the transfer.
191
200
  pending_transaction_id:,
192
201
  # The creditor's bank account routing or transit number. Required in certain
@@ -229,6 +238,7 @@ module Increase
229
238
  instructed_amount: Integer,
230
239
  instructed_currency:
231
240
  Increase::SwiftTransfer::InstructedCurrency::TaggedSymbol,
241
+ intermediary_bank_identification_code: T.nilable(String),
232
242
  pending_transaction_id: T.nilable(String),
233
243
  routing_number: T.nilable(String),
234
244
  source_account_number_id: String,
@@ -81,6 +81,14 @@ module Increase
81
81
  sig { returns(String) }
82
82
  attr_accessor :unstructured_remittance_information
83
83
 
84
+ # The bank identification code (BIC) of the intermediary bank, if the transfer
85
+ # should be routed through one.
86
+ sig { returns(T.nilable(String)) }
87
+ attr_reader :intermediary_bank_identification_code
88
+
89
+ sig { params(intermediary_bank_identification_code: String).void }
90
+ attr_writer :intermediary_bank_identification_code
91
+
84
92
  # Whether the transfer requires explicit approval via the dashboard or API.
85
93
  sig { returns(T.nilable(T::Boolean)) }
86
94
  attr_reader :require_approval
@@ -112,6 +120,7 @@ module Increase
112
120
  Increase::SwiftTransferCreateParams::InstructedCurrency::OrSymbol,
113
121
  source_account_number_id: String,
114
122
  unstructured_remittance_information: String,
123
+ intermediary_bank_identification_code: String,
115
124
  require_approval: T::Boolean,
116
125
  routing_number: String,
117
126
  request_options: Increase::RequestOptions::OrHash
@@ -143,6 +152,9 @@ module Increase
143
152
  source_account_number_id:,
144
153
  # Unstructured remittance information to include in the transfer.
145
154
  unstructured_remittance_information:,
155
+ # The bank identification code (BIC) of the intermediary bank, if the transfer
156
+ # should be routed through one.
157
+ intermediary_bank_identification_code: nil,
146
158
  # Whether the transfer requires explicit approval via the dashboard or API.
147
159
  require_approval: nil,
148
160
  # The creditor's bank account routing or transit number. Required in certain
@@ -168,6 +180,7 @@ module Increase
168
180
  Increase::SwiftTransferCreateParams::InstructedCurrency::OrSymbol,
169
181
  source_account_number_id: String,
170
182
  unstructured_remittance_information: String,
183
+ intermediary_bank_identification_code: String,
171
184
  require_approval: T::Boolean,
172
185
  routing_number: String,
173
186
  request_options: Increase::RequestOptions
@@ -1970,6 +1970,15 @@ module Increase
1970
1970
  )
1971
1971
  end
1972
1972
 
1973
+ # Additional free-form information included by the receiving bank in the return's
1974
+ # addenda record. This is raw, uninterpreted text whose presence and format are
1975
+ # not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
1976
+ # bank may set this to `QUESTIONABLE` (optionally followed by more text) to
1977
+ # indicate it believes the transfer was initiated under questionable
1978
+ # circumstances.
1979
+ sig { returns(T.nilable(String)) }
1980
+ attr_accessor :addenda_information
1981
+
1973
1982
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1974
1983
  # the transfer was created.
1975
1984
  sig { returns(Time) }
@@ -2013,6 +2022,7 @@ module Increase
2013
2022
  # created.
2014
2023
  sig do
2015
2024
  params(
2025
+ addenda_information: T.nilable(String),
2016
2026
  created_at: Time,
2017
2027
  raw_return_reason_code: String,
2018
2028
  return_reason_code:
@@ -2023,6 +2033,13 @@ module Increase
2023
2033
  ).returns(T.attached_class)
2024
2034
  end
2025
2035
  def self.new(
2036
+ # Additional free-form information included by the receiving bank in the return's
2037
+ # addenda record. This is raw, uninterpreted text whose presence and format are
2038
+ # not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
2039
+ # bank may set this to `QUESTIONABLE` (optionally followed by more text) to
2040
+ # indicate it believes the transfer was initiated under questionable
2041
+ # circumstances.
2042
+ addenda_information:,
2026
2043
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
2027
2044
  # the transfer was created.
2028
2045
  created_at:,
@@ -2047,6 +2064,7 @@ module Increase
2047
2064
  sig do
2048
2065
  override.returns(
2049
2066
  {
2067
+ addenda_information: T.nilable(String),
2050
2068
  created_at: Time,
2051
2069
  raw_return_reason_code: String,
2052
2070
  return_reason_code:
@@ -2186,7 +2204,7 @@ module Increase
2186
2204
  Increase::Transaction::Source::ACHTransferReturn::ReturnReasonCode::TaggedSymbol
2187
2205
  )
2188
2206
 
2189
- # Code R17. The receiving bank is unable to process a field in the transfer.
2207
+ # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
2190
2208
  FILE_RECORD_EDIT_CRITERIA =
2191
2209
  T.let(
2192
2210
  :file_record_edit_criteria,
@@ -517,6 +517,20 @@ module Increase
517
517
  Increase::UnwrapWebhookEvent::Category::TaggedSymbol
518
518
  )
519
519
 
520
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
521
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
522
+ T.let(
523
+ :"inbound_real_time_payments_request_for_payment.created",
524
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
525
+ )
526
+
527
+ # Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
528
+ INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
529
+ T.let(
530
+ :"inbound_real_time_payments_request_for_payment.updated",
531
+ Increase::UnwrapWebhookEvent::Category::TaggedSymbol
532
+ )
533
+
520
534
  # Occurs whenever an Inbound Real-Time Payments Transfer is created.
521
535
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED =
522
536
  T.let(
@@ -58,6 +58,7 @@ module Increase
58
58
  sig do
59
59
  params(
60
60
  ach_transfer_id: String,
61
+ addenda_information: String,
61
62
  reason:
62
63
  Increase::Simulations::ACHTransferReturnParams::Reason::OrSymbol,
63
64
  request_options: Increase::RequestOptions::OrHash
@@ -66,6 +67,10 @@ module Increase
66
67
  def return_(
67
68
  # The identifier of the ACH Transfer you wish to return.
68
69
  ach_transfer_id,
70
+ # Free-form information the returning bank includes in the return addenda. For a
71
+ # `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
72
+ # a return the bank believes was initiated under questionable circumstances.
73
+ addenda_information: nil,
69
74
  # The reason why the Federal Reserve or destination bank returned this transfer.
70
75
  # Defaults to `no_account`.
71
76
  reason: nil,
@@ -12,20 +12,21 @@ module Increase
12
12
  sig do
13
13
  params(
14
14
  card_id: String,
15
- pending_transaction_id: String,
16
15
  amount: Integer,
16
+ pending_transaction_id: String,
17
17
  request_options: Increase::RequestOptions::OrHash
18
18
  ).returns(Increase::Transaction)
19
19
  end
20
20
  def create(
21
21
  # The identifier of the Card to create a settlement on.
22
22
  card_id:,
23
- # The identifier of the Pending Transaction for the Card Authorization you wish to
24
- # settle.
25
- pending_transaction_id:,
26
23
  # The amount to be settled. This defaults to the amount of the Pending Transaction
27
- # being settled.
24
+ # being settled, or a random amount if `pending_transaction_id` is not provided.
28
25
  amount: nil,
26
+ # The identifier of the Pending Transaction for the Card Authorization you wish to
27
+ # settle. If not provided, the settlement will be force posted without a Card
28
+ # Authorization.
29
+ pending_transaction_id: nil,
29
30
  request_options: {}
30
31
  )
31
32
  end
@@ -20,6 +20,7 @@ module Increase
20
20
  Increase::SwiftTransferCreateParams::InstructedCurrency::OrSymbol,
21
21
  source_account_number_id: String,
22
22
  unstructured_remittance_information: String,
23
+ intermediary_bank_identification_code: String,
23
24
  require_approval: T::Boolean,
24
25
  routing_number: String,
25
26
  request_options: Increase::RequestOptions::OrHash
@@ -51,6 +52,9 @@ module Increase
51
52
  source_account_number_id:,
52
53
  # Unstructured remittance information to include in the transfer.
53
54
  unstructured_remittance_information:,
55
+ # The bank identification code (BIC) of the intermediary bank, if the transfer
56
+ # should be routed through one.
57
+ intermediary_bank_identification_code: nil,
54
58
  # Whether the transfer requires explicit approval via the dashboard or API.
55
59
  require_approval: nil,
56
60
  # The creditor's bank account routing or transit number. Required in certain
@@ -416,7 +416,7 @@ module Increase
416
416
  # Code R13. The routing number is invalid.
417
417
  INVALID_ACH_ROUTING_NUMBER: :invalid_ach_routing_number
418
418
 
419
- # Code R17. The receiving bank is unable to process a field in the transfer.
419
+ # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
420
420
  FILE_RECORD_EDIT_CRITERIA: :file_record_edit_criteria
421
421
 
422
422
  # Code R45. A rare return reason. The individual name field was invalid.
@@ -743,6 +743,7 @@ module Increase
743
743
 
744
744
  type return_ =
745
745
  {
746
+ addenda_information: String?,
746
747
  created_at: Time,
747
748
  raw_return_reason_code: String,
748
749
  return_reason_code: Increase::Models::ACHTransfer::Return::return_reason_code,
@@ -752,6 +753,8 @@ module Increase
752
753
  }
753
754
 
754
755
  class Return < Increase::Internal::Type::BaseModel
756
+ attr_accessor addenda_information: String?
757
+
755
758
  attr_accessor created_at: Time
756
759
 
757
760
  attr_accessor raw_return_reason_code: String
@@ -765,6 +768,7 @@ module Increase
765
768
  attr_accessor transfer_id: String
766
769
 
767
770
  def initialize: (
771
+ addenda_information: String?,
768
772
  created_at: Time,
769
773
  raw_return_reason_code: String,
770
774
  return_reason_code: Increase::Models::ACHTransfer::Return::return_reason_code,
@@ -774,6 +778,7 @@ module Increase
774
778
  ) -> void
775
779
 
776
780
  def to_hash: -> {
781
+ addenda_information: String?,
777
782
  created_at: Time,
778
783
  raw_return_reason_code: String,
779
784
  return_reason_code: Increase::Models::ACHTransfer::Return::return_reason_code,
@@ -905,7 +910,7 @@ module Increase
905
910
  # Code R13. The routing number is invalid.
906
911
  INVALID_ACH_ROUTING_NUMBER: :invalid_ach_routing_number
907
912
 
908
- # Code R17. The receiving bank is unable to process a field in the transfer.
913
+ # Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
909
914
  FILE_RECORD_EDIT_CRITERIA: :file_record_edit_criteria
910
915
 
911
916
  # Code R45. A rare return reason. The individual name field was invalid.
@@ -80,8 +80,8 @@ module Increase
80
80
  type address =
81
81
  {
82
82
  city: String,
83
- country: String,
84
83
  :line1 => String,
84
+ country: String,
85
85
  :line2 => String,
86
86
  state: String,
87
87
  zip: String
@@ -90,10 +90,12 @@ module Increase
90
90
  class Address < Increase::Internal::Type::BaseModel
91
91
  attr_accessor city: String
92
92
 
93
- attr_accessor country: String
94
-
95
93
  attr_accessor line1: String
96
94
 
95
+ attr_reader country: String?
96
+
97
+ def country=: (String) -> String
98
+
97
99
  attr_reader line2: String?
98
100
 
99
101
  def line2=: (String) -> String
@@ -108,8 +110,8 @@ module Increase
108
110
 
109
111
  def initialize: (
110
112
  city: String,
111
- country: String,
112
113
  line1: String,
114
+ ?country: String,
113
115
  ?line2: String,
114
116
  ?state: String,
115
117
  ?zip: String
@@ -117,8 +119,8 @@ module Increase
117
119
 
118
120
  def to_hash: -> {
119
121
  city: String,
120
- country: String,
121
122
  :line1 => String,
123
+ country: String,
122
124
  :line2 => String,
123
125
  state: String,
124
126
  zip: String
@@ -66,8 +66,8 @@ module Increase
66
66
  type address =
67
67
  {
68
68
  city: String,
69
- country: String,
70
69
  :line1 => String,
70
+ country: String,
71
71
  :line2 => String,
72
72
  state: String,
73
73
  zip: String
@@ -76,10 +76,12 @@ module Increase
76
76
  class Address < Increase::Internal::Type::BaseModel
77
77
  attr_accessor city: String
78
78
 
79
- attr_accessor country: String
80
-
81
79
  attr_accessor line1: String
82
80
 
81
+ attr_reader country: String?
82
+
83
+ def country=: (String) -> String
84
+
83
85
  attr_reader line2: String?
84
86
 
85
87
  def line2=: (String) -> String
@@ -94,8 +96,8 @@ module Increase
94
96
 
95
97
  def initialize: (
96
98
  city: String,
97
- country: String,
98
99
  line1: String,
100
+ ?country: String,
99
101
  ?line2: String,
100
102
  ?state: String,
101
103
  ?zip: String
@@ -103,8 +105,8 @@ module Increase
103
105
 
104
106
  def to_hash: -> {
105
107
  city: String,
106
- country: String,
107
108
  :line1 => String,
109
+ country: String,
108
110
  :line2 => String,
109
111
  state: String,
110
112
  zip: String