lithic 0.15.0 → 0.17.0

data/rbi/lithic/models/card.rbi

@@ -14,7 +14,7 @@ module Lithic
 
       # Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
       # compliant to have PAN returned as a field in production. Please contact
-      # support@lithic.com for questions.
+      # https://support.lithic.com/ for questions.
       sig { returns(T.nilable(String)) }
       attr_reader :pan
 
@@ -28,7 +28,7 @@ module Lithic
         cvv: nil,
         # Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
         # compliant to have PAN returned as a field in production. Please contact
-        # support@lithic.com for questions.
+        # https://support.lithic.com/ for questions.
         pan: nil
       )
       end

data/rbi/lithic/models/card_authorization.rbi

@@ -91,6 +91,20 @@ module Lithic
       sig { returns(String) }
       attr_accessor :merchant_currency
 
+      # Network name validation data, present when the card network requested name
+      # validation for this transaction. Contains the cardholder name provided by the
+      # network and Lithic's computed match result against KYC data on file.
+      sig { returns(T.nilable(Lithic::CardAuthorization::NameValidation)) }
+      attr_reader :name_validation
+
+      sig do
+        params(
+          name_validation:
+            T.nilable(Lithic::CardAuthorization::NameValidation::OrHash)
+        ).void
+      end
+      attr_writer :name_validation
+
       # Where the cardholder received the service, when different from the card acceptor
       # location. This is populated from network data elements such as Mastercard DE-122
       # SE1 SF9-14 and Visa F34 DS02.
@@ -263,6 +277,8 @@ module Lithic
           merchant: Lithic::CardAuthorization::Merchant::OrHash,
           merchant_amount: Integer,
           merchant_currency: String,
+          name_validation:
+            T.nilable(Lithic::CardAuthorization::NameValidation::OrHash),
           service_location:
             T.nilable(Lithic::CardAuthorization::ServiceLocation::OrHash),
           settled_amount: Integer,
@@ -331,6 +347,10 @@ module Lithic
         merchant_amount:,
         # 3-character alphabetic ISO 4217 code for the local currency of the transaction.
         merchant_currency:,
+        # Network name validation data, present when the card network requested name
+        # validation for this transaction. Contains the cardholder name provided by the
+        # network and Lithic's computed match result against KYC data on file.
+        name_validation:,
         # Where the cardholder received the service, when different from the card acceptor
         # location. This is populated from network data elements such as Mastercard DE-122
         # SE1 SF9-14 and Visa F34 DS02.
@@ -401,6 +421,8 @@ module Lithic
             merchant: Lithic::CardAuthorization::Merchant,
             merchant_amount: Integer,
             merchant_currency: String,
+            name_validation:
+              T.nilable(Lithic::CardAuthorization::NameValidation),
             service_location:
               T.nilable(Lithic::CardAuthorization::ServiceLocation),
             settled_amount: Integer,
@@ -1042,6 +1064,209 @@ module Lithic
         end
       end
 
+      class NameValidation < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::CardAuthorization::NameValidation,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Cardholder name as provided by the card network.
+        sig { returns(Lithic::CardAuthorization::NameValidation::Name) }
+        attr_reader :name
+
+        sig do
+          params(
+            name: Lithic::CardAuthorization::NameValidation::Name::OrHash
+          ).void
+        end
+        attr_writer :name
+
+        # Lithic's computed match result comparing the network-provided name to the name
+        # on file.
+        sig do
+          returns(Lithic::CardAuthorization::NameValidation::NameOnFileMatch)
+        end
+        attr_reader :name_on_file_match
+
+        sig do
+          params(
+            name_on_file_match:
+              Lithic::CardAuthorization::NameValidation::NameOnFileMatch::OrHash
+          ).void
+        end
+        attr_writer :name_on_file_match
+
+        # Network name validation data, present when the card network requested name
+        # validation for this transaction. Contains the cardholder name provided by the
+        # network and Lithic's computed match result against KYC data on file.
+        sig do
+          params(
+            name: Lithic::CardAuthorization::NameValidation::Name::OrHash,
+            name_on_file_match:
+              Lithic::CardAuthorization::NameValidation::NameOnFileMatch::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Cardholder name as provided by the card network.
+          name:,
+          # Lithic's computed match result comparing the network-provided name to the name
+          # on file.
+          name_on_file_match:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: Lithic::CardAuthorization::NameValidation::Name,
+              name_on_file_match:
+                Lithic::CardAuthorization::NameValidation::NameOnFileMatch
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Name < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::CardAuthorization::NameValidation::Name,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # First name
+          sig { returns(String) }
+          attr_accessor :first
+
+          # Last name
+          sig { returns(String) }
+          attr_accessor :last
+
+          # Middle name
+          sig { returns(T.nilable(String)) }
+          attr_accessor :middle
+
+          # Cardholder name as provided by the card network.
+          sig do
+            params(
+              first: String,
+              last: String,
+              middle: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # First name
+            first:,
+            # Last name
+            last:,
+            # Middle name
+            middle:
+          )
+          end
+
+          sig do
+            override.returns(
+              { first: String, last: String, middle: T.nilable(String) }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class NameOnFileMatch < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::CardAuthorization::NameValidation::NameOnFileMatch,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # Overall name match result.
+          sig do
+            returns(
+              Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::TaggedSymbol
+            )
+          end
+          attr_accessor :full_name
+
+          # Lithic's computed match result comparing the network-provided name to the name
+          # on file.
+          sig do
+            params(
+              full_name:
+                Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Overall name match result.
+            full_name:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                full_name:
+                  Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Overall name match result.
+          module FullName
+            extend Lithic::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MATCH =
+              T.let(
+                :MATCH,
+                Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::TaggedSymbol
+              )
+            PARTIAL_MATCH =
+              T.let(
+                :PARTIAL_MATCH,
+                Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::TaggedSymbol
+              )
+            NO_MATCH =
+              T.let(
+                :NO_MATCH,
+                Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::TaggedSymbol
+              )
+            UNVERIFIED =
+              T.let(
+                :UNVERIFIED,
+                Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Lithic::CardAuthorization::NameValidation::NameOnFileMatch::FullName::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
       class ServiceLocation < Lithic::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1381,6 +1606,15 @@ module Lithic
             )
           end
 
+        # The date and time when the Authorization Challenge was completed in UTC. Filled
+        # only if the challenge has been completed.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :completed_at
+
+        # The date and time when the Authorization Challenge was created in UTC
+        sig { returns(Time) }
+        attr_accessor :created
+
         # The method used to deliver the challenge to the cardholder
         #
         # - `SMS` - Challenge was delivered via SMS
@@ -1411,27 +1645,24 @@ module Lithic
         end
         attr_accessor :status
 
-        # The date and time when the Authorization Challenge was completed in UTC. Present
-        # only if the status is `COMPLETED`.
-        sig { returns(T.nilable(Time)) }
-        attr_reader :completed_at
-
-        sig { params(completed_at: Time).void }
-        attr_writer :completed_at
-
         # The latest Authorization Challenge that was issued to the cardholder for this
         # merchant.
         sig do
           params(
+            completed_at: T.nilable(Time),
+            created: Time,
             method_:
               Lithic::CardAuthorization::LatestChallenge::Method::OrSymbol,
             phone_number: T.nilable(String),
-            status:
-              Lithic::CardAuthorization::LatestChallenge::Status::OrSymbol,
-            completed_at: Time
+            status: Lithic::CardAuthorization::LatestChallenge::Status::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
+          # The date and time when the Authorization Challenge was completed in UTC. Filled
+          # only if the challenge has been completed.
+          completed_at:,
+          # The date and time when the Authorization Challenge was created in UTC
+          created:,
           # The method used to deliver the challenge to the cardholder
           #
           # - `SMS` - Challenge was delivered via SMS
@@ -1447,22 +1678,20 @@ module Lithic
           # - `PENDING` - Challenge is still open
           # - `EXPIRED` - Challenge has expired without being completed
           # - `ERROR` - There was an error processing the challenge
-          status:,
-          # The date and time when the Authorization Challenge was completed in UTC. Present
-          # only if the status is `COMPLETED`.
-          completed_at: nil
+          status:
         )
         end
 
         sig do
           override.returns(
             {
+              completed_at: T.nilable(Time),
+              created: Time,
               method_:
                 Lithic::CardAuthorization::LatestChallenge::Method::TaggedSymbol,
               phone_number: T.nilable(String),
               status:
-                Lithic::CardAuthorization::LatestChallenge::Status::TaggedSymbol,
-              completed_at: Time
+                Lithic::CardAuthorization::LatestChallenge::Status::TaggedSymbol
             }
           )
         end

data/rbi/lithic/models/financial_accounts/loan_tape.rbi

@@ -157,6 +157,10 @@ module Lithic
         sig { params(ytd_totals: Lithic::StatementTotals::OrHash).void }
         attr_writer :ytd_totals
 
+        # Day of the billing period that this loan tape covers, starting at 1
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :day_of_period
+
         # Interest tier to which this account belongs to
         sig { returns(T.nilable(String)) }
         attr_accessor :tier
@@ -191,6 +195,7 @@ module Lithic
             updated: Time,
             version: Integer,
             ytd_totals: Lithic::StatementTotals::OrHash,
+            day_of_period: T.nilable(Integer),
             tier: T.nilable(String)
           ).returns(T.attached_class)
         end
@@ -232,6 +237,8 @@ module Lithic
           # Version number of the loan tape. This starts at 1
           version:,
           ytd_totals:,
+          # Day of the billing period that this loan tape covers, starting at 1
+          day_of_period: nil,
           # Interest tier to which this account belongs to
           tier: nil
         )
@@ -266,6 +273,7 @@ module Lithic
               updated: Time,
               version: Integer,
               ytd_totals: Lithic::StatementTotals,
+              day_of_period: T.nilable(Integer),
               tier: T.nilable(String)
             }
           )

data/rbi/lithic/models/payment.rbi

@@ -97,6 +97,14 @@ module Lithic
       sig { returns(T.nilable(String)) }
       attr_accessor :external_bank_account_token
 
+      # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
+      # metadata with a resource for your own purposes.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Hash[Symbol, String]).void }
+      attr_writer :tags
+
       sig { returns(T.nilable(Lithic::Payment::Type::TaggedSymbol)) }
       attr_reader :type
 
@@ -134,6 +142,7 @@ module Lithic
           currency: String,
           expected_release_date: T.nilable(Date),
           external_bank_account_token: T.nilable(String),
+          tags: T::Hash[Symbol, String],
           type: Lithic::Payment::Type::OrSymbol,
           user_defined_id: T.nilable(String),
           family: Symbol
@@ -178,6 +187,9 @@ module Lithic
         expected_release_date: nil,
         # External bank account token
         external_bank_account_token: nil,
+        # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
+        # metadata with a resource for your own purposes.
+        tags: nil,
         type: nil,
         # User-defined identifier
         user_defined_id: nil,
@@ -210,6 +222,7 @@ module Lithic
             currency: String,
             expected_release_date: T.nilable(Date),
             external_bank_account_token: T.nilable(String),
+            tags: T::Hash[Symbol, String],
             type: Lithic::Payment::Type::TaggedSymbol,
             user_defined_id: T.nilable(String)
           }

data/rbi/lithic/models/transaction_monitoring/case_activity_entry.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      class CaseActivityEntry < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::TransactionMonitoring::CaseActivityEntry,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Globally unique identifier for the activity entry
+        sig { returns(String) }
+        attr_accessor :token
+
+        # Identifier of the actor that produced the activity entry
+        sig { returns(T.nilable(String)) }
+        attr_accessor :actor_token
+
+        # Date and time at which the activity entry was created
+        sig { returns(Time) }
+        attr_accessor :created
+
+        # The case field that changed, or the action that was taken, in an activity entry:
+        #
+        # - `STATUS` - The case status changed
+        # - `TITLE` - The case title changed
+        # - `ASSIGNED_TO` - The case assignee changed
+        # - `RESOLUTION_OUTCOME` - The resolution outcome was set or changed
+        # - `RESOLUTION_NOTES` - The resolution notes were set or changed
+        # - `TAGS` - The case tags changed
+        # - `PRIORITY` - The case priority changed
+        # - `COMMENT` - A comment was added or edited
+        # - `FILE` - A file was attached to the case
+        sig do
+          returns(Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol)
+        end
+        attr_accessor :entry_type
+
+        # New value of the changed field, when applicable
+        sig { returns(T.nilable(String)) }
+        attr_accessor :new_value
+
+        # Previous value of the changed field, when applicable
+        sig { returns(T.nilable(String)) }
+        attr_accessor :previous_value
+
+        # A single entry in a case's activity feed
+        sig do
+          params(
+            token: String,
+            actor_token: T.nilable(String),
+            created: Time,
+            entry_type:
+              Lithic::TransactionMonitoring::CaseActivityType::OrSymbol,
+            new_value: T.nilable(String),
+            previous_value: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Globally unique identifier for the activity entry
+          token:,
+          # Identifier of the actor that produced the activity entry
+          actor_token:,
+          # Date and time at which the activity entry was created
+          created:,
+          # The case field that changed, or the action that was taken, in an activity entry:
+          #
+          # - `STATUS` - The case status changed
+          # - `TITLE` - The case title changed
+          # - `ASSIGNED_TO` - The case assignee changed
+          # - `RESOLUTION_OUTCOME` - The resolution outcome was set or changed
+          # - `RESOLUTION_NOTES` - The resolution notes were set or changed
+          # - `TAGS` - The case tags changed
+          # - `PRIORITY` - The case priority changed
+          # - `COMMENT` - A comment was added or edited
+          # - `FILE` - A file was attached to the case
+          entry_type:,
+          # New value of the changed field, when applicable
+          new_value:,
+          # Previous value of the changed field, when applicable
+          previous_value:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              token: String,
+              actor_token: T.nilable(String),
+              created: Time,
+              entry_type:
+                Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol,
+              new_value: T.nilable(String),
+              previous_value: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/transaction_monitoring/case_activity_type.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # The case field that changed, or the action that was taken, in an activity entry:
+      #
+      # - `STATUS` - The case status changed
+      # - `TITLE` - The case title changed
+      # - `ASSIGNED_TO` - The case assignee changed
+      # - `RESOLUTION_OUTCOME` - The resolution outcome was set or changed
+      # - `RESOLUTION_NOTES` - The resolution notes were set or changed
+      # - `TAGS` - The case tags changed
+      # - `PRIORITY` - The case priority changed
+      # - `COMMENT` - A comment was added or edited
+      # - `FILE` - A file was attached to the case
+      module CaseActivityType
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::TransactionMonitoring::CaseActivityType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STATUS =
+          T.let(
+            :STATUS,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        TITLE =
+          T.let(
+            :TITLE,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        ASSIGNED_TO =
+          T.let(
+            :ASSIGNED_TO,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        RESOLUTION_OUTCOME =
+          T.let(
+            :RESOLUTION_OUTCOME,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        RESOLUTION_NOTES =
+          T.let(
+            :RESOLUTION_NOTES,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        TAGS =
+          T.let(
+            :TAGS,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        PRIORITY =
+          T.let(
+            :PRIORITY,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        COMMENT =
+          T.let(
+            :COMMENT,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+        FILE =
+          T.let(
+            :FILE,
+            Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::TransactionMonitoring::CaseActivityType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/transaction_monitoring/case_card.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      class CaseCard < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::TransactionMonitoring::CaseCard,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # Token of the account the card belongs to
+        sig { returns(String) }
+        attr_accessor :account_token
+
+        # Token of the card
+        sig { returns(String) }
+        attr_accessor :card_token
+
+        # Number of the card's transactions associated with the case
+        sig { returns(Integer) }
+        attr_accessor :transaction_count
+
+        # Summary of a card's involvement in a case, aggregated across the case's
+        # transactions
+        sig do
+          params(
+            account_token: String,
+            card_token: String,
+            transaction_count: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Token of the account the card belongs to
+          account_token:,
+          # Token of the card
+          card_token:,
+          # Number of the card's transactions associated with the case
+          transaction_count:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_token: String,
+              card_token: String,
+              transaction_count: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end