increase 1.351.0 → 1.353.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 (74) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_statement.rb +12 -4
  4. data/lib/increase/models/balance_lookup.rb +1 -59
  5. data/lib/increase/models/beneficial_owner_create_params.rb +3 -0
  6. data/lib/increase/models/beneficial_owner_update_params.rb +3 -0
  7. data/lib/increase/models/card_payment.rb +1174 -2
  8. data/lib/increase/models/check_transfer.rb +15 -9
  9. data/lib/increase/models/entity.rb +18 -0
  10. data/lib/increase/models/entity_beneficial_owner.rb +3 -0
  11. data/lib/increase/models/entity_create_params.rb +36 -20
  12. data/lib/increase/models/entity_update_params.rb +33 -20
  13. data/lib/increase/models/event.rb +12 -0
  14. data/lib/increase/models/event_list_params.rb +12 -0
  15. data/lib/increase/models/event_subscription.rb +12 -0
  16. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  17. data/lib/increase/models/inbound_ach_transfer.rb +9 -1
  18. data/lib/increase/models/pending_transaction.rb +121 -1
  19. data/lib/increase/models/pending_transaction_list_params.rb +6 -0
  20. data/lib/increase/models/simulations/physical_card_create_params.rb +9 -6
  21. data/lib/increase/models/transaction.rb +1277 -3
  22. data/lib/increase/models/transaction_list_params.rb +6 -0
  23. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  24. data/lib/increase/models/wire_drawdown_request.rb +3 -3
  25. data/lib/increase/models/wire_drawdown_request_list_params.rb +3 -3
  26. data/lib/increase/resources/simulations/account_statements.rb +2 -1
  27. data/lib/increase/resources/simulations/physical_cards.rb +5 -3
  28. data/lib/increase/version.rb +1 -1
  29. data/rbi/increase/models/account_statement.rbi +12 -4
  30. data/rbi/increase/models/balance_lookup.rbi +3 -87
  31. data/rbi/increase/models/beneficial_owner_create_params.rbi +7 -0
  32. data/rbi/increase/models/beneficial_owner_update_params.rbi +7 -0
  33. data/rbi/increase/models/card_payment.rbi +5276 -2964
  34. data/rbi/increase/models/check_transfer.rbi +15 -9
  35. data/rbi/increase/models/entity.rbi +42 -0
  36. data/rbi/increase/models/entity_beneficial_owner.rbi +7 -0
  37. data/rbi/increase/models/entity_create_params.rbi +46 -21
  38. data/rbi/increase/models/entity_update_params.rbi +39 -21
  39. data/rbi/increase/models/event.rbi +28 -0
  40. data/rbi/increase/models/event_list_params.rbi +28 -0
  41. data/rbi/increase/models/event_subscription.rbi +28 -0
  42. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  43. data/rbi/increase/models/inbound_ach_transfer.rbi +8 -0
  44. data/rbi/increase/models/pending_transaction.rbi +254 -0
  45. data/rbi/increase/models/pending_transaction_list_params.rbi +14 -0
  46. data/rbi/increase/models/simulations/physical_card_create_params.rbi +8 -6
  47. data/rbi/increase/models/transaction.rbi +4848 -2358
  48. data/rbi/increase/models/transaction_list_params.rbi +14 -0
  49. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  50. data/rbi/increase/models/wire_drawdown_request.rbi +4 -4
  51. data/rbi/increase/models/wire_drawdown_request_list_params.rbi +6 -6
  52. data/rbi/increase/resources/simulations/account_statements.rbi +2 -1
  53. data/rbi/increase/resources/simulations/physical_cards.rbi +4 -3
  54. data/sig/increase/models/balance_lookup.rbs +3 -42
  55. data/sig/increase/models/beneficial_owner_create_params.rbs +4 -0
  56. data/sig/increase/models/beneficial_owner_update_params.rbs +4 -0
  57. data/sig/increase/models/card_payment.rbs +1186 -0
  58. data/sig/increase/models/entity.rbs +24 -0
  59. data/sig/increase/models/entity_beneficial_owner.rbs +4 -0
  60. data/sig/increase/models/entity_create_params.rbs +24 -11
  61. data/sig/increase/models/entity_update_params.rbs +20 -11
  62. data/sig/increase/models/event.rbs +16 -0
  63. data/sig/increase/models/event_list_params.rbs +16 -0
  64. data/sig/increase/models/event_subscription.rbs +16 -0
  65. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  66. data/sig/increase/models/inbound_ach_transfer.rbs +5 -0
  67. data/sig/increase/models/pending_transaction.rbs +84 -0
  68. data/sig/increase/models/pending_transaction_list_params.rbs +8 -0
  69. data/sig/increase/models/transaction.rbs +1236 -0
  70. data/sig/increase/models/transaction_list_params.rbs +8 -0
  71. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  72. data/sig/increase/models/wire_drawdown_request.rbs +4 -4
  73. data/sig/increase/models/wire_drawdown_request_list_params.rbs +4 -4
  74. metadata +2 -2
@@ -200,6 +200,12 @@ module Increase
200
200
  # Blockchain Off-Ramp Transfer Settlement: details will be under the `blockchain_offramp_transfer_settlement` object.
201
201
  BLOCKCHAIN_OFFRAMP_TRANSFER_SETTLEMENT = :blockchain_offramp_transfer_settlement
202
202
 
203
+ # UK Faster Payment System Transfer Acceptance: details will be under the `uk_faster_payment_system_transfer_acceptance` object.
204
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_ACCEPTANCE = :uk_faster_payment_system_transfer_acceptance
205
+
206
+ # SEPA Instant Transfer Acceptance: details will be under the `sepa_instant_transfer_acceptance` object.
207
+ SEPA_INSTANT_TRANSFER_ACCEPTANCE = :sepa_instant_transfer_acceptance
208
+
203
209
  # The Transaction was made for an undocumented or deprecated reason.
204
210
  OTHER = :other
205
211
 
@@ -422,6 +422,12 @@ module Increase
422
422
  # Occurs whenever a Real-Time Payments Request for Payment is updated.
423
423
  REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
424
424
 
425
+ # Occurs whenever a SEPA Instant Transfer is created.
426
+ SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
427
+
428
+ # Occurs whenever a SEPA Instant Transfer is updated.
429
+ SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
430
+
425
431
  # Occurs whenever a Swift Transfer is created.
426
432
  SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
427
433
 
@@ -431,6 +437,12 @@ module Increase
431
437
  # Occurs whenever a Transaction is created.
432
438
  TRANSACTION_CREATED = :"transaction.created"
433
439
 
440
+ # Occurs whenever a UK Faster Payment System Transfer is created.
441
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
442
+
443
+ # Occurs whenever a UK Faster Payment System Transfer is updated.
444
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
445
+
434
446
  # Occurs whenever a Wire Drawdown Request is created.
435
447
  WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
436
448
 
@@ -343,12 +343,12 @@ module Increase
343
343
  # The drawdown request is queued to be submitted to Fedwire.
344
344
  PENDING_SUBMISSION = :pending_submission
345
345
 
346
- # The drawdown request has been fulfilled by the recipient.
347
- FULFILLED = :fulfilled
348
-
349
346
  # The drawdown request has been sent and the recipient should respond in some way.
350
347
  PENDING_RESPONSE = :pending_response
351
348
 
349
+ # The drawdown request has been fulfilled by the recipient.
350
+ FULFILLED = :fulfilled
351
+
352
352
  # The drawdown request has been refused by the recipient.
353
353
  REFUSED = :refused
354
354
 
@@ -80,12 +80,12 @@ module Increase
80
80
  # The drawdown request is queued to be submitted to Fedwire.
81
81
  PENDING_SUBMISSION = :pending_submission
82
82
 
83
- # The drawdown request has been fulfilled by the recipient.
84
- FULFILLED = :fulfilled
85
-
86
83
  # The drawdown request has been sent and the recipient should respond in some way.
87
84
  PENDING_RESPONSE = :pending_response
88
85
 
86
+ # The drawdown request has been fulfilled by the recipient.
87
+ FULFILLED = :fulfilled
88
+
89
89
  # The drawdown request has been refused by the recipient.
90
90
  REFUSED = :refused
91
91
 
@@ -5,7 +5,8 @@ module Increase
5
5
  class Simulations
6
6
  class AccountStatements
7
7
  # Simulates an [Account Statement](#account-statements) being created for an
8
- # account. In production, Account Statements are generated once per month.
8
+ # account. In production, Account Statements are generated once per month. As in
9
+ # production, the simulated statement covers the previous calendar month.
9
10
  #
10
11
  # @overload create(account_id:, request_options: {})
11
12
  #
@@ -18,11 +18,13 @@ module Increase
18
18
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
19
19
  # carrier expects the card to be delivered.
20
20
  #
21
- # @param city [String] The city where the event took place.
21
+ # @param city [String] The city where the event took place. Required if postal_code is not provided.
22
22
  #
23
- # @param postal_code [String] The postal code where the event took place.
23
+ # @param postal_code [String]
24
+ # The postal code where the event took place. Required unless both city and state
25
+ # are provided.
24
26
  #
25
- # @param state [String] The state where the event took place.
27
+ # @param state [String] The state where the event took place. Required if postal_code is not provided.
26
28
  #
27
29
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
28
30
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.351.0"
4
+ VERSION = "1.353.0"
5
5
  end
@@ -43,12 +43,16 @@ module Increase
43
43
  attr_accessor :starting_balance
44
44
 
45
45
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
46
- # of the period the Account Statement covers.
46
+ # of the period the Account Statement covers. The statement covers all
47
+ # transactions up to, but not including this timestamp. Usually, this is the
48
+ # beginning of the following month.
47
49
  sig { returns(Time) }
48
50
  attr_accessor :statement_period_end
49
51
 
50
52
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
51
- # start of the period the Account Statement covers.
53
+ # start of the period the Account Statement covers. This is the first moment of
54
+ # the statement period and is inclusive. Usually, this is the beginning of the
55
+ # month this statement covers.
52
56
  sig { returns(Time) }
53
57
  attr_accessor :statement_period_start
54
58
 
@@ -91,10 +95,14 @@ module Increase
91
95
  # The Account's balance at the start of its statement period.
92
96
  starting_balance:,
93
97
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
94
- # of the period the Account Statement covers.
98
+ # of the period the Account Statement covers. The statement covers all
99
+ # transactions up to, but not including this timestamp. Usually, this is the
100
+ # beginning of the following month.
95
101
  statement_period_end:,
96
102
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
97
- # start of the period the Account Statement covers.
103
+ # start of the period the Account Statement covers. This is the first moment of
104
+ # the statement period and is inclusive. Usually, this is the beginning of the
105
+ # month this statement covers.
98
106
  statement_period_start:,
99
107
  # A constant representing the object's type. For this resource it will always be
100
108
  # `account_statement`.
@@ -84,15 +84,6 @@ module Increase
84
84
  T.any(Increase::BalanceLookup::Loan, Increase::Internal::AnyHash)
85
85
  end
86
86
 
87
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
88
- # payment is due.
89
- sig { returns(T.nilable(Time)) }
90
- attr_accessor :due_at
91
-
92
- # The total amount due on the loan.
93
- sig { returns(Integer) }
94
- attr_accessor :due_balance
95
-
96
87
  # The fees on the loan that are due and unpaid.
97
88
  sig { returns(T.nilable(Integer)) }
98
89
  attr_accessor :due_fees
@@ -117,44 +108,18 @@ module Increase
117
108
  sig { returns(T.nilable(Integer)) }
118
109
  attr_accessor :not_due_principal
119
110
 
120
- # The amount past due on the loan.
121
- sig { returns(Integer) }
122
- attr_accessor :past_due_balance
123
-
124
- # The receivables balances for the loan.
125
- sig { returns(T.nilable(Increase::BalanceLookup::Loan::Receivables)) }
126
- attr_reader :receivables
127
-
128
- sig do
129
- params(
130
- receivables:
131
- T.nilable(Increase::BalanceLookup::Loan::Receivables::OrHash)
132
- ).void
133
- end
134
- attr_writer :receivables
135
-
136
111
  # The loan balances for the Account.
137
112
  sig do
138
113
  params(
139
- due_at: T.nilable(Time),
140
- due_balance: Integer,
141
114
  due_fees: T.nilable(Integer),
142
115
  due_interest: T.nilable(Integer),
143
116
  due_principal: T.nilable(Integer),
144
117
  not_due_fees: T.nilable(Integer),
145
118
  not_due_interest: T.nilable(Integer),
146
- not_due_principal: T.nilable(Integer),
147
- past_due_balance: Integer,
148
- receivables:
149
- T.nilable(Increase::BalanceLookup::Loan::Receivables::OrHash)
119
+ not_due_principal: T.nilable(Integer)
150
120
  ).returns(T.attached_class)
151
121
  end
152
122
  def self.new(
153
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
154
- # payment is due.
155
- due_at:,
156
- # The total amount due on the loan.
157
- due_balance:,
158
123
  # The fees on the loan that are due and unpaid.
159
124
  due_fees:,
160
125
  # The interest on the loan that is due and unpaid.
@@ -166,73 +131,24 @@ module Increase
166
131
  # The interest on the loan that is not yet due.
167
132
  not_due_interest:,
168
133
  # The principal on the loan that is not yet due.
169
- not_due_principal:,
170
- # The amount past due on the loan.
171
- past_due_balance:,
172
- # The receivables balances for the loan.
173
- receivables:
134
+ not_due_principal:
174
135
  )
175
136
  end
176
137
 
177
138
  sig do
178
139
  override.returns(
179
140
  {
180
- due_at: T.nilable(Time),
181
- due_balance: Integer,
182
141
  due_fees: T.nilable(Integer),
183
142
  due_interest: T.nilable(Integer),
184
143
  due_principal: T.nilable(Integer),
185
144
  not_due_fees: T.nilable(Integer),
186
145
  not_due_interest: T.nilable(Integer),
187
- not_due_principal: T.nilable(Integer),
188
- past_due_balance: Integer,
189
- receivables: T.nilable(Increase::BalanceLookup::Loan::Receivables)
146
+ not_due_principal: T.nilable(Integer)
190
147
  }
191
148
  )
192
149
  end
193
150
  def to_hash
194
151
  end
195
-
196
- class Receivables < Increase::Internal::Type::BaseModel
197
- OrHash =
198
- T.type_alias do
199
- T.any(
200
- Increase::BalanceLookup::Loan::Receivables,
201
- Increase::Internal::AnyHash
202
- )
203
- end
204
-
205
- # The balance of seasoned receivables available to be purchased.
206
- sig { returns(Integer) }
207
- attr_accessor :purchasable_balance
208
-
209
- # The balance of receivables that have been purchased.
210
- sig { returns(Integer) }
211
- attr_accessor :purchased_balance
212
-
213
- # The receivables balances for the loan.
214
- sig do
215
- params(
216
- purchasable_balance: Integer,
217
- purchased_balance: Integer
218
- ).returns(T.attached_class)
219
- end
220
- def self.new(
221
- # The balance of seasoned receivables available to be purchased.
222
- purchasable_balance:,
223
- # The balance of receivables that have been purchased.
224
- purchased_balance:
225
- )
226
- end
227
-
228
- sig do
229
- override.returns(
230
- { purchasable_balance: Integer, purchased_balance: Integer }
231
- )
232
- end
233
- def to_hash
234
- end
235
- end
236
152
  end
237
153
 
238
154
  # A constant representing the object's type. For this resource it will always be
@@ -443,6 +443,13 @@ module Increase
443
443
  Increase::BeneficialOwnerCreateParams::Individual::Identification::Method::TaggedSymbol
444
444
  )
445
445
 
446
+ # The last four digits of a social security number.
447
+ SOCIAL_SECURITY_NUMBER_LAST4 =
448
+ T.let(
449
+ :social_security_number_last4,
450
+ Increase::BeneficialOwnerCreateParams::Individual::Identification::Method::TaggedSymbol
451
+ )
452
+
446
453
  # An individual taxpayer identification number (ITIN).
447
454
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
448
455
  T.let(
@@ -401,6 +401,13 @@ module Increase
401
401
  Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
402
402
  )
403
403
 
404
+ # The last four digits of a social security number.
405
+ SOCIAL_SECURITY_NUMBER_LAST4 =
406
+ T.let(
407
+ :social_security_number_last4,
408
+ Increase::BeneficialOwnerUpdateParams::Identification::Method::TaggedSymbol
409
+ )
410
+
404
411
  # An individual taxpayer identification number (ITIN).
405
412
  INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
406
413
  T.let(