lithic 0.6.0 → 0.8.0

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

@@ -15,6 +15,12 @@ module Lithic
           #   @return [String]
           required :financial_account_token, String
 
+          # @!attribute statement_token
+          #   Globally unique identifier for statements.
+          #
+          #   @return [String]
+          required :statement_token, String
+
           # @!attribute ending_before
           #   A cursor representing an item's token before which a page of results should end.
           #   Used to retrieve the previous page of results before this item.
@@ -35,13 +41,15 @@ module Lithic
           #   @return [String, nil]
           optional :starting_after, String
 
-          # @!method initialize(financial_account_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
+          # @!method initialize(financial_account_token:, statement_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::FinancialAccounts::Statements::LineItemListParams} for more
           #   details.
           #
           #   @param financial_account_token [String] Globally unique identifier for financial account.
           #
+          #   @param statement_token [String] Globally unique identifier for statements.
+          #
           #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
           #
           #   @param page_size [Integer] Page size (for pagination).

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

@@ -34,6 +34,9 @@ module Lithic
             required :amount, Integer
 
             # @!attribute category
+            #   Note: Inbound wire transfers are coming soon (availability varies by partner
+            #   bank). The WIRE category is a preview. To learn more, contact your customer
+            #   success manager.
             #
             #   @return [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
             required :category, enum: -> { Lithic::FinancialAccounts::Statements::StatementLineItems::Data::Category }
@@ -92,7 +95,19 @@ module Lithic
             #   @return [String, nil]
             optional :descriptor, String
 
-            # @!method initialize(token:, amount:, category:, created:, currency:, effective_date:, event_type:, financial_account_token:, financial_transaction_event_token:, financial_transaction_token:, card_token: nil, descriptor: nil)
+            # @!attribute event_subtype
+            #   Subtype of the event that generated the line items
+            #
+            #   @return [String, nil]
+            optional :event_subtype, String, nil?: true
+
+            # @!attribute loan_tape_date
+            #   Date of the loan tape that generated this line item
+            #
+            #   @return [Date, nil]
+            optional :loan_tape_date, Date, nil?: true
+
+            # @!method initialize(token:, amount:, category:, created:, currency:, effective_date:, event_type:, financial_account_token:, financial_transaction_event_token:, financial_transaction_token:, card_token: nil, descriptor: nil, event_subtype: nil, loan_tape_date: nil)
             #   Some parameter documentations has been truncated, see
             #   {Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data} for
             #   more details.
@@ -101,7 +116,7 @@ module Lithic
             #
             #   @param amount [Integer] Transaction amount in cents
             #
-            #   @param category [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
+            #   @param category [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category] Note: Inbound wire transfers are coming soon (availability varies by partner ban
             #
             #   @param created [Time] Timestamp of when the line item was generated
             #
@@ -120,12 +135,21 @@ module Lithic
             #   @param card_token [String] Globally unique identifier for a card
             #
             #   @param descriptor [String]
+            #
+            #   @param event_subtype [String, nil] Subtype of the event that generated the line items
+            #
+            #   @param loan_tape_date [Date, nil] Date of the loan tape that generated this line item
 
+            # Note: Inbound wire transfers are coming soon (availability varies by partner
+            # bank). The WIRE category is a preview. To learn more, contact your customer
+            # success manager.
+            #
             # @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#category
             module Category
               extend Lithic::Internal::Type::Enum
 
               ACH = :ACH
+              WIRE = :WIRE
               BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
               FEE = :FEE
               REWARD = :REWARD
@@ -144,6 +168,7 @@ module Lithic
               MANAGEMENT_FEE = :MANAGEMENT_FEE
               MANAGEMENT_REWARD = :MANAGEMENT_REWARD
               MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
+              HOLD = :HOLD
               PROGRAM_FUNDING = :PROGRAM_FUNDING
 
               # @!method self.values

data/lib/lithic/models/fraud/transaction_report_params.rb

@@ -8,6 +8,11 @@ module Lithic
         extend Lithic::Internal::Type::RequestParameters::Converter
         include Lithic::Internal::Type::RequestParameters
 
+        # @!attribute transaction_token
+        #
+        #   @return [String]
+        required :transaction_token, String
+
         # @!attribute fraud_status
         #   The fraud status of the transaction, string (enum) supporting the following
         #   values:
@@ -57,10 +62,12 @@ module Lithic
         #   @return [Symbol, Lithic::Models::Fraud::TransactionReportParams::FraudType, nil]
         optional :fraud_type, enum: -> { Lithic::Fraud::TransactionReportParams::FraudType }
 
-        # @!method initialize(fraud_status:, comment: nil, fraud_type: nil, request_options: {})
+        # @!method initialize(transaction_token:, fraud_status:, comment: nil, fraud_type: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::Fraud::TransactionReportParams} for more details.
         #
+        #   @param transaction_token [String]
+        #
         #   @param fraud_status [Symbol, Lithic::Models::Fraud::TransactionReportParams::FraudStatus] The fraud status of the transaction, string (enum) supporting the following valu
         #
         #   @param comment [String] Optional field providing additional information or context about why the transac

data/lib/lithic/models/fraud/transaction_retrieve_params.rb

@@ -8,7 +8,13 @@ module Lithic
         extend Lithic::Internal::Type::RequestParameters::Converter
         include Lithic::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute transaction_token
+        #
+        #   @return [String]
+        required :transaction_token, String
+
+        # @!method initialize(transaction_token:, request_options: {})
+        #   @param transaction_token [String]
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/lithic/models/funding_event_retrieve_details_params.rb

@@ -7,7 +7,13 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute funding_event_token
+      #
+      #   @return [String]
+      required :funding_event_token, String
+
+      # @!method initialize(funding_event_token:, request_options: {})
+      #   @param funding_event_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/funding_event_retrieve_params.rb

@@ -7,7 +7,13 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute funding_event_token
+      #
+      #   @return [String]
+      required :funding_event_token, String
+
+      # @!method initialize(funding_event_token:, request_options: {})
+      #   @param funding_event_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/hold.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Holds#create
+    class Hold < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Unique identifier for the transaction
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute created
+      #   ISO 8601 timestamp of when the transaction was created
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute status
+      #   Status of a hold transaction
+      #
+      #   @return [Symbol, Lithic::Models::Hold::Status]
+      required :status, enum: -> { Lithic::Hold::Status }
+
+      # @!attribute updated
+      #   ISO 8601 timestamp of when the transaction was last updated
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!attribute currency
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!attribute events
+      #
+      #   @return [Array<Lithic::Models::HoldEvent>, nil]
+      optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::HoldEvent] }
+
+      # @!attribute expiration_datetime
+      #   When the hold will auto-expire if not resolved
+      #
+      #   @return [Time, nil]
+      optional :expiration_datetime, Time, nil?: true
+
+      # @!attribute family
+      #   HOLD - Hold Transaction
+      #
+      #   @return [Symbol, Lithic::Models::Hold::Family, nil]
+      optional :family, enum: -> { Lithic::Hold::Family }
+
+      # @!attribute financial_account_token
+      #
+      #   @return [String, nil]
+      optional :financial_account_token, String
+
+      # @!attribute pending_amount
+      #   Current pending amount (0 when resolved)
+      #
+      #   @return [Integer, nil]
+      optional :pending_amount, Integer
+
+      # @!attribute result
+      #
+      #   @return [Symbol, Lithic::Models::Hold::Result, nil]
+      optional :result, enum: -> { Lithic::Hold::Result }
+
+      # @!attribute user_defined_id
+      #
+      #   @return [String, nil]
+      optional :user_defined_id, String, nil?: true
+
+      # @!method initialize(token:, created:, status:, updated:, currency: nil, events: nil, expiration_datetime: nil, family: nil, financial_account_token: nil, pending_amount: nil, result: nil, user_defined_id: nil)
+      #   A hold transaction representing reserved funds on a financial account. Holds
+      #   move funds from available to pending balance in anticipation of future payments.
+      #   They can be resolved via settlement (linked to payment), manual release, or
+      #   expiration.
+      #
+      #   @param token [String] Unique identifier for the transaction
+      #
+      #   @param created [Time] ISO 8601 timestamp of when the transaction was created
+      #
+      #   @param status [Symbol, Lithic::Models::Hold::Status] Status of a hold transaction
+      #
+      #   @param updated [Time] ISO 8601 timestamp of when the transaction was last updated
+      #
+      #   @param currency [String]
+      #
+      #   @param events [Array<Lithic::Models::HoldEvent>]
+      #
+      #   @param expiration_datetime [Time, nil] When the hold will auto-expire if not resolved
+      #
+      #   @param family [Symbol, Lithic::Models::Hold::Family] HOLD - Hold Transaction
+      #
+      #   @param financial_account_token [String]
+      #
+      #   @param pending_amount [Integer] Current pending amount (0 when resolved)
+      #
+      #   @param result [Symbol, Lithic::Models::Hold::Result]
+      #
+      #   @param user_defined_id [String, nil]
+
+      # Status of a hold transaction
+      #
+      # @see Lithic::Models::Hold#status
+      module Status
+        extend Lithic::Internal::Type::Enum
+
+        PENDING = :PENDING
+        SETTLED = :SETTLED
+        EXPIRED = :EXPIRED
+        VOIDED = :VOIDED
+        DECLINED = :DECLINED
+        REVERSED = :REVERSED
+        CANCELED = :CANCELED
+        RETURNED = :RETURNED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # HOLD - Hold Transaction
+      #
+      # @see Lithic::Models::Hold#family
+      module Family
+        extend Lithic::Internal::Type::Enum
+
+        HOLD = :HOLD
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Lithic::Models::Hold#result
+      module Result
+        extend Lithic::Internal::Type::Enum
+
+        APPROVED = :APPROVED
+        DECLINED = :DECLINED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/hold_create_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Holds#create
+    class HoldCreateParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute financial_account_token
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute amount
+      #   Amount to hold in cents
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute token
+      #   Customer-provided token for idempotency. Becomes the hold token.
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!attribute expiration_datetime
+      #   When the hold should auto-expire
+      #
+      #   @return [Time, nil]
+      optional :expiration_datetime, Time
+
+      # @!attribute memo
+      #   Reason for the hold
+      #
+      #   @return [String, nil]
+      optional :memo, String, nil?: true
+
+      # @!attribute user_defined_id
+      #   User-provided identifier for the hold
+      #
+      #   @return [String, nil]
+      optional :user_defined_id, String
+
+      # @!method initialize(financial_account_token:, amount:, token: nil, expiration_datetime: nil, memo: nil, user_defined_id: nil, request_options: {})
+      #   @param financial_account_token [String]
+      #
+      #   @param amount [Integer] Amount to hold in cents
+      #
+      #   @param token [String] Customer-provided token for idempotency. Becomes the hold token.
+      #
+      #   @param expiration_datetime [Time] When the hold should auto-expire
+      #
+      #   @param memo [String, nil] Reason for the hold
+      #
+      #   @param user_defined_id [String] User-provided identifier for the hold
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/hold_event.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class HoldEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute amount
+      #   Amount in cents
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute created
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute detailed_results
+      #
+      #   @return [Array<Symbol, Lithic::Models::HoldEvent::DetailedResult>]
+      required :detailed_results,
+               -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::HoldEvent::DetailedResult] }
+
+      # @!attribute memo
+      #
+      #   @return [String, nil]
+      required :memo, String, nil?: true
+
+      # @!attribute result
+      #
+      #   @return [Symbol, Lithic::Models::HoldEvent::Result]
+      required :result, enum: -> { Lithic::HoldEvent::Result }
+
+      # @!attribute settling_transaction_token
+      #   Transaction token of the payment that settled this hold (only populated for
+      #   HOLD_SETTLED events)
+      #
+      #   @return [String, nil]
+      required :settling_transaction_token, String, nil?: true
+
+      # @!attribute type
+      #   Type of hold lifecycle event
+      #
+      #   @return [Symbol, Lithic::Models::HoldEvent::Type]
+      required :type, enum: -> { Lithic::HoldEvent::Type }
+
+      # @!method initialize(token:, amount:, created:, detailed_results:, memo:, result:, settling_transaction_token:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::HoldEvent} for more details.
+      #
+      #   Event representing a lifecycle change to a hold
+      #
+      #   @param token [String]
+      #
+      #   @param amount [Integer] Amount in cents
+      #
+      #   @param created [Time]
+      #
+      #   @param detailed_results [Array<Symbol, Lithic::Models::HoldEvent::DetailedResult>]
+      #
+      #   @param memo [String, nil]
+      #
+      #   @param result [Symbol, Lithic::Models::HoldEvent::Result]
+      #
+      #   @param settling_transaction_token [String, nil] Transaction token of the payment that settled this hold (only populated for HOLD
+      #
+      #   @param type [Symbol, Lithic::Models::HoldEvent::Type] Type of hold lifecycle event
+
+      module DetailedResult
+        extend Lithic::Internal::Type::Enum
+
+        APPROVED = :APPROVED
+        INSUFFICIENT_FUNDS = :INSUFFICIENT_FUNDS
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Lithic::Models::HoldEvent#result
+      module Result
+        extend Lithic::Internal::Type::Enum
+
+        APPROVED = :APPROVED
+        DECLINED = :DECLINED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Type of hold lifecycle event
+      #
+      # @see Lithic::Models::HoldEvent#type
+      module Type
+        extend Lithic::Internal::Type::Enum
+
+        HOLD_INITIATED = :HOLD_INITIATED
+        HOLD_VOIDED = :HOLD_VOIDED
+        HOLD_EXPIRED = :HOLD_EXPIRED
+        HOLD_SETTLED = :HOLD_SETTLED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/hold_list_params.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Holds#list
+    class HoldListParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute financial_account_token
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute begin_
+      #   Date string in RFC 3339 format. Only entries created after the specified time
+      #   will be included. UTC time zone.
+      #
+      #   @return [Time, nil]
+      optional :begin_, Time
+
+      # @!attribute end_
+      #   Date string in RFC 3339 format. Only entries created before the specified time
+      #   will be included. UTC time zone.
+      #
+      #   @return [Time, nil]
+      optional :end_, Time
+
+      # @!attribute ending_before
+      #   A cursor representing an item's token before which a page of results should end.
+      #   Used to retrieve the previous page of results before this item.
+      #
+      #   @return [String, nil]
+      optional :ending_before, String
+
+      # @!attribute page_size
+      #   Page size (for pagination).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute starting_after
+      #   A cursor representing an item's token after which a page of results should
+      #   begin. Used to retrieve the next page of results after this item.
+      #
+      #   @return [String, nil]
+      optional :starting_after, String
+
+      # @!attribute status
+      #   Hold status to filter by.
+      #
+      #   @return [Symbol, Lithic::Models::HoldListParams::Status, nil]
+      optional :status, enum: -> { Lithic::HoldListParams::Status }
+
+      # @!method initialize(financial_account_token:, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::HoldListParams} for more details.
+      #
+      #   @param financial_account_token [String]
+      #
+      #   @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      #
+      #   @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      #
+      #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      #
+      #   @param page_size [Integer] Page size (for pagination).
+      #
+      #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      #
+      #   @param status [Symbol, Lithic::Models::HoldListParams::Status] Hold status to filter by.
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+
+      # Hold status to filter by.
+      module Status
+        extend Lithic::Internal::Type::Enum
+
+        PENDING = :PENDING
+        SETTLED = :SETTLED
+        EXPIRED = :EXPIRED
+        VOIDED = :VOIDED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/hold_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Holds#retrieve
+    class HoldRetrieveParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute hold_token
+      #
+      #   @return [String]
+      required :hold_token, String
+
+      # @!method initialize(hold_token:, request_options: {})
+      #   @param hold_token [String]
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/hold_void_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Holds#void
+    class HoldVoidParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute hold_token
+      #
+      #   @return [String]
+      required :hold_token, String
+
+      # @!attribute memo
+      #   Reason for voiding the hold
+      #
+      #   @return [String, nil]
+      optional :memo, String, nil?: true
+
+      # @!method initialize(hold_token:, memo: nil, request_options: {})
+      #   @param hold_token [String]
+      #
+      #   @param memo [String, nil] Reason for voiding the hold
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/instance_financial_account_type.rb

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