increase 1.334.1 → 1.336.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 (52) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +23 -1
  4. data/lib/increase/models/ach_prenotification.rb +3 -3
  5. data/lib/increase/models/ach_transfer.rb +3 -0
  6. data/lib/increase/models/ach_transfer_create_params.rb +3 -0
  7. data/lib/increase/models/balance_lookup.rb +31 -1
  8. data/lib/increase/models/card_payment.rb +9 -0
  9. data/lib/increase/models/declined_transaction.rb +3 -0
  10. data/lib/increase/models/event.rb +6 -0
  11. data/lib/increase/models/event_list_params.rb +6 -0
  12. data/lib/increase/models/event_subscription.rb +6 -3
  13. data/lib/increase/models/event_subscription_create_params.rb +6 -0
  14. data/lib/increase/models/pending_transaction.rb +3 -0
  15. data/lib/increase/models/real_time_decision.rb +3 -0
  16. data/lib/increase/models/simulations/card_authorization_create_params.rb +3 -0
  17. data/lib/increase/models/transaction.rb +6 -3
  18. data/lib/increase/models/unwrap_webhook_event.rb +6 -0
  19. data/lib/increase/resources/events.rb +4 -1
  20. data/lib/increase/version.rb +1 -1
  21. data/rbi/increase/models/ach_prenotification.rbi +7 -7
  22. data/rbi/increase/models/ach_transfer.rbi +3 -0
  23. data/rbi/increase/models/ach_transfer_create_params.rbi +4 -0
  24. data/rbi/increase/models/balance_lookup.rbi +61 -3
  25. data/rbi/increase/models/card_payment.rbi +21 -0
  26. data/rbi/increase/models/declined_transaction.rbi +7 -0
  27. data/rbi/increase/models/event.rbi +14 -0
  28. data/rbi/increase/models/event_list_params.rbi +14 -0
  29. data/rbi/increase/models/event_subscription.rbi +14 -7
  30. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  31. data/rbi/increase/models/pending_transaction.rbi +7 -0
  32. data/rbi/increase/models/real_time_decision.rbi +7 -0
  33. data/rbi/increase/models/simulations/card_authorization_create_params.rbi +7 -0
  34. data/rbi/increase/models/transaction.rbi +11 -4
  35. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  36. data/rbi/increase/resources/events.rbi +4 -1
  37. data/sig/increase/models/ach_prenotification.rbs +4 -4
  38. data/sig/increase/models/ach_transfer.rbs +4 -1
  39. data/sig/increase/models/ach_transfer_create_params.rbs +4 -1
  40. data/sig/increase/models/balance_lookup.rbs +31 -3
  41. data/sig/increase/models/card_payment.rbs +12 -0
  42. data/sig/increase/models/declined_transaction.rbs +4 -0
  43. data/sig/increase/models/event.rbs +8 -0
  44. data/sig/increase/models/event_list_params.rbs +8 -0
  45. data/sig/increase/models/event_subscription.rbs +9 -4
  46. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  47. data/sig/increase/models/pending_transaction.rbs +4 -0
  48. data/sig/increase/models/real_time_decision.rbs +4 -0
  49. data/sig/increase/models/simulations/card_authorization_create_params.rbs +4 -0
  50. data/sig/increase/models/transaction.rbs +4 -0
  51. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  52. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '0738f1e265f44f1c43532a9288011e11f1b5b35d5e14a1ac3c3a81706c68bc04'
4
- data.tar.gz: 0ba828fc5f2308ad42d2337aefb8477c034de046c3e6b6ffe82acd4a9a336f9e
3
+ metadata.gz: 2ee3a925a5b2860ea0a38a1d0c5cf26596a5085f7d9768edc84e5db058d9cd06
4
+ data.tar.gz: ec7861b5961a85f92013839e29c4223aa95f64a7c5d74e0f907c85da1c3bd858
5
5
  SHA512:
6
- metadata.gz: cb648f0381adf986a15d643787b2ce9ff4d4918e61fa0cf09fee56009189eab2fc30d5e44ddab96b61c0d12bbdadd39a622048600cb0a0ba8912693367afd63b
7
- data.tar.gz: 5442f39859c698039a9b07079e19982f970f6898d051bd54def2c5ee1c064dfa439aee520f508dd9621a2123030fdbab7f2c4e8823b0386fc866a6c5f39e8af8
6
+ metadata.gz: 52e0f7ac349a714518927389a7292215cd49c2827f76a36b8c940a63905f72ab6b2fa8dc76000fe9058560982101eee460d4078c5c3ccc5e782c70da55009ddc
7
+ data.tar.gz: cb4f9dcf606021d9425cfe4cfb9b3028044aaa58eda8d9f83c6e55f439a87e39879fb6bf185b879ce525b2bc4ceed89131e9f25f8ff85824fbc37cc68e19b73d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.336.0](https://github.com/Increase/increase-ruby/compare/v1.335.0...v1.336.0) (2026-06-18)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** api update ([#455](https://github.com/Increase/increase-ruby/issues/455)) ([31c679b](https://github.com/Increase/increase-ruby/commit/31c679bc21197a84a1f773b8d1a4f00cb0c7a07a))
9
+
10
+ ## [1.335.0](https://github.com/Increase/increase-ruby/compare/v1.334.1...v1.335.0) (2026-06-17)
11
+
12
+
13
+ ### Features
14
+
15
+ * **api:** api update ([#451](https://github.com/Increase/increase-ruby/issues/451)) ([b0ece67](https://github.com/Increase/increase-ruby/commit/b0ece6779717f29245e8f50b1a6d3122b29bf48f))
16
+
3
17
  ## [1.334.1](https://github.com/Increase/increase-ruby/compare/v1.334.0...v1.334.1) (2026-06-12)
4
18
 
5
19
 
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.334.1"
18
+ gem "increase", "~> 1.336.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -39,6 +39,9 @@ account = increase.accounts.create(
39
39
  puts(account.id)
40
40
  ```
41
41
 
42
+ > [!IMPORTANT]
43
+ > Fields whose names collide with Ruby keywords are suffixed with an underscore. For example, the `return` field on an ACH Transfer is exposed as `transfer.return_`, and the return simulation is `client.simulations.ach_transfers.return_`.
44
+
42
45
  ### Pagination
43
46
 
44
47
  List methods in the Increase API are paginated.
@@ -67,6 +70,8 @@ if page.next_page?
67
70
  end
68
71
  ```
69
72
 
73
+ Note that page objects are not `Enumerable` — access the current page's items with `#data`, or iterate across pages with `#auto_paging_each` as above.
74
+
70
75
  ### File uploads
71
76
 
72
77
  Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
@@ -89,6 +94,21 @@ puts(file.id)
89
94
 
90
95
  Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
91
96
 
97
+ ### Webhook verification
98
+
99
+ This library includes a helper for verifying webhook signatures. Construct the client with your `webhook_secret` (read from `ENV["INCREASE_WEBHOOK_SECRET"]` by default), then pass the raw request body and headers to `events.unwrap`, which verifies the signature and parses the payload:
100
+
101
+ ```ruby
102
+ increase = Increase::Client.new(
103
+ webhook_secret: ENV["INCREASE_WEBHOOK_SECRET"] # This is the default and can be omitted
104
+ )
105
+
106
+ # In your webhook handler, e.g. a Rails controller action:
107
+ event = increase.events.unwrap(request.body.read, headers: request.headers.to_h)
108
+ ```
109
+
110
+ `StandardWebhooks::WebhookVerificationError` is raised if the signature is invalid, so a webhook that unwraps without raising is guaranteed authentic. Note that the secret is Base64-encoded before being passed to `StandardWebhooks::Webhook` — to sign a synthetic payload in tests, construct the signer the same way: `StandardWebhooks::Webhook.new(Base64.strict_encode64(secret))`.
111
+
92
112
  ### Handling errors
93
113
 
94
114
  When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Increase::Errors::APIError` will be thrown:
@@ -122,6 +142,8 @@ Error codes are as follows:
122
142
  | Timeout | `APITimeoutError` |
123
143
  | Network error | `APIConnectionError` |
124
144
 
145
+ All errors raised by this gem, including `Increase::Errors::APIError` and response-parsing errors like `Increase::Errors::ConversionError`, inherit from `Increase::Errors::Error`, which you can rescue to catch anything the gem raises.
146
+
125
147
  ### Retries
126
148
 
127
149
  Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
@@ -639,15 +639,15 @@ module Increase
639
639
  # The Prenotification is pending submission.
640
640
  PENDING_SUBMITTING = :pending_submitting
641
641
 
642
- # The Prenotification requires attention.
643
- REQUIRES_ATTENTION = :requires_attention
644
-
645
642
  # The Prenotification has been returned.
646
643
  RETURNED = :returned
647
644
 
648
645
  # The Prenotification is complete.
649
646
  SUBMITTED = :submitted
650
647
 
648
+ # The Prenotification requires attention.
649
+ REQUIRES_ATTENTION = :requires_attention
650
+
651
651
  # @!method self.values
652
652
  # @return [Array<Symbol>]
653
653
  end
@@ -672,6 +672,9 @@ module Increase
672
672
  # A savings account.
673
673
  SAVINGS = :savings
674
674
 
675
+ # A loan account used in a lender-borrower relationship. Uncommon.
676
+ LOAN = :loan
677
+
675
678
  # A bank's general ledger. Uncommon.
676
679
  GENERAL_LEDGER = :general_ledger
677
680
 
@@ -343,6 +343,9 @@ module Increase
343
343
  # A savings account.
344
344
  SAVINGS = :savings
345
345
 
346
+ # A loan account used in a lender-borrower relationship. Uncommon.
347
+ LOAN = :loan
348
+
346
349
  # A bank's general ledger. Uncommon.
347
350
  GENERAL_LEDGER = :general_ledger
348
351
 
@@ -75,7 +75,13 @@ module Increase
75
75
  # @return [Integer]
76
76
  required :past_due_balance, Integer
77
77
 
78
- # @!method initialize(due_at:, due_balance:, past_due_balance:)
78
+ # @!attribute receivables
79
+ # The receivables balances for the loan.
80
+ #
81
+ # @return [Increase::Models::BalanceLookup::Loan::Receivables, nil]
82
+ required :receivables, -> { Increase::BalanceLookup::Loan::Receivables }, nil?: true
83
+
84
+ # @!method initialize(due_at:, due_balance:, past_due_balance:, receivables:)
79
85
  # Some parameter documentations has been truncated, see
80
86
  # {Increase::Models::BalanceLookup::Loan} for more details.
81
87
  #
@@ -86,6 +92,30 @@ module Increase
86
92
  # @param due_balance [Integer] The total amount due on the loan.
87
93
  #
88
94
  # @param past_due_balance [Integer] The amount past due on the loan.
95
+ #
96
+ # @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil] The receivables balances for the loan.
97
+
98
+ # @see Increase::Models::BalanceLookup::Loan#receivables
99
+ class Receivables < Increase::Internal::Type::BaseModel
100
+ # @!attribute purchasable_balance
101
+ # The balance of seasoned receivables available to be purchased.
102
+ #
103
+ # @return [Integer]
104
+ required :purchasable_balance, Integer
105
+
106
+ # @!attribute purchased_balance
107
+ # The balance of receivables that have been purchased.
108
+ #
109
+ # @return [Integer]
110
+ required :purchased_balance, Integer
111
+
112
+ # @!method initialize(purchasable_balance:, purchased_balance:)
113
+ # The receivables balances for the loan.
114
+ #
115
+ # @param purchasable_balance [Integer] The balance of seasoned receivables available to be purchased.
116
+ #
117
+ # @param purchased_balance [Integer] The balance of receivables that have been purchased.
118
+ end
89
119
  end
90
120
 
91
121
  # A constant representing the object's type. For this resource it will always be
@@ -2400,6 +2400,9 @@ module Increase
2400
2400
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
2401
2401
  CASH_DISBURSEMENT = :cash_disbursement
2402
2402
 
2403
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
2404
+ CASH_DEPOSIT = :cash_deposit
2405
+
2403
2406
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
2404
2407
  BALANCE_INQUIRY = :balance_inquiry
2405
2408
 
@@ -5294,6 +5297,9 @@ module Increase
5294
5297
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
5295
5298
  CASH_DISBURSEMENT = :cash_disbursement
5296
5299
 
5300
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
5301
+ CASH_DEPOSIT = :cash_deposit
5302
+
5297
5303
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
5298
5304
  BALANCE_INQUIRY = :balance_inquiry
5299
5305
 
@@ -6832,6 +6838,9 @@ module Increase
6832
6838
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
6833
6839
  CASH_DISBURSEMENT = :cash_disbursement
6834
6840
 
6841
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
6842
+ CASH_DEPOSIT = :cash_deposit
6843
+
6835
6844
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
6836
6845
  BALANCE_INQUIRY = :balance_inquiry
6837
6846
 
@@ -1541,6 +1541,9 @@ module Increase
1541
1541
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
1542
1542
  CASH_DISBURSEMENT = :cash_disbursement
1543
1543
 
1544
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
1545
+ CASH_DEPOSIT = :cash_deposit
1546
+
1544
1547
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
1545
1548
  BALANCE_INQUIRY = :balance_inquiry
1546
1549
 
@@ -286,12 +286,18 @@ module Increase
286
286
  # Occurs whenever a Loan Application is updated.
287
287
  LOAN_APPLICATION_UPDATED = :"loan_application.updated"
288
288
 
289
+ # Occurs whenever a Loan Distribution is created.
290
+ LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
291
+
289
292
  # Occurs whenever a Loan Offer is created.
290
293
  LOAN_OFFER_CREATED = :"loan_offer.created"
291
294
 
292
295
  # Occurs whenever a Loan Offer is updated.
293
296
  LOAN_OFFER_UPDATED = :"loan_offer.updated"
294
297
 
298
+ # Occurs whenever a Loan Purchase is created.
299
+ LOAN_PURCHASE_CREATED = :"loan_purchase.created"
300
+
295
301
  # Occurs whenever a Lockbox is created.
296
302
  LOCKBOX_CREATED = :"lockbox.created"
297
303
 
@@ -295,12 +295,18 @@ module Increase
295
295
  # Occurs whenever a Loan Application is updated.
296
296
  LOAN_APPLICATION_UPDATED = :"loan_application.updated"
297
297
 
298
+ # Occurs whenever a Loan Distribution is created.
299
+ LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
300
+
298
301
  # Occurs whenever a Loan Offer is created.
299
302
  LOAN_OFFER_CREATED = :"loan_offer.created"
300
303
 
301
304
  # Occurs whenever a Loan Offer is updated.
302
305
  LOAN_OFFER_UPDATED = :"loan_offer.updated"
303
306
 
307
+ # Occurs whenever a Loan Purchase is created.
308
+ LOAN_PURCHASE_CREATED = :"loan_purchase.created"
309
+
304
310
  # Occurs whenever a Lockbox is created.
305
311
  LOCKBOX_CREATED = :"lockbox.created"
306
312
 
@@ -320,12 +320,18 @@ module Increase
320
320
  # Occurs whenever a Loan Application is updated.
321
321
  LOAN_APPLICATION_UPDATED = :"loan_application.updated"
322
322
 
323
+ # Occurs whenever a Loan Distribution is created.
324
+ LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
325
+
323
326
  # Occurs whenever a Loan Offer is created.
324
327
  LOAN_OFFER_CREATED = :"loan_offer.created"
325
328
 
326
329
  # Occurs whenever a Loan Offer is updated.
327
330
  LOAN_OFFER_UPDATED = :"loan_offer.updated"
328
331
 
332
+ # Occurs whenever a Loan Purchase is created.
333
+ LOAN_PURCHASE_CREATED = :"loan_purchase.created"
334
+
329
335
  # Occurs whenever a Lockbox is created.
330
336
  LOCKBOX_CREATED = :"lockbox.created"
331
337
 
@@ -459,9 +465,6 @@ module Increase
459
465
  # The subscription is permanently disabled and Events will not be delivered.
460
466
  DELETED = :deleted
461
467
 
462
- # The subscription is temporarily disabled due to delivery errors and Events will not be delivered.
463
- REQUIRES_ATTENTION = :requires_attention
464
-
465
468
  # @!method self.values
466
469
  # @return [Array<Symbol>]
467
470
  end
@@ -291,12 +291,18 @@ module Increase
291
291
  # Occurs whenever a Loan Application is updated.
292
292
  LOAN_APPLICATION_UPDATED = :"loan_application.updated"
293
293
 
294
+ # Occurs whenever a Loan Distribution is created.
295
+ LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
296
+
294
297
  # Occurs whenever a Loan Offer is created.
295
298
  LOAN_OFFER_CREATED = :"loan_offer.created"
296
299
 
297
300
  # Occurs whenever a Loan Offer is updated.
298
301
  LOAN_OFFER_UPDATED = :"loan_offer.updated"
299
302
 
303
+ # Occurs whenever a Loan Purchase is created.
304
+ LOAN_PURCHASE_CREATED = :"loan_purchase.created"
305
+
300
306
  # Occurs whenever a Lockbox is created.
301
307
  LOCKBOX_CREATED = :"lockbox.created"
302
308
 
@@ -1828,6 +1828,9 @@ module Increase
1828
1828
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
1829
1829
  CASH_DISBURSEMENT = :cash_disbursement
1830
1830
 
1831
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
1832
+ CASH_DEPOSIT = :cash_deposit
1833
+
1831
1834
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
1832
1835
  BALANCE_INQUIRY = :balance_inquiry
1833
1836
 
@@ -2095,6 +2095,9 @@ module Increase
2095
2095
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
2096
2096
  CASH_DISBURSEMENT = :cash_disbursement
2097
2097
 
2098
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
2099
+ CASH_DEPOSIT = :cash_deposit
2100
+
2098
2101
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
2099
2102
  BALANCE_INQUIRY = :balance_inquiry
2100
2103
 
@@ -355,6 +355,9 @@ module Increase
355
355
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
356
356
  CASH_DISBURSEMENT = :cash_disbursement
357
357
 
358
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
359
+ CASH_DEPOSIT = :cash_deposit
360
+
358
361
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
359
362
  BALANCE_INQUIRY = :balance_inquiry
360
363
 
@@ -24,8 +24,8 @@ module Increase
24
24
  required :amount, Integer
25
25
 
26
26
  # @!attribute created_at
27
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
28
- # Transaction occurred.
27
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
28
+ # the Transaction occurred.
29
29
  #
30
30
  # @return [Time]
31
31
  required :created_at, Time
@@ -89,7 +89,7 @@ module Increase
89
89
  #
90
90
  # @param amount [Integer] The Transaction amount in the minor unit of its currency. For dollars, for examp
91
91
  #
92
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transac
92
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
93
93
  #
94
94
  # @param currency [Symbol, Increase::Models::Transaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction'
95
95
  #
@@ -2523,6 +2523,9 @@ module Increase
2523
2523
  # Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale.
2524
2524
  CASH_DISBURSEMENT = :cash_disbursement
2525
2525
 
2526
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
2527
+ CASH_DEPOSIT = :cash_deposit
2528
+
2526
2529
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
2527
2530
  BALANCE_INQUIRY = :balance_inquiry
2528
2531
 
@@ -285,12 +285,18 @@ module Increase
285
285
  # Occurs whenever a Loan Application is updated.
286
286
  LOAN_APPLICATION_UPDATED = :"loan_application.updated"
287
287
 
288
+ # Occurs whenever a Loan Distribution is created.
289
+ LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
290
+
288
291
  # Occurs whenever a Loan Offer is created.
289
292
  LOAN_OFFER_CREATED = :"loan_offer.created"
290
293
 
291
294
  # Occurs whenever a Loan Offer is updated.
292
295
  LOAN_OFFER_UPDATED = :"loan_offer.updated"
293
296
 
297
+ # Occurs whenever a Loan Purchase is created.
298
+ LOAN_PURCHASE_CREATED = :"loan_purchase.created"
299
+
294
300
  # Occurs whenever a Lockbox is created.
295
301
  LOCKBOX_CREATED = :"lockbox.created"
296
302
 
@@ -64,7 +64,10 @@ module Increase
64
64
  #
65
65
  # @param headers [Hash{String=>String}] The raw HTTP headers that came with the payload
66
66
  #
67
- # @param key [String, nil] The webhook signing key
67
+ # @param key [String, nil] The webhook signing key, as the raw secret string. It is Base64-encoded before
68
+ # being passed to StandardWebhooks, so to sign a synthetic payload in tests,
69
+ # construct the signer the same way:
70
+ # StandardWebhooks::Webhook.new(Base64.strict_encode64(key))
68
71
  #
69
72
  # @return [Increase::Models::UnwrapWebhookEvent]
70
73
  def unwrap(payload, headers:, key: @client.webhook_secret)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.334.1"
4
+ VERSION = "1.336.0"
5
5
  end
@@ -1226,13 +1226,6 @@ module Increase
1226
1226
  Increase::ACHPrenotification::Status::TaggedSymbol
1227
1227
  )
1228
1228
 
1229
- # The Prenotification requires attention.
1230
- REQUIRES_ATTENTION =
1231
- T.let(
1232
- :requires_attention,
1233
- Increase::ACHPrenotification::Status::TaggedSymbol
1234
- )
1235
-
1236
1229
  # The Prenotification has been returned.
1237
1230
  RETURNED =
1238
1231
  T.let(:returned, Increase::ACHPrenotification::Status::TaggedSymbol)
@@ -1241,6 +1234,13 @@ module Increase
1241
1234
  SUBMITTED =
1242
1235
  T.let(:submitted, Increase::ACHPrenotification::Status::TaggedSymbol)
1243
1236
 
1237
+ # The Prenotification requires attention.
1238
+ REQUIRES_ATTENTION =
1239
+ T.let(
1240
+ :requires_attention,
1241
+ Increase::ACHPrenotification::Status::TaggedSymbol
1242
+ )
1243
+
1244
1244
  sig do
1245
1245
  override.returns(
1246
1246
  T::Array[Increase::ACHPrenotification::Status::TaggedSymbol]
@@ -1146,6 +1146,9 @@ module Increase
1146
1146
  # A savings account.
1147
1147
  SAVINGS = T.let(:savings, Increase::ACHTransfer::Funding::TaggedSymbol)
1148
1148
 
1149
+ # A loan account used in a lender-borrower relationship. Uncommon.
1150
+ LOAN = T.let(:loan, Increase::ACHTransfer::Funding::TaggedSymbol)
1151
+
1149
1152
  # A bank's general ledger. Uncommon.
1150
1153
  GENERAL_LEDGER =
1151
1154
  T.let(:general_ledger, Increase::ACHTransfer::Funding::TaggedSymbol)
@@ -706,6 +706,10 @@ module Increase
706
706
  Increase::ACHTransferCreateParams::Funding::TaggedSymbol
707
707
  )
708
708
 
709
+ # A loan account used in a lender-borrower relationship. Uncommon.
710
+ LOAN =
711
+ T.let(:loan, Increase::ACHTransferCreateParams::Funding::TaggedSymbol)
712
+
709
713
  # A bank's general ledger. Uncommon.
710
714
  GENERAL_LEDGER =
711
715
  T.let(
@@ -97,12 +97,26 @@ module Increase
97
97
  sig { returns(Integer) }
98
98
  attr_accessor :past_due_balance
99
99
 
100
+ # The receivables balances for the loan.
101
+ sig { returns(T.nilable(Increase::BalanceLookup::Loan::Receivables)) }
102
+ attr_reader :receivables
103
+
104
+ sig do
105
+ params(
106
+ receivables:
107
+ T.nilable(Increase::BalanceLookup::Loan::Receivables::OrHash)
108
+ ).void
109
+ end
110
+ attr_writer :receivables
111
+
100
112
  # The loan balances for the Account.
101
113
  sig do
102
114
  params(
103
115
  due_at: T.nilable(Time),
104
116
  due_balance: Integer,
105
- past_due_balance: Integer
117
+ past_due_balance: Integer,
118
+ receivables:
119
+ T.nilable(Increase::BalanceLookup::Loan::Receivables::OrHash)
106
120
  ).returns(T.attached_class)
107
121
  end
108
122
  def self.new(
@@ -112,7 +126,9 @@ module Increase
112
126
  # The total amount due on the loan.
113
127
  due_balance:,
114
128
  # The amount past due on the loan.
115
- past_due_balance:
129
+ past_due_balance:,
130
+ # The receivables balances for the loan.
131
+ receivables:
116
132
  )
117
133
  end
118
134
 
@@ -121,12 +137,54 @@ module Increase
121
137
  {
122
138
  due_at: T.nilable(Time),
123
139
  due_balance: Integer,
124
- past_due_balance: Integer
140
+ past_due_balance: Integer,
141
+ receivables: T.nilable(Increase::BalanceLookup::Loan::Receivables)
125
142
  }
126
143
  )
127
144
  end
128
145
  def to_hash
129
146
  end
147
+
148
+ class Receivables < Increase::Internal::Type::BaseModel
149
+ OrHash =
150
+ T.type_alias do
151
+ T.any(
152
+ Increase::BalanceLookup::Loan::Receivables,
153
+ Increase::Internal::AnyHash
154
+ )
155
+ end
156
+
157
+ # The balance of seasoned receivables available to be purchased.
158
+ sig { returns(Integer) }
159
+ attr_accessor :purchasable_balance
160
+
161
+ # The balance of receivables that have been purchased.
162
+ sig { returns(Integer) }
163
+ attr_accessor :purchased_balance
164
+
165
+ # The receivables balances for the loan.
166
+ sig do
167
+ params(
168
+ purchasable_balance: Integer,
169
+ purchased_balance: Integer
170
+ ).returns(T.attached_class)
171
+ end
172
+ def self.new(
173
+ # The balance of seasoned receivables available to be purchased.
174
+ purchasable_balance:,
175
+ # The balance of receivables that have been purchased.
176
+ purchased_balance:
177
+ )
178
+ end
179
+
180
+ sig do
181
+ override.returns(
182
+ { purchasable_balance: Integer, purchased_balance: Integer }
183
+ )
184
+ end
185
+ def to_hash
186
+ end
187
+ end
130
188
  end
131
189
 
132
190
  # A constant representing the object's type. For this resource it will always be
@@ -4570,6 +4570,13 @@ module Increase
4570
4570
  Increase::CardPayment::Element::CardAuthorization::ProcessingCategory::TaggedSymbol
4571
4571
  )
4572
4572
 
4573
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
4574
+ CASH_DEPOSIT =
4575
+ T.let(
4576
+ :cash_deposit,
4577
+ Increase::CardPayment::Element::CardAuthorization::ProcessingCategory::TaggedSymbol
4578
+ )
4579
+
4573
4580
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
4574
4581
  BALANCE_INQUIRY =
4575
4582
  T.let(
@@ -10183,6 +10190,13 @@ module Increase
10183
10190
  Increase::CardPayment::Element::CardDecline::ProcessingCategory::TaggedSymbol
10184
10191
  )
10185
10192
 
10193
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
10194
+ CASH_DEPOSIT =
10195
+ T.let(
10196
+ :cash_deposit,
10197
+ Increase::CardPayment::Element::CardDecline::ProcessingCategory::TaggedSymbol
10198
+ )
10199
+
10186
10200
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
10187
10201
  BALANCE_INQUIRY =
10188
10202
  T.let(
@@ -13207,6 +13221,13 @@ module Increase
13207
13221
  Increase::CardPayment::Element::CardFinancial::ProcessingCategory::TaggedSymbol
13208
13222
  )
13209
13223
 
13224
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
13225
+ CASH_DEPOSIT =
13226
+ T.let(
13227
+ :cash_deposit,
13228
+ Increase::CardPayment::Element::CardFinancial::ProcessingCategory::TaggedSymbol
13229
+ )
13230
+
13210
13231
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
13211
13232
  BALANCE_INQUIRY =
13212
13233
  T.let(
@@ -2906,6 +2906,13 @@ module Increase
2906
2906
  Increase::DeclinedTransaction::Source::CardDecline::ProcessingCategory::TaggedSymbol
2907
2907
  )
2908
2908
 
2909
+ # Cash deposit transactions are used to deposit cash at an ATM or a point of sale.
2910
+ CASH_DEPOSIT =
2911
+ T.let(
2912
+ :cash_deposit,
2913
+ Increase::DeclinedTransaction::Source::CardDecline::ProcessingCategory::TaggedSymbol
2914
+ )
2915
+
2909
2916
  # A balance inquiry transaction is used to check the balance of an account associated with a card.
2910
2917
  BALANCE_INQUIRY =
2911
2918
  T.let(
@@ -558,6 +558,13 @@ module Increase
558
558
  Increase::Event::Category::TaggedSymbol
559
559
  )
560
560
 
561
+ # Occurs whenever a Loan Distribution is created.
562
+ LOAN_DISTRIBUTION_CREATED =
563
+ T.let(
564
+ :"loan_distribution.created",
565
+ Increase::Event::Category::TaggedSymbol
566
+ )
567
+
561
568
  # Occurs whenever a Loan Offer is created.
562
569
  LOAN_OFFER_CREATED =
563
570
  T.let(:"loan_offer.created", Increase::Event::Category::TaggedSymbol)
@@ -566,6 +573,13 @@ module Increase
566
573
  LOAN_OFFER_UPDATED =
567
574
  T.let(:"loan_offer.updated", Increase::Event::Category::TaggedSymbol)
568
575
 
576
+ # Occurs whenever a Loan Purchase is created.
577
+ LOAN_PURCHASE_CREATED =
578
+ T.let(
579
+ :"loan_purchase.created",
580
+ Increase::Event::Category::TaggedSymbol
581
+ )
582
+
569
583
  # Occurs whenever a Lockbox is created.
570
584
  LOCKBOX_CREATED =
571
585
  T.let(:"lockbox.created", Increase::Event::Category::TaggedSymbol)