increase 1.238.0 → 1.240.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 (33) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/client.rb +4 -0
  5. data/lib/increase/models/beneficial_owner_list_params.rb +54 -0
  6. data/lib/increase/models/beneficial_owner_retrieve_params.rb +22 -0
  7. data/lib/increase/models/entity.rb +3 -207
  8. data/lib/increase/models/entity_beneficial_owner.rb +238 -0
  9. data/lib/increase/models/simulations/card_token_create_params.rb +197 -1
  10. data/lib/increase/models.rb +6 -0
  11. data/lib/increase/resources/beneficial_owners.rb +67 -0
  12. data/lib/increase/resources/simulations/card_tokens.rb +3 -1
  13. data/lib/increase/version.rb +1 -1
  14. data/lib/increase.rb +4 -0
  15. data/rbi/increase/client.rbi +3 -0
  16. data/rbi/increase/models/beneficial_owner_list_params.rbi +89 -0
  17. data/rbi/increase/models/beneficial_owner_retrieve_params.rbi +46 -0
  18. data/rbi/increase/models/entity.rbi +3 -403
  19. data/rbi/increase/models/entity_beneficial_owner.rbi +412 -0
  20. data/rbi/increase/models/simulations/card_token_create_params.rbi +495 -0
  21. data/rbi/increase/models.rbi +7 -0
  22. data/rbi/increase/resources/beneficial_owners.rbi +54 -0
  23. data/rbi/increase/resources/simulations/card_tokens.rbi +4 -0
  24. data/sig/increase/client.rbs +2 -0
  25. data/sig/increase/models/beneficial_owner_list_params.rbs +47 -0
  26. data/sig/increase/models/beneficial_owner_retrieve_params.rbs +24 -0
  27. data/sig/increase/models/entity.rbs +4 -174
  28. data/sig/increase/models/entity_beneficial_owner.rbs +193 -0
  29. data/sig/increase/models/simulations/card_token_create_params.rbs +246 -0
  30. data/sig/increase/models.rbs +6 -0
  31. data/sig/increase/resources/beneficial_owners.rbs +20 -0
  32. data/sig/increase/resources/simulations/card_tokens.rbs +1 -0
  33. metadata +14 -2
@@ -6,6 +6,7 @@ module Increase
6
6
  capabilities: ::Array[Increase::Simulations::CardTokenCreateParams::Capability],
7
7
  expiration: Date,
8
8
  :last4 => String,
9
+ outcome: Increase::Simulations::CardTokenCreateParams::Outcome,
9
10
  prefix: String,
10
11
  primary_account_number_length: Integer
11
12
  }
@@ -29,6 +30,12 @@ module Increase
29
30
 
30
31
  def last4=: (String) -> String
31
32
 
33
+ attr_reader outcome: Increase::Simulations::CardTokenCreateParams::Outcome?
34
+
35
+ def outcome=: (
36
+ Increase::Simulations::CardTokenCreateParams::Outcome
37
+ ) -> Increase::Simulations::CardTokenCreateParams::Outcome
38
+
32
39
  attr_reader prefix: String?
33
40
 
34
41
  def prefix=: (String) -> String
@@ -41,6 +48,7 @@ module Increase
41
48
  ?capabilities: ::Array[Increase::Simulations::CardTokenCreateParams::Capability],
42
49
  ?expiration: Date,
43
50
  ?last4: String,
51
+ ?outcome: Increase::Simulations::CardTokenCreateParams::Outcome,
44
52
  ?prefix: String,
45
53
  ?primary_account_number_length: Integer,
46
54
  ?request_options: Increase::request_opts
@@ -50,6 +58,7 @@ module Increase
50
58
  capabilities: ::Array[Increase::Simulations::CardTokenCreateParams::Capability],
51
59
  expiration: Date,
52
60
  :last4 => String,
61
+ outcome: Increase::Simulations::CardTokenCreateParams::Outcome,
53
62
  prefix: String,
54
63
  primary_account_number_length: Integer,
55
64
  request_options: Increase::RequestOptions
@@ -123,6 +132,243 @@ module Increase
123
132
  def self?.values: -> ::Array[Increase::Models::Simulations::CardTokenCreateParams::Capability::route]
124
133
  end
125
134
  end
135
+
136
+ type outcome =
137
+ {
138
+ result: Increase::Models::Simulations::CardTokenCreateParams::Outcome::result,
139
+ decline: Increase::Simulations::CardTokenCreateParams::Outcome::Decline
140
+ }
141
+
142
+ class Outcome < Increase::Internal::Type::BaseModel
143
+ attr_accessor result: Increase::Models::Simulations::CardTokenCreateParams::Outcome::result
144
+
145
+ attr_reader decline: Increase::Simulations::CardTokenCreateParams::Outcome::Decline?
146
+
147
+ def decline=: (
148
+ Increase::Simulations::CardTokenCreateParams::Outcome::Decline
149
+ ) -> Increase::Simulations::CardTokenCreateParams::Outcome::Decline
150
+
151
+ def initialize: (
152
+ result: Increase::Models::Simulations::CardTokenCreateParams::Outcome::result,
153
+ ?decline: Increase::Simulations::CardTokenCreateParams::Outcome::Decline
154
+ ) -> void
155
+
156
+ def to_hash: -> {
157
+ result: Increase::Models::Simulations::CardTokenCreateParams::Outcome::result,
158
+ decline: Increase::Simulations::CardTokenCreateParams::Outcome::Decline
159
+ }
160
+
161
+ type result = :approve | :decline
162
+
163
+ module Result
164
+ extend Increase::Internal::Type::Enum
165
+
166
+ # Any card push transfers or validations will be approved.
167
+ APPROVE: :approve
168
+
169
+ # Any card push transfers or validations will be declined.
170
+ DECLINE: :decline
171
+
172
+ def self?.values: -> ::Array[Increase::Models::Simulations::CardTokenCreateParams::Outcome::result]
173
+ end
174
+
175
+ type decline =
176
+ {
177
+ reason: Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::reason
178
+ }
179
+
180
+ class Decline < Increase::Internal::Type::BaseModel
181
+ attr_reader reason: Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::reason?
182
+
183
+ def reason=: (
184
+ Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::reason
185
+ ) -> Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::reason
186
+
187
+ def initialize: (
188
+ ?reason: Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::reason
189
+ ) -> void
190
+
191
+ def to_hash: -> {
192
+ reason: Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::reason
193
+ }
194
+
195
+ type reason =
196
+ :do_not_honor
197
+ | :activity_count_limit_exceeded
198
+ | :refer_to_card_issuer
199
+ | :refer_to_card_issuer_special_condition
200
+ | :invalid_merchant
201
+ | :pick_up_card
202
+ | :error
203
+ | :pick_up_card_special
204
+ | :invalid_transaction
205
+ | :invalid_amount
206
+ | :invalid_account_number
207
+ | :no_such_issuer
208
+ | :re_enter_transaction
209
+ | :no_credit_account
210
+ | :pick_up_card_lost
211
+ | :pick_up_card_stolen
212
+ | :closed_account
213
+ | :insufficient_funds
214
+ | :no_checking_account
215
+ | :no_savings_account
216
+ | :expired_card
217
+ | :transaction_not_permitted_to_cardholder
218
+ | :transaction_not_allowed_at_terminal
219
+ | :suspected_fraud
220
+ | :activity_amount_limit_exceeded
221
+ | :restricted_card
222
+ | :security_violation
223
+ | :transaction_does_not_fulfill_anti_money_laundering_requirement
224
+ | :blocked_first_use
225
+ | :credit_issuer_unavailable
226
+ | :negative_card_verification_value_results
227
+ | :issuer_unavailable
228
+ | :financial_institution_cannot_be_found
229
+ | :transaction_cannot_be_completed
230
+ | :duplicate_transaction
231
+ | :system_malfunction
232
+ | :additional_customer_authentication_required
233
+ | :surcharge_amount_not_permitted
234
+ | :decline_for_cvv2_failure
235
+ | :stop_payment_order
236
+ | :revocation_of_authorization_order
237
+ | :revocation_of_all_authorizations_order
238
+
239
+ module Reason
240
+ extend Increase::Internal::Type::Enum
241
+
242
+ # The card issuer has declined the transaction without providing a specific reason.
243
+ DO_NOT_HONOR: :do_not_honor
244
+
245
+ # The number of transactions for the card has exceeded the limit set by the issuer.
246
+ ACTIVITY_COUNT_LIMIT_EXCEEDED: :activity_count_limit_exceeded
247
+
248
+ # The card issuer requires the cardholder to contact them for further information regarding the transaction.
249
+ REFER_TO_CARD_ISSUER: :refer_to_card_issuer
250
+
251
+ # The card issuer requires the cardholder to contact them due to a special condition related to the transaction.
252
+ REFER_TO_CARD_ISSUER_SPECIAL_CONDITION: :refer_to_card_issuer_special_condition
253
+
254
+ # The merchant is not valid for this transaction.
255
+ INVALID_MERCHANT: :invalid_merchant
256
+
257
+ # The card should be retained by the terminal.
258
+ PICK_UP_CARD: :pick_up_card
259
+
260
+ # An error occurred during processing of the transaction.
261
+ ERROR: :error
262
+
263
+ # The card should be retained by the terminal due to a special condition.
264
+ PICK_UP_CARD_SPECIAL: :pick_up_card_special
265
+
266
+ # The transaction is invalid and cannot be processed.
267
+ INVALID_TRANSACTION: :invalid_transaction
268
+
269
+ # The amount of the transaction is invalid.
270
+ INVALID_AMOUNT: :invalid_amount
271
+
272
+ # The account number provided is invalid.
273
+ INVALID_ACCOUNT_NUMBER: :invalid_account_number
274
+
275
+ # The issuer of the card could not be found.
276
+ NO_SUCH_ISSUER: :no_such_issuer
277
+
278
+ # The transaction should be re-entered for processing.
279
+ RE_ENTER_TRANSACTION: :re_enter_transaction
280
+
281
+ # There is no credit account associated with the card.
282
+ NO_CREDIT_ACCOUNT: :no_credit_account
283
+
284
+ # The card should be retained by the terminal because it has been reported lost.
285
+ PICK_UP_CARD_LOST: :pick_up_card_lost
286
+
287
+ # The card should be retained by the terminal because it has been reported stolen.
288
+ PICK_UP_CARD_STOLEN: :pick_up_card_stolen
289
+
290
+ # The account associated with the card has been closed.
291
+ CLOSED_ACCOUNT: :closed_account
292
+
293
+ # There are insufficient funds in the account to complete the transaction.
294
+ INSUFFICIENT_FUNDS: :insufficient_funds
295
+
296
+ # There is no checking account associated with the card.
297
+ NO_CHECKING_ACCOUNT: :no_checking_account
298
+
299
+ # There is no savings account associated with the card.
300
+ NO_SAVINGS_ACCOUNT: :no_savings_account
301
+
302
+ # The card has expired and cannot be used for transactions.
303
+ EXPIRED_CARD: :expired_card
304
+
305
+ # The transaction is not permitted for this cardholder.
306
+ TRANSACTION_NOT_PERMITTED_TO_CARDHOLDER: :transaction_not_permitted_to_cardholder
307
+
308
+ # The transaction is not allowed at this terminal.
309
+ TRANSACTION_NOT_ALLOWED_AT_TERMINAL: :transaction_not_allowed_at_terminal
310
+
311
+ # The transaction has been flagged as suspected fraud and cannot be processed.
312
+ SUSPECTED_FRAUD: :suspected_fraud
313
+
314
+ # The amount of activity on the card has exceeded the limit set by the issuer.
315
+ ACTIVITY_AMOUNT_LIMIT_EXCEEDED: :activity_amount_limit_exceeded
316
+
317
+ # The card has restrictions that prevent it from being used for this transaction.
318
+ RESTRICTED_CARD: :restricted_card
319
+
320
+ # A security violation has occurred, preventing the transaction from being processed.
321
+ SECURITY_VIOLATION: :security_violation
322
+
323
+ # The transaction does not meet the anti-money laundering requirements set by the issuer.
324
+ TRANSACTION_DOES_NOT_FULFILL_ANTI_MONEY_LAUNDERING_REQUIREMENT: :transaction_does_not_fulfill_anti_money_laundering_requirement
325
+
326
+ # The first use of the card has been blocked by the issuer.
327
+ BLOCKED_FIRST_USE: :blocked_first_use
328
+
329
+ # The credit issuer is currently unavailable to process the transaction.
330
+ CREDIT_ISSUER_UNAVAILABLE: :credit_issuer_unavailable
331
+
332
+ # The card verification value (CVV) results were negative, indicating a potential issue with the card.
333
+ NEGATIVE_CARD_VERIFICATION_VALUE_RESULTS: :negative_card_verification_value_results
334
+
335
+ # The issuer of the card is currently unavailable to process the transaction.
336
+ ISSUER_UNAVAILABLE: :issuer_unavailable
337
+
338
+ # The financial institution associated with the card could not be found.
339
+ FINANCIAL_INSTITUTION_CANNOT_BE_FOUND: :financial_institution_cannot_be_found
340
+
341
+ # The transaction cannot be completed due to an unspecified reason.
342
+ TRANSACTION_CANNOT_BE_COMPLETED: :transaction_cannot_be_completed
343
+
344
+ # The transaction is a duplicate of a previous transaction and cannot be processed again.
345
+ DUPLICATE_TRANSACTION: :duplicate_transaction
346
+
347
+ # A system malfunction occurred, preventing the transaction from being processed.
348
+ SYSTEM_MALFUNCTION: :system_malfunction
349
+
350
+ # Additional customer authentication is required to complete the transaction.
351
+ ADDITIONAL_CUSTOMER_AUTHENTICATION_REQUIRED: :additional_customer_authentication_required
352
+
353
+ # The surcharge amount applied to the transaction is not permitted by the issuer.
354
+ SURCHARGE_AMOUNT_NOT_PERMITTED: :surcharge_amount_not_permitted
355
+
356
+ # The transaction was declined due to a failure in verifying the CVV2 code.
357
+ DECLINE_FOR_CVV2_FAILURE: :decline_for_cvv2_failure
358
+
359
+ # A stop payment order has been placed on this transaction.
360
+ STOP_PAYMENT_ORDER: :stop_payment_order
361
+
362
+ # An order has been placed to revoke authorization for this transaction.
363
+ REVOCATION_OF_AUTHORIZATION_ORDER: :revocation_of_authorization_order
364
+
365
+ # An order has been placed to revoke all authorizations for this cardholder.
366
+ REVOCATION_OF_ALL_AUTHORIZATIONS_ORDER: :revocation_of_all_authorizations_order
367
+
368
+ def self?.values: -> ::Array[Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::reason]
369
+ end
370
+ end
371
+ end
126
372
  end
127
373
  end
128
374
  end
@@ -63,6 +63,10 @@ module Increase
63
63
 
64
64
  class BalanceLookup = Increase::Models::BalanceLookup
65
65
 
66
+ class BeneficialOwnerListParams = Increase::Models::BeneficialOwnerListParams
67
+
68
+ class BeneficialOwnerRetrieveParams = Increase::Models::BeneficialOwnerRetrieveParams
69
+
66
70
  class BookkeepingAccount = Increase::Models::BookkeepingAccount
67
71
 
68
72
  class BookkeepingAccountBalanceParams = Increase::Models::BookkeepingAccountBalanceParams
@@ -215,6 +219,8 @@ module Increase
215
219
 
216
220
  class EntityArchiveParams = Increase::Models::EntityArchiveParams
217
221
 
222
+ class EntityBeneficialOwner = Increase::Models::EntityBeneficialOwner
223
+
218
224
  class EntityCreateBeneficialOwnerParams = Increase::Models::EntityCreateBeneficialOwnerParams
219
225
 
220
226
  class EntityCreateParams = Increase::Models::EntityCreateParams
@@ -0,0 +1,20 @@
1
+ module Increase
2
+ module Resources
3
+ class BeneficialOwners
4
+ def retrieve: (
5
+ String entity_beneficial_owner_id,
6
+ ?request_options: Increase::request_opts
7
+ ) -> Increase::EntityBeneficialOwner
8
+
9
+ def list: (
10
+ entity_id: String,
11
+ ?cursor: String,
12
+ ?idempotency_key: String,
13
+ ?limit: Integer,
14
+ ?request_options: Increase::request_opts
15
+ ) -> Increase::Internal::Page[Increase::EntityBeneficialOwner]
16
+
17
+ def initialize: (client: Increase::Client) -> void
18
+ end
19
+ end
20
+ end
@@ -6,6 +6,7 @@ module Increase
6
6
  ?capabilities: ::Array[Increase::Simulations::CardTokenCreateParams::Capability],
7
7
  ?expiration: Date,
8
8
  ?last4: String,
9
+ ?outcome: Increase::Simulations::CardTokenCreateParams::Outcome,
9
10
  ?prefix: String,
10
11
  ?primary_account_number_length: Integer,
11
12
  ?request_options: Increase::request_opts
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.238.0
4
+ version: 1.240.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-03-09 00:00:00.000000000 Z
11
+ date: 2026-03-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi
@@ -102,6 +102,8 @@ files:
102
102
  - lib/increase/models/ach_transfer_list_params.rb
103
103
  - lib/increase/models/ach_transfer_retrieve_params.rb
104
104
  - lib/increase/models/balance_lookup.rb
105
+ - lib/increase/models/beneficial_owner_list_params.rb
106
+ - lib/increase/models/beneficial_owner_retrieve_params.rb
105
107
  - lib/increase/models/bookkeeping_account.rb
106
108
  - lib/increase/models/bookkeeping_account_balance_params.rb
107
109
  - lib/increase/models/bookkeeping_account_create_params.rb
@@ -178,6 +180,7 @@ files:
178
180
  - lib/increase/models/entity.rb
179
181
  - lib/increase/models/entity_archive_beneficial_owner_params.rb
180
182
  - lib/increase/models/entity_archive_params.rb
183
+ - lib/increase/models/entity_beneficial_owner.rb
181
184
  - lib/increase/models/entity_create_beneficial_owner_params.rb
182
185
  - lib/increase/models/entity_create_params.rb
183
186
  - lib/increase/models/entity_list_params.rb
@@ -376,6 +379,7 @@ files:
376
379
  - lib/increase/resources/accounts.rb
377
380
  - lib/increase/resources/ach_prenotifications.rb
378
381
  - lib/increase/resources/ach_transfers.rb
382
+ - lib/increase/resources/beneficial_owners.rb
379
383
  - lib/increase/resources/bookkeeping_accounts.rb
380
384
  - lib/increase/resources/bookkeeping_entries.rb
381
385
  - lib/increase/resources/bookkeeping_entry_sets.rb
@@ -513,6 +517,8 @@ files:
513
517
  - rbi/increase/models/ach_transfer_list_params.rbi
514
518
  - rbi/increase/models/ach_transfer_retrieve_params.rbi
515
519
  - rbi/increase/models/balance_lookup.rbi
520
+ - rbi/increase/models/beneficial_owner_list_params.rbi
521
+ - rbi/increase/models/beneficial_owner_retrieve_params.rbi
516
522
  - rbi/increase/models/bookkeeping_account.rbi
517
523
  - rbi/increase/models/bookkeeping_account_balance_params.rbi
518
524
  - rbi/increase/models/bookkeeping_account_create_params.rbi
@@ -589,6 +595,7 @@ files:
589
595
  - rbi/increase/models/entity.rbi
590
596
  - rbi/increase/models/entity_archive_beneficial_owner_params.rbi
591
597
  - rbi/increase/models/entity_archive_params.rbi
598
+ - rbi/increase/models/entity_beneficial_owner.rbi
592
599
  - rbi/increase/models/entity_create_beneficial_owner_params.rbi
593
600
  - rbi/increase/models/entity_create_params.rbi
594
601
  - rbi/increase/models/entity_list_params.rbi
@@ -787,6 +794,7 @@ files:
787
794
  - rbi/increase/resources/accounts.rbi
788
795
  - rbi/increase/resources/ach_prenotifications.rbi
789
796
  - rbi/increase/resources/ach_transfers.rbi
797
+ - rbi/increase/resources/beneficial_owners.rbi
790
798
  - rbi/increase/resources/bookkeeping_accounts.rbi
791
799
  - rbi/increase/resources/bookkeeping_entries.rbi
792
800
  - rbi/increase/resources/bookkeeping_entry_sets.rbi
@@ -923,6 +931,8 @@ files:
923
931
  - sig/increase/models/ach_transfer_list_params.rbs
924
932
  - sig/increase/models/ach_transfer_retrieve_params.rbs
925
933
  - sig/increase/models/balance_lookup.rbs
934
+ - sig/increase/models/beneficial_owner_list_params.rbs
935
+ - sig/increase/models/beneficial_owner_retrieve_params.rbs
926
936
  - sig/increase/models/bookkeeping_account.rbs
927
937
  - sig/increase/models/bookkeeping_account_balance_params.rbs
928
938
  - sig/increase/models/bookkeeping_account_create_params.rbs
@@ -999,6 +1009,7 @@ files:
999
1009
  - sig/increase/models/entity.rbs
1000
1010
  - sig/increase/models/entity_archive_beneficial_owner_params.rbs
1001
1011
  - sig/increase/models/entity_archive_params.rbs
1012
+ - sig/increase/models/entity_beneficial_owner.rbs
1002
1013
  - sig/increase/models/entity_create_beneficial_owner_params.rbs
1003
1014
  - sig/increase/models/entity_create_params.rbs
1004
1015
  - sig/increase/models/entity_list_params.rbs
@@ -1197,6 +1208,7 @@ files:
1197
1208
  - sig/increase/resources/accounts.rbs
1198
1209
  - sig/increase/resources/ach_prenotifications.rbs
1199
1210
  - sig/increase/resources/ach_transfers.rbs
1211
+ - sig/increase/resources/beneficial_owners.rbs
1200
1212
  - sig/increase/resources/bookkeeping_accounts.rbs
1201
1213
  - sig/increase/resources/bookkeeping_entries.rbs
1202
1214
  - sig/increase/resources/bookkeeping_entry_sets.rbs