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

data/lib/lithic/resources/account_holders.rb

@@ -3,6 +3,9 @@
 module Lithic
   module Resources
     class AccountHolders
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::AccountHolderCreateParams} for more details.
+      #
       # Create an account holder and initiate the appropriate onboarding workflow.
       # Account holders and accounts have a 1:1 relationship. When an account holder is
       # successfully created an associated account is also created. All calls to this
@@ -14,25 +17,55 @@ module Lithic
       #
       # @overload create(beneficial_owner_individuals:, business_entity:, control_person:, nature_of_business:, tos_timestamp:, workflow:, individual:, address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, website_url: nil, kyc_passed_timestamp: nil, business_account_token: nil, request_options: {})
       #
-      # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>]
-      # @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity]
-      # @param control_person [Lithic::Models::AccountHolderCreateParams::ControlPerson]
-      # @param nature_of_business [String]
-      # @param tos_timestamp [String]
-      # @param workflow [Symbol, Lithic::Models::AccountHolderCreateParams::Workflow]
-      # @param individual [Lithic::Models::AccountHolderCreateParams::Individual]
-      # @param address [Lithic::Models::Address]
-      # @param email [String]
-      # @param first_name [String]
-      # @param kyc_exemption_type [Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType]
-      # @param last_name [String]
-      # @param phone_number [String]
-      # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>]
-      # @param external_id [String]
-      # @param kyb_passed_timestamp [String]
-      # @param website_url [String]
-      # @param kyc_passed_timestamp [String]
-      # @param business_account_token [String]
+      # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>] You must submit a list of all direct and indirect individuals with 25% or more o
+      # ...
+      #
+      # @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity] Information for business for which the account is being opened and KYB is being
+      # ...
+      #
+      # @param control_person [Lithic::Models::AccountHolderCreateParams::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::AccountHolderCreateParams::Workflow] Specifies the workflow type. This must be 'KYC_EXEMPT'
+      #
+      # @param individual [Lithic::Models::AccountHolderCreateParams::Individual] Information on individual for whom the account is being opened and KYC is being
+      # ...
+      #
+      # @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::AccountHolderCreateParams::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 beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::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.
+      #
+      # @param kyc_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the indiv
+      # ...
+      #
+      # @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AccountHolderCreateResponse]
@@ -54,7 +87,8 @@ module Lithic
       #
       # @overload retrieve(account_holder_token, request_options: {})
       #
-      # @param account_holder_token [String]
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AccountHolder]
@@ -69,6 +103,9 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::AccountHolderUpdateParams} for more details.
+      #
       # Update the information associated with a particular account holder (including
       # business owners and control persons associated to a business account). If Lithic
       # is performing KYB or KYC and additional verification is required we will run the
@@ -82,22 +119,47 @@ module Lithic
       #
       # @overload update(account_holder_token, beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_entity: nil, control_person: nil, external_id: nil, nature_of_business: nil, website_url: nil, individual: nil, address: nil, business_account_token: nil, email: nil, first_name: nil, last_name: nil, legal_business_name: nil, phone_number: nil, request_options: {})
       #
-      # @param account_holder_token [String]
-      # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>]
-      # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>]
-      # @param business_entity [Lithic::Models::AccountHolderUpdateParams::BusinessEntity]
-      # @param control_person [Lithic::Models::AccountHolderUpdateParams::ControlPerson]
-      # @param external_id [String]
-      # @param nature_of_business [String]
-      # @param website_url [String]
-      # @param individual [Lithic::Models::AccountHolderUpdateParams::Individual]
-      # @param address [Lithic::Models::AddressUpdate]
-      # @param business_account_token [String]
-      # @param email [String]
-      # @param first_name [String]
-      # @param last_name [String]
-      # @param legal_business_name [String]
-      # @param phone_number [String]
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
+      # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>] Deprecated.
+      #
+      # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>] You must submit a list of all direct and indirect individuals with 25% or more o
+      # ...
+      #
+      # @param business_entity [Lithic::Models::AccountHolderUpdateParams::BusinessEntity] Information for business for which the account is being opened and KYB is being
+      # ...
+      #
+      # @param control_person [Lithic::Models::AccountHolderUpdateParams::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
+      # ...
+      #
+      # @param external_id [String] A user provided id that can be used to link an account holder with an external s
+      # ...
+      #
+      # @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
+      # ...
+      #
+      # @param website_url [String] Company website URL.
+      #
+      # @param individual [Lithic::Models::AccountHolderUpdateParams::Individual] Information on the individual for whom the account is being opened and KYC is be
+      # ...
+      #
+      # @param address [Lithic::Models::AddressUpdate] Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.
+      #
+      # @param business_account_token [String] Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the
+      # ...
+      #
+      # @param email [String] Allowed for all Account Holders. Account holder's email address. The primary pur
+      # ...
+      #
+      # @param first_name [String] Allowed for KYC-Exempt, BYO-KYC. Account holder's first name.
+      #
+      # @param last_name [String] Allowed for KYC-Exempt, BYO-KYC. Account holder's last name.
+      #
+      # @param legal_business_name [String] Allowed for BYO-KYB. Legal business name of the account holder.
+      #
+      # @param phone_number [String] Allowed for all Account Holders. Account holder's phone number, entered in E.164
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse, Lithic::Models::AccountHolderUpdateResponse::PatchResponse]
@@ -114,22 +176,44 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::AccountHolderListParams} for more details.
+      #
       # Get a list of individual or business account holders and their KYC or KYB
       # evaluation status.
       #
       # @overload list(begin_: nil, email: nil, end_: nil, ending_before: nil, external_id: nil, first_name: nil, last_name: nil, legal_business_name: nil, limit: nil, phone_number: nil, starting_after: nil, request_options: {})
       #
-      # @param begin_ [Time]
-      # @param email [String]
-      # @param end_ [Time]
-      # @param ending_before [String]
-      # @param external_id [String]
-      # @param first_name [String]
-      # @param last_name [String]
-      # @param legal_business_name [String]
-      # @param limit [Integer]
-      # @param phone_number [String]
-      # @param starting_after [String]
+      # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
+      # @param email [String] Email address of the account holder. The query must be an exact match, case inse
+      # ...
+      #
+      # @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 external_id [String] If applicable, represents the external_id associated with the account_holder.
+      #
+      # @param first_name [String] (Individual Account Holders only) The first name of the account holder. The quer
+      # ...
+      #
+      # @param last_name [String] (Individual Account Holders only) The last name of the account holder. The query
+      # ...
+      #
+      # @param legal_business_name [String] (Business Account Holders only) The legal business name of the account holder. T
+      # ...
+      #
+      # @param limit [Integer] The number of account_holders to limit the response to.
+      #
+      # @param phone_number [String] Phone number of the account holder. The query must be an exact match.
+      #
+      # @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}, nil]
       #
       # @return [Lithic::Internal::SinglePage<Lithic::Models::AccountHolder>]
@@ -165,7 +249,8 @@ module Lithic
       #
       # @overload list_documents(account_holder_token, request_options: {})
       #
-      # @param account_holder_token [String]
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AccountHolderListDocumentsResponse]
@@ -197,8 +282,10 @@ module Lithic
       #
       # @overload retrieve_document(document_token, account_holder_token:, request_options: {})
       #
-      # @param document_token [String]
-      # @param account_holder_token [String]
+      # @param document_token [String] Globally unique identifier for the document.
+      #
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Document]
@@ -218,14 +305,23 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams} for more
+      # details.
+      #
       # Simulates a review for an account holder document upload.
       #
       # @overload simulate_enrollment_document_review(document_upload_token:, status:, accepted_entity_status_reasons: nil, status_reason: nil, request_options: {})
       #
-      # @param document_upload_token [String]
-      # @param status [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams::Status]
-      # @param accepted_entity_status_reasons [Array<String>]
-      # @param status_reason [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams::StatusReason]
+      # @param document_upload_token [String] The account holder document upload which to perform the simulation upon.
+      #
+      # @param status [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams::Status] An account holder document's upload status for use within the simulation.
+      #
+      # @param accepted_entity_status_reasons [Array<String>] A list of status reasons associated with a KYB account holder in PENDING_REVIEW
+      #
+      # @param status_reason [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams::StatusReason] Status reason that will be associated with the simulated account holder status.
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Document]
@@ -243,14 +339,21 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::AccountHolderSimulateEnrollmentReviewParams} for more details.
+      #
       # Simulates an enrollment review for an account holder. This endpoint is only
       # applicable for workflows that may required intervention such as `KYB_BASIC`.
       #
       # @overload simulate_enrollment_review(account_holder_token: nil, status: nil, status_reasons: nil, request_options: {})
       #
-      # @param account_holder_token [String]
-      # @param status [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::Status]
-      # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason>]
+      # @param account_holder_token [String] The account holder which to perform the simulation upon.
+      #
+      # @param status [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::Status] An account holder's status for use within the simulation.
+      #
+      # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason>] Status reason that will be associated with the simulated account holder status.
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse]
@@ -288,9 +391,12 @@ module Lithic
       #
       # @overload upload_document(account_holder_token, document_type:, entity_token:, request_options: {})
       #
-      # @param account_holder_token [String]
-      # @param document_type [Symbol, Lithic::Models::AccountHolderUploadDocumentParams::DocumentType]
-      # @param entity_token [String]
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
+      # @param document_type [Symbol, Lithic::Models::AccountHolderUploadDocumentParams::DocumentType] The type of document to upload
+      #
+      # @param entity_token [String] Globally unique identifier for the entity.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Document]

data/lib/lithic/resources/accounts.rb

@@ -7,7 +7,8 @@ module Lithic
       #
       # @overload retrieve(account_token, request_options: {})
       #
-      # @param account_token [String]
+      # @param account_token [String] Globally unique identifier for account.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Account]
@@ -22,18 +23,31 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::AccountUpdateParams} for more details.
+      #
       # Update account configuration such as state or spend limits. Can only be run on
       # accounts that are part of the program managed by this API key. Accounts that are
       # in the `PAUSED` state will not be able to transact or create new cards.
       #
       # @overload update(account_token, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, verification_address: nil, request_options: {})
       #
-      # @param account_token [String]
-      # @param daily_spend_limit [Integer]
-      # @param lifetime_spend_limit [Integer]
-      # @param monthly_spend_limit [Integer]
-      # @param state [Symbol, Lithic::Models::AccountUpdateParams::State]
-      # @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress]
+      # @param account_token [String] Globally unique identifier for account.
+      #
+      # @param daily_spend_limit [Integer] Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a $1
+      # ...
+      #
+      # @param lifetime_spend_limit [Integer] Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
+      # ...
+      #
+      # @param monthly_spend_limit [Integer] Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a
+      # ...
+      #
+      # @param state [Symbol, Lithic::Models::AccountUpdateParams::State] Account states.
+      #
+      # @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress] Address used during Address Verification Service (AVS) checks during transaction
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Account]
@@ -50,15 +64,27 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::AccountListParams} for more details.
+      #
       # List account configurations.
       #
       # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      # @param begin_ [Time]
-      # @param end_ [Time]
-      # @param ending_before [String]
-      # @param page_size [Integer]
-      # @param starting_after [String]
+      # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      # ...
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::Account>]
@@ -84,7 +110,8 @@ module Lithic
       #
       # @overload retrieve_spend_limits(account_token, request_options: {})
       #
-      # @param account_token [String]
+      # @param account_token [String] Globally unique identifier for account.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AccountSpendLimits]

data/lib/lithic/resources/aggregate_balances.rb

@@ -8,7 +8,8 @@ module Lithic
       #
       # @overload list(financial_account_type: nil, request_options: {})
       #
-      # @param financial_account_type [Symbol, Lithic::Models::AggregateBalanceListParams::FinancialAccountType]
+      # @param financial_account_type [Symbol, Lithic::Models::AggregateBalanceListParams::FinancialAccountType] Get the aggregate balance for a given Financial Account type.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::SinglePage<Lithic::Models::AggregateBalance>]

data/lib/lithic/resources/auth_rules/v2/backtests.rb

@@ -33,9 +33,12 @@ module Lithic
           #
           # @overload create(auth_rule_token, end_: nil, start: nil, request_options: {})
           #
-          # @param auth_rule_token [String]
-          # @param end_ [Time]
-          # @param start [Time]
+          # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+          #
+          # @param end_ [Time] The end time of the backtest.
+          #
+          # @param start [Time] The start time of the backtest.
+          #
           # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Lithic::Models::AuthRules::V2::BacktestCreateResponse]
@@ -73,8 +76,10 @@ module Lithic
           #
           # @overload retrieve(auth_rule_backtest_token, auth_rule_token:, request_options: {})
           #
-          # @param auth_rule_backtest_token [String]
-          # @param auth_rule_token [String]
+          # @param auth_rule_backtest_token [String] Globally unique identifier for an Auth Rule backtest.
+          #
+          # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+          #
           # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Lithic::Models::AuthRules::V2::BacktestResults]

data/lib/lithic/resources/auth_rules/v2.rb

@@ -11,13 +11,20 @@ module Lithic
         #
         # @overload create(account_tokens:, card_tokens:, program_level:, name: nil, parameters: nil, type: nil, excluded_card_tokens: nil, request_options: {})
         #
-        # @param account_tokens [Array<String>]
-        # @param card_tokens [Array<String>]
-        # @param program_level [Boolean]
-        # @param name [String, nil]
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
-        # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type]
-        # @param excluded_card_tokens [Array<String>]
+        # @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
+        #
+        # @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
+        #
+        # @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
+        #
+        # @param name [String, nil] Auth Rule Name
+        #
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
+        #
+        # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule
+        #
+        # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2CreateResponse]
@@ -38,7 +45,8 @@ module Lithic
         #
         # @overload retrieve(auth_rule_token, request_options: {})
         #
-        # @param auth_rule_token [String]
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2RetrieveResponse]
@@ -53,6 +61,9 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::AuthRules::V2UpdateParams} for more details.
+        #
         # Updates a V2 authorization rule's properties
         #
         # If `account_tokens`, `card_tokens`, `program_level`, or `excluded_card_tokens`
@@ -61,13 +72,20 @@ module Lithic
         #
         # @overload update(auth_rule_token, account_tokens: nil, name: nil, state: nil, card_tokens: nil, excluded_card_tokens: nil, program_level: nil, request_options: {})
         #
-        # @param auth_rule_token [String]
-        # @param account_tokens [Array<String>]
-        # @param name [String, nil]
-        # @param state [Symbol, Lithic::Models::AuthRules::V2UpdateParams::State]
-        # @param card_tokens [Array<String>]
-        # @param excluded_card_tokens [Array<String>]
-        # @param program_level [Boolean]
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
+        # @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
+        #
+        # @param name [String, nil] Auth Rule Name
+        #
+        # @param state [Symbol, Lithic::Models::AuthRules::V2UpdateParams::State] The desired state of the Auth Rule. ...
+        #
+        # @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
+        #
+        # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
+        #
+        # @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2UpdateResponse]
@@ -84,15 +102,25 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::AuthRules::V2ListParams} for more details.
+        #
         # Lists V2 authorization rules
         #
         # @overload list(account_token: nil, card_token: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        # @param account_token [String]
-        # @param card_token [String]
-        # @param ending_before [String]
-        # @param page_size [Integer]
-        # @param starting_after [String]
+        # @param account_token [String] Only return Authorization Rules that are bound to the provided account token.
+        #
+        # @param card_token [String] Only return Authorization Rules that are bound to the provided card token.
+        #
+        # @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}, nil]
         #
         # @return [Lithic::Internal::CursorPage<Lithic::Models::AuthRules::V2ListResponse>]
@@ -114,7 +142,8 @@ module Lithic
         #
         # @overload delete(auth_rule_token, request_options: {})
         #
-        # @param auth_rule_token [String]
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
@@ -136,11 +165,16 @@ module Lithic
         #
         # @overload apply(auth_rule_token, account_tokens:, card_tokens:, program_level:, excluded_card_tokens: nil, request_options: {})
         #
-        # @param auth_rule_token [String]
-        # @param account_tokens [Array<String>]
-        # @param card_tokens [Array<String>]
-        # @param program_level [Boolean]
-        # @param excluded_card_tokens [Array<String>]
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
+        # @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
+        #
+        # @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
+        #
+        # @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
+        #
+        # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2ApplyResponse]
@@ -164,8 +198,10 @@ module Lithic
         #
         # @overload draft(auth_rule_token, parameters: nil, request_options: {})
         #
-        # @param auth_rule_token [String]
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, nil]
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, nil] Parameters for the Auth Rule
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2DraftResponse]
@@ -187,7 +223,8 @@ module Lithic
         #
         # @overload promote(auth_rule_token, request_options: {})
         #
-        # @param auth_rule_token [String]
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2PromoteResponse]
@@ -256,7 +293,8 @@ module Lithic
         #
         # @overload report(auth_rule_token, request_options: {})
         #
-        # @param auth_rule_token [String]
+        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2ReportResponse]

data/lib/lithic/resources/balances.rb

@@ -3,14 +3,22 @@
 module Lithic
   module Resources
     class Balances
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::BalanceListParams} for more details.
+      #
       # Get the balances for a program, business, or a given end-user account
       #
       # @overload list(account_token: nil, balance_date: nil, business_account_token: nil, financial_account_type: nil, request_options: {})
       #
-      # @param account_token [String]
-      # @param balance_date [Time]
-      # @param business_account_token [String]
-      # @param financial_account_type [Symbol, Lithic::Models::BalanceListParams::FinancialAccountType]
+      # @param account_token [String] List balances for all financial accounts of a given account_token.
+      #
+      # @param balance_date [Time] UTC date and time of the balances to retrieve. Defaults to latest available bala
+      # ...
+      #
+      # @param business_account_token [String] List balances for all financial accounts of a given business_account_token.
+      #
+      # @param financial_account_type [Symbol, Lithic::Models::BalanceListParams::FinancialAccountType] List balances for a given Financial Account type.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::SinglePage<Lithic::Models::Balance>]