increase 1.86.0 → 1.88.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.
@@ -828,7 +828,9 @@ module Increase
828
828
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#clinic
829
829
  class Clinic < Increase::Internal::Type::BaseModel
830
830
  # @!attribute amount
831
- # The amount in minor units of the `currency` field.
831
+ # The amount in minor units of the `currency` field. The amount is positive if it
832
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
833
+ # subtracted from the amount (such as a discount).
832
834
  #
833
835
  # @return [Integer]
834
836
  required :amount, Integer
@@ -847,7 +849,7 @@ module Increase
847
849
  #
848
850
  # The part of this transaction amount that was for clinic-related services.
849
851
  #
850
- # @param amount [Integer] The amount in minor units of the `currency` field.
852
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
851
853
  #
852
854
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
853
855
  end
@@ -855,7 +857,9 @@ module Increase
855
857
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#dental
856
858
  class Dental < Increase::Internal::Type::BaseModel
857
859
  # @!attribute amount
858
- # The amount in minor units of the `currency` field.
860
+ # The amount in minor units of the `currency` field. The amount is positive if it
861
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
862
+ # subtracted from the amount (such as a discount).
859
863
  #
860
864
  # @return [Integer]
861
865
  required :amount, Integer
@@ -874,7 +878,7 @@ module Increase
874
878
  #
875
879
  # The part of this transaction amount that was for dental-related services.
876
880
  #
877
- # @param amount [Integer] The amount in minor units of the `currency` field.
881
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
878
882
  #
879
883
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
880
884
  end
@@ -882,7 +886,9 @@ module Increase
882
886
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#prescription
883
887
  class Prescription < Increase::Internal::Type::BaseModel
884
888
  # @!attribute amount
885
- # The amount in minor units of the `currency` field.
889
+ # The amount in minor units of the `currency` field. The amount is positive if it
890
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
891
+ # subtracted from the amount (such as a discount).
886
892
  #
887
893
  # @return [Integer]
888
894
  required :amount, Integer
@@ -901,7 +907,7 @@ module Increase
901
907
  #
902
908
  # The part of this transaction amount that was for healthcare prescriptions.
903
909
  #
904
- # @param amount [Integer] The amount in minor units of the `currency` field.
910
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
905
911
  #
906
912
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
907
913
  end
@@ -909,7 +915,9 @@ module Increase
909
915
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#surcharge
910
916
  class Surcharge < Increase::Internal::Type::BaseModel
911
917
  # @!attribute amount
912
- # The amount in minor units of the `currency` field.
918
+ # The amount in minor units of the `currency` field. The amount is positive if it
919
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
920
+ # subtracted from the amount (such as a discount).
913
921
  #
914
922
  # @return [Integer]
915
923
  required :amount, Integer
@@ -928,7 +936,7 @@ module Increase
928
936
  #
929
937
  # The surcharge amount charged for this transaction by the merchant.
930
938
  #
931
- # @param amount [Integer] The amount in minor units of the `currency` field.
939
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
932
940
  #
933
941
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
934
942
  end
@@ -936,7 +944,9 @@ module Increase
936
944
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#total_cumulative
937
945
  class TotalCumulative < Increase::Internal::Type::BaseModel
938
946
  # @!attribute amount
939
- # The amount in minor units of the `currency` field.
947
+ # The amount in minor units of the `currency` field. The amount is positive if it
948
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
949
+ # subtracted from the amount (such as a discount).
940
950
  #
941
951
  # @return [Integer]
942
952
  required :amount, Integer
@@ -955,7 +965,7 @@ module Increase
955
965
  #
956
966
  # The total amount of a series of incremental authorizations, optionally provided.
957
967
  #
958
- # @param amount [Integer] The amount in minor units of the `currency` field.
968
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
959
969
  #
960
970
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
961
971
  end
@@ -963,7 +973,9 @@ module Increase
963
973
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#total_healthcare
964
974
  class TotalHealthcare < Increase::Internal::Type::BaseModel
965
975
  # @!attribute amount
966
- # The amount in minor units of the `currency` field.
976
+ # The amount in minor units of the `currency` field. The amount is positive if it
977
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
978
+ # subtracted from the amount (such as a discount).
967
979
  #
968
980
  # @return [Integer]
969
981
  required :amount, Integer
@@ -982,7 +994,7 @@ module Increase
982
994
  #
983
995
  # The total amount of healthcare-related additional amounts.
984
996
  #
985
- # @param amount [Integer] The amount in minor units of the `currency` field.
997
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
986
998
  #
987
999
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
988
1000
  end
@@ -990,7 +1002,9 @@ module Increase
990
1002
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#transit
991
1003
  class Transit < Increase::Internal::Type::BaseModel
992
1004
  # @!attribute amount
993
- # The amount in minor units of the `currency` field.
1005
+ # The amount in minor units of the `currency` field. The amount is positive if it
1006
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1007
+ # subtracted from the amount (such as a discount).
994
1008
  #
995
1009
  # @return [Integer]
996
1010
  required :amount, Integer
@@ -1009,7 +1023,7 @@ module Increase
1009
1023
  #
1010
1024
  # The part of this transaction amount that was for transit-related services.
1011
1025
  #
1012
- # @param amount [Integer] The amount in minor units of the `currency` field.
1026
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1013
1027
  #
1014
1028
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1015
1029
  end
@@ -1017,7 +1031,9 @@ module Increase
1017
1031
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#unknown
1018
1032
  class Unknown < Increase::Internal::Type::BaseModel
1019
1033
  # @!attribute amount
1020
- # The amount in minor units of the `currency` field.
1034
+ # The amount in minor units of the `currency` field. The amount is positive if it
1035
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1036
+ # subtracted from the amount (such as a discount).
1021
1037
  #
1022
1038
  # @return [Integer]
1023
1039
  required :amount, Integer
@@ -1036,7 +1052,7 @@ module Increase
1036
1052
  #
1037
1053
  # An unknown additional amount.
1038
1054
  #
1039
- # @param amount [Integer] The amount in minor units of the `currency` field.
1055
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1040
1056
  #
1041
1057
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1042
1058
  end
@@ -1044,7 +1060,9 @@ module Increase
1044
1060
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#vision
1045
1061
  class Vision < Increase::Internal::Type::BaseModel
1046
1062
  # @!attribute amount
1047
- # The amount in minor units of the `currency` field.
1063
+ # The amount in minor units of the `currency` field. The amount is positive if it
1064
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1065
+ # subtracted from the amount (such as a discount).
1048
1066
  #
1049
1067
  # @return [Integer]
1050
1068
  required :amount, Integer
@@ -1063,7 +1081,7 @@ module Increase
1063
1081
  #
1064
1082
  # The part of this transaction amount that was for vision-related services.
1065
1083
  #
1066
- # @param amount [Integer] The amount in minor units of the `currency` field.
1084
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1067
1085
  #
1068
1086
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1069
1087
  end
@@ -866,7 +866,9 @@ module Increase
866
866
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#clinic
867
867
  class Clinic < Increase::Internal::Type::BaseModel
868
868
  # @!attribute amount
869
- # The amount in minor units of the `currency` field.
869
+ # The amount in minor units of the `currency` field. The amount is positive if it
870
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
871
+ # subtracted from the amount (such as a discount).
870
872
  #
871
873
  # @return [Integer]
872
874
  required :amount, Integer
@@ -885,7 +887,7 @@ module Increase
885
887
  #
886
888
  # The part of this transaction amount that was for clinic-related services.
887
889
  #
888
- # @param amount [Integer] The amount in minor units of the `currency` field.
890
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
889
891
  #
890
892
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
891
893
  end
@@ -893,7 +895,9 @@ module Increase
893
895
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#dental
894
896
  class Dental < Increase::Internal::Type::BaseModel
895
897
  # @!attribute amount
896
- # The amount in minor units of the `currency` field.
898
+ # The amount in minor units of the `currency` field. The amount is positive if it
899
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
900
+ # subtracted from the amount (such as a discount).
897
901
  #
898
902
  # @return [Integer]
899
903
  required :amount, Integer
@@ -912,7 +916,7 @@ module Increase
912
916
  #
913
917
  # The part of this transaction amount that was for dental-related services.
914
918
  #
915
- # @param amount [Integer] The amount in minor units of the `currency` field.
919
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
916
920
  #
917
921
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
918
922
  end
@@ -920,7 +924,9 @@ module Increase
920
924
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#prescription
921
925
  class Prescription < Increase::Internal::Type::BaseModel
922
926
  # @!attribute amount
923
- # The amount in minor units of the `currency` field.
927
+ # The amount in minor units of the `currency` field. The amount is positive if it
928
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
929
+ # subtracted from the amount (such as a discount).
924
930
  #
925
931
  # @return [Integer]
926
932
  required :amount, Integer
@@ -939,7 +945,7 @@ module Increase
939
945
  #
940
946
  # The part of this transaction amount that was for healthcare prescriptions.
941
947
  #
942
- # @param amount [Integer] The amount in minor units of the `currency` field.
948
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
943
949
  #
944
950
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
945
951
  end
@@ -947,7 +953,9 @@ module Increase
947
953
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#surcharge
948
954
  class Surcharge < Increase::Internal::Type::BaseModel
949
955
  # @!attribute amount
950
- # The amount in minor units of the `currency` field.
956
+ # The amount in minor units of the `currency` field. The amount is positive if it
957
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
958
+ # subtracted from the amount (such as a discount).
951
959
  #
952
960
  # @return [Integer]
953
961
  required :amount, Integer
@@ -966,7 +974,7 @@ module Increase
966
974
  #
967
975
  # The surcharge amount charged for this transaction by the merchant.
968
976
  #
969
- # @param amount [Integer] The amount in minor units of the `currency` field.
977
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
970
978
  #
971
979
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
972
980
  end
@@ -974,7 +982,9 @@ module Increase
974
982
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#total_cumulative
975
983
  class TotalCumulative < Increase::Internal::Type::BaseModel
976
984
  # @!attribute amount
977
- # The amount in minor units of the `currency` field.
985
+ # The amount in minor units of the `currency` field. The amount is positive if it
986
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
987
+ # subtracted from the amount (such as a discount).
978
988
  #
979
989
  # @return [Integer]
980
990
  required :amount, Integer
@@ -993,7 +1003,7 @@ module Increase
993
1003
  #
994
1004
  # The total amount of a series of incremental authorizations, optionally provided.
995
1005
  #
996
- # @param amount [Integer] The amount in minor units of the `currency` field.
1006
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
997
1007
  #
998
1008
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
999
1009
  end
@@ -1001,7 +1011,9 @@ module Increase
1001
1011
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#total_healthcare
1002
1012
  class TotalHealthcare < Increase::Internal::Type::BaseModel
1003
1013
  # @!attribute amount
1004
- # The amount in minor units of the `currency` field.
1014
+ # The amount in minor units of the `currency` field. The amount is positive if it
1015
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1016
+ # subtracted from the amount (such as a discount).
1005
1017
  #
1006
1018
  # @return [Integer]
1007
1019
  required :amount, Integer
@@ -1020,7 +1032,7 @@ module Increase
1020
1032
  #
1021
1033
  # The total amount of healthcare-related additional amounts.
1022
1034
  #
1023
- # @param amount [Integer] The amount in minor units of the `currency` field.
1035
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1024
1036
  #
1025
1037
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1026
1038
  end
@@ -1028,7 +1040,9 @@ module Increase
1028
1040
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#transit
1029
1041
  class Transit < Increase::Internal::Type::BaseModel
1030
1042
  # @!attribute amount
1031
- # The amount in minor units of the `currency` field.
1043
+ # The amount in minor units of the `currency` field. The amount is positive if it
1044
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1045
+ # subtracted from the amount (such as a discount).
1032
1046
  #
1033
1047
  # @return [Integer]
1034
1048
  required :amount, Integer
@@ -1047,7 +1061,7 @@ module Increase
1047
1061
  #
1048
1062
  # The part of this transaction amount that was for transit-related services.
1049
1063
  #
1050
- # @param amount [Integer] The amount in minor units of the `currency` field.
1064
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1051
1065
  #
1052
1066
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1053
1067
  end
@@ -1055,7 +1069,9 @@ module Increase
1055
1069
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#unknown
1056
1070
  class Unknown < Increase::Internal::Type::BaseModel
1057
1071
  # @!attribute amount
1058
- # The amount in minor units of the `currency` field.
1072
+ # The amount in minor units of the `currency` field. The amount is positive if it
1073
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1074
+ # subtracted from the amount (such as a discount).
1059
1075
  #
1060
1076
  # @return [Integer]
1061
1077
  required :amount, Integer
@@ -1074,7 +1090,7 @@ module Increase
1074
1090
  #
1075
1091
  # An unknown additional amount.
1076
1092
  #
1077
- # @param amount [Integer] The amount in minor units of the `currency` field.
1093
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1078
1094
  #
1079
1095
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1080
1096
  end
@@ -1082,7 +1098,9 @@ module Increase
1082
1098
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#vision
1083
1099
  class Vision < Increase::Internal::Type::BaseModel
1084
1100
  # @!attribute amount
1085
- # The amount in minor units of the `currency` field.
1101
+ # The amount in minor units of the `currency` field. The amount is positive if it
1102
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1103
+ # subtracted from the amount (such as a discount).
1086
1104
  #
1087
1105
  # @return [Integer]
1088
1106
  required :amount, Integer
@@ -1101,7 +1119,7 @@ module Increase
1101
1119
  #
1102
1120
  # The part of this transaction amount that was for vision-related services.
1103
1121
  #
1104
- # @param amount [Integer] The amount in minor units of the `currency` field.
1122
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1105
1123
  #
1106
1124
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1107
1125
  end
@@ -587,7 +587,9 @@ module Increase
587
587
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#clinic
588
588
  class Clinic < Increase::Internal::Type::BaseModel
589
589
  # @!attribute amount
590
- # The amount in minor units of the `currency` field.
590
+ # The amount in minor units of the `currency` field. The amount is positive if it
591
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
592
+ # subtracted from the amount (such as a discount).
591
593
  #
592
594
  # @return [Integer]
593
595
  required :amount, Integer
@@ -606,7 +608,7 @@ module Increase
606
608
  #
607
609
  # The part of this transaction amount that was for clinic-related services.
608
610
  #
609
- # @param amount [Integer] The amount in minor units of the `currency` field.
611
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
610
612
  #
611
613
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
612
614
  end
@@ -614,7 +616,9 @@ module Increase
614
616
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#dental
615
617
  class Dental < Increase::Internal::Type::BaseModel
616
618
  # @!attribute amount
617
- # The amount in minor units of the `currency` field.
619
+ # The amount in minor units of the `currency` field. The amount is positive if it
620
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
621
+ # subtracted from the amount (such as a discount).
618
622
  #
619
623
  # @return [Integer]
620
624
  required :amount, Integer
@@ -633,7 +637,7 @@ module Increase
633
637
  #
634
638
  # The part of this transaction amount that was for dental-related services.
635
639
  #
636
- # @param amount [Integer] The amount in minor units of the `currency` field.
640
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
637
641
  #
638
642
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
639
643
  end
@@ -641,7 +645,9 @@ module Increase
641
645
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#prescription
642
646
  class Prescription < Increase::Internal::Type::BaseModel
643
647
  # @!attribute amount
644
- # The amount in minor units of the `currency` field.
648
+ # The amount in minor units of the `currency` field. The amount is positive if it
649
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
650
+ # subtracted from the amount (such as a discount).
645
651
  #
646
652
  # @return [Integer]
647
653
  required :amount, Integer
@@ -660,7 +666,7 @@ module Increase
660
666
  #
661
667
  # The part of this transaction amount that was for healthcare prescriptions.
662
668
  #
663
- # @param amount [Integer] The amount in minor units of the `currency` field.
669
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
664
670
  #
665
671
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
666
672
  end
@@ -668,7 +674,9 @@ module Increase
668
674
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#surcharge
669
675
  class Surcharge < Increase::Internal::Type::BaseModel
670
676
  # @!attribute amount
671
- # The amount in minor units of the `currency` field.
677
+ # The amount in minor units of the `currency` field. The amount is positive if it
678
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
679
+ # subtracted from the amount (such as a discount).
672
680
  #
673
681
  # @return [Integer]
674
682
  required :amount, Integer
@@ -687,7 +695,7 @@ module Increase
687
695
  #
688
696
  # The surcharge amount charged for this transaction by the merchant.
689
697
  #
690
- # @param amount [Integer] The amount in minor units of the `currency` field.
698
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
691
699
  #
692
700
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
693
701
  end
@@ -695,7 +703,9 @@ module Increase
695
703
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#total_cumulative
696
704
  class TotalCumulative < Increase::Internal::Type::BaseModel
697
705
  # @!attribute amount
698
- # The amount in minor units of the `currency` field.
706
+ # The amount in minor units of the `currency` field. The amount is positive if it
707
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
708
+ # subtracted from the amount (such as a discount).
699
709
  #
700
710
  # @return [Integer]
701
711
  required :amount, Integer
@@ -714,7 +724,7 @@ module Increase
714
724
  #
715
725
  # The total amount of a series of incremental authorizations, optionally provided.
716
726
  #
717
- # @param amount [Integer] The amount in minor units of the `currency` field.
727
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
718
728
  #
719
729
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
720
730
  end
@@ -722,7 +732,9 @@ module Increase
722
732
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#total_healthcare
723
733
  class TotalHealthcare < Increase::Internal::Type::BaseModel
724
734
  # @!attribute amount
725
- # The amount in minor units of the `currency` field.
735
+ # The amount in minor units of the `currency` field. The amount is positive if it
736
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
737
+ # subtracted from the amount (such as a discount).
726
738
  #
727
739
  # @return [Integer]
728
740
  required :amount, Integer
@@ -741,7 +753,7 @@ module Increase
741
753
  #
742
754
  # The total amount of healthcare-related additional amounts.
743
755
  #
744
- # @param amount [Integer] The amount in minor units of the `currency` field.
756
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
745
757
  #
746
758
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
747
759
  end
@@ -749,7 +761,9 @@ module Increase
749
761
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#transit
750
762
  class Transit < Increase::Internal::Type::BaseModel
751
763
  # @!attribute amount
752
- # The amount in minor units of the `currency` field.
764
+ # The amount in minor units of the `currency` field. The amount is positive if it
765
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
766
+ # subtracted from the amount (such as a discount).
753
767
  #
754
768
  # @return [Integer]
755
769
  required :amount, Integer
@@ -768,7 +782,7 @@ module Increase
768
782
  #
769
783
  # The part of this transaction amount that was for transit-related services.
770
784
  #
771
- # @param amount [Integer] The amount in minor units of the `currency` field.
785
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
772
786
  #
773
787
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
774
788
  end
@@ -776,7 +790,9 @@ module Increase
776
790
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#unknown
777
791
  class Unknown < Increase::Internal::Type::BaseModel
778
792
  # @!attribute amount
779
- # The amount in minor units of the `currency` field.
793
+ # The amount in minor units of the `currency` field. The amount is positive if it
794
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
795
+ # subtracted from the amount (such as a discount).
780
796
  #
781
797
  # @return [Integer]
782
798
  required :amount, Integer
@@ -795,7 +811,7 @@ module Increase
795
811
  #
796
812
  # An unknown additional amount.
797
813
  #
798
- # @param amount [Integer] The amount in minor units of the `currency` field.
814
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
799
815
  #
800
816
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
801
817
  end
@@ -803,7 +819,9 @@ module Increase
803
819
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#vision
804
820
  class Vision < Increase::Internal::Type::BaseModel
805
821
  # @!attribute amount
806
- # The amount in minor units of the `currency` field.
822
+ # The amount in minor units of the `currency` field. The amount is positive if it
823
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
824
+ # subtracted from the amount (such as a discount).
807
825
  #
808
826
  # @return [Integer]
809
827
  required :amount, Integer
@@ -822,7 +840,7 @@ module Increase
822
840
  #
823
841
  # The part of this transaction amount that was for vision-related services.
824
842
  #
825
- # @param amount [Integer] The amount in minor units of the `currency` field.
843
+ # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
826
844
  #
827
845
  # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
828
846
  end
@@ -10,15 +10,15 @@ module Increase
10
10
  #
11
11
  # @overload create(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {})
12
12
  #
13
- # @param account_id [String] The identifier for the account that will send the transfer.
13
+ # @param account_id [String] The identifier for the originating Account that will send the transfer.
14
14
  #
15
15
  # @param amount [Integer] The transfer amount in the minor unit of the account currency. For dollars, for
16
16
  #
17
- # @param description [String] The description you choose to give the transfer.
17
+ # @param description [String] An internal-facing description for the transfer for display in the API and dashb
18
18
  #
19
- # @param destination_account_id [String] The identifier for the account that will receive the transfer.
19
+ # @param destination_account_id [String] The identifier for the destination Account that will receive the transfer.
20
20
  #
21
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
21
+ # @param require_approval [Boolean] Whether the transfer should require explicit approval via the dashboard or API.
22
22
  #
23
23
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
24
  #
@@ -90,7 +90,7 @@ module Increase
90
90
  )
91
91
  end
92
92
 
93
- # Approve an Account Transfer
93
+ # Approves an Account Transfer in status `pending_approval`.
94
94
  #
95
95
  # @overload approve(account_transfer_id, request_options: {})
96
96
  #
@@ -110,7 +110,7 @@ module Increase
110
110
  )
111
111
  end
112
112
 
113
- # Cancel an Account Transfer
113
+ # Cancels an Account Transfer in status `pending_approval`.
114
114
  #
115
115
  # @overload cancel(account_transfer_id, request_options: {})
116
116
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.86.0"
4
+ VERSION = "1.88.0"
5
5
  end