increase 1.351.0 → 1.352.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 (51) 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/entity_create_params.rb +33 -20
  6. data/lib/increase/models/entity_update_params.rb +33 -20
  7. data/lib/increase/models/event.rb +12 -0
  8. data/lib/increase/models/event_list_params.rb +12 -0
  9. data/lib/increase/models/event_subscription.rb +12 -0
  10. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  11. data/lib/increase/models/inbound_ach_transfer.rb +9 -1
  12. data/lib/increase/models/pending_transaction.rb +121 -1
  13. data/lib/increase/models/pending_transaction_list_params.rb +6 -0
  14. data/lib/increase/models/simulations/physical_card_create_params.rb +9 -6
  15. data/lib/increase/models/transaction.rb +103 -1
  16. data/lib/increase/models/transaction_list_params.rb +6 -0
  17. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  18. data/lib/increase/resources/simulations/account_statements.rb +2 -1
  19. data/lib/increase/resources/simulations/physical_cards.rb +5 -3
  20. data/lib/increase/version.rb +1 -1
  21. data/rbi/increase/models/account_statement.rbi +12 -4
  22. data/rbi/increase/models/balance_lookup.rbi +3 -87
  23. data/rbi/increase/models/entity_create_params.rbi +39 -21
  24. data/rbi/increase/models/entity_update_params.rbi +39 -21
  25. data/rbi/increase/models/event.rbi +28 -0
  26. data/rbi/increase/models/event_list_params.rbi +28 -0
  27. data/rbi/increase/models/event_subscription.rbi +28 -0
  28. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  29. data/rbi/increase/models/inbound_ach_transfer.rbi +8 -0
  30. data/rbi/increase/models/pending_transaction.rbi +254 -0
  31. data/rbi/increase/models/pending_transaction_list_params.rbi +14 -0
  32. data/rbi/increase/models/simulations/physical_card_create_params.rbi +8 -6
  33. data/rbi/increase/models/transaction.rbi +178 -0
  34. data/rbi/increase/models/transaction_list_params.rbi +14 -0
  35. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  36. data/rbi/increase/resources/simulations/account_statements.rbi +2 -1
  37. data/rbi/increase/resources/simulations/physical_cards.rbi +4 -3
  38. data/sig/increase/models/balance_lookup.rbs +3 -42
  39. data/sig/increase/models/entity_create_params.rbs +20 -11
  40. data/sig/increase/models/entity_update_params.rbs +20 -11
  41. data/sig/increase/models/event.rbs +16 -0
  42. data/sig/increase/models/event_list_params.rbs +16 -0
  43. data/sig/increase/models/event_subscription.rbs +16 -0
  44. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  45. data/sig/increase/models/inbound_ach_transfer.rbs +5 -0
  46. data/sig/increase/models/pending_transaction.rbs +84 -0
  47. data/sig/increase/models/pending_transaction_list_params.rbs +8 -0
  48. data/sig/increase/models/transaction.rbs +50 -0
  49. data/sig/increase/models/transaction_list_params.rbs +8 -0
  50. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  51. metadata +2 -2
@@ -28,19 +28,20 @@ module Increase
28
28
  optional :carrier_estimated_delivery_at, Time
29
29
 
30
30
  # @!attribute city
31
- # The city where the event took place.
31
+ # The city where the event took place. Required if postal_code is not provided.
32
32
  #
33
33
  # @return [String, nil]
34
34
  optional :city, String
35
35
 
36
36
  # @!attribute postal_code
37
- # The postal code where the event took place.
37
+ # The postal code where the event took place. Required unless both city and state
38
+ # are provided.
38
39
  #
39
40
  # @return [String, nil]
40
41
  optional :postal_code, String
41
42
 
42
43
  # @!attribute state
43
- # The state where the event took place.
44
+ # The state where the event took place. Required if postal_code is not provided.
44
45
  #
45
46
  # @return [String, nil]
46
47
  optional :state, String
@@ -55,11 +56,13 @@ module Increase
55
56
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
56
57
  # carrier expects the card to be delivered.
57
58
  #
58
- # @param city [String] The city where the event took place.
59
+ # @param city [String] The city where the event took place. Required if postal_code is not provided.
59
60
  #
60
- # @param postal_code [String] The postal code where the event took place.
61
+ # @param postal_code [String]
62
+ # The postal code where the event took place. Required unless both city and state
63
+ # are provided.
61
64
  #
62
- # @param state [String] The state where the event took place.
65
+ # @param state [String] The state where the event took place. Required if postal_code is not provided.
63
66
  #
64
67
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
65
68
 
@@ -545,6 +545,18 @@ module Increase
545
545
  # @return [Increase::Models::Transaction::Source::SampleFunds, nil]
546
546
  optional :sample_funds, -> { Increase::Transaction::Source::SampleFunds }, nil?: true
547
547
 
548
+ # @!attribute sepa_instant_transfer_acceptance
549
+ # A SEPA Instant Transfer Acceptance object. This field will be present in the
550
+ # JSON response if and only if `category` is equal to
551
+ # `sepa_instant_transfer_acceptance`. A SEPA Instant Transfer Acceptance is
552
+ # created when a SEPA Instant Transfer sent from Increase is accepted by the
553
+ # recipient's bank.
554
+ #
555
+ # @return [Increase::Models::Transaction::Source::SepaInstantTransferAcceptance, nil]
556
+ optional :sepa_instant_transfer_acceptance,
557
+ -> { Increase::Transaction::Source::SepaInstantTransferAcceptance },
558
+ nil?: true
559
+
548
560
  # @!attribute swift_transfer_intention
549
561
  # A Swift Transfer Intention object. This field will be present in the JSON
550
562
  # response if and only if `category` is equal to `swift_transfer_intention`. A
@@ -563,6 +575,18 @@ module Increase
563
575
  # @return [Increase::Models::Transaction::Source::SwiftTransferReturn, nil]
564
576
  optional :swift_transfer_return, -> { Increase::Transaction::Source::SwiftTransferReturn }, nil?: true
565
577
 
578
+ # @!attribute uk_faster_payment_system_transfer_acceptance
579
+ # An UK Faster Payment System Transfer Acceptance object. This field will be
580
+ # present in the JSON response if and only if `category` is equal to
581
+ # `uk_faster_payment_system_transfer_acceptance`. A UK Faster Payment System
582
+ # Transfer Acceptance is created when a UK Faster Payment System Transfer sent
583
+ # from Increase is accepted by the recipient's bank.
584
+ #
585
+ # @return [Increase::Models::Transaction::Source::UkFasterPaymentSystemTransferAcceptance, nil]
586
+ optional :uk_faster_payment_system_transfer_acceptance,
587
+ -> { Increase::Transaction::Source::UkFasterPaymentSystemTransferAcceptance },
588
+ nil?: true
589
+
566
590
  # @!attribute wire_transfer_intention
567
591
  # A Wire Transfer Intention object. This field will be present in the JSON
568
592
  # response if and only if `category` is equal to `wire_transfer_intention`. A Wire
@@ -575,7 +599,7 @@ module Increase
575
599
  },
576
600
  nil?: true
577
601
 
578
- # @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fednow_transfer_return: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, swift_transfer_intention: nil, swift_transfer_return: nil, wire_transfer_intention: nil)
602
+ # @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fednow_transfer_return: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, sepa_instant_transfer_acceptance: nil, swift_transfer_intention: nil, swift_transfer_return: nil, uk_faster_payment_system_transfer_acceptance: nil, wire_transfer_intention: nil)
579
603
  # This is an object giving more details on the network-level event that caused the
580
604
  # Transaction. Note that for backwards compatibility reasons, additional
581
605
  # undocumented keys may appear in this object. These should be treated as
@@ -806,6 +830,13 @@ module Increase
806
830
  # only if `category` is equal to `sample_funds`. Sample funds for testing
807
831
  # purposes.
808
832
  #
833
+ # @param sepa_instant_transfer_acceptance [Increase::Models::Transaction::Source::SepaInstantTransferAcceptance, nil]
834
+ # A SEPA Instant Transfer Acceptance object. This field will be present in the
835
+ # JSON response if and only if `category` is equal to
836
+ # `sepa_instant_transfer_acceptance`. A SEPA Instant Transfer Acceptance is
837
+ # created when a SEPA Instant Transfer sent from Increase is accepted by the
838
+ # recipient's bank.
839
+ #
809
840
  # @param swift_transfer_intention [Increase::Models::Transaction::Source::SwiftTransferIntention, nil]
810
841
  # A Swift Transfer Intention object. This field will be present in the JSON
811
842
  # response if and only if `category` is equal to `swift_transfer_intention`. A
@@ -816,6 +847,13 @@ module Increase
816
847
  # if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
817
848
  # Return is created when a Swift Transfer is returned by the receiving bank.
818
849
  #
850
+ # @param uk_faster_payment_system_transfer_acceptance [Increase::Models::Transaction::Source::UkFasterPaymentSystemTransferAcceptance, nil]
851
+ # An UK Faster Payment System Transfer Acceptance object. This field will be
852
+ # present in the JSON response if and only if `category` is equal to
853
+ # `uk_faster_payment_system_transfer_acceptance`. A UK Faster Payment System
854
+ # Transfer Acceptance is created when a UK Faster Payment System Transfer sent
855
+ # from Increase is accepted by the recipient's bank.
856
+ #
819
857
  # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil]
820
858
  # A Wire Transfer Intention object. This field will be present in the JSON
821
859
  # response if and only if `category` is equal to `wire_transfer_intention`. A Wire
@@ -942,6 +980,12 @@ module Increase
942
980
  # Blockchain Off-Ramp Transfer Settlement: details will be under the `blockchain_offramp_transfer_settlement` object.
943
981
  BLOCKCHAIN_OFFRAMP_TRANSFER_SETTLEMENT = :blockchain_offramp_transfer_settlement
944
982
 
983
+ # UK Faster Payment System Transfer Acceptance: details will be under the `uk_faster_payment_system_transfer_acceptance` object.
984
+ UK_FASTER_PAYMENT_SYSTEM_TRANSFER_ACCEPTANCE = :uk_faster_payment_system_transfer_acceptance
985
+
986
+ # SEPA Instant Transfer Acceptance: details will be under the `sepa_instant_transfer_acceptance` object.
987
+ SEPA_INSTANT_TRANSFER_ACCEPTANCE = :sepa_instant_transfer_acceptance
988
+
945
989
  # The Transaction was made for an undocumented or deprecated reason.
946
990
  OTHER = :other
947
991
 
@@ -8143,6 +8187,35 @@ module Increase
8143
8187
  # @param originator [String] Where the sample funds came from.
8144
8188
  end
8145
8189
 
8190
+ # @see Increase::Models::Transaction::Source#sepa_instant_transfer_acceptance
8191
+ class SepaInstantTransferAcceptance < Increase::Internal::Type::BaseModel
8192
+ # @!attribute accepted_at
8193
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
8194
+ # the recipient's bank accepted the transfer.
8195
+ #
8196
+ # @return [Time]
8197
+ required :accepted_at, Time
8198
+
8199
+ # @!attribute settlement_amount
8200
+ # The transfer amount in USD cents.
8201
+ #
8202
+ # @return [Integer]
8203
+ required :settlement_amount, Integer
8204
+
8205
+ # @!method initialize(accepted_at:, settlement_amount:)
8206
+ # A SEPA Instant Transfer Acceptance object. This field will be present in the
8207
+ # JSON response if and only if `category` is equal to
8208
+ # `sepa_instant_transfer_acceptance`. A SEPA Instant Transfer Acceptance is
8209
+ # created when a SEPA Instant Transfer sent from Increase is accepted by the
8210
+ # recipient's bank.
8211
+ #
8212
+ # @param accepted_at [Time]
8213
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
8214
+ # the recipient's bank accepted the transfer.
8215
+ #
8216
+ # @param settlement_amount [Integer] The transfer amount in USD cents.
8217
+ end
8218
+
8146
8219
  # @see Increase::Models::Transaction::Source#swift_transfer_intention
8147
8220
  class SwiftTransferIntention < Increase::Internal::Type::BaseModel
8148
8221
  # @!attribute transfer_id
@@ -8175,6 +8248,35 @@ module Increase
8175
8248
  # @param transfer_id [String] The identifier of the Swift Transfer that led to this Transaction.
8176
8249
  end
8177
8250
 
8251
+ # @see Increase::Models::Transaction::Source#uk_faster_payment_system_transfer_acceptance
8252
+ class UkFasterPaymentSystemTransferAcceptance < Increase::Internal::Type::BaseModel
8253
+ # @!attribute accepted_at
8254
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
8255
+ # the recipient's bank accepted the transfer.
8256
+ #
8257
+ # @return [Time]
8258
+ required :accepted_at, Time
8259
+
8260
+ # @!attribute settlement_amount
8261
+ # The transfer amount in USD cents.
8262
+ #
8263
+ # @return [Integer]
8264
+ required :settlement_amount, Integer
8265
+
8266
+ # @!method initialize(accepted_at:, settlement_amount:)
8267
+ # An UK Faster Payment System Transfer Acceptance object. This field will be
8268
+ # present in the JSON response if and only if `category` is equal to
8269
+ # `uk_faster_payment_system_transfer_acceptance`. A UK Faster Payment System
8270
+ # Transfer Acceptance is created when a UK Faster Payment System Transfer sent
8271
+ # from Increase is accepted by the recipient's bank.
8272
+ #
8273
+ # @param accepted_at [Time]
8274
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
8275
+ # the recipient's bank accepted the transfer.
8276
+ #
8277
+ # @param settlement_amount [Integer] The transfer amount in USD cents.
8278
+ end
8279
+
8178
8280
  # @see Increase::Models::Transaction::Source#wire_transfer_intention
8179
8281
  class WireTransferIntention < Increase::Internal::Type::BaseModel
8180
8282
  # @!attribute account_number
@@ -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
 
@@ -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.352.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
@@ -3859,22 +3859,19 @@ module Increase
3859
3859
  )
3860
3860
  end
3861
3861
 
3862
- # The city of the address.
3862
+ # The city, district, town, or village of the address.
3863
3863
  sig { returns(String) }
3864
3864
  attr_accessor :city
3865
3865
 
3866
- # The first line of the address. This is usually the street number and street.
3867
- sig { returns(String) }
3868
- attr_accessor :line1
3869
-
3870
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
3871
- # the address.
3866
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
3867
+ #
3868
+ # Defaults to `US`.
3872
3869
  sig { returns(String) }
3873
- attr_accessor :state
3870
+ attr_accessor :country
3874
3871
 
3875
- # The ZIP code of the address.
3872
+ # The first line of the address. This is usually the street number and street.
3876
3873
  sig { returns(String) }
3877
- attr_accessor :zip
3874
+ attr_accessor :line1
3878
3875
 
3879
3876
  # The second line of the address. This might be the floor or room number.
3880
3877
  sig { returns(T.nilable(String)) }
@@ -3883,29 +3880,49 @@ module Increase
3883
3880
  sig { params(line2: String).void }
3884
3881
  attr_writer :line2
3885
3882
 
3883
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
3884
+ # state, province, or region of the address. Required in certain countries.
3885
+ sig { returns(T.nilable(String)) }
3886
+ attr_reader :state
3887
+
3888
+ sig { params(state: String).void }
3889
+ attr_writer :state
3890
+
3891
+ # The ZIP or postal code of the address. Required in certain countries.
3892
+ sig { returns(T.nilable(String)) }
3893
+ attr_reader :zip
3894
+
3895
+ sig { params(zip: String).void }
3896
+ attr_writer :zip
3897
+
3886
3898
  # The trust's physical address. Mail receiving locations like PO Boxes and PMB's
3887
3899
  # are disallowed.
3888
3900
  sig do
3889
3901
  params(
3890
3902
  city: String,
3903
+ country: String,
3891
3904
  line1: String,
3905
+ line2: String,
3892
3906
  state: String,
3893
- zip: String,
3894
- line2: String
3907
+ zip: String
3895
3908
  ).returns(T.attached_class)
3896
3909
  end
3897
3910
  def self.new(
3898
- # The city of the address.
3911
+ # The city, district, town, or village of the address.
3899
3912
  city:,
3913
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
3914
+ #
3915
+ # Defaults to `US`.
3916
+ country:,
3900
3917
  # The first line of the address. This is usually the street number and street.
3901
3918
  line1:,
3902
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
3903
- # the address.
3904
- state:,
3905
- # The ZIP code of the address.
3906
- zip:,
3907
3919
  # The second line of the address. This might be the floor or room number.
3908
- line2: nil
3920
+ line2: nil,
3921
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
3922
+ # state, province, or region of the address. Required in certain countries.
3923
+ state: nil,
3924
+ # The ZIP or postal code of the address. Required in certain countries.
3925
+ zip: nil
3909
3926
  )
3910
3927
  end
3911
3928
 
@@ -3913,10 +3930,11 @@ module Increase
3913
3930
  override.returns(
3914
3931
  {
3915
3932
  city: String,
3933
+ country: String,
3916
3934
  line1: String,
3935
+ line2: String,
3917
3936
  state: String,
3918
- zip: String,
3919
- line2: String
3937
+ zip: String
3920
3938
  }
3921
3939
  )
3922
3940
  end
@@ -2417,22 +2417,19 @@ module Increase
2417
2417
  )
2418
2418
  end
2419
2419
 
2420
- # The city of the address.
2420
+ # The city, district, town, or village of the address.
2421
2421
  sig { returns(String) }
2422
2422
  attr_accessor :city
2423
2423
 
2424
- # The first line of the address. This is usually the street number and street.
2425
- sig { returns(String) }
2426
- attr_accessor :line1
2427
-
2428
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2429
- # the address.
2424
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2425
+ #
2426
+ # Defaults to `US`.
2430
2427
  sig { returns(String) }
2431
- attr_accessor :state
2428
+ attr_accessor :country
2432
2429
 
2433
- # The ZIP code of the address.
2430
+ # The first line of the address. This is usually the street number and street.
2434
2431
  sig { returns(String) }
2435
- attr_accessor :zip
2432
+ attr_accessor :line1
2436
2433
 
2437
2434
  # The second line of the address. This might be the floor or room number.
2438
2435
  sig { returns(T.nilable(String)) }
@@ -2441,29 +2438,49 @@ module Increase
2441
2438
  sig { params(line2: String).void }
2442
2439
  attr_writer :line2
2443
2440
 
2441
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2442
+ # state, province, or region of the address. Required in certain countries.
2443
+ sig { returns(T.nilable(String)) }
2444
+ attr_reader :state
2445
+
2446
+ sig { params(state: String).void }
2447
+ attr_writer :state
2448
+
2449
+ # The ZIP or postal code of the address. Required in certain countries.
2450
+ sig { returns(T.nilable(String)) }
2451
+ attr_reader :zip
2452
+
2453
+ sig { params(zip: String).void }
2454
+ attr_writer :zip
2455
+
2444
2456
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
2445
2457
  # are disallowed.
2446
2458
  sig do
2447
2459
  params(
2448
2460
  city: String,
2461
+ country: String,
2449
2462
  line1: String,
2463
+ line2: String,
2450
2464
  state: String,
2451
- zip: String,
2452
- line2: String
2465
+ zip: String
2453
2466
  ).returns(T.attached_class)
2454
2467
  end
2455
2468
  def self.new(
2456
- # The city of the address.
2469
+ # The city, district, town, or village of the address.
2457
2470
  city:,
2471
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2472
+ #
2473
+ # Defaults to `US`.
2474
+ country:,
2458
2475
  # The first line of the address. This is usually the street number and street.
2459
2476
  line1:,
2460
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
2461
- # the address.
2462
- state:,
2463
- # The ZIP code of the address.
2464
- zip:,
2465
2477
  # The second line of the address. This might be the floor or room number.
2466
- line2: nil
2478
+ line2: nil,
2479
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
2480
+ # state, province, or region of the address. Required in certain countries.
2481
+ state: nil,
2482
+ # The ZIP or postal code of the address. Required in certain countries.
2483
+ zip: nil
2467
2484
  )
2468
2485
  end
2469
2486
 
@@ -2471,10 +2488,11 @@ module Increase
2471
2488
  override.returns(
2472
2489
  {
2473
2490
  city: String,
2491
+ country: String,
2474
2492
  line1: String,
2493
+ line2: String,
2475
2494
  state: String,
2476
- zip: String,
2477
- line2: String
2495
+ zip: String
2478
2496
  }
2479
2497
  )
2480
2498
  end