lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

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

@@ -129,27 +129,51 @@ module Lithic
         optional :next_statement_end_date, Date
 
         # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil)
-        #   @param token [String]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::FinancialAccounts::Statement} for more details.
+        #
+        #   @param token [String] Globally unique identifier for a statement
+        #
         #   @param account_standing [Lithic::Models::FinancialAccounts::Statement::AccountStanding]
+        #
         #   @param amount_due [Lithic::Models::FinancialAccounts::Statement::AmountDue]
-        #   @param available_credit [Integer]
-        #   @param created [Time]
-        #   @param credit_limit [Integer]
-        #   @param credit_product_token [String]
-        #   @param days_in_billing_cycle [Integer]
-        #   @param ending_balance [Integer]
-        #   @param financial_account_token [String]
-        #   @param payment_due_date [Date, nil]
+        #
+        #   @param available_credit [Integer] Amount of credit available to spend in cents
+        #
+        #   @param created [Time] Timestamp of when the statement was created
+        #
+        #   @param credit_limit [Integer] This is the maximum credit balance extended by the lender in cents
+        #
+        #   @param credit_product_token [String] Globally unique identifier for a credit product
+        #
+        #   @param days_in_billing_cycle [Integer] Number of days in the billing cycle
+        #
+        #   @param ending_balance [Integer] Balance at the end of the billing period. For charge cards, this should be the s
+        #   ...
+        #
+        #   @param financial_account_token [String] Globally unique identifier for a financial account
+        #
+        #   @param payment_due_date [Date, nil] Date when the payment is due
+        #
         #   @param period_totals [Lithic::Models::FinancialAccounts::Statement::PeriodTotals]
-        #   @param starting_balance [Integer]
-        #   @param statement_end_date [Date]
-        #   @param statement_start_date [Date]
+        #
+        #   @param starting_balance [Integer] Balance at the start of the billing period
+        #
+        #   @param statement_end_date [Date] Date when the billing period ended
+        #
+        #   @param statement_start_date [Date] Date when the billing period began
+        #
         #   @param statement_type [Symbol, Lithic::Models::FinancialAccounts::Statement::StatementType]
-        #   @param updated [Time]
+        #
+        #   @param updated [Time] Timestamp of when the statement was updated
+        #
         #   @param ytd_totals [Lithic::Models::FinancialAccounts::Statement::YtdTotals]
+        #
         #   @param interest_details [Lithic::Models::FinancialAccounts::Statement::InterestDetails, nil]
-        #   @param next_payment_due_date [Date]
-        #   @param next_statement_end_date [Date]
+        #
+        #   @param next_payment_due_date [Date] Date when the next payment is due
+        #
+        #   @param next_statement_end_date [Date] Date when the next billing period will end
 
         # @see Lithic::Models::FinancialAccounts::Statement#account_standing
         class AccountStanding < Lithic::Internal::Type::BaseModel
@@ -203,13 +227,20 @@ module Lithic
                    enum: -> { Lithic::Models::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]
-          #   @param consecutive_minimum_payments_made [Integer]
-          #   @param consecutive_minimum_payments_missed [Integer]
-          #   @param days_past_due [Integer]
-          #   @param financial_account_state [Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState]
-          #   @param has_grace [Boolean]
-          #   @param period_number [Integer]
+          #   @param consecutive_full_payments_made [Integer] Number of consecutive full payments made
+          #
+          #   @param consecutive_minimum_payments_made [Integer] Number of consecutive minimum payments made
+          #
+          #   @param consecutive_minimum_payments_missed [Integer] Number of consecutive minimum payments missed
+          #
+          #   @param days_past_due [Integer] Number of days past due
+          #
+          #   @param financial_account_state [Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState] Information about the financial account state
+          #
+          #   @param has_grace [Boolean] Whether the account currently has grace or not
+          #
+          #   @param period_number [Integer] Current overall period number
+          #
           #   @param period_state [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::PeriodState]
 
           # @see Lithic::Models::FinancialAccounts::Statement::AccountStanding#financial_account_state
@@ -232,8 +263,9 @@ module Lithic
             # @!method initialize(status:, substatus: nil)
             #   Information about the financial account state
             #
-            #   @param status [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Status]
-            #   @param substatus [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Substatus, nil]
+            #   @param status [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Status] Status of the financial account
+            #
+            #   @param substatus [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Substatus, nil] Substatus for the financial account
 
             # Status of the financial account
             #
@@ -298,8 +330,13 @@ module Lithic
           required :past_due, Integer
 
           # @!method initialize(amount:, past_due:)
-          #   @param amount [Integer]
-          #   @param past_due [Integer]
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::Statement::AmountDue} for more details.
+          #
+          #   @param amount [Integer] Payment due at the end of the billing period in cents. Negative amount indicates
+          #   ...
+          #
+          #   @param past_due [Integer] Amount past due for statement in cents
         end
 
         # @see Lithic::Models::FinancialAccounts::Statement#period_totals
@@ -348,13 +385,23 @@ module Lithic
           required :purchases, Integer
 
           # @!method initialize(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          #   @param balance_transfers [Integer]
-          #   @param cash_advances [Integer]
-          #   @param credits [Integer]
-          #   @param fees [Integer]
-          #   @param interest [Integer]
-          #   @param payments [Integer]
-          #   @param purchases [Integer]
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::Statement::PeriodTotals} for more details.
+          #
+          #   @param balance_transfers [Integer] Opening balance transferred from previous account in cents
+          #
+          #   @param cash_advances [Integer] ATM and cashback transactions in cents
+          #
+          #   @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
+          #   ...
+          #
+          #   @param fees [Integer] Volume of debit management operation transactions less any interest in cents
+          #
+          #   @param interest [Integer] Interest accrued in cents
+          #
+          #   @param payments [Integer] Any funds transfers which affective the balance in cents
+          #
+          #   @param purchases [Integer] Net card transaction volume less any cash advances in cents
         end
 
         # @see Lithic::Models::FinancialAccounts::Statement#statement_type
@@ -415,13 +462,23 @@ module Lithic
           required :purchases, Integer
 
           # @!method initialize(balance_transfers:, cash_advances:, credits:, fees:, interest:, payments:, purchases:)
-          #   @param balance_transfers [Integer]
-          #   @param cash_advances [Integer]
-          #   @param credits [Integer]
-          #   @param fees [Integer]
-          #   @param interest [Integer]
-          #   @param payments [Integer]
-          #   @param purchases [Integer]
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::Statement::YtdTotals} for more details.
+          #
+          #   @param balance_transfers [Integer] Opening balance transferred from previous account in cents
+          #
+          #   @param cash_advances [Integer] ATM and cashback transactions in cents
+          #
+          #   @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
+          #   ...
+          #
+          #   @param fees [Integer] Volume of debit management operation transactions less any interest in cents
+          #
+          #   @param interest [Integer] Interest accrued in cents
+          #
+          #   @param payments [Integer] Any funds transfers which affective the balance in cents
+          #
+          #   @param purchases [Integer] Net card transaction volume less any cash advances in cents
         end
 
         # @see Lithic::Models::FinancialAccounts::Statement#interest_details

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

@@ -49,12 +49,25 @@ module Lithic
         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: {})
-        #   @param begin_ [Date]
-        #   @param end_ [Date]
-        #   @param ending_before [String]
-        #   @param include_initial_statements [Boolean]
-        #   @param page_size [Integer]
-        #   @param starting_after [String]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::FinancialAccounts::StatementListParams} for more details.
+        #
+        #   @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
+        #   ...
+        #
+        #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        #   ...
+        #
+        #   @param include_initial_statements [Boolean] Whether to include the initial statement. It is not included by default.
+        #
+        #   @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 request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -15,7 +15,8 @@ module Lithic
         required :financial_account_token, String
 
         # @!method initialize(financial_account_token:, request_options: {})
-        #   @param financial_account_token [String]
+        #   @param financial_account_token [String] Globally unique identifier for financial account.
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -36,10 +36,20 @@ module Lithic
           optional :starting_after, String
 
           # @!method initialize(financial_account_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
-          #   @param financial_account_token [String]
-          #   @param ending_before [String]
-          #   @param page_size [Integer]
-          #   @param starting_after [String]
+          #   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 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 request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
         end
       end

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

@@ -94,17 +94,33 @@ module Lithic
             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)
-            #   @param token [String]
-            #   @param amount [Integer]
+            #   Some parameter documentations has been truncated, see
+            #   {Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data} for
+            #   more details.
+            #
+            #   @param token [String] Globally unique identifier for a Statement Line Item
+            #
+            #   @param amount [Integer] Transaction amount in cents
+            #
             #   @param category [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
-            #   @param created [Time]
-            #   @param currency [String]
-            #   @param effective_date [Date]
+            #
+            #   @param created [Time] Timestamp of when the line item was generated
+            #
+            #   @param currency [String] 3-character alphabetic ISO 4217 code for the settling currency of the transactio
+            #   ...
+            #
+            #   @param effective_date [Date] Date that the transaction effected the account balance
+            #
             #   @param event_type [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::EventType]
-            #   @param financial_account_token [String]
-            #   @param financial_transaction_event_token [String]
-            #   @param financial_transaction_token [String]
-            #   @param card_token [String]
+            #
+            #   @param financial_account_token [String] Globally unique identifier for a financial account
+            #
+            #   @param financial_transaction_event_token [String] Globally unique identifier for a financial transaction event
+            #
+            #   @param financial_transaction_token [String] Globally unique identifier for a financial transaction
+            #
+            #   @param card_token [String] Globally unique identifier for a card
+            #
             #   @param descriptor [String]
 
             # @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#category

data/lib/lithic/models/financial_transaction.rb

@@ -90,17 +90,35 @@ module Lithic
       required :updated, Time
 
       # @!method initialize(token:, category:, created:, currency:, descriptor:, events:, pending_amount:, result:, settled_amount:, status:, updated:)
-      #   @param token [String]
-      #   @param category [Symbol, Lithic::Models::FinancialTransaction::Category]
-      #   @param created [Time]
-      #   @param currency [String]
-      #   @param descriptor [String]
-      #   @param events [Array<Lithic::Models::FinancialTransaction::Event>]
-      #   @param pending_amount [Integer]
-      #   @param result [Symbol, Lithic::Models::FinancialTransaction::Result]
-      #   @param settled_amount [Integer]
-      #   @param status [Symbol, Lithic::Models::FinancialTransaction::Status]
-      #   @param updated [Time]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::FinancialTransaction} for more details.
+      #
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param category [Symbol, Lithic::Models::FinancialTransaction::Category] Status types: ...
+      #
+      #   @param created [Time] Date and time when the financial transaction first occurred. UTC time zone.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code for the settling currency of the transactio
+      #   ...
+      #
+      #   @param descriptor [String] A string that provides a description of the financial transaction; may be useful
+      #   ...
+      #
+      #   @param events [Array<Lithic::Models::FinancialTransaction::Event>] A list of all financial events that have modified this financial transaction.
+      #
+      #   @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
+      #   ...
+      #
+      #   @param result [Symbol, Lithic::Models::FinancialTransaction::Result] APPROVED transactions were successful while DECLINED transactions were declined
+      #   ...
+      #
+      #   @param settled_amount [Integer] Amount of the transaction that has been settled in the currency's smallest unit
+      #   ...
+      #
+      #   @param status [Symbol, Lithic::Models::FinancialTransaction::Status] Status types: ...
+      #
+      #   @param updated [Time] Date and time when the financial transaction was last updated. UTC time zone.
 
       # Status types:
       #
@@ -156,10 +174,19 @@ module Lithic
         optional :type, enum: -> { Lithic::Models::FinancialTransaction::Event::Type }
 
         # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
-        #   @param token [String]
-        #   @param amount [Integer]
-        #   @param created [Time]
-        #   @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::FinancialTransaction::Event} for more details.
+        #
+        #   @param token [String] Globally unique identifier.
+        #
+        #   @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
+        #   ...
+        #
+        #   @param created [Time] Date and time when the financial event occurred. UTC time zone.
+        #
+        #   @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
+        #   ...
+        #
         #   @param type [Symbol, Lithic::Models::FinancialTransaction::Event::Type]
 
         # APPROVED financial events were successful while DECLINED financial events were

data/lib/lithic/models/kyb.rb

@@ -88,16 +88,35 @@ module Lithic
       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, website_url: nil)
-      #   @param beneficial_owner_individuals [Array<Lithic::Models::KYB::BeneficialOwnerIndividual>]
-      #   @param business_entity [Lithic::Models::KYB::BusinessEntity]
-      #   @param control_person [Lithic::Models::KYB::ControlPerson]
-      #   @param nature_of_business [String]
-      #   @param tos_timestamp [String]
-      #   @param workflow [Symbol, Lithic::Models::KYB::Workflow]
-      #   @param beneficial_owner_entities [Array<Lithic::Models::KYB::BeneficialOwnerEntity>]
-      #   @param external_id [String]
-      #   @param kyb_passed_timestamp [String]
-      #   @param website_url [String]
+      #   Some parameter documentations has been truncated, see {Lithic::Models::KYB} for
+      #   more details.
+      #
+      #   @param beneficial_owner_individuals [Array<Lithic::Models::KYB::BeneficialOwnerIndividual>] You must submit a list of all direct and indirect individuals with 25% or more o
+      #   ...
+      #
+      #   @param business_entity [Lithic::Models::KYB::BusinessEntity] Information for business for which the account is being opened and KYB is being
+      #   ...
+      #
+      #   @param control_person [Lithic::Models::KYB::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
+      #   ...
+      #
+      #   @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
+      #   ...
+      #
+      #   @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
+      #   ...
+      #
+      #   @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 KYC was completed on the busin
+      #   ...
+      #
+      #   @param website_url [String] Company website URL.
 
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute address
@@ -148,15 +167,26 @@ module Lithic
         optional :phone_number, String
 
         # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::KYB::BeneficialOwnerIndividual} for more details.
+        #
         #   Individuals associated with a KYB application. Phone number is optional.
         #
-        #   @param address [Lithic::Models::Address]
-        #   @param dob [String]
-        #   @param email [String]
-        #   @param first_name [String]
-        #   @param government_id [String]
-        #   @param last_name [String]
-        #   @param phone_number [String]
+        #   @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
+        #   ...
+        #
+        #   @param dob [String] Individual's date of birth, as an RFC 3339 date.
+        #
+        #   @param email [String] Individual's email address. ...
+        #
+        #   @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
+        #
+        #   @param government_id [String] Government-issued identification number (required for identity verification and
+        #   ...
+        #
+        #   @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
+        #
+        #   @param phone_number [String] Individual's phone number, entered in E.164 format. ...
       end
 
       # @see Lithic::Models::KYB#business_entity
@@ -203,15 +233,27 @@ module Lithic
         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::BusinessEntity} for more details.
+        #
         #   Information for business for which the account is being opened and KYB is being
         #   run.
         #
-        #   @param address [Lithic::Models::Address]
-        #   @param government_id [String]
-        #   @param legal_business_name [String]
-        #   @param phone_numbers [Array<String>]
-        #   @param dba_business_name [String]
-        #   @param parent_company [String]
+        #   @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
 
       # @see Lithic::Models::KYB#control_person
@@ -264,6 +306,9 @@ module Lithic
         optional :phone_number, String
 
         # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::KYB::ControlPerson} for more details.
+        #
         #   An individual with significant responsibility for managing the legal entity
         #   (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
         #   Officer, Managing Member, General Partner, President, Vice President, or
@@ -273,13 +318,21 @@ module Lithic
         #   [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
         #   (Section II) for more background.
         #
-        #   @param address [Lithic::Models::Address]
-        #   @param dob [String]
-        #   @param email [String]
-        #   @param first_name [String]
-        #   @param government_id [String]
-        #   @param last_name [String]
-        #   @param phone_number [String]
+        #   @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
+        #   ...
+        #
+        #   @param dob [String] Individual's date of birth, as an RFC 3339 date.
+        #
+        #   @param email [String] Individual's email address. ...
+        #
+        #   @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
+        #
+        #   @param government_id [String] Government-issued identification number (required for identity verification and
+        #   ...
+        #
+        #   @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
+        #
+        #   @param phone_number [String] Individual's phone number, entered in E.164 format. ...
       end
 
       # Specifies the type of KYB workflow to run.
@@ -338,12 +391,24 @@ module Lithic
         optional :parent_company, String
 
         # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
-        #   @param address [Lithic::Models::Address]
-        #   @param government_id [String]
-        #   @param legal_business_name [String]
-        #   @param phone_numbers [Array<String>]
-        #   @param dba_business_name [String]
-        #   @param parent_company [String]
+        #   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

data/lib/lithic/models/kyb_business_entity.rb

@@ -45,12 +45,24 @@ module Lithic
       optional :parent_company, String
 
       # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
-      #   @param address [Lithic::Models::KYBBusinessEntity::Address]
-      #   @param government_id [String]
-      #   @param legal_business_name [String]
-      #   @param phone_numbers [Array<String>]
-      #   @param dba_business_name [String]
-      #   @param parent_company [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::KYBBusinessEntity} for more details.
+      #
+      #   @param address [Lithic::Models::KYBBusinessEntity::Address] Business''s physical address - PO boxes, UPS drops, and FedEx drops are not acce
+      #   ...
+      #
+      #   @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).
 
       # @see Lithic::Models::KYBBusinessEntity#address
       class Address < Lithic::Internal::Type::BaseModel
@@ -94,15 +106,26 @@ module Lithic
         optional :address2, String
 
         # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::KYBBusinessEntity::Address} for more details.
+        #
         #   Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
         #   acceptable; APO/FPO are acceptable.
         #
-        #   @param address1 [String]
-        #   @param city [String]
-        #   @param country [String]
-        #   @param postal_code [String]
-        #   @param state [String]
-        #   @param address2 [String]
+        #   @param address1 [String] Valid deliverable address (no PO boxes).
+        #
+        #   @param city [String] Name of city.
+        #
+        #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+        #   ...
+        #
+        #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+        #   ...
+        #
+        #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+        #   ...
+        #
+        #   @param address2 [String] Unit or apartment number (if applicable).
       end
     end
   end