lithic 0.1.0.pre.alpha.1

data/rbi/lib/lithic/models/settlement_report.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class SettlementReport < Lithic::BaseModel
+      # Date and time when the transaction first occurred. UTC time zone.
+      sig { returns(Time) }
+      attr_accessor :created
+
+      # 3-character alphabetic ISO 4217 code. (This field is deprecated and will be
+      #   removed in a future version of the API.)
+      sig { returns(String) }
+      attr_accessor :currency
+
+      sig { returns(T::Array[Lithic::Models::SettlementSummaryDetails]) }
+      attr_accessor :details
+
+      # The total gross amount of disputes settlements. (This field is deprecated and
+      #   will be removed in a future version of the API. To compute total amounts, Lithic
+      #   recommends that customers sum the relevant settlement amounts found within
+      #   `details`.)
+      sig { returns(Integer) }
+      attr_accessor :disputes_gross_amount
+
+      # The total amount of interchange. (This field is deprecated and will be removed
+      #   in a future version of the API. To compute total amounts, Lithic recommends that
+      #   customers sum the relevant settlement amounts found within `details`.)
+      sig { returns(Integer) }
+      attr_accessor :interchange_gross_amount
+
+      # Indicates that all data expected on the given report date is available.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_complete
+
+      # Total amount of gross other fees outside of interchange. (This field is
+      #   deprecated and will be removed in a future version of the API. To compute total
+      #   amounts, Lithic recommends that customers sum the relevant settlement amounts
+      #   found within `details`.)
+      sig { returns(Integer) }
+      attr_accessor :other_fees_gross_amount
+
+      # Date of when the report was first generated.
+      sig { returns(String) }
+      attr_accessor :report_date
+
+      # The total net amount of cash moved. (net value of settled_gross_amount,
+      #   interchange, fees). (This field is deprecated and will be removed in a future
+      #   version of the API. To compute total amounts, Lithic recommends that customers
+      #   sum the relevant settlement amounts found within `details`.)
+      sig { returns(Integer) }
+      attr_accessor :settled_net_amount
+
+      # The total amount of settlement impacting transactions (excluding interchange,
+      #   fees, and disputes). (This field is deprecated and will be removed in a future
+      #   version of the API. To compute total amounts, Lithic recommends that customers
+      #   sum the relevant settlement amounts found within `details`.)
+      sig { returns(Integer) }
+      attr_accessor :transactions_gross_amount
+
+      # Date and time when the transaction first occurred. UTC time zone.
+      sig { returns(Time) }
+      attr_accessor :updated
+
+      sig do
+        params(
+          created: Time,
+          currency: String,
+          details: T::Array[T.any(Lithic::Models::SettlementSummaryDetails, Lithic::Util::AnyHash)],
+          disputes_gross_amount: Integer,
+          interchange_gross_amount: Integer,
+          is_complete: T::Boolean,
+          other_fees_gross_amount: Integer,
+          report_date: String,
+          settled_net_amount: Integer,
+          transactions_gross_amount: Integer,
+          updated: Time
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        created:,
+        currency:,
+        details:,
+        disputes_gross_amount:,
+        interchange_gross_amount:,
+        is_complete:,
+        other_fees_gross_amount:,
+        report_date:,
+        settled_net_amount:,
+        transactions_gross_amount:,
+        updated:
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              created: Time,
+              currency: String,
+              details: T::Array[Lithic::Models::SettlementSummaryDetails],
+              disputes_gross_amount: Integer,
+              interchange_gross_amount: Integer,
+              is_complete: T::Boolean,
+              other_fees_gross_amount: Integer,
+              report_date: String,
+              settled_net_amount: Integer,
+              transactions_gross_amount: Integer,
+              updated: Time
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/settlement_summary_details.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class SettlementSummaryDetails < Lithic::BaseModel
+      # 3-character alphabetic ISO 4217 code.
+      sig { returns(T.nilable(String)) }
+      attr_reader :currency
+
+      sig { params(currency: String).void }
+      attr_writer :currency
+
+      # The total gross amount of disputes settlements.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :disputes_gross_amount
+
+      sig { params(disputes_gross_amount: Integer).void }
+      attr_writer :disputes_gross_amount
+
+      # The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
+      #   for Visa).
+      sig { returns(T.nilable(String)) }
+      attr_reader :institution
+
+      sig { params(institution: String).void }
+      attr_writer :institution
+
+      # The total amount of interchange.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :interchange_gross_amount
+
+      sig { params(interchange_gross_amount: Integer).void }
+      attr_writer :interchange_gross_amount
+
+      # Card network where the transaction took place
+      sig { returns(T.nilable(Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol)) }
+      attr_reader :network
+
+      sig { params(network: Lithic::Models::SettlementSummaryDetails::Network::OrSymbol).void }
+      attr_writer :network
+
+      # Total amount of gross other fees outside of interchange.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :other_fees_gross_amount
+
+      sig { params(other_fees_gross_amount: Integer).void }
+      attr_writer :other_fees_gross_amount
+
+      # The total net amount of cash moved. (net value of settled_gross_amount,
+      #   interchange, fees).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :settled_net_amount
+
+      sig { params(settled_net_amount: Integer).void }
+      attr_writer :settled_net_amount
+
+      # The total amount of settlement impacting transactions (excluding interchange,
+      #   fees, and disputes).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :transactions_gross_amount
+
+      sig { params(transactions_gross_amount: Integer).void }
+      attr_writer :transactions_gross_amount
+
+      sig do
+        params(
+          currency: String,
+          disputes_gross_amount: Integer,
+          institution: String,
+          interchange_gross_amount: Integer,
+          network: Lithic::Models::SettlementSummaryDetails::Network::OrSymbol,
+          other_fees_gross_amount: Integer,
+          settled_net_amount: Integer,
+          transactions_gross_amount: Integer
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        currency: nil,
+        disputes_gross_amount: nil,
+        institution: nil,
+        interchange_gross_amount: nil,
+        network: nil,
+        other_fees_gross_amount: nil,
+        settled_net_amount: nil,
+        transactions_gross_amount: nil
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              currency: String,
+              disputes_gross_amount: Integer,
+              institution: String,
+              interchange_gross_amount: Integer,
+              network: Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol,
+              other_fees_gross_amount: Integer,
+              settled_net_amount: Integer,
+              transactions_gross_amount: Integer
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # Card network where the transaction took place
+      module Network
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::SettlementSummaryDetails::Network) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol) }
+
+        INTERLINK = T.let(:INTERLINK, Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol)
+        MAESTRO = T.let(:MAESTRO, Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol)
+        MASTERCARD = T.let(:MASTERCARD, Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol)
+        UNKNOWN = T.let(:UNKNOWN, Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol)
+        VISA = T.let(:VISA, Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::SettlementSummaryDetails::Network::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/shipping_address.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class ShippingAddress < Lithic::BaseModel
+      # Valid USPS routable address.
+      sig { returns(String) }
+      attr_accessor :address1
+
+      # City
+      sig { returns(String) }
+      attr_accessor :city
+
+      # Uppercase ISO 3166-1 alpha-3 three character abbreviation.
+      sig { returns(String) }
+      attr_accessor :country
+
+      # Customer's first name. This will be the first name printed on the physical card.
+      #   The combined length of `first_name` and `last_name` may not exceed 25
+      #   characters.
+      sig { returns(String) }
+      attr_accessor :first_name
+
+      # Customer's surname (family name). This will be the last name printed on the
+      #   physical card. The combined length of `first_name` and `last_name` may not
+      #   exceed 25 characters.
+      sig { returns(String) }
+      attr_accessor :last_name
+
+      # Postal code (formerly zipcode). For US addresses, either five-digit postal code
+      #   or nine-digit postal code (ZIP+4) using the format 12345-1234.
+      sig { returns(String) }
+      attr_accessor :postal_code
+
+      # Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a
+      #   limit of 24 characters for other countries.
+      sig { returns(String) }
+      attr_accessor :state
+
+      # Unit number (if applicable).
+      sig { returns(T.nilable(String)) }
+      attr_reader :address2
+
+      sig { params(address2: String).void }
+      attr_writer :address2
+
+      # Email address to be contacted for expedited shipping process purposes. Required
+      #   if `shipping_method` is `EXPEDITED`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # Text to be printed on line two of the physical card. Use of this field requires
+      #   additional permissions.
+      sig { returns(T.nilable(String)) }
+      attr_reader :line2_text
+
+      sig { params(line2_text: String).void }
+      attr_writer :line2_text
+
+      # Cardholder's phone number in E.164 format to be contacted for expedited shipping
+      #   process purposes. Required if `shipping_method` is `EXPEDITED`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone_number
+
+      sig { params(phone_number: String).void }
+      attr_writer :phone_number
+
+      sig do
+        params(
+          address1: String,
+          city: String,
+          country: String,
+          first_name: String,
+          last_name: String,
+          postal_code: String,
+          state: String,
+          address2: String,
+          email: String,
+          line2_text: String,
+          phone_number: String
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        address1:,
+        city:,
+        country:,
+        first_name:,
+        last_name:,
+        postal_code:,
+        state:,
+        address2: nil,
+        email: nil,
+        line2_text: nil,
+        phone_number: nil
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              address1: String,
+              city: String,
+              country: String,
+              first_name: String,
+              last_name: String,
+              postal_code: String,
+              state: String,
+              address2: String,
+              email: String,
+              line2_text: String,
+              phone_number: String
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/spend_limit_duration.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Lithic
+  module Models
+    # Spend limit duration values:
+    #
+    #   - `ANNUALLY` - Card will authorize transactions up to spend limit for the
+    #     trailing year.
+    #   - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
+    #     of the card.
+    #   - `MONTHLY` - Card will authorize transactions up to spend limit for the
+    #     trailing month. To support recurring monthly payments, which can occur on
+    #     different day every month, the time window we consider for monthly velocity
+    #     starts 6 days after the current calendar date one month prior.
+    #   - `TRANSACTION` - Card will authorize multiple transactions if each individual
+    #     transaction is under the spend limit.
+    module SpendLimitDuration
+      extend Lithic::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::SpendLimitDuration) }
+      OrSymbol = T.type_alias { T.any(Symbol, Lithic::Models::SpendLimitDuration::TaggedSymbol) }
+
+      ANNUALLY = T.let(:ANNUALLY, Lithic::Models::SpendLimitDuration::TaggedSymbol)
+      FOREVER = T.let(:FOREVER, Lithic::Models::SpendLimitDuration::TaggedSymbol)
+      MONTHLY = T.let(:MONTHLY, Lithic::Models::SpendLimitDuration::TaggedSymbol)
+      TRANSACTION = T.let(:TRANSACTION, Lithic::Models::SpendLimitDuration::TaggedSymbol)
+
+      sig { override.returns(T::Array[Lithic::Models::SpendLimitDuration::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/three_ds/authentication_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module ThreeDS
+      class AuthenticationRetrieveParams < Lithic::BaseModel
+        extend Lithic::RequestParameters::Converter
+        include Lithic::RequestParameters
+
+        sig do
+          params(
+            request_options: T.any(
+              Lithic::RequestOptions,
+              Lithic::Util::AnyHash
+            )
+          ).returns(T.attached_class)
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({request_options: Lithic::RequestOptions}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end