increase 1.72.0 → 1.73.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.
@@ -3021,28 +3021,21 @@ module Increase
3021
3021
  end
3022
3022
  OrSymbol = T.type_alias { T.any(Symbol, String) }
3023
3023
 
3024
- # No address was provided in the authorization request.
3024
+ # No address information was provided in the authorization request.
3025
3025
  NOT_CHECKED =
3026
3026
  T.let(
3027
3027
  :not_checked,
3028
3028
  Increase::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result::TaggedSymbol
3029
3029
  )
3030
3030
 
3031
- # Postal code matches, but the street address was not verified.
3032
- POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
3033
- T.let(
3034
- :postal_code_match_address_not_checked,
3035
- Increase::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result::TaggedSymbol
3036
- )
3037
-
3038
- # Postal code matches, but the street address does not match.
3031
+ # Postal code matches, but the street address does not match or was not provided.
3039
3032
  POSTAL_CODE_MATCH_ADDRESS_NO_MATCH =
3040
3033
  T.let(
3041
3034
  :postal_code_match_address_no_match,
3042
3035
  Increase::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result::TaggedSymbol
3043
3036
  )
3044
3037
 
3045
- # Postal code does not match, but the street address matches.
3038
+ # Postal code does not match, but the street address matches or was not provided.
3046
3039
  POSTAL_CODE_NO_MATCH_ADDRESS_MATCH =
3047
3040
  T.let(
3048
3041
  :postal_code_no_match_address_match,
@@ -3063,6 +3056,13 @@ module Increase
3063
3056
  Increase::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result::TaggedSymbol
3064
3057
  )
3065
3058
 
3059
+ # Postal code matches, but the street address was not verified. (deprecated)
3060
+ POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
3061
+ T.let(
3062
+ :postal_code_match_address_not_checked,
3063
+ Increase::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result::TaggedSymbol
3064
+ )
3065
+
3066
3066
  sig do
3067
3067
  override.returns(
3068
3068
  T::Array[
@@ -2918,28 +2918,21 @@ module Increase
2918
2918
  end
2919
2919
  OrSymbol = T.type_alias { T.any(Symbol, String) }
2920
2920
 
2921
- # No address was provided in the authorization request.
2921
+ # No address information was provided in the authorization request.
2922
2922
  NOT_CHECKED =
2923
2923
  T.let(
2924
2924
  :not_checked,
2925
2925
  Increase::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2926
2926
  )
2927
2927
 
2928
- # Postal code matches, but the street address was not verified.
2929
- POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
2930
- T.let(
2931
- :postal_code_match_address_not_checked,
2932
- Increase::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2933
- )
2934
-
2935
- # Postal code matches, but the street address does not match.
2928
+ # Postal code matches, but the street address does not match or was not provided.
2936
2929
  POSTAL_CODE_MATCH_ADDRESS_NO_MATCH =
2937
2930
  T.let(
2938
2931
  :postal_code_match_address_no_match,
2939
2932
  Increase::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2940
2933
  )
2941
2934
 
2942
- # Postal code does not match, but the street address matches.
2935
+ # Postal code does not match, but the street address matches or was not provided.
2943
2936
  POSTAL_CODE_NO_MATCH_ADDRESS_MATCH =
2944
2937
  T.let(
2945
2938
  :postal_code_no_match_address_match,
@@ -2960,6 +2953,13 @@ module Increase
2960
2953
  Increase::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2961
2954
  )
2962
2955
 
2956
+ # Postal code matches, but the street address was not verified. (deprecated)
2957
+ POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
2958
+ T.let(
2959
+ :postal_code_match_address_not_checked,
2960
+ Increase::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2961
+ )
2962
+
2963
2963
  sig do
2964
2964
  override.returns(
2965
2965
  T::Array[
@@ -477,6 +477,25 @@ module Increase
477
477
  end
478
478
  attr_accessor :decision
479
479
 
480
+ # Present if and only if `decision` is `decline`. Contains information related to
481
+ # the reason the authorization was declined.
482
+ sig do
483
+ returns(
484
+ T.nilable(Increase::RealTimeDecision::CardAuthorization::Decline)
485
+ )
486
+ end
487
+ attr_reader :decline
488
+
489
+ sig do
490
+ params(
491
+ decline:
492
+ T.nilable(
493
+ Increase::RealTimeDecision::CardAuthorization::Decline::OrHash
494
+ )
495
+ ).void
496
+ end
497
+ attr_writer :decline
498
+
480
499
  # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
481
500
  # purchase), the identifier of the token that was used.
482
501
  sig { returns(T.nilable(String)) }
@@ -641,6 +660,10 @@ module Increase
641
660
  T.nilable(
642
661
  Increase::RealTimeDecision::CardAuthorization::Decision::OrSymbol
643
662
  ),
663
+ decline:
664
+ T.nilable(
665
+ Increase::RealTimeDecision::CardAuthorization::Decline::OrHash
666
+ ),
644
667
  digital_wallet_token_id: T.nilable(String),
645
668
  direction:
646
669
  Increase::RealTimeDecision::CardAuthorization::Direction::OrSymbol,
@@ -682,6 +705,9 @@ module Increase
682
705
  card_id:,
683
706
  # Whether or not the authorization was approved.
684
707
  decision:,
708
+ # Present if and only if `decision` is `decline`. Contains information related to
709
+ # the reason the authorization was declined.
710
+ decline:,
685
711
  # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
686
712
  # purchase), the identifier of the token that was used.
687
713
  digital_wallet_token_id:,
@@ -755,6 +781,10 @@ module Increase
755
781
  T.nilable(
756
782
  Increase::RealTimeDecision::CardAuthorization::Decision::TaggedSymbol
757
783
  ),
784
+ decline:
785
+ T.nilable(
786
+ Increase::RealTimeDecision::CardAuthorization::Decline
787
+ ),
758
788
  digital_wallet_token_id: T.nilable(String),
759
789
  direction:
760
790
  Increase::RealTimeDecision::CardAuthorization::Direction::TaggedSymbol,
@@ -1469,6 +1499,33 @@ module Increase
1469
1499
  end
1470
1500
  end
1471
1501
 
1502
+ class Decline < Increase::Internal::Type::BaseModel
1503
+ OrHash =
1504
+ T.type_alias do
1505
+ T.any(
1506
+ Increase::RealTimeDecision::CardAuthorization::Decline,
1507
+ Increase::Internal::AnyHash
1508
+ )
1509
+ end
1510
+
1511
+ # The reason the authorization was declined.
1512
+ sig { returns(String) }
1513
+ attr_accessor :reason
1514
+
1515
+ # Present if and only if `decision` is `decline`. Contains information related to
1516
+ # the reason the authorization was declined.
1517
+ sig { params(reason: String).returns(T.attached_class) }
1518
+ def self.new(
1519
+ # The reason the authorization was declined.
1520
+ reason:
1521
+ )
1522
+ end
1523
+
1524
+ sig { override.returns({ reason: String }) }
1525
+ def to_hash
1526
+ end
1527
+ end
1528
+
1472
1529
  # The direction describes the direction the funds will move, either from the
1473
1530
  # cardholder to the merchant or from the merchant to the cardholder.
1474
1531
  module Direction
@@ -2525,28 +2582,21 @@ module Increase
2525
2582
  end
2526
2583
  OrSymbol = T.type_alias { T.any(Symbol, String) }
2527
2584
 
2528
- # No address was provided in the authorization request.
2585
+ # No address information was provided in the authorization request.
2529
2586
  NOT_CHECKED =
2530
2587
  T.let(
2531
2588
  :not_checked,
2532
2589
  Increase::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2533
2590
  )
2534
2591
 
2535
- # Postal code matches, but the street address was not verified.
2536
- POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
2537
- T.let(
2538
- :postal_code_match_address_not_checked,
2539
- Increase::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2540
- )
2541
-
2542
- # Postal code matches, but the street address does not match.
2592
+ # Postal code matches, but the street address does not match or was not provided.
2543
2593
  POSTAL_CODE_MATCH_ADDRESS_NO_MATCH =
2544
2594
  T.let(
2545
2595
  :postal_code_match_address_no_match,
2546
2596
  Increase::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2547
2597
  )
2548
2598
 
2549
- # Postal code does not match, but the street address matches.
2599
+ # Postal code does not match, but the street address matches or was not provided.
2550
2600
  POSTAL_CODE_NO_MATCH_ADDRESS_MATCH =
2551
2601
  T.let(
2552
2602
  :postal_code_no_match_address_match,
@@ -2567,6 +2617,13 @@ module Increase
2567
2617
  Increase::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2568
2618
  )
2569
2619
 
2620
+ # Postal code matches, but the street address was not verified. (deprecated)
2621
+ POSTAL_CODE_MATCH_ADDRESS_NOT_CHECKED =
2622
+ T.let(
2623
+ :postal_code_match_address_not_checked,
2624
+ Increase::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result::TaggedSymbol
2625
+ )
2626
+
2570
2627
  sig do
2571
2628
  override.returns(
2572
2629
  T::Array[
@@ -347,8 +347,50 @@ module Increase
347
347
  end
348
348
  attr_accessor :decision
349
349
 
350
+ # If your application approves the authorization, this contains metadata about
351
+ # your decision to approve. Your response here is advisory to the acquiring bank.
352
+ # The bank may choose to reverse the authorization if you approve the transaction
353
+ # but indicate the address does not match.
354
+ sig do
355
+ returns(
356
+ T.nilable(
357
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval
358
+ )
359
+ )
360
+ end
361
+ attr_reader :approval
362
+
363
+ sig do
364
+ params(
365
+ approval:
366
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::OrHash
367
+ ).void
368
+ end
369
+ attr_writer :approval
370
+
371
+ # If your application declines the authorization, this contains details about the
372
+ # decline.
373
+ sig do
374
+ returns(
375
+ T.nilable(
376
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline
377
+ )
378
+ )
379
+ end
380
+ attr_reader :decline
381
+
382
+ sig do
383
+ params(
384
+ decline:
385
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::OrHash
386
+ ).void
387
+ end
388
+ attr_writer :decline
389
+
350
390
  # The reason the card authorization was declined. This translates to a specific
351
- # decline code that is sent to the card network.
391
+ # decline code that is sent to the card network. This field is deprecated, please
392
+ # transition to using the `decline` object as this field will be removed in a
393
+ # future release.
352
394
  sig do
353
395
  returns(
354
396
  T.nilable(
@@ -372,6 +414,10 @@ module Increase
372
414
  params(
373
415
  decision:
374
416
  Increase::RealTimeDecisionActionParams::CardAuthorization::Decision::OrSymbol,
417
+ approval:
418
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::OrHash,
419
+ decline:
420
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::OrHash,
375
421
  decline_reason:
376
422
  Increase::RealTimeDecisionActionParams::CardAuthorization::DeclineReason::OrSymbol
377
423
  ).returns(T.attached_class)
@@ -379,8 +425,18 @@ module Increase
379
425
  def self.new(
380
426
  # Whether the card authorization should be approved or declined.
381
427
  decision:,
428
+ # If your application approves the authorization, this contains metadata about
429
+ # your decision to approve. Your response here is advisory to the acquiring bank.
430
+ # The bank may choose to reverse the authorization if you approve the transaction
431
+ # but indicate the address does not match.
432
+ approval: nil,
433
+ # If your application declines the authorization, this contains details about the
434
+ # decline.
435
+ decline: nil,
382
436
  # The reason the card authorization was declined. This translates to a specific
383
- # decline code that is sent to the card network.
437
+ # decline code that is sent to the card network. This field is deprecated, please
438
+ # transition to using the `decline` object as this field will be removed in a
439
+ # future release.
384
440
  decline_reason: nil
385
441
  )
386
442
  end
@@ -390,6 +446,10 @@ module Increase
390
446
  {
391
447
  decision:
392
448
  Increase::RealTimeDecisionActionParams::CardAuthorization::Decision::OrSymbol,
449
+ approval:
450
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval,
451
+ decline:
452
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline,
393
453
  decline_reason:
394
454
  Increase::RealTimeDecisionActionParams::CardAuthorization::DeclineReason::OrSymbol
395
455
  }
@@ -436,8 +496,339 @@ module Increase
436
496
  end
437
497
  end
438
498
 
499
+ class Approval < Increase::Internal::Type::BaseModel
500
+ OrHash =
501
+ T.type_alias do
502
+ T.any(
503
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval,
504
+ Increase::Internal::AnyHash
505
+ )
506
+ end
507
+
508
+ # Your decisions on whether or not each provided address component is a match.
509
+ # Your response here is evaluated against the customer's provided `postal_code`
510
+ # and `line1`, and an appropriate network response is generated. For example, if
511
+ # you would like to approve all transactions for a given card, you can submit
512
+ # `match` for both `postal_code` and `line1` and Increase will generate an
513
+ # approval with an Address Verification System (AVS) code that will match all of
514
+ # the available address information, or will report that no check was performed if
515
+ # no address information is available. If you do not provide a response, the
516
+ # address verification result will be calculated by Increase using the available
517
+ # address information available on the card. If none is available, Increase will
518
+ # report that no check was performed.
519
+ sig do
520
+ returns(
521
+ T.nilable(
522
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult
523
+ )
524
+ )
525
+ end
526
+ attr_reader :cardholder_address_verification_result
527
+
528
+ sig do
529
+ params(
530
+ cardholder_address_verification_result:
531
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::OrHash
532
+ ).void
533
+ end
534
+ attr_writer :cardholder_address_verification_result
535
+
536
+ # If your application approves the authorization, this contains metadata about
537
+ # your decision to approve. Your response here is advisory to the acquiring bank.
538
+ # The bank may choose to reverse the authorization if you approve the transaction
539
+ # but indicate the address does not match.
540
+ sig do
541
+ params(
542
+ cardholder_address_verification_result:
543
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::OrHash
544
+ ).returns(T.attached_class)
545
+ end
546
+ def self.new(
547
+ # Your decisions on whether or not each provided address component is a match.
548
+ # Your response here is evaluated against the customer's provided `postal_code`
549
+ # and `line1`, and an appropriate network response is generated. For example, if
550
+ # you would like to approve all transactions for a given card, you can submit
551
+ # `match` for both `postal_code` and `line1` and Increase will generate an
552
+ # approval with an Address Verification System (AVS) code that will match all of
553
+ # the available address information, or will report that no check was performed if
554
+ # no address information is available. If you do not provide a response, the
555
+ # address verification result will be calculated by Increase using the available
556
+ # address information available on the card. If none is available, Increase will
557
+ # report that no check was performed.
558
+ cardholder_address_verification_result: nil
559
+ )
560
+ end
561
+
562
+ sig do
563
+ override.returns(
564
+ {
565
+ cardholder_address_verification_result:
566
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult
567
+ }
568
+ )
569
+ end
570
+ def to_hash
571
+ end
572
+
573
+ class CardholderAddressVerificationResult < Increase::Internal::Type::BaseModel
574
+ OrHash =
575
+ T.type_alias do
576
+ T.any(
577
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult,
578
+ Increase::Internal::AnyHash
579
+ )
580
+ end
581
+
582
+ # Your decision on the address line of the provided address.
583
+ sig do
584
+ returns(
585
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1::OrSymbol
586
+ )
587
+ end
588
+ attr_accessor :line1
589
+
590
+ # Your decision on the postal code of the provided address.
591
+ sig do
592
+ returns(
593
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode::OrSymbol
594
+ )
595
+ end
596
+ attr_accessor :postal_code
597
+
598
+ # Your decisions on whether or not each provided address component is a match.
599
+ # Your response here is evaluated against the customer's provided `postal_code`
600
+ # and `line1`, and an appropriate network response is generated. For example, if
601
+ # you would like to approve all transactions for a given card, you can submit
602
+ # `match` for both `postal_code` and `line1` and Increase will generate an
603
+ # approval with an Address Verification System (AVS) code that will match all of
604
+ # the available address information, or will report that no check was performed if
605
+ # no address information is available. If you do not provide a response, the
606
+ # address verification result will be calculated by Increase using the available
607
+ # address information available on the card. If none is available, Increase will
608
+ # report that no check was performed.
609
+ sig do
610
+ params(
611
+ line1:
612
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1::OrSymbol,
613
+ postal_code:
614
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode::OrSymbol
615
+ ).returns(T.attached_class)
616
+ end
617
+ def self.new(
618
+ # Your decision on the address line of the provided address.
619
+ line1:,
620
+ # Your decision on the postal code of the provided address.
621
+ postal_code:
622
+ )
623
+ end
624
+
625
+ sig do
626
+ override.returns(
627
+ {
628
+ line1:
629
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1::OrSymbol,
630
+ postal_code:
631
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode::OrSymbol
632
+ }
633
+ )
634
+ end
635
+ def to_hash
636
+ end
637
+
638
+ # Your decision on the address line of the provided address.
639
+ module Line1
640
+ extend Increase::Internal::Type::Enum
641
+
642
+ TaggedSymbol =
643
+ T.type_alias do
644
+ T.all(
645
+ Symbol,
646
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1
647
+ )
648
+ end
649
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
650
+
651
+ # The cardholder address verification result matches the address provided by the merchant.
652
+ MATCH =
653
+ T.let(
654
+ :match,
655
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1::TaggedSymbol
656
+ )
657
+
658
+ # The cardholder address verification result does not match the address provided by the merchant.
659
+ NO_MATCH =
660
+ T.let(
661
+ :no_match,
662
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1::TaggedSymbol
663
+ )
664
+
665
+ sig do
666
+ override.returns(
667
+ T::Array[
668
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1::TaggedSymbol
669
+ ]
670
+ )
671
+ end
672
+ def self.values
673
+ end
674
+ end
675
+
676
+ # Your decision on the postal code of the provided address.
677
+ module PostalCode
678
+ extend Increase::Internal::Type::Enum
679
+
680
+ TaggedSymbol =
681
+ T.type_alias do
682
+ T.all(
683
+ Symbol,
684
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode
685
+ )
686
+ end
687
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
688
+
689
+ # The cardholder address verification result matches the address provided by the merchant.
690
+ MATCH =
691
+ T.let(
692
+ :match,
693
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode::TaggedSymbol
694
+ )
695
+
696
+ # The cardholder address verification result does not match the address provided by the merchant.
697
+ NO_MATCH =
698
+ T.let(
699
+ :no_match,
700
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode::TaggedSymbol
701
+ )
702
+
703
+ sig do
704
+ override.returns(
705
+ T::Array[
706
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode::TaggedSymbol
707
+ ]
708
+ )
709
+ end
710
+ def self.values
711
+ end
712
+ end
713
+ end
714
+ end
715
+
716
+ class Decline < Increase::Internal::Type::BaseModel
717
+ OrHash =
718
+ T.type_alias do
719
+ T.any(
720
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline,
721
+ Increase::Internal::AnyHash
722
+ )
723
+ end
724
+
725
+ # The reason the card authorization was declined. This translates to a specific
726
+ # decline code that is sent to the card network.
727
+ sig do
728
+ returns(
729
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::OrSymbol
730
+ )
731
+ end
732
+ attr_accessor :reason
733
+
734
+ # If your application declines the authorization, this contains details about the
735
+ # decline.
736
+ sig do
737
+ params(
738
+ reason:
739
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::OrSymbol
740
+ ).returns(T.attached_class)
741
+ end
742
+ def self.new(
743
+ # The reason the card authorization was declined. This translates to a specific
744
+ # decline code that is sent to the card network.
745
+ reason:
746
+ )
747
+ end
748
+
749
+ sig do
750
+ override.returns(
751
+ {
752
+ reason:
753
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::OrSymbol
754
+ }
755
+ )
756
+ end
757
+ def to_hash
758
+ end
759
+
760
+ # The reason the card authorization was declined. This translates to a specific
761
+ # decline code that is sent to the card network.
762
+ module Reason
763
+ extend Increase::Internal::Type::Enum
764
+
765
+ TaggedSymbol =
766
+ T.type_alias do
767
+ T.all(
768
+ Symbol,
769
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason
770
+ )
771
+ end
772
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
773
+
774
+ # The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again.
775
+ INSUFFICIENT_FUNDS =
776
+ T.let(
777
+ :insufficient_funds,
778
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::TaggedSymbol
779
+ )
780
+
781
+ # This type of transaction is not allowed for this card. This transaction should not be retried.
782
+ TRANSACTION_NEVER_ALLOWED =
783
+ T.let(
784
+ :transaction_never_allowed,
785
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::TaggedSymbol
786
+ )
787
+
788
+ # The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again.
789
+ EXCEEDS_APPROVAL_LIMIT =
790
+ T.let(
791
+ :exceeds_approval_limit,
792
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::TaggedSymbol
793
+ )
794
+
795
+ # The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again.
796
+ CARD_TEMPORARILY_DISABLED =
797
+ T.let(
798
+ :card_temporarily_disabled,
799
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::TaggedSymbol
800
+ )
801
+
802
+ # The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.
803
+ SUSPECTED_FRAUD =
804
+ T.let(
805
+ :suspected_fraud,
806
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::TaggedSymbol
807
+ )
808
+
809
+ # The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly.
810
+ OTHER =
811
+ T.let(
812
+ :other,
813
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::TaggedSymbol
814
+ )
815
+
816
+ sig do
817
+ override.returns(
818
+ T::Array[
819
+ Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason::TaggedSymbol
820
+ ]
821
+ )
822
+ end
823
+ def self.values
824
+ end
825
+ end
826
+ end
827
+
439
828
  # The reason the card authorization was declined. This translates to a specific
440
- # decline code that is sent to the card network.
829
+ # decline code that is sent to the card network. This field is deprecated, please
830
+ # transition to using the `decline` object as this field will be removed in a
831
+ # future release.
441
832
  module DeclineReason
442
833
  extend Increase::Internal::Type::Enum
443
834
 
@@ -521,6 +912,8 @@ module Increase
521
912
  end
522
913
  attr_accessor :result
523
914
 
915
+ # If your application was able to deliver the one-time passcode, this contains
916
+ # metadata about the delivery. Exactly one of `phone` or `email` must be provided.
524
917
  sig do
525
918
  returns(
526
919
  T.nilable(
@@ -551,6 +944,8 @@ module Increase
551
944
  def self.new(
552
945
  # Whether your application was able to deliver the one-time passcode.
553
946
  result:,
947
+ # If your application was able to deliver the one-time passcode, this contains
948
+ # metadata about the delivery. Exactly one of `phone` or `email` must be provided.
554
949
  success: nil
555
950
  )
556
951
  end
@@ -630,6 +1025,8 @@ module Increase
630
1025
  sig { params(phone: String).void }
631
1026
  attr_writer :phone
632
1027
 
1028
+ # If your application was able to deliver the one-time passcode, this contains
1029
+ # metadata about the delivery. Exactly one of `phone` or `email` must be provided.
633
1030
  sig { params(email: String, phone: String).returns(T.attached_class) }
634
1031
  def self.new(
635
1032
  # The email address that was used to verify the cardholder via one-time passcode.