lithic 0.1.0.pre.alpha.55 → 0.1.0

data/lib/lithic/models/external_bank_account_update_response.rb

@@ -97,49 +97,49 @@ module Lithic
       #   returned will be null
       #
       #   @return [String, nil]
-      optional :account_token, String
+      optional :account_token, String, nil?: true
 
       # @!attribute address
       #   Address
       #
       #   @return [Lithic::Models::ExternalBankAccountAddress, nil]
-      optional :address, -> { Lithic::ExternalBankAccountAddress }
+      optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true
 
       # @!attribute company_id
       #   Optional field that helps identify bank accounts in receipts
       #
       #   @return [String, nil]
-      optional :company_id, String
+      optional :company_id, String, nil?: true
 
       # @!attribute dob
       #   Date of Birth of the Individual that owns the external bank account
       #
       #   @return [Date, nil]
-      optional :dob, Date
+      optional :dob, Date, nil?: true
 
       # @!attribute doing_business_as
       #   Doing Business As
       #
       #   @return [String, nil]
-      optional :doing_business_as, String
+      optional :doing_business_as, String, nil?: true
 
       # @!attribute financial_account_token
       #   The financial account token of the operating account to fund the micro deposits
       #
       #   @return [String, nil]
-      optional :financial_account_token, String
+      optional :financial_account_token, String, nil?: true
 
       # @!attribute name
       #   The nickname for this External Bank Account
       #
       #   @return [String, nil]
-      optional :name, String
+      optional :name, String, nil?: true
 
       # @!attribute user_defined_id
       #   User Defined ID
       #
       #   @return [String, nil]
-      optional :user_defined_id, String
+      optional :user_defined_id, String, nil?: true
 
       # @!attribute verification_failed_reason
       #   Optional free text description of the reason for the failed verification. For
@@ -147,7 +147,7 @@ module Lithic
       #   by the ACH network
       #
       #   @return [String, nil]
-      optional :verification_failed_reason, String
+      optional :verification_failed_reason, String, nil?: true
 
       # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil)
       #   Some parameter documentations has been truncated, see
@@ -179,23 +179,23 @@ module Lithic
       #
       #   @param verification_state [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::VerificationState] Verification State
       #
-      #   @param account_token [String] Indicates which Lithic account the external account is associated with. For exte
+      #   @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte
       #
-      #   @param address [Lithic::Models::ExternalBankAccountAddress] Address
+      #   @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address
       #
-      #   @param company_id [String] Optional field that helps identify bank accounts in receipts
+      #   @param company_id [String, nil] Optional field that helps identify bank accounts in receipts
       #
-      #   @param dob [Date] Date of Birth of the Individual that owns the external bank account
+      #   @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account
       #
-      #   @param doing_business_as [String] Doing Business As
+      #   @param doing_business_as [String, nil] Doing Business As
       #
-      #   @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits
+      #   @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits
       #
-      #   @param name [String] The nickname for this External Bank Account
+      #   @param name [String, nil] The nickname for this External Bank Account
       #
-      #   @param user_defined_id [String] User Defined ID
+      #   @param user_defined_id [String, nil] User Defined ID
       #
-      #   @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC
+      #   @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC
 
       # Owner Type
       #

data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb

@@ -99,49 +99,49 @@ module Lithic
         #   returned will be null
         #
         #   @return [String, nil]
-        optional :account_token, String
+        optional :account_token, String, nil?: true
 
         # @!attribute address
         #   Address
         #
         #   @return [Lithic::Models::ExternalBankAccountAddress, nil]
-        optional :address, -> { Lithic::ExternalBankAccountAddress }
+        optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true
 
         # @!attribute company_id
         #   Optional field that helps identify bank accounts in receipts
         #
         #   @return [String, nil]
-        optional :company_id, String
+        optional :company_id, String, nil?: true
 
         # @!attribute dob
         #   Date of Birth of the Individual that owns the external bank account
         #
         #   @return [Date, nil]
-        optional :dob, Date
+        optional :dob, Date, nil?: true
 
         # @!attribute doing_business_as
         #   Doing Business As
         #
         #   @return [String, nil]
-        optional :doing_business_as, String
+        optional :doing_business_as, String, nil?: true
 
         # @!attribute financial_account_token
         #   The financial account token of the operating account to fund the micro deposits
         #
         #   @return [String, nil]
-        optional :financial_account_token, String
+        optional :financial_account_token, String, nil?: true
 
         # @!attribute name
         #   The nickname for this External Bank Account
         #
         #   @return [String, nil]
-        optional :name, String
+        optional :name, String, nil?: true
 
         # @!attribute user_defined_id
         #   User Defined ID
         #
         #   @return [String, nil]
-        optional :user_defined_id, String
+        optional :user_defined_id, String, nil?: true
 
         # @!attribute verification_failed_reason
         #   Optional free text description of the reason for the failed verification. For
@@ -149,7 +149,7 @@ module Lithic
         #   by the ACH network
         #
         #   @return [String, nil]
-        optional :verification_failed_reason, String
+        optional :verification_failed_reason, String, nil?: true
 
         # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil)
         #   Some parameter documentations has been truncated, see
@@ -182,23 +182,23 @@ module Lithic
         #
         #   @param verification_state [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState] Verification State
         #
-        #   @param account_token [String] Indicates which Lithic account the external account is associated with. For exte
+        #   @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte
         #
-        #   @param address [Lithic::Models::ExternalBankAccountAddress] Address
+        #   @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address
         #
-        #   @param company_id [String] Optional field that helps identify bank accounts in receipts
+        #   @param company_id [String, nil] Optional field that helps identify bank accounts in receipts
         #
-        #   @param dob [Date] Date of Birth of the Individual that owns the external bank account
+        #   @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account
         #
-        #   @param doing_business_as [String] Doing Business As
+        #   @param doing_business_as [String, nil] Doing Business As
         #
-        #   @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits
+        #   @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits
         #
-        #   @param name [String] The nickname for this External Bank Account
+        #   @param name [String, nil] The nickname for this External Bank Account
         #
-        #   @param user_defined_id [String] User Defined ID
+        #   @param user_defined_id [String, nil] User Defined ID
         #
-        #   @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC
+        #   @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC
 
         # Owner Type
         #

data/lib/lithic/models/external_payment.rb

@@ -77,7 +77,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, events: nil, family: nil, financial_account_token: nil, payment_type: nil, pending_amount: nil, result: nil, settled_amount: nil, user_defined_id: nil)
       #   @param token [String] Unique identifier for the transaction
@@ -106,7 +106,7 @@ module Lithic
       #
       #   @param settled_amount [Integer]
       #
-      #   @param user_defined_id [String]
+      #   @param user_defined_id [String, nil]
 
       # The status of the transaction
       #
@@ -119,6 +119,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -131,6 +132,8 @@ module Lithic
         EXTERNAL_WIRE = :EXTERNAL_WIRE
         EXTERNAL_ACH = :EXTERNAL_ACH
         EXTERNAL_CHECK = :EXTERNAL_CHECK
+        EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
+        EXTERNAL_RTP = :EXTERNAL_RTP
         EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
 
         # @!method self.values
@@ -234,6 +237,16 @@ module Lithic
           EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
           EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
           EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
+          EXTERNAL_FEDNOW_INITIATED = :EXTERNAL_FEDNOW_INITIATED
+          EXTERNAL_FEDNOW_CANCELED = :EXTERNAL_FEDNOW_CANCELED
+          EXTERNAL_FEDNOW_SETTLED = :EXTERNAL_FEDNOW_SETTLED
+          EXTERNAL_FEDNOW_REVERSED = :EXTERNAL_FEDNOW_REVERSED
+          EXTERNAL_FEDNOW_RELEASED = :EXTERNAL_FEDNOW_RELEASED
+          EXTERNAL_RTP_INITIATED = :EXTERNAL_RTP_INITIATED
+          EXTERNAL_RTP_CANCELED = :EXTERNAL_RTP_CANCELED
+          EXTERNAL_RTP_SETTLED = :EXTERNAL_RTP_SETTLED
+          EXTERNAL_RTP_REVERSED = :EXTERNAL_RTP_REVERSED
+          EXTERNAL_RTP_RELEASED = :EXTERNAL_RTP_RELEASED
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/lithic/models/external_payment_create_params.rb

@@ -70,6 +70,8 @@ module Lithic
         EXTERNAL_WIRE = :EXTERNAL_WIRE
         EXTERNAL_ACH = :EXTERNAL_ACH
         EXTERNAL_CHECK = :EXTERNAL_CHECK
+        EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
+        EXTERNAL_RTP = :EXTERNAL_RTP
         EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
 
         # @!method self.values

data/lib/lithic/models/external_payment_list_params.rb

@@ -104,6 +104,8 @@ module Lithic
         EXTERNAL_WIRE = :EXTERNAL_WIRE
         EXTERNAL_ACH = :EXTERNAL_ACH
         EXTERNAL_CHECK = :EXTERNAL_CHECK
+        EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
+        EXTERNAL_RTP = :EXTERNAL_RTP
         EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
 
         # @!method self.values
@@ -130,6 +132,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/financial_account.rb

@@ -97,9 +97,10 @@ module Lithic
       class CreditConfiguration < Lithic::Internal::Type::BaseModel
         # @!attribute auto_collection_configuration
         #
-        #   @return [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration]
+        #   @return [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, nil]
         required :auto_collection_configuration,
-                 -> { Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration }
+                 -> { Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration },
+                 nil?: true
 
         # @!attribute credit_limit
         #
@@ -124,7 +125,7 @@ module Lithic
         required :tier, String, nil?: true
 
         # @!method initialize(auto_collection_configuration:, credit_limit:, credit_product_token:, external_bank_account_token:, tier:)
-        #   @param auto_collection_configuration [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration]
+        #   @param auto_collection_configuration [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, nil]
         #
         #   @param credit_limit [Integer, nil]
         #

data/lib/lithic/models/financial_account_balance.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class FinancialAccountBalance < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Globally unique identifier for the financial account that holds this balance.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute available_amount
+      #   Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+      #
+      #   @return [Integer]
+      required :available_amount, Integer
+
+      # @!attribute created
+      #   Date and time for when the balance was first created.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #   3-character alphabetic ISO 4217 code for the local currency of the balance.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute last_transaction_event_token
+      #   Globally unique identifier for the last financial transaction event that
+      #   impacted this balance.
+      #
+      #   @return [String]
+      required :last_transaction_event_token, String
+
+      # @!attribute last_transaction_token
+      #   Globally unique identifier for the last financial transaction that impacted this
+      #   balance.
+      #
+      #   @return [String]
+      required :last_transaction_token, String
+
+      # @!attribute pending_amount
+      #   Funds not available for spend due to card authorizations or pending ACH release.
+      #   Shown in the currency's smallest unit (e.g., cents for USD).
+      #
+      #   @return [Integer]
+      required :pending_amount, Integer
+
+      # @!attribute total_amount
+      #   The sum of available and pending balance in the currency's smallest unit (e.g.,
+      #   cents for USD).
+      #
+      #   @return [Integer]
+      required :total_amount, Integer
+
+      # @!attribute type
+      #   Type of financial account.
+      #
+      #   @return [Symbol, Lithic::Models::FinancialAccountBalance::Type]
+      required :type, enum: -> { Lithic::FinancialAccountBalance::Type }
+
+      # @!attribute updated
+      #   Date and time for when the balance was last updated.
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!method initialize(token:, available_amount:, created:, currency:, last_transaction_event_token:, last_transaction_token:, pending_amount:, total_amount:, type:, updated:)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::FinancialAccountBalance} for more details.
+      #
+      #   Balance of a Financial Account
+      #
+      #   @param token [String] Globally unique identifier for the financial account that holds this balance.
+      #
+      #   @param available_amount [Integer] Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+      #
+      #   @param created [Time] Date and time for when the balance was first created.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code for the local currency of the balance.
+      #
+      #   @param last_transaction_event_token [String] Globally unique identifier for the last financial transaction event that impacte
+      #
+      #   @param last_transaction_token [String] Globally unique identifier for the last financial transaction that impacted this
+      #
+      #   @param pending_amount [Integer] Funds not available for spend due to card authorizations or pending ACH release.
+      #
+      #   @param total_amount [Integer] The sum of available and pending balance in the currency's smallest unit (e.g.,
+      #
+      #   @param type [Symbol, Lithic::Models::FinancialAccountBalance::Type] Type of financial account.
+      #
+      #   @param updated [Time] Date and time for when the balance was last updated.
+
+      # Type of financial account.
+      #
+      # @see Lithic::Models::FinancialAccountBalance#type
+      module Type
+        extend Lithic::Internal::Type::Enum
+
+        ISSUING = :ISSUING
+        OPERATING = :OPERATING
+        RESERVE = :RESERVE
+        SECURITY = :SECURITY
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/financial_accounts/category_balances.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class CategoryBalances < Lithic::Internal::Type::BaseModel
+        # @!attribute fees
+        #
+        #   @return [Integer]
+        required :fees, Integer
+
+        # @!attribute interest
+        #
+        #   @return [Integer]
+        required :interest, Integer
+
+        # @!attribute principal
+        #
+        #   @return [Integer]
+        required :principal, Integer
+
+        # @!method initialize(fees:, interest:, principal:)
+        #   @param fees [Integer]
+        #   @param interest [Integer]
+        #   @param principal [Integer]
+      end
+    end
+  end
+end