lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

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

data/lib/lithic/models/kyc.rb

@@ -41,11 +41,22 @@ module Lithic
       optional :kyc_passed_timestamp, String
 
       # @!method initialize(individual:, tos_timestamp:, workflow:, external_id: nil, kyc_passed_timestamp: nil)
-      #   @param individual [Lithic::Models::KYC::Individual]
-      #   @param tos_timestamp [String]
-      #   @param workflow [Symbol, Lithic::Models::KYC::Workflow]
-      #   @param external_id [String]
-      #   @param kyc_passed_timestamp [String]
+      #   Some parameter documentations has been truncated, see {Lithic::Models::KYC} for
+      #   more details.
+      #
+      #   @param individual [Lithic::Models::KYC::Individual] Information on individual for whom the account is being opened and KYC is being
+      #   ...
+      #
+      #   @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
+      #   ...
+      #
+      #   @param workflow [Symbol, Lithic::Models::KYC::Workflow] Specifies the type of KYC workflow to run.
+      #
+      #   @param external_id [String] A user provided id that can be used to link an account holder with an external s
+      #   ...
+      #
+      #   @param kyc_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the indiv
+      #   ...
 
       # @see Lithic::Models::KYC#individual
       class Individual < Lithic::Internal::Type::BaseModel
@@ -97,16 +108,27 @@ module Lithic
         required :phone_number, String
 
         # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::KYC::Individual} for more details.
+        #
         #   Information on individual for whom the account is being opened and KYC is being
         #   run.
         #
-        #   @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 KYC workflow to run.

data/lib/lithic/models/kyc_exempt.rb

@@ -62,15 +62,29 @@ module Lithic
       optional :external_id, String
 
       # @!method initialize(address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, workflow:, business_account_token: nil, external_id: nil)
-      #   @param address [Lithic::Models::Address]
-      #   @param email [String]
-      #   @param first_name [String]
-      #   @param kyc_exemption_type [Symbol, Lithic::Models::KYCExempt::KYCExemptionType]
-      #   @param last_name [String]
-      #   @param phone_number [String]
-      #   @param workflow [Symbol, Lithic::Models::KYCExempt::Workflow]
-      #   @param business_account_token [String]
-      #   @param external_id [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::KYCExempt} for more details.
+      #
+      #   @param address [Lithic::Models::Address] KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
+      #   ...
+      #
+      #   @param email [String] The KYC Exempt user's email
+      #
+      #   @param first_name [String] The KYC Exempt user's first name
+      #
+      #   @param kyc_exemption_type [Symbol, Lithic::Models::KYCExempt::KYCExemptionType] Specifies the type of KYC Exempt user
+      #
+      #   @param last_name [String] The KYC Exempt user's last name
+      #
+      #   @param phone_number [String] The KYC Exempt user's phone number, entered in E.164 format.
+      #
+      #   @param workflow [Symbol, Lithic::Models::KYCExempt::Workflow] Specifies the workflow type. This must be 'KYC_EXEMPT'
+      #
+      #   @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+      #   ...
+      #
+      #   @param external_id [String] A user provided id that can be used to link an account holder with an external s
+      #   ...
 
       # Specifies the type of KYC Exempt user
       #

data/lib/lithic/models/management_operation_list_params.rb

@@ -66,15 +66,32 @@ module Lithic
       optional :status, enum: -> { Lithic::Models::ManagementOperationListParams::Status }
 
       # @!method initialize(begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
-      #   @param begin_ [Time]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::ManagementOperationListParams} for more details.
+      #
+      #   @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      #   ...
+      #
       #   @param business_account_token [String]
-      #   @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category]
-      #   @param end_ [Time]
-      #   @param ending_before [String]
-      #   @param financial_account_token [String]
-      #   @param page_size [Integer]
-      #   @param starting_after [String]
-      #   @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status]
+      #
+      #   @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category] Management operation category to be returned.
+      #
+      #   @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 financial_account_token [String] Globally unique identifier for the financial account. Accepted type dependent on
+      #   ...
+      #
+      #   @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::ManagementOperationListParams::Status] Management operation status to be returned.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Management operation category to be returned.

data/lib/lithic/models/message_attempt.rb

@@ -54,15 +54,25 @@ module Lithic
       required :url, String
 
       # @!method initialize(token:, created:, event_subscription_token:, event_token:, response:, response_status_code:, status:, url:)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::MessageAttempt} for more details.
+      #
       #   A subscription to specific event types.
       #
-      #   @param token [String]
-      #   @param created [Time]
-      #   @param event_subscription_token [String]
-      #   @param event_token [String]
-      #   @param response [String]
-      #   @param response_status_code [Integer]
-      #   @param status [Symbol, Lithic::Models::MessageAttempt::Status]
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param created [Time] An RFC 3339 timestamp for when the event was created. UTC time zone. ...
+      #
+      #   @param event_subscription_token [String] Globally unique identifier.
+      #
+      #   @param event_token [String] Globally unique identifier.
+      #
+      #   @param response [String] The response body from the event subscription's URL.
+      #
+      #   @param response_status_code [Integer] The response status code from the event subscription's URL.
+      #
+      #   @param status [Symbol, Lithic::Models::MessageAttempt::Status] The status of the event attempt.
+      #
       #   @param url [String]
 
       # The status of the event attempt.

data/lib/lithic/models/non_pci_card.rb

@@ -168,29 +168,61 @@ module Lithic
       optional :replacement_for, String, nil?: true
 
       # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, cardholder_currency: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, pending_commands: nil, product_id: nil, replacement_for: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::NonPCICard} for more details.
+      #
       #   Card details without PCI information
       #
-      #   @param token [String]
-      #   @param account_token [String]
-      #   @param card_program_token [String]
-      #   @param created [Time]
-      #   @param funding [Lithic::Models::NonPCICard::Funding]
-      #   @param last_four [String]
-      #   @param pin_status [Symbol, Lithic::Models::NonPCICard::PinStatus]
-      #   @param spend_limit [Integer]
-      #   @param spend_limit_duration [Symbol, Lithic::Models::NonPCICard::SpendLimitDuration]
-      #   @param state [Symbol, Lithic::Models::NonPCICard::State]
-      #   @param type [Symbol, Lithic::Models::NonPCICard::Type]
-      #   @param auth_rule_tokens [Array<String>]
-      #   @param cardholder_currency [String]
-      #   @param digital_card_art_token [String]
-      #   @param exp_month [String]
-      #   @param exp_year [String]
-      #   @param hostname [String]
-      #   @param memo [String]
-      #   @param pending_commands [Array<String>]
-      #   @param product_id [String]
-      #   @param replacement_for [String, nil]
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param account_token [String] Globally unique identifier for the account to which the card belongs.
+      #
+      #   @param card_program_token [String] Globally unique identifier for the card program on which the card exists.
+      #
+      #   @param created [Time] An RFC 3339 timestamp for when the card was created. UTC time zone.
+      #
+      #   @param funding [Lithic::Models::NonPCICard::Funding] Deprecated: Funding account for the card.
+      #
+      #   @param last_four [String] Last four digits of the card number.
+      #
+      #   @param pin_status [Symbol, Lithic::Models::NonPCICard::PinStatus] Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+      #   ...
+      #
+      #   @param spend_limit [Integer] Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,00
+      #   ...
+      #
+      #   @param spend_limit_duration [Symbol, Lithic::Models::NonPCICard::SpendLimitDuration] Spend limit duration
+      #
+      #   @param state [Symbol, Lithic::Models::NonPCICard::State] Card state values: \* `CLOSED` - Card will no longer approve authorizations.
+      #   Clos ...
+      #
+      #   @param type [Symbol, Lithic::Models::NonPCICard::Type] Card types: \* `VIRTUAL` - Card will authorize at any merchant and can be added
+      #   t ...
+      #
+      #   @param auth_rule_tokens [Array<String>] List of identifiers for the Auth Rule(s) that are applied on the card. This fiel
+      #   ...
+      #
+      #   @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
+      #
+      #   @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user's digital wallet afte
+      #   ...
+      #
+      #   @param exp_month [String] Two digit (MM) expiry month.
+      #
+      #   @param exp_year [String] Four digit (yyyy) expiry year.
+      #
+      #   @param hostname [String] Hostname of card's locked merchant (will be empty if not applicable).
+      #
+      #   @param memo [String] Friendly name to identify the card.
+      #
+      #   @param pending_commands [Array<String>] Indicates if there are offline PIN changes pending card interaction with an offl
+      #   ...
+      #
+      #   @param product_id [String] Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
+      #   ...
+      #
+      #   @param replacement_for [String, nil] If the card is a replacement for another card, the globally unique identifier fo
+      #   ...
 
       # @see Lithic::Models::NonPCICard#funding
       class Funding < Lithic::Internal::Type::BaseModel
@@ -243,15 +275,28 @@ module Lithic
         optional :nickname, String
 
         # @!method initialize(token:, created:, last_four:, state:, type:, account_name: nil, nickname: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::NonPCICard::Funding} for more details.
+        #
         #   Deprecated: Funding account for the card.
         #
-        #   @param token [String]
-        #   @param created [Time]
-        #   @param last_four [String]
-        #   @param state [Symbol, Lithic::Models::NonPCICard::Funding::State]
-        #   @param type [Symbol, Lithic::Models::NonPCICard::Funding::Type]
-        #   @param account_name [String]
-        #   @param nickname [String]
+        #   @param token [String] A globally unique identifier for this FundingAccount.
+        #
+        #   @param created [Time] An RFC 3339 string representing when this funding source was added to the Lithic
+        #   ...
+        #
+        #   @param last_four [String] The last 4 digits of the account (e.g. bank account, debit card) associated with
+        #   ...
+        #
+        #   @param state [Symbol, Lithic::Models::NonPCICard::Funding::State] State of funding source. Funding source states: \* `ENABLED` - The funding
+        #   accoun ...
+        #
+        #   @param type [Symbol, Lithic::Models::NonPCICard::Funding::Type] Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _ `DEP
+        #   ...
+        #
+        #   @param account_name [String] Account name identifying the funding source. This may be `null`.
+        #
+        #   @param nickname [String] The nickname given to the `FundingAccount` or `null` if it has no nickname.
 
         # State of funding source. Funding source states: _ `ENABLED` - The funding
         # account is available to use for card creation and transactions. _ `PENDING` -

data/lib/lithic/models/payment.rb

@@ -122,25 +122,49 @@ module Lithic
       optional :expected_release_date, Date
 
       # @!method initialize(token:, category:, created:, currency:, descriptor:, direction:, events:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, pending_amount:, result:, settled_amount:, source:, status:, updated:, user_defined_id:, expected_release_date: nil)
-      #   @param token [String]
-      #   @param category [Symbol, Lithic::Models::Payment::Category]
-      #   @param created [Time]
-      #   @param currency [String]
-      #   @param descriptor [String]
+      #   Some parameter documentations has been truncated, see {Lithic::Models::Payment}
+      #   for more details.
+      #
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param category [Symbol, Lithic::Models::Payment::Category] Payment category
+      #
+      #   @param created [Time] Date and time when the payment first occurred. UTC time zone.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code for the settling currency of the payment.
+      #
+      #   @param descriptor [String] A string that provides a description of the payment; may be useful to display to
+      #   ...
+      #
       #   @param direction [Symbol, Lithic::Models::Payment::Direction]
-      #   @param events [Array<Lithic::Models::Payment::Event>]
+      #
+      #   @param events [Array<Lithic::Models::Payment::Event>] A list of all payment events that have modified this payment.
+      #
       #   @param external_bank_account_token [String, nil]
+      #
       #   @param financial_account_token [String]
+      #
       #   @param method_ [Symbol, Lithic::Models::Payment::Method]
+      #
       #   @param method_attributes [Lithic::Models::Payment::MethodAttributes]
-      #   @param pending_amount [Integer]
-      #   @param result [Symbol, Lithic::Models::Payment::Result]
-      #   @param settled_amount [Integer]
+      #
+      #   @param pending_amount [Integer] Pending amount of the payment in the currency's smallest unit (e.g., cents). ...
+      #
+      #   @param result [Symbol, Lithic::Models::Payment::Result] APPROVED payments were successful while DECLINED payments were declined by Lithi
+      #   ...
+      #
+      #   @param settled_amount [Integer] Amount of the payment that has been settled in the currency's smallest unit (e.g
+      #   ...
+      #
       #   @param source [Symbol, Lithic::Models::Payment::Source]
-      #   @param status [Symbol, Lithic::Models::Payment::Status]
-      #   @param updated [Time]
+      #
+      #   @param status [Symbol, Lithic::Models::Payment::Status] Status types: ...
+      #
+      #   @param updated [Time] Date and time when the financial transaction was last updated. UTC time zone.
+      #
       #   @param user_defined_id [String, nil]
-      #   @param expected_release_date [Date]
+      #
+      #   @param expected_release_date [Date] Date when the financial transaction expected to be released after settlement
 
       # Payment category
       #
@@ -225,12 +249,22 @@ module Lithic
                  -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::Payment::Event::DetailedResult] }
 
         # @!method initialize(token:, amount:, created:, result:, type:, detailed_results: nil)
-        #   @param token [String]
-        #   @param amount [Integer]
-        #   @param created [Time]
-        #   @param result [Symbol, Lithic::Models::Payment::Event::Result]
-        #   @param type [Symbol, Lithic::Models::Payment::Event::Type]
-        #   @param detailed_results [Array<Symbol, Lithic::Models::Payment::Event::DetailedResult>]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::Payment::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::Payment::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
+        #   ...
+        #
+        #   @param type [Symbol, Lithic::Models::Payment::Event::Type] Event types: ...
+        #
+        #   @param detailed_results [Array<Symbol, Lithic::Models::Payment::Event::DetailedResult>] More detailed reasons for the event
 
         # APPROVED financial events were successful while DECLINED financial events were
         # declined by user, Lithic, or the network.