increase 1.187.0 → 1.188.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 (32) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +9 -9
  4. data/lib/increase/models/account.rb +99 -1
  5. data/lib/increase/models/account_create_params.rb +96 -1
  6. data/lib/increase/models/account_statement.rb +43 -1
  7. data/lib/increase/models/account_update_params.rb +22 -1
  8. data/lib/increase/models/balance_lookup.rb +43 -1
  9. data/lib/increase/models/program.rb +23 -1
  10. data/lib/increase/models/simulations/program_create_params.rb +9 -1
  11. data/lib/increase/resources/accounts.rb +8 -2
  12. data/lib/increase/resources/simulations/programs.rb +3 -1
  13. data/lib/increase/version.rb +1 -1
  14. data/rbi/increase/models/account.rbi +146 -0
  15. data/rbi/increase/models/account_create_params.rbi +168 -0
  16. data/rbi/increase/models/account_statement.rbi +64 -0
  17. data/rbi/increase/models/account_update_params.rbi +41 -1
  18. data/rbi/increase/models/balance_lookup.rbi +64 -0
  19. data/rbi/increase/models/program.rbi +38 -0
  20. data/rbi/increase/models/simulations/program_create_params.rbi +11 -0
  21. data/rbi/increase/resources/accounts.rbi +9 -0
  22. data/rbi/increase/resources/simulations/programs.rbi +3 -0
  23. data/sig/increase/models/account.rbs +75 -0
  24. data/sig/increase/models/account_create_params.rbs +85 -0
  25. data/sig/increase/models/account_statement.rbs +28 -0
  26. data/sig/increase/models/account_update_params.rbs +20 -1
  27. data/sig/increase/models/balance_lookup.rbs +28 -0
  28. data/sig/increase/models/program.rbs +15 -0
  29. data/sig/increase/models/simulations/program_create_params.rbs +7 -0
  30. data/sig/increase/resources/accounts.rbs +3 -0
  31. data/sig/increase/resources/simulations/programs.rbs +1 -0
  32. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 45084b35519dfc71669f570a7bd6f0ef13309a2bd573a84b0670d1aa2ca5a9ba
4
- data.tar.gz: fa903d0696bb0a75e50a4f4eb62293639837077a774f7a43fcd9300770662a55
3
+ metadata.gz: c98557936bb267bc225fcb8324d48c6973f0f5a1971850833cbe003cf92f2dd2
4
+ data.tar.gz: 4ebd4bef09b3597873cb144c1bddf7f0ee7e6a731756240d73e537f3a36010d5
5
5
  SHA512:
6
- metadata.gz: 9bd3e636dc84cdc9a19c786a4dd1a19ed5adec2468c5b346f36017078f882c0f4598a60da0476160642aaaee5d5a67d02de3b7112c344f6db30dc01c2881b533
7
- data.tar.gz: df3bf415a4c65186689a7d9e7eed4709d81d860231755f1f052b6997cef6a47071e72a32d2391075265b87218b0b20eeb81717b8b06eda9a58fa272e32f8c7ff
6
+ metadata.gz: 4bbf0a1760bba1aadbd3da7ccc5b871b6c92c6ff216ce42cc5d91799fc7d0f41a740bef64489f662ba95c5ef50c48a727af4e58d7bb1d57e77a0bf1cc99ff611
7
+ data.tar.gz: 063d3224a71d7704b734fd9d463f0fd7d9c45735a4992809d55356a7724d4155c96ea74addb4d35715ea94bca21e196f354d9cc6127c86acf3c0f754d44b3e0a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.188.0 (2026-01-30)
4
+
5
+ Full Changelog: [v1.187.0...v1.188.0](https://github.com/Increase/increase-ruby/compare/v1.187.0...v1.188.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([edc7e8c](https://github.com/Increase/increase-ruby/commit/edc7e8c374bf5a108ea08346136ed22be11beca2))
10
+
3
11
  ## 1.187.0 (2026-01-30)
4
12
 
5
13
  Full Changelog: [v1.186.0...v1.187.0](https://github.com/Increase/increase-ruby/compare/v1.186.0...v1.187.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.187.0"
18
+ gem "increase", "~> 1.188.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -273,25 +273,25 @@ increase.accounts.create(**params)
273
273
  Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
274
274
 
275
275
  ```ruby
276
- # :active
277
- puts(Increase::AccountNumberUpdateParams::Status::ACTIVE)
276
+ # :loan
277
+ puts(Increase::AccountCreateParams::Funding::LOAN)
278
278
 
279
- # Revealed type: `T.all(Increase::AccountNumberUpdateParams::Status, Symbol)`
280
- T.reveal_type(Increase::AccountNumberUpdateParams::Status::ACTIVE)
279
+ # Revealed type: `T.all(Increase::AccountCreateParams::Funding, Symbol)`
280
+ T.reveal_type(Increase::AccountCreateParams::Funding::LOAN)
281
281
  ```
282
282
 
283
283
  Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
284
284
 
285
285
  ```ruby
286
286
  # Using the enum constants preserves the tagged type information:
287
- increase.account_numbers.update(
288
- status: Increase::AccountNumberUpdateParams::Status::ACTIVE,
287
+ increase.accounts.create(
288
+ funding: Increase::AccountCreateParams::Funding::LOAN,
289
289
  # …
290
290
  )
291
291
 
292
292
  # Literal values are also permissible:
293
- increase.account_numbers.update(
294
- status: :active,
293
+ increase.accounts.create(
294
+ funding: :loan,
295
295
  # …
296
296
  )
297
297
  ```
@@ -52,6 +52,12 @@ module Increase
52
52
  # @return [String]
53
53
  required :entity_id, String
54
54
 
55
+ # @!attribute funding
56
+ # Whether the Account is funded by a loan or by deposits.
57
+ #
58
+ # @return [Symbol, Increase::Models::Account::Funding, nil]
59
+ required :funding, enum: -> { Increase::Account::Funding }, nil?: true
60
+
55
61
  # @!attribute idempotency_key
56
62
  # The idempotency key you chose for this object. This value is unique across
57
63
  # Increase and is used to ensure that a request is only processed once. Learn more
@@ -89,6 +95,12 @@ module Increase
89
95
  # @return [String]
90
96
  required :interest_rate, String
91
97
 
98
+ # @!attribute loan
99
+ # The Account's loan-related information, if the Account is a loan account.
100
+ #
101
+ # @return [Increase::Models::Account::Loan, nil]
102
+ required :loan, -> { Increase::Account::Loan }, nil?: true
103
+
92
104
  # @!attribute name
93
105
  # The name you choose for the Account.
94
106
  #
@@ -115,7 +127,7 @@ module Increase
115
127
  # @return [Symbol, Increase::Models::Account::Type]
116
128
  required :type, enum: -> { Increase::Account::Type }
117
129
 
118
- # @!method initialize(id:, account_revenue_rate:, bank:, closed_at:, created_at:, currency:, entity_id:, idempotency_key:, informational_entity_id:, interest_accrued:, interest_accrued_at:, interest_rate:, name:, program_id:, status:, type:)
130
+ # @!method initialize(id:, account_revenue_rate:, bank:, closed_at:, created_at:, currency:, entity_id:, funding:, idempotency_key:, informational_entity_id:, interest_accrued:, interest_accrued_at:, interest_rate:, loan:, name:, program_id:, status:, type:)
119
131
  # Some parameter documentations has been truncated, see
120
132
  # {Increase::Models::Account} for more details.
121
133
  #
@@ -136,6 +148,8 @@ module Increase
136
148
  #
137
149
  # @param entity_id [String] The identifier for the Entity the Account belongs to.
138
150
  #
151
+ # @param funding [Symbol, Increase::Models::Account::Funding, nil] Whether the Account is funded by a loan or by deposits.
152
+ #
139
153
  # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
140
154
  #
141
155
  # @param informational_entity_id [String, nil] The identifier of an Entity that, while not owning the Account, is associated wi
@@ -146,6 +160,8 @@ module Increase
146
160
  #
147
161
  # @param interest_rate [String] The interest rate currently being earned on the account, as a string containing
148
162
  #
163
+ # @param loan [Increase::Models::Account::Loan, nil] The Account's loan-related information, if the Account is a loan account.
164
+ #
149
165
  # @param name [String] The name you choose for the Account.
150
166
  #
151
167
  # @param program_id [String] The identifier of the Program determining the compliance and commercial terms of
@@ -187,6 +203,88 @@ module Increase
187
203
  # @return [Array<Symbol>]
188
204
  end
189
205
 
206
+ # Whether the Account is funded by a loan or by deposits.
207
+ #
208
+ # @see Increase::Models::Account#funding
209
+ module Funding
210
+ extend Increase::Internal::Type::Enum
211
+
212
+ # An account funded by a loan. Before opening a loan account, contact support@increase.com to set up a loan program.
213
+ LOAN = :loan
214
+
215
+ # An account funded by deposits.
216
+ DEPOSITS = :deposits
217
+
218
+ # @!method self.values
219
+ # @return [Array<Symbol>]
220
+ end
221
+
222
+ # @see Increase::Models::Account#loan
223
+ class Loan < Increase::Internal::Type::BaseModel
224
+ # @!attribute credit_limit
225
+ # The maximum amount of money that can be borrowed on the Account.
226
+ #
227
+ # @return [Integer]
228
+ required :credit_limit, Integer
229
+
230
+ # @!attribute grace_period_days
231
+ # The number of days after the statement date that the Account can be past due
232
+ # before being considered delinquent.
233
+ #
234
+ # @return [Integer]
235
+ required :grace_period_days, Integer
236
+
237
+ # @!attribute maturity_date
238
+ # The date on which the loan matures.
239
+ #
240
+ # @return [Date, nil]
241
+ required :maturity_date, Date, nil?: true
242
+
243
+ # @!attribute statement_day_of_month
244
+ # The day of the month on which the loan statement is generated.
245
+ #
246
+ # @return [Integer]
247
+ required :statement_day_of_month, Integer
248
+
249
+ # @!attribute statement_payment_type
250
+ # The type of payment for the loan.
251
+ #
252
+ # @return [Symbol, Increase::Models::Account::Loan::StatementPaymentType]
253
+ required :statement_payment_type, enum: -> { Increase::Account::Loan::StatementPaymentType }
254
+
255
+ # @!method initialize(credit_limit:, grace_period_days:, maturity_date:, statement_day_of_month:, statement_payment_type:)
256
+ # Some parameter documentations has been truncated, see
257
+ # {Increase::Models::Account::Loan} for more details.
258
+ #
259
+ # The Account's loan-related information, if the Account is a loan account.
260
+ #
261
+ # @param credit_limit [Integer] The maximum amount of money that can be borrowed on the Account.
262
+ #
263
+ # @param grace_period_days [Integer] The number of days after the statement date that the Account can be past due bef
264
+ #
265
+ # @param maturity_date [Date, nil] The date on which the loan matures.
266
+ #
267
+ # @param statement_day_of_month [Integer] The day of the month on which the loan statement is generated.
268
+ #
269
+ # @param statement_payment_type [Symbol, Increase::Models::Account::Loan::StatementPaymentType] The type of payment for the loan.
270
+
271
+ # The type of payment for the loan.
272
+ #
273
+ # @see Increase::Models::Account::Loan#statement_payment_type
274
+ module StatementPaymentType
275
+ extend Increase::Internal::Type::Enum
276
+
277
+ # The borrower must pay the full balance of the loan at the end of the statement period.
278
+ BALANCE = :balance
279
+
280
+ # The borrower must pay the accrued interest at the end of the statement period.
281
+ INTEREST_UNTIL_MATURITY = :interest_until_maturity
282
+
283
+ # @!method self.values
284
+ # @return [Array<Symbol>]
285
+ end
286
+ end
287
+
190
288
  # The status of the Account.
191
289
  #
192
290
  # @see Increase::Models::Account#status
@@ -19,6 +19,12 @@ module Increase
19
19
  # @return [String, nil]
20
20
  optional :entity_id, String
21
21
 
22
+ # @!attribute funding
23
+ # Whether the Account is funded by a loan or by deposits.
24
+ #
25
+ # @return [Symbol, Increase::Models::AccountCreateParams::Funding, nil]
26
+ optional :funding, enum: -> { Increase::AccountCreateParams::Funding }
27
+
22
28
  # @!attribute informational_entity_id
23
29
  # The identifier of an Entity that, while not owning the Account, is associated
24
30
  # with its activity. This is generally the beneficiary of the funds.
@@ -26,6 +32,12 @@ module Increase
26
32
  # @return [String, nil]
27
33
  optional :informational_entity_id, String
28
34
 
35
+ # @!attribute loan
36
+ # The loan details for the account.
37
+ #
38
+ # @return [Increase::Models::AccountCreateParams::Loan, nil]
39
+ optional :loan, -> { Increase::AccountCreateParams::Loan }
40
+
29
41
  # @!attribute program_id
30
42
  # The identifier for the Program that this Account falls under. Required if you
31
43
  # operate more than one Program.
@@ -33,7 +45,7 @@ module Increase
33
45
  # @return [String, nil]
34
46
  optional :program_id, String
35
47
 
36
- # @!method initialize(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {})
48
+ # @!method initialize(name:, entity_id: nil, funding: nil, informational_entity_id: nil, loan: nil, program_id: nil, request_options: {})
37
49
  # Some parameter documentations has been truncated, see
38
50
  # {Increase::Models::AccountCreateParams} for more details.
39
51
  #
@@ -41,11 +53,94 @@ module Increase
41
53
  #
42
54
  # @param entity_id [String] The identifier for the Entity that will own the Account.
43
55
  #
56
+ # @param funding [Symbol, Increase::Models::AccountCreateParams::Funding] Whether the Account is funded by a loan or by deposits.
57
+ #
44
58
  # @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi
45
59
  #
60
+ # @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
61
+ #
46
62
  # @param program_id [String] The identifier for the Program that this Account falls under. Required if you op
47
63
  #
48
64
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
65
+
66
+ # Whether the Account is funded by a loan or by deposits.
67
+ module Funding
68
+ extend Increase::Internal::Type::Enum
69
+
70
+ # An account funded by a loan. Before opening a loan account, contact support@increase.com to set up a loan program.
71
+ LOAN = :loan
72
+
73
+ # An account funded by deposits.
74
+ DEPOSITS = :deposits
75
+
76
+ # @!method self.values
77
+ # @return [Array<Symbol>]
78
+ end
79
+
80
+ class Loan < Increase::Internal::Type::BaseModel
81
+ # @!attribute credit_limit
82
+ # The maximum amount of money that can be drawn from the Account.
83
+ #
84
+ # @return [Integer]
85
+ required :credit_limit, Integer
86
+
87
+ # @!attribute grace_period_days
88
+ # The number of days after the statement date that the Account can be past due
89
+ # before being considered delinquent.
90
+ #
91
+ # @return [Integer]
92
+ required :grace_period_days, Integer
93
+
94
+ # @!attribute statement_day_of_month
95
+ # The day of the month on which the loan statement is generated.
96
+ #
97
+ # @return [Integer]
98
+ required :statement_day_of_month, Integer
99
+
100
+ # @!attribute statement_payment_type
101
+ # The type of statement payment for the account.
102
+ #
103
+ # @return [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType]
104
+ required :statement_payment_type, enum: -> { Increase::AccountCreateParams::Loan::StatementPaymentType }
105
+
106
+ # @!attribute maturity_date
107
+ # The date on which the loan matures.
108
+ #
109
+ # @return [Date, nil]
110
+ optional :maturity_date, Date
111
+
112
+ # @!method initialize(credit_limit:, grace_period_days:, statement_day_of_month:, statement_payment_type:, maturity_date: nil)
113
+ # Some parameter documentations has been truncated, see
114
+ # {Increase::Models::AccountCreateParams::Loan} for more details.
115
+ #
116
+ # The loan details for the account.
117
+ #
118
+ # @param credit_limit [Integer] The maximum amount of money that can be drawn from the Account.
119
+ #
120
+ # @param grace_period_days [Integer] The number of days after the statement date that the Account can be past due bef
121
+ #
122
+ # @param statement_day_of_month [Integer] The day of the month on which the loan statement is generated.
123
+ #
124
+ # @param statement_payment_type [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType] The type of statement payment for the account.
125
+ #
126
+ # @param maturity_date [Date] The date on which the loan matures.
127
+
128
+ # The type of statement payment for the account.
129
+ #
130
+ # @see Increase::Models::AccountCreateParams::Loan#statement_payment_type
131
+ module StatementPaymentType
132
+ extend Increase::Internal::Type::Enum
133
+
134
+ # The borrower must pay the full balance of the loan at the end of the statement period.
135
+ BALANCE = :balance
136
+
137
+ # The borrower must pay the accrued interest at the end of the statement period.
138
+ INTEREST_UNTIL_MATURITY = :interest_until_maturity
139
+
140
+ # @!method self.values
141
+ # @return [Array<Symbol>]
142
+ end
143
+ end
49
144
  end
50
145
  end
51
146
  end
@@ -35,6 +35,12 @@ module Increase
35
35
  # @return [String]
36
36
  required :file_id, String
37
37
 
38
+ # @!attribute loan
39
+ # The loan balances.
40
+ #
41
+ # @return [Increase::Models::AccountStatement::Loan, nil]
42
+ required :loan, -> { Increase::AccountStatement::Loan }, nil?: true
43
+
38
44
  # @!attribute starting_balance
39
45
  # The Account's balance at the start of its statement period.
40
46
  #
@@ -62,7 +68,7 @@ module Increase
62
68
  # @return [Symbol, Increase::Models::AccountStatement::Type]
63
69
  required :type, enum: -> { Increase::AccountStatement::Type }
64
70
 
65
- # @!method initialize(id:, account_id:, created_at:, ending_balance:, file_id:, starting_balance:, statement_period_end:, statement_period_start:, type:)
71
+ # @!method initialize(id:, account_id:, created_at:, ending_balance:, file_id:, loan:, starting_balance:, statement_period_end:, statement_period_start:, type:)
66
72
  # Some parameter documentations has been truncated, see
67
73
  # {Increase::Models::AccountStatement} for more details.
68
74
  #
@@ -80,6 +86,8 @@ module Increase
80
86
  #
81
87
  # @param file_id [String] The identifier of the File containing a PDF of the statement.
82
88
  #
89
+ # @param loan [Increase::Models::AccountStatement::Loan, nil] The loan balances.
90
+ #
83
91
  # @param starting_balance [Integer] The Account's balance at the start of its statement period.
84
92
  #
85
93
  # @param statement_period_end [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
@@ -88,6 +96,40 @@ module Increase
88
96
  #
89
97
  # @param type [Symbol, Increase::Models::AccountStatement::Type] A constant representing the object's type. For this resource it will always be `
90
98
 
99
+ # @see Increase::Models::AccountStatement#loan
100
+ class Loan < Increase::Internal::Type::BaseModel
101
+ # @!attribute due_at
102
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
103
+ # payment is due.
104
+ #
105
+ # @return [Time, nil]
106
+ required :due_at, Time, nil?: true
107
+
108
+ # @!attribute due_balance
109
+ # The total amount due on the loan.
110
+ #
111
+ # @return [Integer]
112
+ required :due_balance, Integer
113
+
114
+ # @!attribute past_due_balance
115
+ # The amount past due on the loan.
116
+ #
117
+ # @return [Integer]
118
+ required :past_due_balance, Integer
119
+
120
+ # @!method initialize(due_at:, due_balance:, past_due_balance:)
121
+ # Some parameter documentations has been truncated, see
122
+ # {Increase::Models::AccountStatement::Loan} for more details.
123
+ #
124
+ # The loan balances.
125
+ #
126
+ # @param due_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan pa
127
+ #
128
+ # @param due_balance [Integer] The total amount due on the loan.
129
+ #
130
+ # @param past_due_balance [Integer] The amount past due on the loan.
131
+ end
132
+
91
133
  # A constant representing the object's type. For this resource it will always be
92
134
  # `account_statement`.
93
135
  #
@@ -7,16 +7,37 @@ module Increase
7
7
  extend Increase::Internal::Type::RequestParameters::Converter
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute loan
11
+ # The loan details for the account.
12
+ #
13
+ # @return [Increase::Models::AccountUpdateParams::Loan, nil]
14
+ optional :loan, -> { Increase::AccountUpdateParams::Loan }
15
+
10
16
  # @!attribute name
11
17
  # The new name of the Account.
12
18
  #
13
19
  # @return [String, nil]
14
20
  optional :name, String
15
21
 
16
- # @!method initialize(name: nil, request_options: {})
22
+ # @!method initialize(loan: nil, name: nil, request_options: {})
23
+ # @param loan [Increase::Models::AccountUpdateParams::Loan] The loan details for the account.
24
+ #
17
25
  # @param name [String] The new name of the Account.
18
26
  #
19
27
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
28
+
29
+ class Loan < Increase::Internal::Type::BaseModel
30
+ # @!attribute credit_limit
31
+ # The maximum amount of money that can be drawn from the Account.
32
+ #
33
+ # @return [Integer]
34
+ required :credit_limit, Integer
35
+
36
+ # @!method initialize(credit_limit:)
37
+ # The loan details for the account.
38
+ #
39
+ # @param credit_limit [Integer] The maximum amount of money that can be drawn from the Account.
40
+ end
20
41
  end
21
42
  end
22
43
  end
@@ -24,6 +24,12 @@ module Increase
24
24
  # @return [Integer]
25
25
  required :current_balance, Integer
26
26
 
27
+ # @!attribute loan
28
+ # The loan balances for the Account.
29
+ #
30
+ # @return [Increase::Models::BalanceLookup::Loan, nil]
31
+ required :loan, -> { Increase::BalanceLookup::Loan }, nil?: true
32
+
27
33
  # @!attribute type
28
34
  # A constant representing the object's type. For this resource it will always be
29
35
  # `balance_lookup`.
@@ -31,7 +37,7 @@ module Increase
31
37
  # @return [Symbol, Increase::Models::BalanceLookup::Type]
32
38
  required :type, enum: -> { Increase::BalanceLookup::Type }
33
39
 
34
- # @!method initialize(account_id:, available_balance:, current_balance:, type:)
40
+ # @!method initialize(account_id:, available_balance:, current_balance:, loan:, type:)
35
41
  # Some parameter documentations has been truncated, see
36
42
  # {Increase::Models::BalanceLookup} for more details.
37
43
  #
@@ -44,8 +50,44 @@ module Increase
44
50
  #
45
51
  # @param current_balance [Integer] The Account's current balance, representing the sum of all posted Transactions o
46
52
  #
53
+ # @param loan [Increase::Models::BalanceLookup::Loan, nil] The loan balances for the Account.
54
+ #
47
55
  # @param type [Symbol, Increase::Models::BalanceLookup::Type] A constant representing the object's type. For this resource it will always be `
48
56
 
57
+ # @see Increase::Models::BalanceLookup#loan
58
+ class Loan < Increase::Internal::Type::BaseModel
59
+ # @!attribute due_at
60
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
61
+ # payment is due.
62
+ #
63
+ # @return [Time, nil]
64
+ required :due_at, Time, nil?: true
65
+
66
+ # @!attribute due_balance
67
+ # The total amount due on the loan.
68
+ #
69
+ # @return [Integer]
70
+ required :due_balance, Integer
71
+
72
+ # @!attribute past_due_balance
73
+ # The amount past due on the loan.
74
+ #
75
+ # @return [Integer]
76
+ required :past_due_balance, Integer
77
+
78
+ # @!method initialize(due_at:, due_balance:, past_due_balance:)
79
+ # Some parameter documentations has been truncated, see
80
+ # {Increase::Models::BalanceLookup::Loan} for more details.
81
+ #
82
+ # The loan balances for the Account.
83
+ #
84
+ # @param due_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan pa
85
+ #
86
+ # @param due_balance [Integer] The total amount due on the loan.
87
+ #
88
+ # @param past_due_balance [Integer] The amount past due on the loan.
89
+ end
90
+
49
91
  # A constant representing the object's type. For this resource it will always be
50
92
  # `balance_lookup`.
51
93
  #
@@ -43,6 +43,12 @@ module Increase
43
43
  # @return [String]
44
44
  required :interest_rate, String
45
45
 
46
+ # @!attribute lending
47
+ # The lending details for the program.
48
+ #
49
+ # @return [Increase::Models::Program::Lending, nil]
50
+ required :lending, -> { Increase::Program::Lending }, nil?: true
51
+
46
52
  # @!attribute name
47
53
  # The name of the Program.
48
54
  #
@@ -63,7 +69,7 @@ module Increase
63
69
  # @return [Time]
64
70
  required :updated_at, Time
65
71
 
66
- # @!method initialize(id:, bank:, billing_account_id:, created_at:, default_digital_card_profile_id:, interest_rate:, name:, type:, updated_at:)
72
+ # @!method initialize(id:, bank:, billing_account_id:, created_at:, default_digital_card_profile_id:, interest_rate:, lending:, name:, type:, updated_at:)
67
73
  # Some parameter documentations has been truncated, see
68
74
  # {Increase::Models::Program} for more details.
69
75
  #
@@ -84,6 +90,8 @@ module Increase
84
90
  #
85
91
  # @param interest_rate [String] The Interest Rate currently being earned on the accounts in this program, as a s
86
92
  #
93
+ # @param lending [Increase::Models::Program::Lending, nil] The lending details for the program.
94
+ #
87
95
  # @param name [String] The name of the Program.
88
96
  #
89
97
  # @param type [Symbol, Increase::Models::Program::Type] A constant representing the object's type. For this resource it will always be `
@@ -109,6 +117,20 @@ module Increase
109
117
  # @return [Array<Symbol>]
110
118
  end
111
119
 
120
+ # @see Increase::Models::Program#lending
121
+ class Lending < Increase::Internal::Type::BaseModel
122
+ # @!attribute maximum_extendable_credit
123
+ # The maximum extendable credit of the program.
124
+ #
125
+ # @return [Integer]
126
+ required :maximum_extendable_credit, Integer
127
+
128
+ # @!method initialize(maximum_extendable_credit:)
129
+ # The lending details for the program.
130
+ #
131
+ # @param maximum_extendable_credit [Integer] The maximum extendable credit of the program.
132
+ end
133
+
112
134
  # A constant representing the object's type. For this resource it will always be
113
135
  # `program`.
114
136
  #
@@ -20,17 +20,25 @@ module Increase
20
20
  # @return [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank, nil]
21
21
  optional :bank, enum: -> { Increase::Simulations::ProgramCreateParams::Bank }
22
22
 
23
+ # @!attribute lending_maximum_extendable_credit
24
+ # The maximum extendable credit of the program being added.
25
+ #
26
+ # @return [Integer, nil]
27
+ optional :lending_maximum_extendable_credit, Integer
28
+
23
29
  # @!attribute reserve_account_id
24
30
  # The identifier of the Account the Program should be added to is for.
25
31
  #
26
32
  # @return [String, nil]
27
33
  optional :reserve_account_id, String
28
34
 
29
- # @!method initialize(name:, bank: nil, reserve_account_id: nil, request_options: {})
35
+ # @!method initialize(name:, bank: nil, lending_maximum_extendable_credit: nil, reserve_account_id: nil, request_options: {})
30
36
  # @param name [String] The name of the program being added.
31
37
  #
32
38
  # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank] The bank for the program's accounts, defaults to First Internet Bank.
33
39
  #
40
+ # @param lending_maximum_extendable_credit [Integer] The maximum extendable credit of the program being added.
41
+ #
34
42
  # @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
35
43
  #
36
44
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
@@ -8,14 +8,18 @@ module Increase
8
8
  #
9
9
  # Create an Account
10
10
  #
11
- # @overload create(name:, entity_id: nil, informational_entity_id: nil, program_id: nil, request_options: {})
11
+ # @overload create(name:, entity_id: nil, funding: nil, informational_entity_id: nil, loan: nil, program_id: nil, request_options: {})
12
12
  #
13
13
  # @param name [String] The name you choose for the Account.
14
14
  #
15
15
  # @param entity_id [String] The identifier for the Entity that will own the Account.
16
16
  #
17
+ # @param funding [Symbol, Increase::Models::AccountCreateParams::Funding] Whether the Account is funded by a loan or by deposits.
18
+ #
17
19
  # @param informational_entity_id [String] The identifier of an Entity that, while not owning the Account, is associated wi
18
20
  #
21
+ # @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
22
+ #
19
23
  # @param program_id [String] The identifier for the Program that this Account falls under. Required if you op
20
24
  #
21
25
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -56,10 +60,12 @@ module Increase
56
60
 
57
61
  # Update an Account
58
62
  #
59
- # @overload update(account_id, name: nil, request_options: {})
63
+ # @overload update(account_id, loan: nil, name: nil, request_options: {})
60
64
  #
61
65
  # @param account_id [String] The identifier of the Account to update.
62
66
  #
67
+ # @param loan [Increase::Models::AccountUpdateParams::Loan] The loan details for the account.
68
+ #
63
69
  # @param name [String] The new name of the Account.
64
70
  #
65
71
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -9,12 +9,14 @@ module Increase
9
9
  # operates more than one program, `program_id` is a required field when creating
10
10
  # accounts.
11
11
  #
12
- # @overload create(name:, bank: nil, reserve_account_id: nil, request_options: {})
12
+ # @overload create(name:, bank: nil, lending_maximum_extendable_credit: nil, reserve_account_id: nil, request_options: {})
13
13
  #
14
14
  # @param name [String] The name of the program being added.
15
15
  #
16
16
  # @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank] The bank for the program's accounts, defaults to First Internet Bank.
17
17
  #
18
+ # @param lending_maximum_extendable_credit [Integer] The maximum extendable credit of the program being added.
19
+ #
18
20
  # @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
19
21
  #
20
22
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.187.0"
4
+ VERSION = "1.188.0"
5
5
  end