increase 1.19.0 → 1.21.0

data/rbi/increase/models/pending_transaction.rbi

@@ -889,6 +889,24 @@ module Increase
           end
           attr_accessor :actioner
 
+          # Additional amounts associated with the card authorization, such as ATM
+          # surcharges fees. These are usually a subset of the `amount` field and are used
+          # to provide more detailed information about the transaction.
+          sig do
+            returns(
+              Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts
+            )
+          end
+          attr_reader :additional_amounts
+
+          sig do
+            params(
+              additional_amounts:
+                Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::OrHash
+            ).void
+          end
+          attr_writer :additional_amounts
+
           # The pending amount in the minor unit of the transaction's currency. For dollars,
           # for example, this is cents.
           sig { returns(Integer) }
@@ -1065,6 +1083,8 @@ module Increase
               id: String,
               actioner:
                 Increase::PendingTransaction::Source::CardAuthorization::Actioner::OrSymbol,
+              additional_amounts:
+                Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::OrHash,
               amount: Integer,
               card_payment_id: String,
               currency:
@@ -1105,6 +1125,10 @@ module Increase
             # Whether this authorization was approved by Increase, the card network through
             # stand-in processing, or the user through a real-time decision.
             actioner:,
+            # Additional amounts associated with the card authorization, such as ATM
+            # surcharges fees. These are usually a subset of the `amount` field and are used
+            # to provide more detailed information about the transaction.
+            additional_amounts:,
             # The pending amount in the minor unit of the transaction's currency. For dollars,
             # for example, this is cents.
             amount:,
@@ -1179,6 +1203,8 @@ module Increase
                 id: String,
                 actioner:
                   Increase::PendingTransaction::Source::CardAuthorization::Actioner::TaggedSymbol,
+                additional_amounts:
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts,
                 amount: Integer,
                 card_payment_id: String,
                 currency:
@@ -1263,6 +1289,648 @@ module Increase
             end
           end
 
+          class AdditionalAmounts < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # The part of this transaction amount that was for clinic-related services.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic
+                )
+              )
+            end
+            attr_reader :clinic
+
+            sig do
+              params(
+                clinic:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic::OrHash
+                  )
+              ).void
+            end
+            attr_writer :clinic
+
+            # The part of this transaction amount that was for dental-related services.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental
+                )
+              )
+            end
+            attr_reader :dental
+
+            sig do
+              params(
+                dental:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental::OrHash
+                  )
+              ).void
+            end
+            attr_writer :dental
+
+            # The part of this transaction amount that was for healthcare prescriptions.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription
+                )
+              )
+            end
+            attr_reader :prescription
+
+            sig do
+              params(
+                prescription:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription::OrHash
+                  )
+              ).void
+            end
+            attr_writer :prescription
+
+            # The surcharge amount charged for this transaction by the merchant.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge
+                )
+              )
+            end
+            attr_reader :surcharge
+
+            sig do
+              params(
+                surcharge:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge::OrHash
+                  )
+              ).void
+            end
+            attr_writer :surcharge
+
+            # The total amount of a series of incremental authorizations, optionally provided.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative
+                )
+              )
+            end
+            attr_reader :total_cumulative
+
+            sig do
+              params(
+                total_cumulative:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative::OrHash
+                  )
+              ).void
+            end
+            attr_writer :total_cumulative
+
+            # The total amount of healthcare-related additional amounts.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare
+                )
+              )
+            end
+            attr_reader :total_healthcare
+
+            sig do
+              params(
+                total_healthcare:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare::OrHash
+                  )
+              ).void
+            end
+            attr_writer :total_healthcare
+
+            # The part of this transaction amount that was for transit-related services.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit
+                )
+              )
+            end
+            attr_reader :transit
+
+            sig do
+              params(
+                transit:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit::OrHash
+                  )
+              ).void
+            end
+            attr_writer :transit
+
+            # An unknown additional amount.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown
+                )
+              )
+            end
+            attr_reader :unknown
+
+            sig do
+              params(
+                unknown:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown::OrHash
+                  )
+              ).void
+            end
+            attr_writer :unknown
+
+            # The part of this transaction amount that was for vision-related services.
+            sig do
+              returns(
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision
+                )
+              )
+            end
+            attr_reader :vision
+
+            sig do
+              params(
+                vision:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision::OrHash
+                  )
+              ).void
+            end
+            attr_writer :vision
+
+            # Additional amounts associated with the card authorization, such as ATM
+            # surcharges fees. These are usually a subset of the `amount` field and are used
+            # to provide more detailed information about the transaction.
+            sig do
+              params(
+                clinic:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic::OrHash
+                  ),
+                dental:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental::OrHash
+                  ),
+                prescription:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription::OrHash
+                  ),
+                surcharge:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge::OrHash
+                  ),
+                total_cumulative:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative::OrHash
+                  ),
+                total_healthcare:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare::OrHash
+                  ),
+                transit:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit::OrHash
+                  ),
+                unknown:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown::OrHash
+                  ),
+                vision:
+                  T.nilable(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision::OrHash
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The part of this transaction amount that was for clinic-related services.
+              clinic:,
+              # The part of this transaction amount that was for dental-related services.
+              dental:,
+              # The part of this transaction amount that was for healthcare prescriptions.
+              prescription:,
+              # The surcharge amount charged for this transaction by the merchant.
+              surcharge:,
+              # The total amount of a series of incremental authorizations, optionally provided.
+              total_cumulative:,
+              # The total amount of healthcare-related additional amounts.
+              total_healthcare:,
+              # The part of this transaction amount that was for transit-related services.
+              transit:,
+              # An unknown additional amount.
+              unknown:,
+              # The part of this transaction amount that was for vision-related services.
+              vision:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  clinic:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic
+                    ),
+                  dental:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental
+                    ),
+                  prescription:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription
+                    ),
+                  surcharge:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge
+                    ),
+                  total_cumulative:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative
+                    ),
+                  total_healthcare:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare
+                    ),
+                  transit:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit
+                    ),
+                  unknown:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown
+                    ),
+                  vision:
+                    T.nilable(
+                      Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision
+                    )
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Clinic < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The part of this transaction amount that was for clinic-related services.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class Dental < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The part of this transaction amount that was for dental-related services.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class Prescription < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The part of this transaction amount that was for healthcare prescriptions.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class Surcharge < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The surcharge amount charged for this transaction by the merchant.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class TotalCumulative < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The total amount of a series of incremental authorizations, optionally provided.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class TotalHealthcare < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The total amount of healthcare-related additional amounts.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class Transit < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The part of this transaction amount that was for transit-related services.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class Unknown < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # An unknown additional amount.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+
+            class Vision < Increase::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Increase::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision,
+                    Increase::Internal::AnyHash
+                  )
+                end
+
+              # The amount in minor units of the `currency` field.
+              sig { returns(Integer) }
+              attr_accessor :amount
+
+              # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+              # amount's currency.
+              sig { returns(String) }
+              attr_accessor :currency
+
+              # The part of this transaction amount that was for vision-related services.
+              sig do
+                params(amount: Integer, currency: String).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # The amount in minor units of the `currency` field.
+                amount:,
+                # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                # amount's currency.
+                currency:
+              )
+              end
+
+              sig { override.returns({ amount: Integer, currency: String }) }
+              def to_hash
+              end
+            end
+          end
+
           # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
           # transaction's currency.
           module Currency