increase 1.126.0 → 1.128.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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/models/card_dispute.rb +311 -66
  5. data/lib/increase/models/card_dispute_create_params.rb +102 -30
  6. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +104 -30
  7. data/lib/increase/models/card_payment.rb +60 -15
  8. data/lib/increase/models/declined_transaction.rb +21 -6
  9. data/lib/increase/models/export_create_params.rb +8 -3
  10. data/lib/increase/models/pending_transaction.rb +32 -33
  11. data/lib/increase/models/real_time_decision.rb +24 -6
  12. data/lib/increase/models/simulations/card_dispute_action_params.rb +97 -27
  13. data/lib/increase/models/transaction.rb +23 -6
  14. data/lib/increase/resources/exports.rb +1 -1
  15. data/lib/increase/version.rb +1 -1
  16. data/rbi/increase/models/card_dispute.rbi +1038 -88
  17. data/rbi/increase/models/card_dispute_create_params.rbi +364 -40
  18. data/rbi/increase/models/card_dispute_submit_user_submission_params.rbi +364 -40
  19. data/rbi/increase/models/card_payment.rbi +211 -20
  20. data/rbi/increase/models/declined_transaction.rbi +78 -8
  21. data/rbi/increase/models/export_create_params.rbi +25 -4
  22. data/rbi/increase/models/pending_transaction.rbi +90 -53
  23. data/rbi/increase/models/real_time_decision.rbi +90 -8
  24. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +333 -36
  25. data/rbi/increase/models/transaction.rbi +76 -8
  26. data/rbi/increase/resources/exports.rbi +1 -1
  27. data/sig/increase/models/card_dispute.rbs +264 -88
  28. data/sig/increase/models/card_dispute_create_params.rbs +150 -50
  29. data/sig/increase/models/card_dispute_submit_user_submission_params.rbs +150 -50
  30. data/sig/increase/models/card_payment.rbs +60 -20
  31. data/sig/increase/models/declined_transaction.rbs +24 -8
  32. data/sig/increase/models/export_create_params.rbs +15 -5
  33. data/sig/increase/models/pending_transaction.rbs +29 -27
  34. data/sig/increase/models/real_time_decision.rbs +24 -8
  35. data/sig/increase/models/simulations/card_dispute_action_params.rbs +135 -45
  36. data/sig/increase/models/transaction.rbs +24 -8
  37. data/sig/increase/resources/exports.rbs +1 -1
  38. metadata +1 -1
@@ -21,11 +21,6 @@ module Increase
21
21
  sig { returns(Integer) }
22
22
  attr_accessor :amount
23
23
 
24
- # How the Pending Transaction affects the balance of its Account while its status
25
- # is `pending`.
26
- sig { returns(Increase::PendingTransaction::BalanceImpact::TaggedSymbol) }
27
- attr_accessor :balance_impact
28
-
29
24
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
30
25
  # Transaction was completed.
31
26
  sig { returns(T.nilable(Time)) }
@@ -48,6 +43,12 @@ module Increase
48
43
  sig { returns(String) }
49
44
  attr_accessor :description
50
45
 
46
+ # The amount that this Pending Transaction decrements the available balance of its
47
+ # Account. This is usually the same as `amount`, but will differ if the amount is
48
+ # positive.
49
+ sig { returns(Integer) }
50
+ attr_accessor :held_amount
51
+
51
52
  # The identifier for the route this Pending Transaction came through. Routes are
52
53
  # things like cards and ACH details.
53
54
  sig { returns(T.nilable(String)) }
@@ -89,11 +90,11 @@ module Increase
89
90
  id: String,
90
91
  account_id: String,
91
92
  amount: Integer,
92
- balance_impact: Increase::PendingTransaction::BalanceImpact::OrSymbol,
93
93
  completed_at: T.nilable(Time),
94
94
  created_at: Time,
95
95
  currency: Increase::PendingTransaction::Currency::OrSymbol,
96
96
  description: String,
97
+ held_amount: Integer,
97
98
  route_id: T.nilable(String),
98
99
  route_type:
99
100
  T.nilable(Increase::PendingTransaction::RouteType::OrSymbol),
@@ -110,9 +111,6 @@ module Increase
110
111
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
111
112
  # for example, this is cents.
112
113
  amount:,
113
- # How the Pending Transaction affects the balance of its Account while its status
114
- # is `pending`.
115
- balance_impact:,
116
114
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
117
115
  # Transaction was completed.
118
116
  completed_at:,
@@ -127,6 +125,10 @@ module Increase
127
125
  # provide. For a Pending Transaction related to a payment, this is the description
128
126
  # the vendor provides.
129
127
  description:,
128
+ # The amount that this Pending Transaction decrements the available balance of its
129
+ # Account. This is usually the same as `amount`, but will differ if the amount is
130
+ # positive.
131
+ held_amount:,
130
132
  # The identifier for the route this Pending Transaction came through. Routes are
131
133
  # things like cards and ACH details.
132
134
  route_id:,
@@ -151,12 +153,11 @@ module Increase
151
153
  id: String,
152
154
  account_id: String,
153
155
  amount: Integer,
154
- balance_impact:
155
- Increase::PendingTransaction::BalanceImpact::TaggedSymbol,
156
156
  completed_at: T.nilable(Time),
157
157
  created_at: Time,
158
158
  currency: Increase::PendingTransaction::Currency::TaggedSymbol,
159
159
  description: String,
160
+ held_amount: Integer,
160
161
  route_id: T.nilable(String),
161
162
  route_type:
162
163
  T.nilable(Increase::PendingTransaction::RouteType::TaggedSymbol),
@@ -169,40 +170,6 @@ module Increase
169
170
  def to_hash
170
171
  end
171
172
 
172
- # How the Pending Transaction affects the balance of its Account while its status
173
- # is `pending`.
174
- module BalanceImpact
175
- extend Increase::Internal::Type::Enum
176
-
177
- TaggedSymbol =
178
- T.type_alias do
179
- T.all(Symbol, Increase::PendingTransaction::BalanceImpact)
180
- end
181
- OrSymbol = T.type_alias { T.any(Symbol, String) }
182
-
183
- # This Pending Transaction will decrement the available balance on the Account while its status is `pending`.
184
- AFFECTS_AVAILABLE_BALANCE =
185
- T.let(
186
- :affects_available_balance,
187
- Increase::PendingTransaction::BalanceImpact::TaggedSymbol
188
- )
189
-
190
- # This Pending Transaction does not affect the available balance on the Account.
191
- NONE =
192
- T.let(
193
- :none,
194
- Increase::PendingTransaction::BalanceImpact::TaggedSymbol
195
- )
196
-
197
- sig do
198
- override.returns(
199
- T::Array[Increase::PendingTransaction::BalanceImpact::TaggedSymbol]
200
- )
201
- end
202
- def self.values
203
- end
204
- end
205
-
206
173
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
207
174
  # Transaction's currency. This will match the currency on the Pending
208
175
  # Transaction's Account.
@@ -483,8 +450,16 @@ module Increase
483
450
 
484
451
  # If the category of this Transaction source is equal to `other`, this field will
485
452
  # contain an empty object, otherwise it will contain null.
486
- sig { returns(T.nilable(T.anything)) }
487
- attr_accessor :other
453
+ sig { returns(T.nilable(Increase::PendingTransaction::Source::Other)) }
454
+ attr_reader :other
455
+
456
+ sig do
457
+ params(
458
+ other:
459
+ T.nilable(Increase::PendingTransaction::Source::Other::OrHash)
460
+ ).void
461
+ end
462
+ attr_writer :other
488
463
 
489
464
  # A Real-Time Payments Transfer Instruction object. This field will be present in
490
465
  # the JSON response if and only if `category` is equal to
@@ -598,7 +573,8 @@ module Increase
598
573
  T.nilable(
599
574
  Increase::PendingTransaction::Source::InboundWireTransferReversal::OrHash
600
575
  ),
601
- other: T.nilable(T.anything),
576
+ other:
577
+ T.nilable(Increase::PendingTransaction::Source::Other::OrHash),
602
578
  real_time_payments_transfer_instruction:
603
579
  T.nilable(
604
580
  Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction::OrHash
@@ -712,7 +688,7 @@ module Increase
712
688
  T.nilable(
713
689
  Increase::PendingTransaction::Source::InboundWireTransferReversal
714
690
  ),
715
- other: T.nilable(T.anything),
691
+ other: T.nilable(Increase::PendingTransaction::Source::Other),
716
692
  real_time_payments_transfer_instruction:
717
693
  T.nilable(
718
694
  Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction
@@ -2197,8 +2173,24 @@ module Increase
2197
2173
  attr_accessor :category
2198
2174
 
2199
2175
  # Fields specific to the `pulse` network.
2200
- sig { returns(T.nilable(T.anything)) }
2201
- attr_accessor :pulse
2176
+ sig do
2177
+ returns(
2178
+ T.nilable(
2179
+ Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Pulse
2180
+ )
2181
+ )
2182
+ end
2183
+ attr_reader :pulse
2184
+
2185
+ sig do
2186
+ params(
2187
+ pulse:
2188
+ T.nilable(
2189
+ Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Pulse::OrHash
2190
+ )
2191
+ ).void
2192
+ end
2193
+ attr_writer :pulse
2202
2194
 
2203
2195
  # Fields specific to the `visa` network.
2204
2196
  sig do
@@ -2225,7 +2217,10 @@ module Increase
2225
2217
  params(
2226
2218
  category:
2227
2219
  Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category::OrSymbol,
2228
- pulse: T.nilable(T.anything),
2220
+ pulse:
2221
+ T.nilable(
2222
+ Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Pulse::OrHash
2223
+ ),
2229
2224
  visa:
2230
2225
  T.nilable(
2231
2226
  Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::OrHash
@@ -2247,7 +2242,10 @@ module Increase
2247
2242
  {
2248
2243
  category:
2249
2244
  Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category::TaggedSymbol,
2250
- pulse: T.nilable(T.anything),
2245
+ pulse:
2246
+ T.nilable(
2247
+ Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Pulse
2248
+ ),
2251
2249
  visa:
2252
2250
  T.nilable(
2253
2251
  Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa
@@ -2296,6 +2294,25 @@ module Increase
2296
2294
  end
2297
2295
  end
2298
2296
 
2297
+ class Pulse < Increase::Internal::Type::BaseModel
2298
+ OrHash =
2299
+ T.type_alias do
2300
+ T.any(
2301
+ Increase::PendingTransaction::Source::CardAuthorization::NetworkDetails::Pulse,
2302
+ Increase::Internal::AnyHash
2303
+ )
2304
+ end
2305
+
2306
+ # Fields specific to the `pulse` network.
2307
+ sig { returns(T.attached_class) }
2308
+ def self.new
2309
+ end
2310
+
2311
+ sig { override.returns({}) }
2312
+ def to_hash
2313
+ end
2314
+ end
2315
+
2299
2316
  class Visa < Increase::Internal::Type::BaseModel
2300
2317
  OrHash =
2301
2318
  T.type_alias do
@@ -3899,6 +3916,26 @@ module Increase
3899
3916
  end
3900
3917
  end
3901
3918
 
3919
+ class Other < Increase::Internal::Type::BaseModel
3920
+ OrHash =
3921
+ T.type_alias do
3922
+ T.any(
3923
+ Increase::PendingTransaction::Source::Other,
3924
+ Increase::Internal::AnyHash
3925
+ )
3926
+ end
3927
+
3928
+ # If the category of this Transaction source is equal to `other`, this field will
3929
+ # contain an empty object, otherwise it will contain null.
3930
+ sig { returns(T.attached_class) }
3931
+ def self.new
3932
+ end
3933
+
3934
+ sig { override.returns({}) }
3935
+ def to_hash
3936
+ end
3937
+ end
3938
+
3902
3939
  class RealTimePaymentsTransferInstruction < Increase::Internal::Type::BaseModel
3903
3940
  OrHash =
3904
3941
  T.type_alias do
@@ -1693,8 +1693,24 @@ module Increase
1693
1693
  attr_accessor :category
1694
1694
 
1695
1695
  # Fields specific to the `pulse` network.
1696
- sig { returns(T.nilable(T.anything)) }
1697
- attr_accessor :pulse
1696
+ sig do
1697
+ returns(
1698
+ T.nilable(
1699
+ Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Pulse
1700
+ )
1701
+ )
1702
+ end
1703
+ attr_reader :pulse
1704
+
1705
+ sig do
1706
+ params(
1707
+ pulse:
1708
+ T.nilable(
1709
+ Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Pulse::OrHash
1710
+ )
1711
+ ).void
1712
+ end
1713
+ attr_writer :pulse
1698
1714
 
1699
1715
  # Fields specific to the `visa` network.
1700
1716
  sig do
@@ -1721,7 +1737,10 @@ module Increase
1721
1737
  params(
1722
1738
  category:
1723
1739
  Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Category::OrSymbol,
1724
- pulse: T.nilable(T.anything),
1740
+ pulse:
1741
+ T.nilable(
1742
+ Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Pulse::OrHash
1743
+ ),
1725
1744
  visa:
1726
1745
  T.nilable(
1727
1746
  Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::OrHash
@@ -1743,7 +1762,10 @@ module Increase
1743
1762
  {
1744
1763
  category:
1745
1764
  Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Category::TaggedSymbol,
1746
- pulse: T.nilable(T.anything),
1765
+ pulse:
1766
+ T.nilable(
1767
+ Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Pulse
1768
+ ),
1747
1769
  visa:
1748
1770
  T.nilable(
1749
1771
  Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Visa
@@ -1792,6 +1814,25 @@ module Increase
1792
1814
  end
1793
1815
  end
1794
1816
 
1817
+ class Pulse < Increase::Internal::Type::BaseModel
1818
+ OrHash =
1819
+ T.type_alias do
1820
+ T.any(
1821
+ Increase::RealTimeDecision::CardAuthorization::NetworkDetails::Pulse,
1822
+ Increase::Internal::AnyHash
1823
+ )
1824
+ end
1825
+
1826
+ # Fields specific to the `pulse` network.
1827
+ sig { returns(T.attached_class) }
1828
+ def self.new
1829
+ end
1830
+
1831
+ sig { override.returns({}) }
1832
+ def to_hash
1833
+ end
1834
+ end
1835
+
1795
1836
  class Visa < Increase::Internal::Type::BaseModel
1796
1837
  OrHash =
1797
1838
  T.type_alias do
@@ -2337,8 +2378,24 @@ module Increase
2337
2378
  attr_writer :incremental_authorization
2338
2379
 
2339
2380
  # Fields specific to the category `initial_authorization`.
2340
- sig { returns(T.nilable(T.anything)) }
2341
- attr_accessor :initial_authorization
2381
+ sig do
2382
+ returns(
2383
+ T.nilable(
2384
+ Increase::RealTimeDecision::CardAuthorization::RequestDetails::InitialAuthorization
2385
+ )
2386
+ )
2387
+ end
2388
+ attr_reader :initial_authorization
2389
+
2390
+ sig do
2391
+ params(
2392
+ initial_authorization:
2393
+ T.nilable(
2394
+ Increase::RealTimeDecision::CardAuthorization::RequestDetails::InitialAuthorization::OrHash
2395
+ )
2396
+ ).void
2397
+ end
2398
+ attr_writer :initial_authorization
2342
2399
 
2343
2400
  # Fields specific to the type of request, such as an incremental authorization.
2344
2401
  sig do
@@ -2349,7 +2406,10 @@ module Increase
2349
2406
  T.nilable(
2350
2407
  Increase::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization::OrHash
2351
2408
  ),
2352
- initial_authorization: T.nilable(T.anything)
2409
+ initial_authorization:
2410
+ T.nilable(
2411
+ Increase::RealTimeDecision::CardAuthorization::RequestDetails::InitialAuthorization::OrHash
2412
+ )
2353
2413
  ).returns(T.attached_class)
2354
2414
  end
2355
2415
  def self.new(
@@ -2372,7 +2432,10 @@ module Increase
2372
2432
  T.nilable(
2373
2433
  Increase::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization
2374
2434
  ),
2375
- initial_authorization: T.nilable(T.anything)
2435
+ initial_authorization:
2436
+ T.nilable(
2437
+ Increase::RealTimeDecision::CardAuthorization::RequestDetails::InitialAuthorization
2438
+ )
2376
2439
  }
2377
2440
  )
2378
2441
  end
@@ -2463,6 +2526,25 @@ module Increase
2463
2526
  def to_hash
2464
2527
  end
2465
2528
  end
2529
+
2530
+ class InitialAuthorization < Increase::Internal::Type::BaseModel
2531
+ OrHash =
2532
+ T.type_alias do
2533
+ T.any(
2534
+ Increase::RealTimeDecision::CardAuthorization::RequestDetails::InitialAuthorization,
2535
+ Increase::Internal::AnyHash
2536
+ )
2537
+ end
2538
+
2539
+ # Fields specific to the category `initial_authorization`.
2540
+ sig { returns(T.attached_class) }
2541
+ def self.new
2542
+ end
2543
+
2544
+ sig { override.returns({}) }
2545
+ def to_hash
2546
+ end
2547
+ end
2466
2548
  end
2467
2549
 
2468
2550
  class Verification < Increase::Internal::Type::BaseModel