increase 1.215.0 → 1.217.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +18 -0
- data/README.md +1 -1
- data/lib/increase/models/check_deposit.rb +71 -1
- data/lib/increase/models/event_subscription.rb +246 -234
- data/lib/increase/models/real_time_decision_action_params.rb +38 -1
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/check_deposit.rbi +132 -0
- data/rbi/increase/models/event_subscription.rbi +830 -779
- data/rbi/increase/models/real_time_decision_action_params.rbi +70 -3
- data/sig/increase/models/check_deposit.rbs +65 -0
- data/sig/increase/models/event_subscription.rbs +367 -350
- data/sig/increase/models/real_time_decision_action_params.rbs +28 -3
- metadata +1 -1
|
@@ -110,7 +110,14 @@ module Increase
|
|
|
110
110
|
# @return [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result]
|
|
111
111
|
required :result, enum: -> { Increase::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result }
|
|
112
112
|
|
|
113
|
-
# @!
|
|
113
|
+
# @!attribute success
|
|
114
|
+
# If your application was able to deliver the one-time code, this contains
|
|
115
|
+
# metadata about the delivery.
|
|
116
|
+
#
|
|
117
|
+
# @return [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success, nil]
|
|
118
|
+
optional :success, -> { Increase::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success }
|
|
119
|
+
|
|
120
|
+
# @!method initialize(result:, success: nil)
|
|
114
121
|
# Some parameter documentations has been truncated, see
|
|
115
122
|
# {Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge}
|
|
116
123
|
# for more details.
|
|
@@ -119,6 +126,8 @@ module Increase
|
|
|
119
126
|
# this object contains your response.
|
|
120
127
|
#
|
|
121
128
|
# @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result] Whether the card authentication challenge was successfully delivered to the card
|
|
129
|
+
#
|
|
130
|
+
# @param success [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success] If your application was able to deliver the one-time code, this contains metadat
|
|
122
131
|
|
|
123
132
|
# Whether the card authentication challenge was successfully delivered to the
|
|
124
133
|
# cardholder.
|
|
@@ -136,6 +145,34 @@ module Increase
|
|
|
136
145
|
# @!method self.values
|
|
137
146
|
# @return [Array<Symbol>]
|
|
138
147
|
end
|
|
148
|
+
|
|
149
|
+
# @see Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge#success
|
|
150
|
+
class Success < Increase::Internal::Type::BaseModel
|
|
151
|
+
# @!attribute email
|
|
152
|
+
# The email address that was used to deliver the one-time code to the cardholder.
|
|
153
|
+
#
|
|
154
|
+
# @return [String, nil]
|
|
155
|
+
optional :email, String
|
|
156
|
+
|
|
157
|
+
# @!attribute phone
|
|
158
|
+
# The phone number that was used to deliver the one-time code to the cardholder
|
|
159
|
+
# via SMS.
|
|
160
|
+
#
|
|
161
|
+
# @return [String, nil]
|
|
162
|
+
optional :phone, String
|
|
163
|
+
|
|
164
|
+
# @!method initialize(email: nil, phone: nil)
|
|
165
|
+
# Some parameter documentations has been truncated, see
|
|
166
|
+
# {Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success}
|
|
167
|
+
# for more details.
|
|
168
|
+
#
|
|
169
|
+
# If your application was able to deliver the one-time code, this contains
|
|
170
|
+
# metadata about the delivery.
|
|
171
|
+
#
|
|
172
|
+
# @param email [String] The email address that was used to deliver the one-time code to the cardholder.
|
|
173
|
+
#
|
|
174
|
+
# @param phone [String] The phone number that was used to deliver the one-time code to the cardholder vi
|
|
175
|
+
end
|
|
139
176
|
end
|
|
140
177
|
|
|
141
178
|
class CardAuthorization < Increase::Internal::Type::BaseModel
|
data/lib/increase/version.rb
CHANGED
|
@@ -42,6 +42,11 @@ module Increase
|
|
|
42
42
|
end
|
|
43
43
|
attr_writer :deposit_acceptance
|
|
44
44
|
|
|
45
|
+
# If the deposit or the return was adjusted by the receiving institution, this
|
|
46
|
+
# will contain details of the adjustments.
|
|
47
|
+
sig { returns(T::Array[Increase::CheckDeposit::DepositAdjustment]) }
|
|
48
|
+
attr_accessor :deposit_adjustments
|
|
49
|
+
|
|
45
50
|
# If your deposit is rejected by Increase, this will contain details as to why it
|
|
46
51
|
# was rejected.
|
|
47
52
|
sig { returns(T.nilable(Increase::CheckDeposit::DepositRejection)) }
|
|
@@ -141,6 +146,8 @@ module Increase
|
|
|
141
146
|
created_at: Time,
|
|
142
147
|
deposit_acceptance:
|
|
143
148
|
T.nilable(Increase::CheckDeposit::DepositAcceptance::OrHash),
|
|
149
|
+
deposit_adjustments:
|
|
150
|
+
T::Array[Increase::CheckDeposit::DepositAdjustment::OrHash],
|
|
144
151
|
deposit_rejection:
|
|
145
152
|
T.nilable(Increase::CheckDeposit::DepositRejection::OrHash),
|
|
146
153
|
deposit_return:
|
|
@@ -174,6 +181,9 @@ module Increase
|
|
|
174
181
|
# Once your deposit is successfully parsed and accepted by Increase, this will
|
|
175
182
|
# contain details of the parsed check.
|
|
176
183
|
deposit_acceptance:,
|
|
184
|
+
# If the deposit or the return was adjusted by the receiving institution, this
|
|
185
|
+
# will contain details of the adjustments.
|
|
186
|
+
deposit_adjustments:,
|
|
177
187
|
# If your deposit is rejected by Increase, this will contain details as to why it
|
|
178
188
|
# was rejected.
|
|
179
189
|
deposit_rejection:,
|
|
@@ -220,6 +230,8 @@ module Increase
|
|
|
220
230
|
created_at: Time,
|
|
221
231
|
deposit_acceptance:
|
|
222
232
|
T.nilable(Increase::CheckDeposit::DepositAcceptance),
|
|
233
|
+
deposit_adjustments:
|
|
234
|
+
T::Array[Increase::CheckDeposit::DepositAdjustment],
|
|
223
235
|
deposit_rejection:
|
|
224
236
|
T.nilable(Increase::CheckDeposit::DepositRejection),
|
|
225
237
|
deposit_return: T.nilable(Increase::CheckDeposit::DepositReturn),
|
|
@@ -373,6 +385,126 @@ module Increase
|
|
|
373
385
|
end
|
|
374
386
|
end
|
|
375
387
|
|
|
388
|
+
class DepositAdjustment < Increase::Internal::Type::BaseModel
|
|
389
|
+
OrHash =
|
|
390
|
+
T.type_alias do
|
|
391
|
+
T.any(
|
|
392
|
+
Increase::CheckDeposit::DepositAdjustment,
|
|
393
|
+
Increase::Internal::AnyHash
|
|
394
|
+
)
|
|
395
|
+
end
|
|
396
|
+
|
|
397
|
+
# The time at which the adjustment was received.
|
|
398
|
+
sig { returns(Time) }
|
|
399
|
+
attr_accessor :adjusted_at
|
|
400
|
+
|
|
401
|
+
# The amount of the adjustment.
|
|
402
|
+
sig { returns(Integer) }
|
|
403
|
+
attr_accessor :amount
|
|
404
|
+
|
|
405
|
+
# The reason for the adjustment.
|
|
406
|
+
sig do
|
|
407
|
+
returns(
|
|
408
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
409
|
+
)
|
|
410
|
+
end
|
|
411
|
+
attr_accessor :reason
|
|
412
|
+
|
|
413
|
+
# The id of the transaction for the adjustment.
|
|
414
|
+
sig { returns(String) }
|
|
415
|
+
attr_accessor :transaction_id
|
|
416
|
+
|
|
417
|
+
sig do
|
|
418
|
+
params(
|
|
419
|
+
adjusted_at: Time,
|
|
420
|
+
amount: Integer,
|
|
421
|
+
reason: Increase::CheckDeposit::DepositAdjustment::Reason::OrSymbol,
|
|
422
|
+
transaction_id: String
|
|
423
|
+
).returns(T.attached_class)
|
|
424
|
+
end
|
|
425
|
+
def self.new(
|
|
426
|
+
# The time at which the adjustment was received.
|
|
427
|
+
adjusted_at:,
|
|
428
|
+
# The amount of the adjustment.
|
|
429
|
+
amount:,
|
|
430
|
+
# The reason for the adjustment.
|
|
431
|
+
reason:,
|
|
432
|
+
# The id of the transaction for the adjustment.
|
|
433
|
+
transaction_id:
|
|
434
|
+
)
|
|
435
|
+
end
|
|
436
|
+
|
|
437
|
+
sig do
|
|
438
|
+
override.returns(
|
|
439
|
+
{
|
|
440
|
+
adjusted_at: Time,
|
|
441
|
+
amount: Integer,
|
|
442
|
+
reason:
|
|
443
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol,
|
|
444
|
+
transaction_id: String
|
|
445
|
+
}
|
|
446
|
+
)
|
|
447
|
+
end
|
|
448
|
+
def to_hash
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# The reason for the adjustment.
|
|
452
|
+
module Reason
|
|
453
|
+
extend Increase::Internal::Type::Enum
|
|
454
|
+
|
|
455
|
+
TaggedSymbol =
|
|
456
|
+
T.type_alias do
|
|
457
|
+
T.all(Symbol, Increase::CheckDeposit::DepositAdjustment::Reason)
|
|
458
|
+
end
|
|
459
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
460
|
+
|
|
461
|
+
# The return was initiated too late and the receiving institution has responded with a Late Return Claim.
|
|
462
|
+
LATE_RETURN =
|
|
463
|
+
T.let(
|
|
464
|
+
:late_return,
|
|
465
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
466
|
+
)
|
|
467
|
+
|
|
468
|
+
# The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
|
|
469
|
+
WRONG_PAYEE_CREDIT =
|
|
470
|
+
T.let(
|
|
471
|
+
:wrong_payee_credit,
|
|
472
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
473
|
+
)
|
|
474
|
+
|
|
475
|
+
# The check was deposited with a different amount than what was written on the check.
|
|
476
|
+
ADJUSTED_AMOUNT =
|
|
477
|
+
T.let(
|
|
478
|
+
:adjusted_amount,
|
|
479
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
480
|
+
)
|
|
481
|
+
|
|
482
|
+
# The recipient was not able to process the check. This usually happens for e.g., low quality images.
|
|
483
|
+
NON_CONFORMING_ITEM =
|
|
484
|
+
T.let(
|
|
485
|
+
:non_conforming_item,
|
|
486
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
487
|
+
)
|
|
488
|
+
|
|
489
|
+
# The check has already been deposited elsewhere and so this is a duplicate.
|
|
490
|
+
PAID =
|
|
491
|
+
T.let(
|
|
492
|
+
:paid,
|
|
493
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
494
|
+
)
|
|
495
|
+
|
|
496
|
+
sig do
|
|
497
|
+
override.returns(
|
|
498
|
+
T::Array[
|
|
499
|
+
Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
|
|
500
|
+
]
|
|
501
|
+
)
|
|
502
|
+
end
|
|
503
|
+
def self.values
|
|
504
|
+
end
|
|
505
|
+
end
|
|
506
|
+
end
|
|
507
|
+
|
|
376
508
|
class DepositRejection < Increase::Internal::Type::BaseModel
|
|
377
509
|
OrHash =
|
|
378
510
|
T.type_alias do
|