lithic 0.1.0.pre.alpha.54 → 0.1.0.pre.alpha.56

data/lib/lithic/models/financial_transaction.rb

@@ -44,8 +44,8 @@ module Lithic
       # @!attribute events
       #   A list of all financial events that have modified this financial transaction.
       #
-      #   @return [Array<Lithic::Models::FinancialTransaction::Event>]
-      required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event] }
+      #   @return [Array<Lithic::Models::FinancialEvent>]
+      required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] }
 
       # @!attribute pending_amount
       #   Pending amount of the transaction in the currency's smallest unit (e.g., cents),
@@ -103,7 +103,7 @@ module Lithic
       #
       #   @param descriptor [String] A string that provides a description of the financial transaction; may be useful
       #
-      #   @param events [Array<Lithic::Models::FinancialTransaction::Event>] A list of all financial events that have modified this financial transaction.
+      #   @param events [Array<Lithic::Models::FinancialEvent>] A list of all financial events that have modified this financial transaction.
       #
       #   @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
       #
@@ -136,149 +136,6 @@ module Lithic
         #   @return [Array<Symbol>]
       end
 
-      class Event < Lithic::Internal::Type::BaseModel
-        # @!attribute token
-        #   Globally unique identifier.
-        #
-        #   @return [String, nil]
-        optional :token, String
-
-        # @!attribute amount
-        #   Amount of the financial event that has been settled in the currency's smallest
-        #   unit (e.g., cents).
-        #
-        #   @return [Integer, nil]
-        optional :amount, Integer
-
-        # @!attribute created
-        #   Date and time when the financial event occurred. UTC time zone.
-        #
-        #   @return [Time, nil]
-        optional :created, Time
-
-        # @!attribute result
-        #   APPROVED financial events were successful while DECLINED financial events were
-        #   declined by user, Lithic, or the network.
-        #
-        #   @return [Symbol, Lithic::Models::FinancialTransaction::Event::Result, nil]
-        optional :result, enum: -> { Lithic::FinancialTransaction::Event::Result }
-
-        # @!attribute type
-        #
-        #   @return [Symbol, Lithic::Models::FinancialTransaction::Event::Type, nil]
-        optional :type, enum: -> { Lithic::FinancialTransaction::Event::Type }
-
-        # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Lithic::Models::FinancialTransaction::Event} for more details.
-        #
-        #   Financial Event
-        #
-        #   @param token [String] Globally unique identifier.
-        #
-        #   @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
-        #
-        #   @param created [Time] Date and time when the financial event occurred. UTC time zone.
-        #
-        #   @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
-        #
-        #   @param type [Symbol, Lithic::Models::FinancialTransaction::Event::Type]
-
-        # APPROVED financial events were successful while DECLINED financial events were
-        # declined by user, Lithic, or the network.
-        #
-        # @see Lithic::Models::FinancialTransaction::Event#result
-        module Result
-          extend Lithic::Internal::Type::Enum
-
-          APPROVED = :APPROVED
-          DECLINED = :DECLINED
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Lithic::Models::FinancialTransaction::Event#type
-        module Type
-          extend Lithic::Internal::Type::Enum
-
-          ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED
-          ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED
-          ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
-          ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED
-          ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED
-          ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
-          ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
-          ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
-          ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
-          ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
-          ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
-          ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
-          ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
-          ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
-          AUTHORIZATION = :AUTHORIZATION
-          AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE
-          AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY
-          AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL
-          BALANCE_INQUIRY = :BALANCE_INQUIRY
-          BILLING_ERROR = :BILLING_ERROR
-          BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL
-          CARD_TO_CARD = :CARD_TO_CARD
-          CASH_BACK = :CASH_BACK
-          CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
-          CLEARING = :CLEARING
-          COLLECTION = :COLLECTION
-          CORRECTION_CREDIT = :CORRECTION_CREDIT
-          CORRECTION_DEBIT = :CORRECTION_DEBIT
-          CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
-          CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE
-          CURRENCY_CONVERSION = :CURRENCY_CONVERSION
-          CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
-          DISPUTE_WON = :DISPUTE_WON
-          EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED
-          EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED
-          EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED
-          EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED
-          EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED
-          EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED
-          EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED
-          EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
-          EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
-          EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
-          EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
-          EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
-          EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
-          EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED
-          EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED
-          EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED
-          EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED
-          EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
-          EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
-          EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
-          FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
-          FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
-          INTEREST = :INTEREST
-          INTEREST_REVERSAL = :INTEREST_REVERSAL
-          INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
-          LATE_PAYMENT = :LATE_PAYMENT
-          LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
-          LOSS_WRITE_OFF = :LOSS_WRITE_OFF
-          PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
-          PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
-          SERVICE = :SERVICE
-          RETURN = :RETURN
-          RETURN_REVERSAL = :RETURN_REVERSAL
-          TRANSFER = :TRANSFER
-          TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS
-          RETURNED_PAYMENT = :RETURNED_PAYMENT
-          RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
-          LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # APPROVED transactions were successful while DECLINED transactions were declined
       # by user, Lithic, or the network.
       #

data/lib/lithic/models/management_operation_list_params.rb

@@ -112,6 +112,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/management_operation_transaction.rb

@@ -92,7 +92,7 @@ module Lithic
       # @!attribute user_defined_id
       #
       #   @return [String, nil]
-      optional :user_defined_id, String
+      optional :user_defined_id, String, nil?: true
 
       # @!method initialize(token:, created:, status:, updated:, category: nil, currency: nil, direction: nil, events: nil, external_resource: nil, family: nil, financial_account_token: nil, pending_amount: nil, result: nil, settled_amount: nil, transaction_series: nil, user_defined_id: nil)
       #   @param token [String] Unique identifier for the transaction
@@ -125,7 +125,7 @@ module Lithic
       #
       #   @param transaction_series [Lithic::Models::ManagementOperationTransaction::TransactionSeries, nil]
       #
-      #   @param user_defined_id [String]
+      #   @param user_defined_id [String, nil]
 
       # The status of the transaction
       #
@@ -138,6 +138,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -213,7 +214,7 @@ module Lithic
         # @!attribute subtype
         #
         #   @return [String, nil]
-        optional :subtype, String
+        optional :subtype, String, nil?: true
 
         # @!method initialize(token:, amount:, created:, detailed_results:, effective_date:, memo:, result:, type:, subtype: nil)
         #   @param token [String]
@@ -224,7 +225,7 @@ module Lithic
         #   @param memo [String]
         #   @param result [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Result]
         #   @param type [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Type]
-        #   @param subtype [String]
+        #   @param subtype [String, nil]
 
         module DetailedResult
           extend Lithic::Internal::Type::Enum

data/lib/lithic/models/merchant.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class Merchant < Lithic::Internal::Type::BaseModel
+      # @!attribute acceptor_id
+      #   Unique alphanumeric identifier for the payment card acceptor (merchant).
+      #
+      #   @return [String]
+      required :acceptor_id, String
+
+      # @!attribute acquiring_institution_id
+      #   Unique numeric identifier of the acquiring institution.
+      #
+      #   @return [String]
+      required :acquiring_institution_id, String
+
+      # @!attribute city
+      #   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.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   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.
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute descriptor
+      #   Short description of card acceptor.
+      #
+      #   @return [String]
+      required :descriptor, String
+
+      # @!attribute mcc
+      #   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.
+      #
+      #   @return [String]
+      required :mcc, String
+
+      # @!attribute state
+      #   Geographic state of card acceptor.
+      #
+      #   @return [String]
+      required :state, String
+
+      # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:)
+      #   Some parameter documentations has been truncated, see {Lithic::Models::Merchant}
+      #   for more details.
+      #
+      #   @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant).
+      #
+      #   @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution.
+      #
+      #   @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present
+      #
+      #   @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph
+      #
+      #   @param descriptor [String] Short description of card acceptor.
+      #
+      #   @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
+      #
+      #   @param state [String] Geographic state of card acceptor.
+    end
+  end
+end

data/lib/lithic/models/payment.rb

@@ -71,10 +71,10 @@ module Lithic
       required :pending_amount, Integer
 
       # @!attribute related_account_tokens
-      #   Related account tokens for the transaction
+      #   Account tokens related to a payment transaction
       #
-      #   @return [Lithic::Models::Payment::RelatedAccountTokens]
-      required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }
+      #   @return [Lithic::Models::Payment::RelatedAccountTokens, nil]
+      required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }, nil?: true
 
       # @!attribute result
       #   Transaction result
@@ -158,7 +158,7 @@ module Lithic
       #
       #   @param pending_amount [Integer] Pending amount in cents
       #
-      #   @param related_account_tokens [Lithic::Models::Payment::RelatedAccountTokens] Related account tokens for the transaction
+      #   @param related_account_tokens [Lithic::Models::Payment::RelatedAccountTokens, nil] Account tokens related to a payment transaction
       #
       #   @param result [Symbol, Lithic::Models::Payment::Result] Transaction result
       #
@@ -371,6 +371,7 @@ module Lithic
           extend Lithic::Internal::Type::Enum
 
           APPROVED = :APPROVED
+          DECLINED = :DECLINED
           FUNDS_INSUFFICIENT = :FUNDS_INSUFFICIENT
           ACCOUNT_INVALID = :ACCOUNT_INVALID
           PROGRAM_TRANSACTION_LIMIT_EXCEEDED = :PROGRAM_TRANSACTION_LIMIT_EXCEEDED
@@ -483,6 +484,12 @@ module Lithic
         end
 
         class WireMethodAttributes < Lithic::Internal::Type::BaseModel
+          # @!attribute wire_message_type
+          #   Type of wire message
+          #
+          #   @return [String, nil]
+          required :wire_message_type, String, nil?: true
+
           # @!attribute wire_network
           #   Type of wire transfer
           #
@@ -512,17 +519,13 @@ module Lithic
           #   @return [String, nil]
           optional :remittance_information, String, nil?: true
 
-          # @!attribute wire_message_type
-          #   Type of wire message
-          #
-          #   @return [String, nil]
-          optional :wire_message_type, String
-
-          # @!method initialize(wire_network:, creditor: nil, debtor: nil, message_id: nil, remittance_information: nil, wire_message_type: nil)
+          # @!method initialize(wire_message_type:, wire_network:, creditor: nil, debtor: nil, message_id: nil, remittance_information: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::Payment::MethodAttributes::WireMethodAttributes} for more
           #   details.
           #
+          #   @param wire_message_type [String, nil] Type of wire message
+          #
           #   @param wire_network [Symbol, Lithic::Models::Payment::MethodAttributes::WireMethodAttributes::WireNetwork] Type of wire transfer
           #
           #   @param creditor [Lithic::Models::WirePartyDetails]
@@ -532,8 +535,6 @@ module Lithic
           #   @param message_id [String, nil] Point to point reference identifier, as assigned by the instructing party, used
           #
           #   @param remittance_information [String, nil] Payment details or invoice reference
-          #
-          #   @param wire_message_type [String] Type of wire message
 
           # Type of wire transfer
           #
@@ -568,7 +569,7 @@ module Lithic
         required :business_account_token, String, nil?: true
 
         # @!method initialize(account_token:, business_account_token:)
-        #   Related account tokens for the transaction
+        #   Account tokens related to a payment transaction
         #
         #   @param account_token [String, nil] Globally unique identifier for the account
         #
@@ -613,6 +614,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/payment_return_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Payments#return_
+    class PaymentReturnParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute financial_account_token
+      #   Globally unique identifier for the financial account
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute return_reason_code
+      #   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 [String]
+      required :return_reason_code, String
+
+      # @!attribute addenda
+      #   Optional additional information about the return. Limited to 44 characters
+      #
+      #   @return [String, nil]
+      optional :addenda, String, nil?: true
+
+      # @!attribute date_of_death
+      #   Date of death in YYYY-MM-DD format. Required when using return codes **R14**
+      #   (representative payee deceased) or **R15** (beneficiary or account holder
+      #   deceased)
+      #
+      #   @return [Date, nil]
+      optional :date_of_death, Date, nil?: true
+
+      # @!attribute memo
+      #   Optional memo for the return. Limited to 10 characters
+      #
+      #   @return [String, nil]
+      optional :memo, String, nil?: true
+
+      # @!method initialize(financial_account_token:, return_reason_code:, addenda: nil, date_of_death: nil, memo: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::PaymentReturnParams} for more details.
+      #
+      #   @param financial_account_token [String] Globally unique identifier for the financial account
+      #
+      #   @param return_reason_code [String] ACH return reason code indicating the reason for returning the payment. Supporte
+      #
+      #   @param addenda [String, nil] Optional additional information about the return. Limited to 44 characters
+      #
+      #   @param date_of_death [Date, nil] Date of death in YYYY-MM-DD format. Required when using return codes **R14** (re
+      #
+      #   @param memo [String, nil] Optional memo for the return. Limited to 10 characters
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/payment_simulate_action_params.rb

@@ -13,23 +13,39 @@ module Lithic
       #   @return [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType]
       required :event_type, enum: -> { Lithic::PaymentSimulateActionParams::EventType }
 
+      # @!attribute date_of_death
+      #   Date of Death for ACH Return
+      #
+      #   @return [Date, nil]
+      optional :date_of_death, Date
+
       # @!attribute decline_reason
       #   Decline reason
       #
       #   @return [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason, nil]
       optional :decline_reason, enum: -> { Lithic::PaymentSimulateActionParams::DeclineReason }
 
+      # @!attribute return_addenda
+      #   Return Addenda
+      #
+      #   @return [String, nil]
+      optional :return_addenda, String
+
       # @!attribute return_reason_code
       #   Return Reason Code
       #
       #   @return [String, nil]
       optional :return_reason_code, String
 
-      # @!method initialize(event_type:, decline_reason: nil, return_reason_code: nil, request_options: {})
+      # @!method initialize(event_type:, date_of_death: nil, decline_reason: nil, return_addenda: nil, return_reason_code: nil, request_options: {})
       #   @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType] Event Type
       #
+      #   @param date_of_death [Date] Date of Death for ACH Return
+      #
       #   @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason] Decline reason
       #
+      #   @param return_addenda [String] Return Addenda
+      #
       #   @param return_reason_code [String] Return Reason Code
       #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]

data/lib/lithic/models/statement_totals.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class StatementTotals < Lithic::Internal::Type::BaseModel
+      # @!attribute balance_transfers
+      #   Opening balance transferred from previous account in cents
+      #
+      #   @return [Integer]
+      required :balance_transfers, Integer
+
+      # @!attribute cash_advances
+      #   ATM and cashback transactions in cents
+      #
+      #   @return [Integer]
+      required :cash_advances, Integer
+
+      # @!attribute credits
+      #   Volume of credit management operation transactions less any balance transfers in
+      #   cents
+      #
+      #   @return [Integer]
+      required :credits, Integer
+
+      # @!attribute debits
+      #   Volume of debit management operation transactions less any interest in cents
+      #
+      #   @return [Integer]
+      required :debits, Integer
+
+      # @!attribute fees
+      #   Volume of debit management operation transactions less any interest in cents
+      #
+      #   @return [Integer]
+      required :fees, Integer
+
+      # @!attribute interest
+      #   Interest accrued in cents
+      #
+      #   @return [Integer]
+      required :interest, Integer
+
+      # @!attribute payments
+      #   Any funds transfers which affective the balance in cents
+      #
+      #   @return [Integer]
+      required :payments, Integer
+
+      # @!attribute purchases
+      #   Net card transaction volume less any cash advances in cents
+      #
+      #   @return [Integer]
+      required :purchases, Integer
+
+      # @!attribute credit_details
+      #   Breakdown of credits
+      #
+      #   @return [Object, nil]
+      optional :credit_details, Lithic::Internal::Type::Unknown
+
+      # @!attribute debit_details
+      #   Breakdown of debits
+      #
+      #   @return [Object, nil]
+      optional :debit_details, Lithic::Internal::Type::Unknown
+
+      # @!attribute payment_details
+      #   Breakdown of payments
+      #
+      #   @return [Object, nil]
+      optional :payment_details, Lithic::Internal::Type::Unknown
+
+      # @!method initialize(balance_transfers:, cash_advances:, credits:, debits:, fees:, interest:, payments:, purchases:, credit_details: nil, debit_details: nil, payment_details: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::StatementTotals} for more details.
+      #
+      #   @param balance_transfers [Integer] Opening balance transferred from previous account in cents
+      #
+      #   @param cash_advances [Integer] ATM and cashback transactions in cents
+      #
+      #   @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
+      #
+      #   @param debits [Integer] Volume of debit management operation transactions less any interest in cents
+      #
+      #   @param fees [Integer] Volume of debit management operation transactions less any interest in cents
+      #
+      #   @param interest [Integer] Interest accrued in cents
+      #
+      #   @param payments [Integer] Any funds transfers which affective the balance in cents
+      #
+      #   @param purchases [Integer] Net card transaction volume less any cash advances in cents
+      #
+      #   @param credit_details [Object] Breakdown of credits
+      #
+      #   @param debit_details [Object] Breakdown of debits
+      #
+      #   @param payment_details [Object] Breakdown of payments
+    end
+  end
+end

data/lib/lithic/models/three_ds/authentication_retrieve_response.rb

@@ -312,22 +312,22 @@ module Lithic
           optional :name, String, nil?: true
 
           # @!attribute phone_number_home
-          #   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`.
           #
           #   @return [String, nil]
           optional :phone_number_home, String, nil?: true
 
           # @!attribute phone_number_mobile
-          #   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`.
           #
           #   @return [String, nil]
           optional :phone_number_mobile, String, nil?: true
 
           # @!attribute phone_number_work
-          #   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`.
           #
           #   @return [String, nil]
           optional :phone_number_work, String, nil?: true
@@ -356,11 +356,11 @@ module Lithic
           #
           #   @param name [String, nil] Name of the cardholder. Maps to EMV 3DS field `cardholderName`.
           #
-          #   @param phone_number_home [String, nil] Home phone number provided by the cardholder. Maps to EMV 3DS fields `homePhone.
+          #   @param phone_number_home [String, nil] Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS fi
           #
-          #   @param phone_number_mobile [String, nil] Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields `mob
+          #   @param phone_number_mobile [String, nil] Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV
           #
-          #   @param phone_number_work [String, nil] Work phone number provided by the cardholder. Maps to EMV 3DS fields `workPhone.
+          #   @param phone_number_work [String, nil] Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS fi
           #
           #   @param shipping_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress] Object containing data on the shipping address provided during the transaction.