lithic 0.5.0 → 0.7.0

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      # @see Lithic::Resources::FinancialAccounts::LoanTapeConfiguration#retrieve
+      class FinancialAccountsLoanTapeConfiguration < Lithic::Internal::Type::BaseModel
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute financial_account_token
+        #
+        #   @return [String]
+        required :financial_account_token, String
+
+        # @!attribute instance_token
+        #
+        #   @return [String]
+        required :instance_token, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute credit_product_token
+        #
+        #   @return [String, nil]
+        optional :credit_product_token, String
+
+        # @!attribute loan_tape_rebuild_configuration
+        #   Configuration for building loan tapes
+        #
+        #   @return [Lithic::Models::FinancialAccounts::LoanTapeRebuildConfiguration, nil]
+        optional :loan_tape_rebuild_configuration, -> { Lithic::FinancialAccounts::LoanTapeRebuildConfiguration }
+
+        # @!attribute tier_schedule_changed_at
+        #
+        #   @return [Time, nil]
+        optional :tier_schedule_changed_at, Time
+
+        # @!method initialize(created_at:, financial_account_token:, instance_token:, updated_at:, credit_product_token: nil, loan_tape_rebuild_configuration: nil, tier_schedule_changed_at: nil)
+        #   Configuration for loan tapes
+        #
+        #   @param created_at [Time]
+        #
+        #   @param financial_account_token [String]
+        #
+        #   @param instance_token [String]
+        #
+        #   @param updated_at [Time]
+        #
+        #   @param credit_product_token [String]
+        #
+        #   @param loan_tape_rebuild_configuration [Lithic::Models::FinancialAccounts::LoanTapeRebuildConfiguration] Configuration for building loan tapes
+        #
+        #   @param tier_schedule_changed_at [Time]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      # @see Lithic::Resources::FinancialAccounts::LoanTapeConfiguration#retrieve
+      class LoanTapeConfigurationRetrieveParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        # @!attribute financial_account_token
+        #   Globally unique identifier for financial account.
+        #
+        #   @return [String]
+        required :financial_account_token, String
+
+        # @!method initialize(financial_account_token:, request_options: {})
+        #   @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -8,6 +8,12 @@ module Lithic
         extend Lithic::Internal::Type::RequestParameters::Converter
         include Lithic::Internal::Type::RequestParameters
 
+        # @!attribute financial_account_token
+        #   Globally unique identifier for financial account.
+        #
+        #   @return [String]
+        required :financial_account_token, String
+
         # @!attribute begin_
         #   Date string in RFC 3339 format. Only entries created after the specified date
         #   will be included.
@@ -42,10 +48,12 @@ module Lithic
         #   @return [String, nil]
         optional :starting_after, String
 
-        # @!method initialize(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
+        # @!method initialize(financial_account_token:, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::FinancialAccounts::LoanTapeListParams} for more details.
         #
+        #   @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         #   @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
         #
         #   @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      class LoanTapeRebuildConfiguration < Lithic::Internal::Type::BaseModel
+        # @!attribute rebuild_needed
+        #   Whether the account's loan tapes need to be rebuilt or not
+        #
+        #   @return [Boolean]
+        required :rebuild_needed, Lithic::Internal::Type::Boolean
+
+        # @!attribute last_rebuild
+        #   The date for which the account's loan tapes were last rebuilt
+        #
+        #   @return [Date, nil]
+        optional :last_rebuild, Date
+
+        # @!attribute rebuild_from
+        #   Date from which to start rebuilding from if the account requires a rebuild
+        #
+        #   @return [Date, nil]
+        optional :rebuild_from, Date
+
+        # @!method initialize(rebuild_needed:, last_rebuild: nil, rebuild_from: nil)
+        #   Configuration for building loan tapes
+        #
+        #   @param rebuild_needed [Boolean] Whether the account's loan tapes need to be rebuilt or not
+        #
+        #   @param last_rebuild [Date] The date for which the account's loan tapes were last rebuilt
+        #
+        #   @param rebuild_from [Date] Date from which to start rebuilding from if the account requires a rebuild
+      end
+    end
+  end
+end

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

@@ -14,9 +14,17 @@ module Lithic
         #   @return [String]
         required :financial_account_token, String
 
-        # @!method initialize(financial_account_token:, request_options: {})
+        # @!attribute loan_tape_token
+        #   Globally unique identifier for loan tape.
+        #
+        #   @return [String]
+        required :loan_tape_token, String
+
+        # @!method initialize(financial_account_token:, loan_tape_token:, request_options: {})
         #   @param financial_account_token [String] Globally unique identifier for financial account.
         #
+        #   @param loan_tape_token [String] Globally unique identifier for loan tape.
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -299,6 +299,7 @@ module Lithic
               END_USER_REQUEST = :END_USER_REQUEST
               BANK_REQUEST = :BANK_REQUEST
               DELINQUENT = :DELINQUENT
+              INTEREST_AND_FEES_PAUSED = :INTEREST_AND_FEES_PAUSED
 
               # @!method self.values
               #   @return [Array<Symbol>]

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

@@ -8,6 +8,12 @@ module Lithic
         extend Lithic::Internal::Type::RequestParameters::Converter
         include Lithic::Internal::Type::RequestParameters
 
+        # @!attribute financial_account_token
+        #   Globally unique identifier for financial account.
+        #
+        #   @return [String]
+        required :financial_account_token, String
+
         # @!attribute begin_
         #   Date string in RFC 3339 format. Only entries created after the specified date
         #   will be included.
@@ -48,10 +54,12 @@ module Lithic
         #   @return [String, nil]
         optional :starting_after, String
 
-        # @!method initialize(begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {})
+        # @!method initialize(financial_account_token:, begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::FinancialAccounts::StatementListParams} for more details.
         #
+        #   @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         #   @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
         #
         #   @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w

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

@@ -14,9 +14,17 @@ module Lithic
         #   @return [String]
         required :financial_account_token, String
 
-        # @!method initialize(financial_account_token:, request_options: {})
+        # @!attribute statement_token
+        #   Globally unique identifier for statements.
+        #
+        #   @return [String]
+        required :statement_token, String
+
+        # @!method initialize(financial_account_token:, statement_token:, request_options: {})
         #   @param financial_account_token [String] Globally unique identifier for financial account.
         #
+        #   @param statement_token [String] Globally unique identifier for statements.
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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/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/kyb.rb

@@ -56,15 +56,6 @@ module Lithic
       #   @return [Symbol, Lithic::Models::KYB::Workflow]
       required :workflow, enum: -> { Lithic::KYB::Workflow }
 
-      # @!attribute beneficial_owner_entities
-      #   @deprecated
-      #
-      #   Deprecated.
-      #
-      #   @return [Array<Lithic::Models::KYB::BeneficialOwnerEntity>, nil]
-      optional :beneficial_owner_entities,
-               -> { Lithic::Internal::Type::ArrayOf[Lithic::KYB::BeneficialOwnerEntity] }
-
       # @!attribute external_id
       #   A user provided id that can be used to link an account holder with an external
       #   system
@@ -94,7 +85,7 @@ module Lithic
       #   @return [String, nil]
       optional :website_url, String
 
-      # @!method initialize(beneficial_owner_individuals:, business_entity:, control_person:, nature_of_business:, tos_timestamp:, workflow:, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, naics_code: nil, website_url: nil)
+      # @!method initialize(beneficial_owner_individuals:, business_entity:, control_person:, nature_of_business:, tos_timestamp:, workflow:, external_id: nil, kyb_passed_timestamp: nil, naics_code: nil, website_url: nil)
       #   Some parameter documentations has been truncated, see {Lithic::Models::KYB} for
       #   more details.
       #
@@ -110,8 +101,6 @@ module Lithic
       #
       #   @param workflow [Symbol, Lithic::Models::KYB::Workflow] Specifies the type of KYB workflow to run.
       #
-      #   @param beneficial_owner_entities [Array<Lithic::Models::KYB::BeneficialOwnerEntity>] Deprecated.
-      #
       #   @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 KYB was completed on the busin
@@ -341,65 +330,6 @@ module Lithic
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
-        # @!attribute address
-        #   Business's physical address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable.
-        #
-        #   @return [Lithic::Models::Address]
-        required :address, -> { Lithic::Address }
-
-        # @!attribute government_id
-        #   Government-issued identification number. US Federal Employer Identification
-        #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
-        #   without hyphens.
-        #
-        #   @return [String]
-        required :government_id, String
-
-        # @!attribute legal_business_name
-        #   Legal (formal) business name.
-        #
-        #   @return [String]
-        required :legal_business_name, String
-
-        # @!attribute phone_numbers
-        #   One or more of the business's phone number(s), entered as a list in E.164
-        #   format.
-        #
-        #   @return [Array<String>]
-        required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
-
-        # @!attribute dba_business_name
-        #   Any name that the business operates under that is not its legal business name
-        #   (if applicable).
-        #
-        #   @return [String, nil]
-        optional :dba_business_name, String
-
-        # @!attribute parent_company
-        #   Parent company name (if applicable).
-        #
-        #   @return [String, nil]
-        optional :parent_company, String
-
-        # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Lithic::Models::KYB::BeneficialOwnerEntity} for more details.
-        #
-        #   @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
-        #
-        #   @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
-        #
-        #   @param legal_business_name [String] Legal (formal) business name.
-        #
-        #   @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
-        #
-        #   @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
-        #
-        #   @param parent_company [String] Parent company name (if applicable).
-      end
     end
   end
 end

data/lib/lithic/models/management_operation_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 management_operation_token
+      #
+      #   @return [String]
+      required :management_operation_token, String
+
+      # @!method initialize(management_operation_token:, request_options: {})
+      #   @param management_operation_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/management_operation_reverse_params.rb

@@ -7,6 +7,11 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
+      # @!attribute management_operation_token
+      #
+      #   @return [String]
+      required :management_operation_token, String
+
       # @!attribute effective_date
       #
       #   @return [Date]
@@ -17,7 +22,8 @@ module Lithic
       #   @return [String, nil]
       optional :memo, String
 
-      # @!method initialize(effective_date:, memo: nil, request_options: {})
+      # @!method initialize(management_operation_token:, effective_date:, memo: nil, request_options: {})
+      #   @param management_operation_token [String]
       #   @param effective_date [Date]
       #   @param memo [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]

data/lib/lithic/models/network_program_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 network_program_token
+      #
+      #   @return [String]
+      required :network_program_token, String
+
+      # @!method initialize(network_program_token:, request_options: {})
+      #   @param network_program_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/parsed_webhook_event.rb

@@ -205,14 +205,6 @@ module Lithic
 
         # @see Lithic::Models::ParsedWebhookEvent::KYBPayload#update_request
         class UpdateRequest < Lithic::Internal::Type::BaseModel
-          # @!attribute beneficial_owner_entities
-          #   @deprecated
-          #
-          #   Deprecated.
-          #
-          #   @return [Array<Lithic::Models::KYBBusinessEntity>, nil]
-          optional :beneficial_owner_entities, -> { Lithic::Internal::Type::ArrayOf[Lithic::KYBBusinessEntity] }
-
           # @!attribute beneficial_owner_individuals
           #   You must submit a list of all direct and indirect individuals with 25% or more
           #   ownership in the company. A maximum of 4 beneficial owners can be submitted. If
@@ -245,15 +237,13 @@ module Lithic
           #   @return [Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson, nil]
           optional :control_person, -> { Lithic::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson }
 
-          # @!method initialize(beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_entity: nil, control_person: nil)
+          # @!method initialize(beneficial_owner_individuals: nil, business_entity: nil, control_person: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest} for more
           #   details.
           #
           #   Original request to update the account holder.
           #
-          #   @param beneficial_owner_entities [Array<Lithic::Models::KYBBusinessEntity>] Deprecated.
-          #
           #   @param beneficial_owner_individuals [Array<Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual>] You must submit a list of all direct and indirect individuals with 25% or more o
           #
           #   @param business_entity [Lithic::Models::KYBBusinessEntity] Information for business for which the account is being opened and KYB is being

data/lib/lithic/models/payment_create_params.rb

@@ -44,6 +44,12 @@ module Lithic
       #   @return [String, nil]
       optional :token, String
 
+      # @!attribute hold
+      #   Optional hold to settle when this payment is initiated.
+      #
+      #   @return [Lithic::Models::PaymentCreateParams::Hold, nil]
+      optional :hold, -> { Lithic::PaymentCreateParams::Hold }
+
       # @!attribute memo
       #
       #   @return [String, nil]
@@ -54,7 +60,7 @@ module Lithic
       #   @return [String, nil]
       optional :user_defined_id, String
 
-      # @!method initialize(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, memo: nil, user_defined_id: nil, request_options: {})
+      # @!method initialize(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, hold: nil, memo: nil, user_defined_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::PaymentCreateParams} for more details.
       #
@@ -72,6 +78,8 @@ module Lithic
       #
       #   @param token [String] Customer-provided token that will serve as an idempotency token. This token will
       #
+      #   @param hold [Lithic::Models::PaymentCreateParams::Hold] Optional hold to settle when this payment is initiated.
+      #
       #   @param memo [String]
       #
       #   @param user_defined_id [String]
@@ -134,6 +142,19 @@ module Lithic
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class Hold < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   Token of the hold to settle when this payment is initiated.
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!method initialize(token:)
+        #   Optional hold to settle when this payment is initiated.
+        #
+        #   @param token [String] Token of the hold to settle when this payment is initiated.
+      end
     end
   end
 end

data/lib/lithic/models/payment_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 payment_token
+      #
+      #   @return [String]
+      required :payment_token, String
+
+      # @!method initialize(payment_token:, request_options: {})
+      #   @param payment_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/payment_retry_params.rb

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

data/lib/lithic/models/payment_return_params.rb

@@ -7,6 +7,11 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
+      # @!attribute payment_token
+      #
+      #   @return [String]
+      required :payment_token, String
+
       # @!attribute financial_account_token
       #   Globally unique identifier for the financial account
       #
@@ -42,10 +47,12 @@ module Lithic
       #   @return [String, nil]
       optional :memo, String, nil?: true
 
-      # @!method initialize(financial_account_token:, return_reason_code:, addenda: nil, date_of_death: nil, memo: nil, request_options: {})
+      # @!method initialize(payment_token:, financial_account_token:, return_reason_code:, addenda: nil, date_of_death: nil, memo: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::PaymentReturnParams} for more details.
       #
+      #   @param payment_token [String]
+      #
       #   @param financial_account_token [String] Globally unique identifier for the financial account
       #
       #   @param return_reason_code [String] ACH return reason code indicating the reason for returning the payment. Supporte

data/lib/lithic/models/payment_simulate_action_params.rb

@@ -7,6 +7,11 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
+      # @!attribute payment_token
+      #
+      #   @return [String]
+      required :payment_token, String
+
       # @!attribute event_type
       #   Event Type
       #
@@ -37,7 +42,9 @@ module Lithic
       #   @return [String, nil]
       optional :return_reason_code, String
 
-      # @!method initialize(event_type:, date_of_death: nil, decline_reason: nil, return_addenda: nil, return_reason_code: nil, request_options: {})
+      # @!method initialize(payment_token:, event_type:, date_of_death: nil, decline_reason: nil, return_addenda: nil, return_reason_code: nil, request_options: {})
+      #   @param payment_token [String]
+      #
       #   @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType] Event Type
       #
       #   @param date_of_death [Date] Date of Death for ACH Return