lithic 0.1.0.pre.alpha.40 → 0.1.0.pre.alpha.42

data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi

@@ -957,26 +957,6 @@ module Lithic
               )
             end
 
-          # Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
-          # `acquirerMerchantId`.
-          sig { returns(String) }
-          attr_accessor :id
-
-          # Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
-          # field `merchantCountryCode`. Permitted values: ISO 3166-1 alpha-3 country code
-          # (e.g., USA).
-          sig { returns(String) }
-          attr_accessor :country
-
-          # Merchant category code assigned to the merchant that describes its business
-          # activity type. Maps to EMV 3DS field `mcc`.
-          sig { returns(String) }
-          attr_accessor :mcc
-
-          # Name of the merchant. Maps to EMV 3DS field `merchantName`.
-          sig { returns(String) }
-          attr_accessor :name
-
           # Object containing additional data indicating additional risk factors related to
           # the e-commerce transaction.
           sig do
@@ -994,46 +974,70 @@ module Lithic
           end
           attr_writer :risk_indicator
 
+          # Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
+          # `acquirerMerchantId`. May not be present for non-payment authentications.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :id
+
+          # Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
+          # field `merchantCountryCode`. Permitted values: ISO 3166-1 alpha-3 country code
+          # (e.g., USA). May not be present for non-payment authentications.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :country
+
+          # Merchant category code assigned to the merchant that describes its business
+          # activity type. Maps to EMV 3DS field `mcc`. May not be present for non-payment
+          # authentications.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :mcc
+
+          # Name of the merchant. Maps to EMV 3DS field `merchantName`. May not be present
+          # for non-payment authentications.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
           # Object containing data about the merchant involved in the e-commerce
           # transaction.
           sig do
             params(
-              id: String,
-              country: String,
-              mcc: String,
-              name: String,
               risk_indicator:
-                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::OrHash
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::OrHash,
+              id: T.nilable(String),
+              country: T.nilable(String),
+              mcc: T.nilable(String),
+              name: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
+            # Object containing additional data indicating additional risk factors related to
+            # the e-commerce transaction.
+            risk_indicator:,
             # Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
-            # `acquirerMerchantId`.
-            id:,
+            # `acquirerMerchantId`. May not be present for non-payment authentications.
+            id: nil,
             # Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
             # field `merchantCountryCode`. Permitted values: ISO 3166-1 alpha-3 country code
-            # (e.g., USA).
-            country:,
+            # (e.g., USA). May not be present for non-payment authentications.
+            country: nil,
             # Merchant category code assigned to the merchant that describes its business
-            # activity type. Maps to EMV 3DS field `mcc`.
-            mcc:,
-            # Name of the merchant. Maps to EMV 3DS field `merchantName`.
-            name:,
-            # Object containing additional data indicating additional risk factors related to
-            # the e-commerce transaction.
-            risk_indicator:
+            # activity type. Maps to EMV 3DS field `mcc`. May not be present for non-payment
+            # authentications.
+            mcc: nil,
+            # Name of the merchant. Maps to EMV 3DS field `merchantName`. May not be present
+            # for non-payment authentications.
+            name: nil
           )
           end
 
           sig do
             override.returns(
               {
-                id: String,
-                country: String,
-                mcc: String,
-                name: String,
                 risk_indicator:
-                  Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator
+                  Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator,
+                id: T.nilable(String),
+                country: T.nilable(String),
+                mcc: T.nilable(String),
+                name: T.nilable(String)
               }
             )
           end
@@ -1624,38 +1628,114 @@ module Lithic
               )
             end
 
-          # Device information gathered from the cardholder's device - JSON name/value pairs
-          # that is Base64url encoded. Maps to EMV 3DS field `deviceInfo`.
+          # Device model: e.g. "Apple iPhone 16".
+          sig { returns(T.nilable(String)) }
+          attr_accessor :device
+
+          # Raw device information - base64-encoded JSON object. Maps to EMV 3DS field
+          # `deviceInfo`.
           sig { returns(T.nilable(String)) }
           attr_accessor :device_info
 
-          # External IP address used by the app generating the 3DS authentication request.
-          # Maps to EMV 3DS field `appIp`.
+          # IP address of the device.
           sig { returns(T.nilable(String)) }
           attr_reader :ip
 
           sig { params(ip: String).void }
           attr_writer :ip
 
+          # Latitude coordinate of current device location.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :latitude
+
+          # Device locale: e.g. "en-US".
+          sig { returns(T.nilable(String)) }
+          attr_accessor :locale
+
+          # Longitude coordinate of current device location.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :longitude
+
+          # Operating System: e.g. "Android 12", "iOS 17.1".
+          sig { returns(T.nilable(String)) }
+          attr_accessor :os
+
+          # Device platform: Android, iOS, Windows, etc.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :platform
+
+          # Screen height in pixels.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :screen_height
+
+          # Screen width in pixels.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :screen_width
+
+          # Time zone offset in minutes between UTC and device local time.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :time_zone
+
           # Object containing data about the app used in the e-commerce transaction. Present
           # if the channel is 'APP_BASED'.
           sig do
-            params(device_info: T.nilable(String), ip: String).returns(
-              T.attached_class
-            )
+            params(
+              device: T.nilable(String),
+              device_info: T.nilable(String),
+              ip: String,
+              latitude: T.nilable(Float),
+              locale: T.nilable(String),
+              longitude: T.nilable(Float),
+              os: T.nilable(String),
+              platform: T.nilable(String),
+              screen_height: T.nilable(Integer),
+              screen_width: T.nilable(Integer),
+              time_zone: T.nilable(String)
+            ).returns(T.attached_class)
           end
           def self.new(
-            # Device information gathered from the cardholder's device - JSON name/value pairs
-            # that is Base64url encoded. Maps to EMV 3DS field `deviceInfo`.
+            # Device model: e.g. "Apple iPhone 16".
+            device: nil,
+            # Raw device information - base64-encoded JSON object. Maps to EMV 3DS field
+            # `deviceInfo`.
             device_info: nil,
-            # External IP address used by the app generating the 3DS authentication request.
-            # Maps to EMV 3DS field `appIp`.
-            ip: nil
+            # IP address of the device.
+            ip: nil,
+            # Latitude coordinate of current device location.
+            latitude: nil,
+            # Device locale: e.g. "en-US".
+            locale: nil,
+            # Longitude coordinate of current device location.
+            longitude: nil,
+            # Operating System: e.g. "Android 12", "iOS 17.1".
+            os: nil,
+            # Device platform: Android, iOS, Windows, etc.
+            platform: nil,
+            # Screen height in pixels.
+            screen_height: nil,
+            # Screen width in pixels.
+            screen_width: nil,
+            # Time zone offset in minutes between UTC and device local time.
+            time_zone: nil
           )
           end
 
           sig do
-            override.returns({ device_info: T.nilable(String), ip: String })
+            override.returns(
+              {
+                device: T.nilable(String),
+                device_info: T.nilable(String),
+                ip: String,
+                latitude: T.nilable(Float),
+                locale: T.nilable(String),
+                longitude: T.nilable(Float),
+                os: T.nilable(String),
+                platform: T.nilable(String),
+                screen_height: T.nilable(Integer),
+                screen_width: T.nilable(Integer),
+                time_zone: T.nilable(String)
+              }
+            )
           end
           def to_hash
           end
@@ -1772,9 +1852,8 @@ module Lithic
           sig { returns(T.nilable(String)) }
           attr_accessor :language
 
-          # Time zone of the cardholder's browser offset in minutes between UTC and the
-          # cardholder browser's local time. The offset is positive if the local time is
-          # behind UTC and negative if it is ahead. Maps to EMV 3DS field `browserTz`.
+          # Time zone offset in minutes between UTC and browser local time. Maps to EMV 3DS
+          # field `browserTz`.
           sig { returns(T.nilable(String)) }
           attr_accessor :time_zone
 
@@ -1811,9 +1890,8 @@ module Lithic
             # Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS
             # field `browserLanguage`.
             language: nil,
-            # Time zone of the cardholder's browser offset in minutes between UTC and the
-            # cardholder browser's local time. The offset is positive if the local time is
-            # behind UTC and negative if it is ahead. Maps to EMV 3DS field `browserTz`.
+            # Time zone offset in minutes between UTC and browser local time. Maps to EMV 3DS
+            # field `browserTz`.
             time_zone: nil,
             # Content of the HTTP user-agent header. Maps to EMV 3DS field `browserUserAgent`.
             user_agent: nil
@@ -1854,6 +1932,29 @@ module Lithic
           end
           attr_accessor :method_type
 
+          # Indicates the status of the challenge
+          #
+          # - SUCCESS - Cardholder completed the challenge successfully
+          # - PENDING - Challenge was issued to the cardholder and was not completed yet
+          # - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
+          #   provided phone number. Relevant only for SMS_OTP method
+          # - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
+          #   given challenge TTL
+          # - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
+          #   "cancel" on the challenge UI
+          # - CANCELED_OOB - Cardholder canceled the challenge out of band
+          # - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
+          #   incorrect OTP more than the allowed number of times or requesting a new OTP
+          #   more than the allowed number of times
+          # - ABORTED - Merchant aborted authentication after a challenge was requested
+          # - ERROR - The challenge failed for a reason different than those documented
+          sig do
+            returns(
+              Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+            )
+          end
+          attr_accessor :status
+
           # The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
           sig { returns(T.nilable(String)) }
           attr_accessor :phone_number
@@ -1864,12 +1965,31 @@ module Lithic
             params(
               method_type:
                 Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType::OrSymbol,
+              status:
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::OrSymbol,
               phone_number: T.nilable(String)
             ).returns(T.attached_class)
           end
           def self.new(
             # The type of challenge method used for authentication.
             method_type:,
+            # Indicates the status of the challenge
+            #
+            # - SUCCESS - Cardholder completed the challenge successfully
+            # - PENDING - Challenge was issued to the cardholder and was not completed yet
+            # - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
+            #   provided phone number. Relevant only for SMS_OTP method
+            # - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
+            #   given challenge TTL
+            # - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
+            #   "cancel" on the challenge UI
+            # - CANCELED_OOB - Cardholder canceled the challenge out of band
+            # - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
+            #   incorrect OTP more than the allowed number of times or requesting a new OTP
+            #   more than the allowed number of times
+            # - ABORTED - Merchant aborted authentication after a challenge was requested
+            # - ERROR - The challenge failed for a reason different than those documented
+            status:,
             # The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
             phone_number: nil
           )
@@ -1880,6 +2000,8 @@ module Lithic
               {
                 method_type:
                   Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType::TaggedSymbol,
+                status:
+                  Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol,
                 phone_number: T.nilable(String)
               }
             )
@@ -1921,6 +2043,91 @@ module Lithic
             def self.values
             end
           end
+
+          # Indicates the status of the challenge
+          #
+          # - SUCCESS - Cardholder completed the challenge successfully
+          # - PENDING - Challenge was issued to the cardholder and was not completed yet
+          # - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
+          #   provided phone number. Relevant only for SMS_OTP method
+          # - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
+          #   given challenge TTL
+          # - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
+          #   "cancel" on the challenge UI
+          # - CANCELED_OOB - Cardholder canceled the challenge out of band
+          # - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
+          #   incorrect OTP more than the allowed number of times or requesting a new OTP
+          #   more than the allowed number of times
+          # - ABORTED - Merchant aborted authentication after a challenge was requested
+          # - ERROR - The challenge failed for a reason different than those documented
+          module Status
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SUCCESS =
+              T.let(
+                :SUCCESS,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            PENDING =
+              T.let(
+                :PENDING,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            SMS_DELIVERY_FAILED =
+              T.let(
+                :SMS_DELIVERY_FAILED,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            CARDHOLDER_TIMEOUT =
+              T.let(
+                :CARDHOLDER_TIMEOUT,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            CANCELED_VIA_CHALLENGE_UI =
+              T.let(
+                :CANCELED_VIA_CHALLENGE_UI,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            CANCELED_OOB =
+              T.let(
+                :CANCELED_OOB,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            ATTEMPTS_EXCEEDED =
+              T.let(
+                :ATTEMPTS_EXCEEDED,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            ABORTED =
+              T.let(
+                :ABORTED,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+            ERROR =
+              T.let(
+                :ERROR,
+                Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         # Entity that orchestrates the challenge. This won't be set for authentications

data/rbi/lithic/models/transaction.rbi

@@ -1813,6 +1813,8 @@ module Lithic
           T.type_alias { T.all(Symbol, Lithic::Transaction::Result) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        ACCOUNT_PAUSED =
+          T.let(:ACCOUNT_PAUSED, Lithic::Transaction::Result::TaggedSymbol)
         ACCOUNT_STATE_TRANSACTION_FAIL =
           T.let(
             :ACCOUNT_STATE_TRANSACTION_FAIL,
@@ -2424,6 +2426,11 @@ module Lithic
               :ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED,
               Lithic::Transaction::Event::DetailedResult::TaggedSymbol
             )
+          ACCOUNT_PAUSED =
+            T.let(
+              :ACCOUNT_PAUSED,
+              Lithic::Transaction::Event::DetailedResult::TaggedSymbol
+            )
           ACCOUNT_UNDER_REVIEW =
             T.let(
               :ACCOUNT_UNDER_REVIEW,
@@ -3069,6 +3076,11 @@ module Lithic
             T.type_alias { T.all(Symbol, Lithic::Transaction::Event::Result) }
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+          ACCOUNT_PAUSED =
+            T.let(
+              :ACCOUNT_PAUSED,
+              Lithic::Transaction::Event::Result::TaggedSymbol
+            )
           ACCOUNT_STATE_TRANSACTION_FAIL =
             T.let(
               :ACCOUNT_STATE_TRANSACTION_FAIL,
@@ -3292,6 +3304,11 @@ module Lithic
                 :ACCOUNT_MONTHLY_SPEND_LIMIT_EXCEEDED,
                 Lithic::Transaction::Event::RuleResult::Result::TaggedSymbol
               )
+            ACCOUNT_PAUSED =
+              T.let(
+                :ACCOUNT_PAUSED,
+                Lithic::Transaction::Event::RuleResult::Result::TaggedSymbol
+              )
             ACCOUNT_UNDER_REVIEW =
               T.let(
                 :ACCOUNT_UNDER_REVIEW,

data/rbi/lithic/models/transfer.rbi

@@ -260,6 +260,7 @@ module Lithic
         sig { params(type: Lithic::Transfer::Event::Type::OrSymbol).void }
         attr_writer :type
 
+        # Financial Event
         sig do
           params(
             token: String,

data/rbi/lithic/models/wire_party_details.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class WirePartyDetails < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Lithic::WirePartyDetails, Lithic::Internal::AnyHash)
+        end
+
+      # Account number
+      sig { returns(T.nilable(String)) }
+      attr_accessor :account_number
+
+      # Routing number or BIC of the financial institution
+      sig { returns(T.nilable(String)) }
+      attr_accessor :agent_id
+
+      # Name of the financial institution
+      sig { returns(T.nilable(String)) }
+      attr_accessor :agent_name
+
+      # Name of the person or company
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig do
+        params(
+          account_number: T.nilable(String),
+          agent_id: T.nilable(String),
+          agent_name: T.nilable(String),
+          name: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Account number
+        account_number: nil,
+        # Routing number or BIC of the financial institution
+        agent_id: nil,
+        # Name of the financial institution
+        agent_name: nil,
+        # Name of the person or company
+        name: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_number: T.nilable(String),
+            agent_id: T.nilable(String),
+            agent_name: T.nilable(String),
+            name: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lithic/models.rbi

@@ -3,6 +3,11 @@
 module Lithic
   Account = Lithic::Models::Account
 
+  AccountActivityListParams = Lithic::Models::AccountActivityListParams
+
+  AccountActivityRetrieveTransactionParams =
+    Lithic::Models::AccountActivityRetrieveTransactionParams
+
   AccountFinancialAccountType = Lithic::Models::AccountFinancialAccountType
 
   AccountHolder = Lithic::Models::AccountHolder
@@ -378,4 +383,6 @@ module Lithic
   TransferCreateParams = Lithic::Models::TransferCreateParams
 
   VerificationMethod = Lithic::Models::VerificationMethod
+
+  WirePartyDetails = Lithic::Models::WirePartyDetails
 end

data/rbi/lithic/resources/account_activity.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class AccountActivity
+      # Retrieve a list of transactions across all public accounts.
+      sig do
+        params(
+          account_token: String,
+          begin_: Time,
+          business_account_token: String,
+          category: Lithic::AccountActivityListParams::Category::OrSymbol,
+          end_: Time,
+          ending_before: String,
+          financial_account_token: String,
+          page_size: Integer,
+          result: Lithic::AccountActivityListParams::Result::OrSymbol,
+          starting_after: String,
+          status: Lithic::AccountActivityListParams::Status::OrSymbol,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(
+          Lithic::Internal::CursorPage[
+            Lithic::Models::AccountActivityListResponse::Variants
+          ]
+        )
+      end
+      def list(
+        # Filter by account token
+        account_token: nil,
+        # Date string in RFC 3339 format. Only entries created after the specified time
+        # will be included. UTC time zone.
+        begin_: nil,
+        # Filter by business account token
+        business_account_token: nil,
+        # Filter by transaction category
+        category: nil,
+        # Date string in RFC 3339 format. Only entries created before the specified time
+        # will be included. UTC time zone.
+        end_: nil,
+        # A cursor representing an item's token before which a page of results should end.
+        # Used to retrieve the previous page of results before this item.
+        ending_before: nil,
+        # Filter by financial account token
+        financial_account_token: nil,
+        # Page size (for pagination).
+        page_size: nil,
+        # Filter by transaction result
+        result: nil,
+        # A cursor representing an item's token after which a page of results should
+        # begin. Used to retrieve the next page of results after this item.
+        starting_after: nil,
+        # Filter by transaction status
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a single transaction
+      sig do
+        params(
+          transaction_token: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(
+          Lithic::Models::AccountActivityRetrieveTransactionResponse::Variants
+        )
+      end
+      def retrieve_transaction(
+        # The unique identifier for the transaction
+        transaction_token,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Lithic::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end