lithic 0.1.0.pre.alpha.55 → 0.1.0.pre.alpha.56

data/rbi/lithic/models/payment.rbi

@@ -50,13 +50,14 @@ module Lithic
       sig { returns(Integer) }
       attr_accessor :pending_amount
 
-      # Related account tokens for the transaction
-      sig { returns(Lithic::Payment::RelatedAccountTokens) }
+      # Account tokens related to a payment transaction
+      sig { returns(T.nilable(Lithic::Payment::RelatedAccountTokens)) }
       attr_reader :related_account_tokens
 
       sig do
         params(
-          related_account_tokens: Lithic::Payment::RelatedAccountTokens::OrHash
+          related_account_tokens:
+            T.nilable(Lithic::Payment::RelatedAccountTokens::OrHash)
         ).void
       end
       attr_writer :related_account_tokens
@@ -123,7 +124,8 @@ module Lithic
               Lithic::Payment::MethodAttributes::WireMethodAttributes::OrHash
             ),
           pending_amount: Integer,
-          related_account_tokens: Lithic::Payment::RelatedAccountTokens::OrHash,
+          related_account_tokens:
+            T.nilable(Lithic::Payment::RelatedAccountTokens::OrHash),
           result: Lithic::Payment::Result::OrSymbol,
           settled_amount: Integer,
           source: Lithic::Payment::Source::OrSymbol,
@@ -158,7 +160,7 @@ module Lithic
         method_attributes:,
         # Pending amount in cents
         pending_amount:,
-        # Related account tokens for the transaction
+        # Account tokens related to a payment transaction
         related_account_tokens:,
         # Transaction result
         result:,
@@ -198,7 +200,8 @@ module Lithic
             method_: Lithic::Payment::Method::TaggedSymbol,
             method_attributes: Lithic::Payment::MethodAttributes::Variants,
             pending_amount: Integer,
-            related_account_tokens: Lithic::Payment::RelatedAccountTokens,
+            related_account_tokens:
+              T.nilable(Lithic::Payment::RelatedAccountTokens),
             result: Lithic::Payment::Result::TaggedSymbol,
             settled_amount: Integer,
             source: Lithic::Payment::Source::TaggedSymbol,
@@ -567,6 +570,11 @@ module Lithic
               :APPROVED,
               Lithic::Payment::Event::DetailedResult::TaggedSymbol
             )
+          DECLINED =
+            T.let(
+              :DECLINED,
+              Lithic::Payment::Event::DetailedResult::TaggedSymbol
+            )
           FUNDS_INSUFFICIENT =
             T.let(
               :FUNDS_INSUFFICIENT,
@@ -928,7 +936,7 @@ module Lithic
         sig { returns(T.nilable(String)) }
         attr_accessor :business_account_token
 
-        # Related account tokens for the transaction
+        # Account tokens related to a payment transaction
         sig do
           params(
             account_token: T.nilable(String),
@@ -1002,6 +1010,7 @@ module Lithic
         DECLINED = T.let(:DECLINED, Lithic::Payment::Status::TaggedSymbol)
         REVERSED = T.let(:REVERSED, Lithic::Payment::Status::TaggedSymbol)
         CANCELED = T.let(:CANCELED, Lithic::Payment::Status::TaggedSymbol)
+        RETURNED = T.let(:RETURNED, Lithic::Payment::Status::TaggedSymbol)
 
         sig do
           override.returns(T::Array[Lithic::Payment::Status::TaggedSymbol])

data/rbi/lithic/models/payment_return_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class PaymentReturnParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Lithic::PaymentReturnParams, Lithic::Internal::AnyHash)
+        end
+
+      # Globally unique identifier for the financial account
+      sig { returns(String) }
+      attr_accessor :financial_account_token
+
+      # ACH return reason code indicating the reason for returning the payment.
+      # Supported codes include R01-R53 and R80-R85. For a complete list of return codes
+      # and their meanings, see
+      # [ACH Return Reasons](https://docs.lithic.com/docs/ach-overview#ach-return-reasons)
+      sig { returns(String) }
+      attr_accessor :return_reason_code
+
+      # Optional additional information about the return. Limited to 44 characters
+      sig { returns(T.nilable(String)) }
+      attr_accessor :addenda
+
+      # Date of death in YYYY-MM-DD format. Required when using return codes **R14**
+      # (representative payee deceased) or **R15** (beneficiary or account holder
+      # deceased)
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :date_of_death
+
+      # Optional memo for the return. Limited to 10 characters
+      sig { returns(T.nilable(String)) }
+      attr_accessor :memo
+
+      sig do
+        params(
+          financial_account_token: String,
+          return_reason_code: String,
+          addenda: T.nilable(String),
+          date_of_death: T.nilable(Date),
+          memo: T.nilable(String),
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Globally unique identifier for the financial account
+        financial_account_token:,
+        # ACH return reason code indicating the reason for returning the payment.
+        # Supported codes include R01-R53 and R80-R85. For a complete list of return codes
+        # and their meanings, see
+        # [ACH Return Reasons](https://docs.lithic.com/docs/ach-overview#ach-return-reasons)
+        return_reason_code:,
+        # Optional additional information about the return. Limited to 44 characters
+        addenda: nil,
+        # Date of death in YYYY-MM-DD format. Required when using return codes **R14**
+        # (representative payee deceased) or **R15** (beneficiary or account holder
+        # deceased)
+        date_of_death: nil,
+        # Optional memo for the return. Limited to 10 characters
+        memo: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            financial_account_token: String,
+            return_reason_code: String,
+            addenda: T.nilable(String),
+            date_of_death: T.nilable(Date),
+            memo: T.nilable(String),
+            request_options: Lithic::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lithic/models/statement_totals.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class StatementTotals < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Lithic::StatementTotals, Lithic::Internal::AnyHash)
+        end
+
+      # Opening balance transferred from previous account in cents
+      sig { returns(Integer) }
+      attr_accessor :balance_transfers
+
+      # ATM and cashback transactions in cents
+      sig { returns(Integer) }
+      attr_accessor :cash_advances
+
+      # Volume of credit management operation transactions less any balance transfers in
+      # cents
+      sig { returns(Integer) }
+      attr_accessor :credits
+
+      # Volume of debit management operation transactions less any interest in cents
+      sig { returns(Integer) }
+      attr_accessor :debits
+
+      # Volume of debit management operation transactions less any interest in cents
+      sig { returns(Integer) }
+      attr_accessor :fees
+
+      # Interest accrued in cents
+      sig { returns(Integer) }
+      attr_accessor :interest
+
+      # Any funds transfers which affective the balance in cents
+      sig { returns(Integer) }
+      attr_accessor :payments
+
+      # Net card transaction volume less any cash advances in cents
+      sig { returns(Integer) }
+      attr_accessor :purchases
+
+      # Breakdown of credits
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :credit_details
+
+      sig { params(credit_details: T.anything).void }
+      attr_writer :credit_details
+
+      # Breakdown of debits
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :debit_details
+
+      sig { params(debit_details: T.anything).void }
+      attr_writer :debit_details
+
+      # Breakdown of payments
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :payment_details
+
+      sig { params(payment_details: T.anything).void }
+      attr_writer :payment_details
+
+      sig do
+        params(
+          balance_transfers: Integer,
+          cash_advances: Integer,
+          credits: Integer,
+          debits: Integer,
+          fees: Integer,
+          interest: Integer,
+          payments: Integer,
+          purchases: Integer,
+          credit_details: T.anything,
+          debit_details: T.anything,
+          payment_details: T.anything
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Opening balance transferred from previous account in cents
+        balance_transfers:,
+        # ATM and cashback transactions in cents
+        cash_advances:,
+        # Volume of credit management operation transactions less any balance transfers in
+        # cents
+        credits:,
+        # Volume of debit management operation transactions less any interest in cents
+        debits:,
+        # Volume of debit management operation transactions less any interest in cents
+        fees:,
+        # Interest accrued in cents
+        interest:,
+        # Any funds transfers which affective the balance in cents
+        payments:,
+        # Net card transaction volume less any cash advances in cents
+        purchases:,
+        # Breakdown of credits
+        credit_details: nil,
+        # Breakdown of debits
+        debit_details: nil,
+        # Breakdown of payments
+        payment_details: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            balance_transfers: Integer,
+            cash_advances: Integer,
+            credits: Integer,
+            debits: Integer,
+            fees: Integer,
+            interest: Integer,
+            payments: Integer,
+            purchases: Integer,
+            credit_details: T.anything,
+            debit_details: T.anything,
+            payment_details: T.anything
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -677,18 +677,18 @@ module Lithic
           sig { returns(T.nilable(String)) }
           attr_accessor :name
 
-          # Home phone number provided by the cardholder. Maps to EMV 3DS fields
-          # `homePhone.cc` and `homePhone.subscriber`.
+          # Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS
+          # fields `homePhone.cc` and `homePhone.subscriber`.
           sig { returns(T.nilable(String)) }
           attr_accessor :phone_number_home
 
-          # Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
-          # `mobilePhone.cc` and `mobilePhone.subscriber`.
+          # Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV
+          # 3DS fields `mobilePhone.cc` and `mobilePhone.subscriber`.
           sig { returns(T.nilable(String)) }
           attr_accessor :phone_number_mobile
 
-          # Work phone number provided by the cardholder. Maps to EMV 3DS fields
-          # `workPhone.cc` and `workPhone.subscriber`.
+          # Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS
+          # fields `workPhone.cc` and `workPhone.subscriber`.
           sig { returns(T.nilable(String)) }
           attr_accessor :phone_number_work
 
@@ -745,14 +745,14 @@ module Lithic
             email: nil,
             # Name of the cardholder. Maps to EMV 3DS field `cardholderName`.
             name: nil,
-            # Home phone number provided by the cardholder. Maps to EMV 3DS fields
-            # `homePhone.cc` and `homePhone.subscriber`.
+            # Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS
+            # fields `homePhone.cc` and `homePhone.subscriber`.
             phone_number_home: nil,
-            # Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
-            # `mobilePhone.cc` and `mobilePhone.subscriber`.
+            # Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV
+            # 3DS fields `mobilePhone.cc` and `mobilePhone.subscriber`.
             phone_number_mobile: nil,
-            # Work phone number provided by the cardholder. Maps to EMV 3DS fields
-            # `workPhone.cc` and `workPhone.subscriber`.
+            # Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS
+            # fields `workPhone.cc` and `workPhone.subscriber`.
             phone_number_work: nil,
             # Object containing data on the shipping address provided during the transaction.
             shipping_address: nil

data/rbi/lithic/models/transaction.rbi

@@ -76,10 +76,10 @@ module Lithic
       sig { returns(T.nilable(String)) }
       attr_accessor :financial_account_token
 
-      sig { returns(Lithic::Transaction::Merchant) }
+      sig { returns(Lithic::Merchant) }
       attr_reader :merchant
 
-      sig { params(merchant: Lithic::Transaction::Merchant::OrHash).void }
+      sig { params(merchant: Lithic::Merchant::OrHash).void }
       attr_writer :merchant
 
       # Analogous to the 'amount', but in the merchant currency.
@@ -160,7 +160,7 @@ module Lithic
             T.nilable(Lithic::Transaction::CardholderAuthentication::OrHash),
           created: Time,
           financial_account_token: T.nilable(String),
-          merchant: Lithic::Transaction::Merchant::OrHash,
+          merchant: Lithic::Merchant::OrHash,
           merchant_amount: T.nilable(Integer),
           merchant_authorization_amount: T.nilable(Integer),
           merchant_currency: String,
@@ -252,7 +252,7 @@ module Lithic
               T.nilable(Lithic::Transaction::CardholderAuthentication),
             created: Time,
             financial_account_token: T.nilable(String),
-            merchant: Lithic::Transaction::Merchant,
+            merchant: Lithic::Merchant,
             merchant_amount: T.nilable(Integer),
             merchant_authorization_amount: T.nilable(Integer),
             merchant_currency: String,
@@ -820,92 +820,6 @@ module Lithic
         end
       end
 
-      class Merchant < Lithic::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(Lithic::Transaction::Merchant, Lithic::Internal::AnyHash)
-          end
-
-        # Unique alphanumeric identifier for the payment card acceptor (merchant).
-        sig { returns(String) }
-        attr_accessor :acceptor_id
-
-        # Unique numeric identifier of the acquiring institution.
-        sig { returns(String) }
-        attr_accessor :acquiring_institution_id
-
-        # City of card acceptor. Note that in many cases, particularly in card-not-present
-        # transactions, merchants may send through a phone number or URL in this field.
-        sig { returns(String) }
-        attr_accessor :city
-
-        # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
-        # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
-        sig { returns(String) }
-        attr_accessor :country
-
-        # Short description of card acceptor.
-        sig { returns(String) }
-        attr_accessor :descriptor
-
-        # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
-        # used to classify a business by the types of goods or services it provides.
-        sig { returns(String) }
-        attr_accessor :mcc
-
-        # Geographic state of card acceptor.
-        sig { returns(String) }
-        attr_accessor :state
-
-        sig do
-          params(
-            acceptor_id: String,
-            acquiring_institution_id: String,
-            city: String,
-            country: String,
-            descriptor: String,
-            mcc: String,
-            state: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Unique alphanumeric identifier for the payment card acceptor (merchant).
-          acceptor_id:,
-          # Unique numeric identifier of the acquiring institution.
-          acquiring_institution_id:,
-          # City of card acceptor. Note that in many cases, particularly in card-not-present
-          # transactions, merchants may send through a phone number or URL in this field.
-          city:,
-          # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
-          # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
-          country:,
-          # Short description of card acceptor.
-          descriptor:,
-          # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
-          # used to classify a business by the types of goods or services it provides.
-          mcc:,
-          # Geographic state of card acceptor.
-          state:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              acceptor_id: String,
-              acquiring_institution_id: String,
-              city: String,
-              country: String,
-              descriptor: String,
-              mcc: String,
-              state: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
       # Card network of the authorization. Value is `UNKNOWN` when Lithic cannot
       # determine the network code from the upstream provider.
       module Network