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

data/lib/lithic/models/external_bank_account_unpause_response.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::ExternalBankAccounts#unpause
+    class ExternalBankAccountUnpauseResponse < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   A globally unique identifier for this record of an external bank account
+      #   association. If a program links an external bank account to more than one
+      #   end-user or to both the program and the end-user, then Lithic will return each
+      #   record of the association
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute country
+      #   The country that the bank account is located in using ISO 3166-1. We will only
+      #   accept USA bank accounts e.g., USA
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute created
+      #   An ISO 8601 string representing when this funding source was added to the Lithic
+      #   account.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #   currency of the external account 3-character alphabetic ISO 4217 code
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute last_four
+      #   The last 4 digits of the bank account. Derived by Lithic from the account number
+      #   passed
+      #
+      #   @return [String]
+      required :last_four, String
+
+      # @!attribute owner
+      #   Legal Name of the business or individual who owns the external account. This
+      #   will appear in statements
+      #
+      #   @return [String]
+      required :owner, String
+
+      # @!attribute owner_type
+      #   Owner Type
+      #
+      #   @return [Symbol, Lithic::Models::OwnerType]
+      required :owner_type, enum: -> { Lithic::OwnerType }
+
+      # @!attribute routing_number
+      #   Routing Number
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute state
+      #   Account State
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::State]
+      required :state, enum: -> { Lithic::Models::ExternalBankAccountUnpauseResponse::State }
+
+      # @!attribute type
+      #   Account Type
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::Type]
+      required :type, enum: -> { Lithic::Models::ExternalBankAccountUnpauseResponse::Type }
+
+      # @!attribute verification_attempts
+      #   The number of attempts at verification
+      #
+      #   @return [Integer]
+      required :verification_attempts, Integer
+
+      # @!attribute verification_method
+      #   Verification Method
+      #
+      #   @return [Symbol, Lithic::Models::VerificationMethod]
+      required :verification_method, enum: -> { Lithic::VerificationMethod }
+
+      # @!attribute verification_state
+      #   Verification State
+      #
+      #   @return [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState]
+      required :verification_state,
+               enum: -> { Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState }
+
+      # @!attribute account_token
+      #   Indicates which Lithic account the external account is associated with. For
+      #   external accounts that are associated with the program, account_token field
+      #   returned will be null
+      #
+      #   @return [String, nil]
+      optional :account_token, String, nil?: true
+
+      # @!attribute address
+      #   Address
+      #
+      #   @return [Lithic::Models::ExternalBankAccountAddress, nil]
+      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, nil?: true
+
+      # @!attribute dob
+      #   Date of Birth of the Individual that owns the external bank account
+      #
+      #   @return [Date, nil]
+      optional :dob, Date, nil?: true
+
+      # @!attribute doing_business_as
+      #   Doing Business As
+      #
+      #   @return [String, nil]
+      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, nil?: true
+
+      # @!attribute name
+      #   The nickname for this External Bank Account
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute user_defined_id
+      #   User Defined ID
+      #
+      #   @return [String, nil]
+      optional :user_defined_id, String, nil?: true
+
+      # @!attribute verification_failed_reason
+      #   Optional free text description of the reason for the failed verification. For
+      #   ACH micro-deposits returned, this field will display the reason return code sent
+      #   by the ACH network
+      #
+      #   @return [String, nil]
+      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
+      #   {Lithic::Models::ExternalBankAccountUnpauseResponse} for more details.
+      #
+      #   @param token [String] A globally unique identifier for this record of an external bank account associa
+      #
+      #   @param country [String] The country that the bank account is located in using ISO 3166-1. We will only a
+      #
+      #   @param created [Time] An ISO 8601 string representing when this funding source was added to the Lithic
+      #
+      #   @param currency [String] currency of the external account 3-character alphabetic ISO 4217 code
+      #
+      #   @param last_four [String] The last 4 digits of the bank account. Derived by Lithic from the account number
+      #
+      #   @param owner [String] Legal Name of the business or individual who owns the external account. This wil
+      #
+      #   @param owner_type [Symbol, Lithic::Models::OwnerType] Owner Type
+      #
+      #   @param routing_number [String] Routing Number
+      #
+      #   @param state [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::State] Account State
+      #
+      #   @param type [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::Type] Account Type
+      #
+      #   @param verification_attempts [Integer] The number of attempts at verification
+      #
+      #   @param verification_method [Symbol, Lithic::Models::VerificationMethod] Verification Method
+      #
+      #   @param verification_state [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState] Verification State
+      #
+      #   @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte
+      #
+      #   @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address
+      #
+      #   @param company_id [String, nil] Optional field that helps identify bank accounts in receipts
+      #
+      #   @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account
+      #
+      #   @param doing_business_as [String, nil] Doing Business As
+      #
+      #   @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits
+      #
+      #   @param name [String, nil] The nickname for this External Bank Account
+      #
+      #   @param user_defined_id [String, nil] User Defined ID
+      #
+      #   @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC
+
+      # Account State
+      #
+      # @see Lithic::Models::ExternalBankAccountUnpauseResponse#state
+      module State
+        extend Lithic::Internal::Type::Enum
+
+        ENABLED = :ENABLED
+        CLOSED = :CLOSED
+        PAUSED = :PAUSED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Account Type
+      #
+      # @see Lithic::Models::ExternalBankAccountUnpauseResponse#type
+      module Type
+        extend Lithic::Internal::Type::Enum
+
+        CHECKING = :CHECKING
+        SAVINGS = :SAVINGS
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Verification State
+      #
+      # @see Lithic::Models::ExternalBankAccountUnpauseResponse#verification_state
+      module VerificationState
+        extend Lithic::Internal::Type::Enum
+
+        PENDING = :PENDING
+        ENABLED = :ENABLED
+        FAILED_VERIFICATION = :FAILED_VERIFICATION
+        INSUFFICIENT_FUNDS = :INSUFFICIENT_FUNDS
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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>]

data/lib/lithic/models/external_payment_list_params.rb

@@ -130,6 +130,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
         #
@@ -123,34 +124,8 @@ module Lithic
         #   @return [String, nil]
         required :tier, String, nil?: true
 
-        # @!attribute charged_off_reason
-        #   @deprecated
-        #
-        #   Reason for the financial account being marked as Charged Off
-        #
-        #   @return [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::ChargedOffReason, nil]
-        optional :charged_off_reason,
-                 enum: -> { Lithic::FinancialAccount::CreditConfiguration::ChargedOffReason },
-                 nil?: true
-
-        # @!attribute financial_account_state
-        #   @deprecated
-        #
-        #   State of the financial account
-        #
-        #   @return [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::FinancialAccountState, nil]
-        optional :financial_account_state,
-                 enum: -> { Lithic::FinancialAccount::CreditConfiguration::FinancialAccountState },
-                 nil?: true
-
-        # @!attribute is_spend_blocked
-        #   @deprecated
-        #
-        #   @return [Boolean, nil]
-        optional :is_spend_blocked, Lithic::Internal::Type::Boolean
-
-        # @!method initialize(auto_collection_configuration:, credit_limit:, credit_product_token:, external_bank_account_token:, tier:, charged_off_reason: nil, financial_account_state: nil, is_spend_blocked: nil)
-        #   @param auto_collection_configuration [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration]
+        # @!method initialize(auto_collection_configuration:, credit_limit:, credit_product_token:, external_bank_account_token:, tier:)
+        #   @param auto_collection_configuration [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, nil]
         #
         #   @param credit_limit [Integer, nil]
         #
@@ -159,12 +134,6 @@ module Lithic
         #   @param external_bank_account_token [String, nil]
         #
         #   @param tier [String, nil] Tier assigned to the financial account
-        #
-        #   @param charged_off_reason [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::ChargedOffReason, nil] Reason for the financial account being marked as Charged Off
-        #
-        #   @param financial_account_state [Symbol, Lithic::Models::FinancialAccount::CreditConfiguration::FinancialAccountState, nil] State of the financial account
-        #
-        #   @param is_spend_blocked [Boolean]
 
         # @see Lithic::Models::FinancialAccount::CreditConfiguration#auto_collection_configuration
         class AutoCollectionConfiguration < Lithic::Internal::Type::BaseModel
@@ -177,38 +146,6 @@ module Lithic
           # @!method initialize(auto_collection_enabled:)
           #   @param auto_collection_enabled [Boolean] If auto collection is enabled for this account
         end
-
-        # @deprecated
-        #
-        # Reason for the financial account being marked as Charged Off
-        #
-        # @see Lithic::Models::FinancialAccount::CreditConfiguration#charged_off_reason
-        module ChargedOffReason
-          extend Lithic::Internal::Type::Enum
-
-          DELINQUENT = :DELINQUENT
-          FRAUD = :FRAUD
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @deprecated
-        #
-        # State of the financial account
-        #
-        # @see Lithic::Models::FinancialAccount::CreditConfiguration#financial_account_state
-        module FinancialAccountState
-          extend Lithic::Internal::Type::Enum
-
-          PENDING = :PENDING
-          CURRENT = :CURRENT
-          DELINQUENT = :DELINQUENT
-          CHARGED_OFF = :CHARGED_OFF
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
 
       # Status of the financial account

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