lithic 0.1.0.pre.alpha.40 → 0.1.0.pre.alpha.42

data/lib/lithic/models/external_payment.rb

@@ -5,85 +5,139 @@ module Lithic
     # @see Lithic::Resources::ExternalPayments#create
     class ExternalPayment < Lithic::Internal::Type::BaseModel
       # @!attribute token
+      #   Unique identifier for the transaction
       #
       #   @return [String]
       required :token, String
 
-      # @!attribute category
-      #
-      #   @return [Symbol, Lithic::Models::ExternalPayment::Category]
-      required :category, enum: -> { Lithic::ExternalPayment::Category }
-
       # @!attribute created
+      #   ISO 8601 timestamp of when the transaction was created
       #
       #   @return [Time]
       required :created, Time
 
+      # @!attribute family
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPayment::Family]
+      required :family, enum: -> { Lithic::ExternalPayment::Family }
+
+      # @!attribute status
+      #   The status of the transaction
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPayment::Status]
+      required :status, enum: -> { Lithic::ExternalPayment::Status }
+
+      # @!attribute updated
+      #   ISO 8601 timestamp of when the transaction was last updated
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!attribute category
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPayment::Category, nil]
+      optional :category, enum: -> { Lithic::ExternalPayment::Category }
+
       # @!attribute currency
       #
-      #   @return [String]
-      required :currency, String
+      #   @return [String, nil]
+      optional :currency, String
 
       # @!attribute events
       #
-      #   @return [Array<Lithic::Models::ExternalPayment::Event>]
-      required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::ExternalPayment::Event] }
+      #   @return [Array<Lithic::Models::ExternalPayment::Event>, nil]
+      optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::ExternalPayment::Event] }
 
       # @!attribute financial_account_token
       #
-      #   @return [String]
-      required :financial_account_token, String
+      #   @return [String, nil]
+      optional :financial_account_token, String
 
       # @!attribute payment_type
       #
-      #   @return [Symbol, Lithic::Models::ExternalPayment::PaymentType]
-      required :payment_type, enum: -> { Lithic::ExternalPayment::PaymentType }
+      #   @return [Symbol, Lithic::Models::ExternalPayment::PaymentType, nil]
+      optional :payment_type, enum: -> { Lithic::ExternalPayment::PaymentType }
 
       # @!attribute pending_amount
       #
-      #   @return [Integer]
-      required :pending_amount, Integer
+      #   @return [Integer, nil]
+      optional :pending_amount, Integer
 
       # @!attribute result
       #
-      #   @return [Symbol, Lithic::Models::ExternalPayment::Result]
-      required :result, enum: -> { Lithic::ExternalPayment::Result }
+      #   @return [Symbol, Lithic::Models::ExternalPayment::Result, nil]
+      optional :result, enum: -> { Lithic::ExternalPayment::Result }
 
       # @!attribute settled_amount
       #
-      #   @return [Integer]
-      required :settled_amount, Integer
-
-      # @!attribute status
-      #
-      #   @return [Symbol, Lithic::Models::ExternalPayment::Status]
-      required :status, enum: -> { Lithic::ExternalPayment::Status }
-
-      # @!attribute updated
-      #
-      #   @return [Time]
-      required :updated, Time
+      #   @return [Integer, nil]
+      optional :settled_amount, Integer
 
       # @!attribute user_defined_id
       #
       #   @return [String, nil]
       optional :user_defined_id, String
 
-      # @!method initialize(token:, category:, created:, currency:, events:, financial_account_token:, payment_type:, pending_amount:, result:, settled_amount:, status:, updated:, user_defined_id: nil)
-      #   @param token [String]
+      # @!method initialize(token:, created:, family:, status:, updated:, category: nil, currency: nil, events: 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
+      #
+      #   @param created [Time] ISO 8601 timestamp of when the transaction was created
+      #
+      #   @param family [Symbol, Lithic::Models::ExternalPayment::Family]
+      #
+      #   @param status [Symbol, Lithic::Models::ExternalPayment::Status] The status of the transaction
+      #
+      #   @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
+      #
       #   @param category [Symbol, Lithic::Models::ExternalPayment::Category]
-      #   @param created [Time]
+      #
       #   @param currency [String]
+      #
       #   @param events [Array<Lithic::Models::ExternalPayment::Event>]
+      #
       #   @param financial_account_token [String]
+      #
       #   @param payment_type [Symbol, Lithic::Models::ExternalPayment::PaymentType]
+      #
       #   @param pending_amount [Integer]
+      #
       #   @param result [Symbol, Lithic::Models::ExternalPayment::Result]
+      #
       #   @param settled_amount [Integer]
-      #   @param status [Symbol, Lithic::Models::ExternalPayment::Status]
-      #   @param updated [Time]
+      #
       #   @param user_defined_id [String]
 
+      # @see Lithic::Models::ExternalPayment#family
+      module Family
+        extend Lithic::Internal::Type::Enum
+
+        CARD = :CARD
+        PAYMENT = :PAYMENT
+        TRANSFER = :TRANSFER
+        INTERNAL = :INTERNAL
+        EXTERNAL_PAYMENT = :EXTERNAL_PAYMENT
+        MANAGEMENT_OPERATION = :MANAGEMENT_OPERATION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the transaction
+      #
+      # @see Lithic::Models::ExternalPayment#status
+      module Status
+        extend Lithic::Internal::Type::Enum
+
+        PENDING = :PENDING
+        SETTLED = :SETTLED
+        DECLINED = :DECLINED
+        REVERSED = :REVERSED
+        CANCELED = :CANCELED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Lithic::Models::ExternalPayment#category
       module Category
         extend Lithic::Internal::Type::Enum
@@ -153,6 +207,7 @@ module Lithic
           extend Lithic::Internal::Type::Enum
 
           APPROVED = :APPROVED
+          INSUFFICIENT_FUNDS = :INSUFFICIENT_FUNDS
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -220,20 +275,6 @@ module Lithic
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      # @see Lithic::Models::ExternalPayment#status
-      module Status
-        extend Lithic::Internal::Type::Enum
-
-        PENDING = :PENDING
-        SETTLED = :SETTLED
-        DECLINED = :DECLINED
-        REVERSED = :REVERSED
-        CANCELED = :CANCELED
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/lithic/models/financial_account.rb

@@ -210,6 +210,7 @@ module Lithic
         SECURITY = :SECURITY
         PROGRAM_RECEIVABLES = :PROGRAM_RECEIVABLES
         COLLECTION = :COLLECTION
+        PROGRAM_BANK_ACCOUNTS_PAYABLE = :PROGRAM_BANK_ACCOUNTS_PAYABLE
 
         # @!method self.values
         #   @return [Array<Symbol>]

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

@@ -101,10 +101,7 @@ module Lithic
         # @!attribute previous_statement_balance
         #
         #   @return [Lithic::Models::FinancialAccounts::LoanTape::PreviousStatementBalance]
-        required :previous_statement_balance,
-                 -> {
-                   Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance
-                 }
+        required :previous_statement_balance, -> { Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance }
 
         # @!attribute starting_balance
         #   Balance at the start of the day
@@ -231,10 +228,7 @@ module Lithic
           # @!attribute period_state
           #
           #   @return [Symbol, Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::PeriodState]
-          required :period_state,
-                   enum: -> {
-                     Lithic::FinancialAccounts::LoanTape::AccountStanding::PeriodState
-                   }
+          required :period_state, enum: -> { Lithic::FinancialAccounts::LoanTape::AccountStanding::PeriodState }
 
           # @!method initialize(consecutive_full_payments_made:, consecutive_minimum_payments_made:, consecutive_minimum_payments_missed:, days_past_due:, financial_account_state:, has_grace:, period_number:, period_state:)
           #   @param consecutive_full_payments_made [Integer] Number of consecutive full payments made
@@ -260,9 +254,7 @@ module Lithic
             #
             #   @return [Symbol, Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Status]
             required :status,
-                     enum: -> {
-                       Lithic::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Status
-                     }
+                     enum: -> { Lithic::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Status }
 
             # @!attribute substatus
             #   Substatus for the financial account
@@ -353,10 +345,7 @@ module Lithic
           #   Amount due for the past billing cycles.
           #
           #   @return [Lithic::Models::FinancialAccounts::LoanTape::Balances::PastStatementsDue]
-          required :past_statements_due,
-                   -> {
-                     Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue
-                   }
+          required :past_statements_due, -> { Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue }
 
           # @!method initialize(due:, next_statement_due:, past_due:, past_statements_due:)
           #   Some parameter documentations has been truncated, see
@@ -560,9 +549,7 @@ module Lithic
           #
           #   @return [Symbol, Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::InterestCalculationMethod]
           required :interest_calculation_method,
-                   enum: -> {
-                     Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestCalculationMethod
-                   }
+                   enum: -> { Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestCalculationMethod }
 
           # @!attribute interest_for_period
           #

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

@@ -220,10 +220,7 @@ module Lithic
           # @!attribute period_state
           #
           #   @return [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::PeriodState]
-          required :period_state,
-                   enum: -> {
-                     Lithic::FinancialAccounts::Statement::AccountStanding::PeriodState
-                   }
+          required :period_state, enum: -> { Lithic::FinancialAccounts::Statement::AccountStanding::PeriodState }
 
           # @!method initialize(consecutive_full_payments_made:, consecutive_minimum_payments_made:, consecutive_minimum_payments_missed:, days_past_due:, financial_account_state:, has_grace:, period_number:, period_state:)
           #   @param consecutive_full_payments_made [Integer] Number of consecutive full payments made
@@ -249,9 +246,7 @@ module Lithic
             #
             #   @return [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Status]
             required :status,
-                     enum: -> {
-                       Lithic::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Status
-                     }
+                     enum: -> { Lithic::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Status }
 
             # @!attribute substatus
             #   Substatus for the financial account
@@ -503,9 +498,7 @@ module Lithic
           #
           #   @return [Symbol, Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod]
           required :interest_calculation_method,
-                   enum: -> {
-                     Lithic::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod
-                   }
+                   enum: -> { Lithic::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod }
 
           # @!attribute interest_for_period
           #

data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb

@@ -9,9 +9,7 @@ module Lithic
           #
           #   @return [Array<Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data>]
           required :data,
-                   -> {
-                     Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::Statements::StatementLineItems::Data]
-                   }
+                   -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::Statements::StatementLineItems::Data] }
 
           # @!attribute has_more
           #
@@ -38,10 +36,7 @@ module Lithic
             # @!attribute category
             #
             #   @return [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
-            required :category,
-                     enum: -> {
-                       Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category
-                     }
+            required :category, enum: -> { Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category }
 
             # @!attribute created
             #   Timestamp of when the line item was generated

data/lib/lithic/models/financial_transaction.rb

@@ -172,6 +172,8 @@ module Lithic
         #   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

data/lib/lithic/models/instance_financial_account_type.rb

@@ -15,6 +15,7 @@ module Lithic
       SECURITY = :SECURITY
       PROGRAM_RECEIVABLES = :PROGRAM_RECEIVABLES
       COLLECTION = :COLLECTION
+      PROGRAM_BANK_ACCOUNTS_PAYABLE = :PROGRAM_BANK_ACCOUNTS_PAYABLE
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/lithic/models/kyb.rb

@@ -73,7 +73,7 @@ module Lithic
       optional :external_id, String
 
       # @!attribute kyb_passed_timestamp
-      #   An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+      #   An RFC 3339 timestamp indicating when precomputed KYB was completed on the
       #   business with a pass result.
       #
       #   This field is required only if workflow type is `KYB_BYO`.
@@ -107,7 +107,7 @@ module Lithic
       #
       #   @param external_id [String] A user provided id that can be used to link an account holder with an external s
       #
-      #   @param kyb_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the busin
+      #   @param kyb_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYB was completed on the busin
       #
       #   @param website_url [String] Company website URL.
 

data/lib/lithic/models/management_operation_transaction.rb

@@ -5,91 +5,106 @@ module Lithic
     # @see Lithic::Resources::ManagementOperations#create
     class ManagementOperationTransaction < Lithic::Internal::Type::BaseModel
       # @!attribute token
+      #   Unique identifier for the transaction
       #
       #   @return [String]
       required :token, String
 
-      # @!attribute category
-      #
-      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Category]
-      required :category, enum: -> { Lithic::ManagementOperationTransaction::Category }
-
       # @!attribute created
+      #   ISO 8601 timestamp of when the transaction was created
       #
       #   @return [Time]
       required :created, Time
 
+      # @!attribute family
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Family]
+      required :family, enum: -> { Lithic::ManagementOperationTransaction::Family }
+
+      # @!attribute status
+      #   The status of the transaction
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Status]
+      required :status, enum: -> { Lithic::ManagementOperationTransaction::Status }
+
+      # @!attribute updated
+      #   ISO 8601 timestamp of when the transaction was last updated
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!attribute category
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Category, nil]
+      optional :category, enum: -> { Lithic::ManagementOperationTransaction::Category }
+
       # @!attribute currency
       #
-      #   @return [String]
-      required :currency, String
+      #   @return [String, nil]
+      optional :currency, String
 
       # @!attribute direction
       #
-      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Direction]
-      required :direction, enum: -> { Lithic::ManagementOperationTransaction::Direction }
+      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Direction, nil]
+      optional :direction, enum: -> { Lithic::ManagementOperationTransaction::Direction }
 
       # @!attribute events
       #
-      #   @return [Array<Lithic::Models::ManagementOperationTransaction::Event>]
-      required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::ManagementOperationTransaction::Event] }
+      #   @return [Array<Lithic::Models::ManagementOperationTransaction::Event>, nil]
+      optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::ManagementOperationTransaction::Event] }
+
+      # @!attribute external_resource
+      #   External resource associated with the management operation
+      #
+      #   @return [Lithic::Models::ExternalResource, nil]
+      optional :external_resource, -> { Lithic::ExternalResource }, nil?: true
 
       # @!attribute financial_account_token
       #
-      #   @return [String]
-      required :financial_account_token, String
+      #   @return [String, nil]
+      optional :financial_account_token, String
 
       # @!attribute pending_amount
       #
-      #   @return [Integer]
-      required :pending_amount, Integer
+      #   @return [Integer, nil]
+      optional :pending_amount, Integer
 
       # @!attribute result
       #
-      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Result]
-      required :result, enum: -> { Lithic::ManagementOperationTransaction::Result }
+      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Result, nil]
+      optional :result, enum: -> { Lithic::ManagementOperationTransaction::Result }
 
       # @!attribute settled_amount
       #
-      #   @return [Integer]
-      required :settled_amount, Integer
-
-      # @!attribute status
-      #
-      #   @return [Symbol, Lithic::Models::ManagementOperationTransaction::Status]
-      required :status, enum: -> { Lithic::ManagementOperationTransaction::Status }
+      #   @return [Integer, nil]
+      optional :settled_amount, Integer
 
       # @!attribute transaction_series
       #
       #   @return [Lithic::Models::ManagementOperationTransaction::TransactionSeries, nil]
-      required :transaction_series,
+      optional :transaction_series,
                -> {
                  Lithic::ManagementOperationTransaction::TransactionSeries
                },
                nil?: true
 
-      # @!attribute updated
-      #
-      #   @return [Time]
-      required :updated, Time
-
-      # @!attribute external_resource
-      #   External resource associated with the management operation
-      #
-      #   @return [Lithic::Models::ExternalResource, nil]
-      optional :external_resource, -> { Lithic::ExternalResource }, nil?: true
-
       # @!attribute user_defined_id
       #
       #   @return [String, nil]
       optional :user_defined_id, String
 
-      # @!method initialize(token:, category:, created:, currency:, direction:, events:, financial_account_token:, pending_amount:, result:, settled_amount:, status:, transaction_series:, updated:, external_resource: nil, user_defined_id: nil)
-      #   @param token [String]
+      # @!method initialize(token:, created:, family:, status:, updated:, category: nil, currency: nil, direction: nil, events: nil, external_resource: 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
       #
-      #   @param category [Symbol, Lithic::Models::ManagementOperationTransaction::Category]
+      #   @param created [Time] ISO 8601 timestamp of when the transaction was created
+      #
+      #   @param family [Symbol, Lithic::Models::ManagementOperationTransaction::Family]
       #
-      #   @param created [Time]
+      #   @param status [Symbol, Lithic::Models::ManagementOperationTransaction::Status] The status of the transaction
+      #
+      #   @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
+      #
+      #   @param category [Symbol, Lithic::Models::ManagementOperationTransaction::Category]
       #
       #   @param currency [String]
       #
@@ -97,6 +112,8 @@ module Lithic
       #
       #   @param events [Array<Lithic::Models::ManagementOperationTransaction::Event>]
       #
+      #   @param external_resource [Lithic::Models::ExternalResource, nil] External resource associated with the management operation
+      #
       #   @param financial_account_token [String]
       #
       #   @param pending_amount [Integer]
@@ -105,16 +122,41 @@ module Lithic
       #
       #   @param settled_amount [Integer]
       #
-      #   @param status [Symbol, Lithic::Models::ManagementOperationTransaction::Status]
-      #
       #   @param transaction_series [Lithic::Models::ManagementOperationTransaction::TransactionSeries, nil]
       #
-      #   @param updated [Time]
-      #
-      #   @param external_resource [Lithic::Models::ExternalResource, nil] External resource associated with the management operation
-      #
       #   @param user_defined_id [String]
 
+      # @see Lithic::Models::ManagementOperationTransaction#family
+      module Family
+        extend Lithic::Internal::Type::Enum
+
+        CARD = :CARD
+        PAYMENT = :PAYMENT
+        TRANSFER = :TRANSFER
+        INTERNAL = :INTERNAL
+        EXTERNAL_PAYMENT = :EXTERNAL_PAYMENT
+        MANAGEMENT_OPERATION = :MANAGEMENT_OPERATION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the transaction
+      #
+      # @see Lithic::Models::ManagementOperationTransaction#status
+      module Status
+        extend Lithic::Internal::Type::Enum
+
+        PENDING = :PENDING
+        SETTLED = :SETTLED
+        DECLINED = :DECLINED
+        REVERSED = :REVERSED
+        CANCELED = :CANCELED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Lithic::Models::ManagementOperationTransaction#category
       module Category
         extend Lithic::Internal::Type::Enum
@@ -160,9 +202,7 @@ module Lithic
         #
         #   @return [Array<Symbol, Lithic::Models::ManagementOperationTransaction::Event::DetailedResult>]
         required :detailed_results,
-                 -> {
-                   Lithic::Internal::Type::ArrayOf[enum: Lithic::ManagementOperationTransaction::Event::DetailedResult]
-                 }
+                 -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::ManagementOperationTransaction::Event::DetailedResult] }
 
         # @!attribute effective_date
         #
@@ -204,6 +244,7 @@ module Lithic
           extend Lithic::Internal::Type::Enum
 
           APPROVED = :APPROVED
+          INSUFFICIENT_FUNDS = :INSUFFICIENT_FUNDS
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -260,20 +301,6 @@ module Lithic
         #   @return [Array<Symbol>]
       end
 
-      # @see Lithic::Models::ManagementOperationTransaction#status
-      module Status
-        extend Lithic::Internal::Type::Enum
-
-        PENDING = :PENDING
-        SETTLED = :SETTLED
-        DECLINED = :DECLINED
-        REVERSED = :REVERSED
-        CANCELED = :CANCELED
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # @see Lithic::Models::ManagementOperationTransaction#transaction_series
       class TransactionSeries < Lithic::Internal::Type::BaseModel
         # @!attribute related_transaction_event_token