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

data/lib/lithic/models/book_transfer_response.rb

@@ -86,18 +86,40 @@ module Lithic
       required :updated, Time
 
       # @!method initialize(token:, category:, created:, currency:, events:, from_financial_account_token:, pending_amount:, result:, settled_amount:, status:, to_financial_account_token:, updated:)
-      #   @param token [String]
-      #   @param category [Symbol, Lithic::Models::BookTransferResponse::Category]
-      #   @param created [Time]
-      #   @param currency [String]
-      #   @param events [Array<Lithic::Models::BookTransferResponse::Event>]
-      #   @param from_financial_account_token [String]
-      #   @param pending_amount [Integer]
-      #   @param result [Symbol, Lithic::Models::BookTransferResponse::Result]
-      #   @param settled_amount [Integer]
-      #   @param status [Symbol, Lithic::Models::BookTransferResponse::Status]
-      #   @param to_financial_account_token [Object]
-      #   @param updated [Time]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::BookTransferResponse} for more details.
+      #
+      #   @param token [String] Customer-provided token that will serve as an idempotency token. This token will
+      #   ...
+      #
+      #   @param category [Symbol, Lithic::Models::BookTransferResponse::Category] Category of the book transfer
+      #
+      #   @param created [Time] Date and time when the transfer occurred. UTC time zone.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code for the settling currency of the transactio
+      #   ...
+      #
+      #   @param events [Array<Lithic::Models::BookTransferResponse::Event>] A list of all financial events that have modified this transfer.
+      #
+      #   @param from_financial_account_token [String] Globally unique identifier for the financial account or card that will send the
+      #   ...
+      #
+      #   @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
+      #   ...
+      #
+      #   @param result [Symbol, Lithic::Models::BookTransferResponse::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::BookTransferResponse::Status] Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The trans
+      #   ...
+      #
+      #   @param to_financial_account_token [Object] Globally unique identifier for the financial account or card that will receive t
+      #   ...
+      #
+      #   @param updated [Time] Date and time when the financial transaction was last updated. UTC time zone.
 
       # Category of the book transfer
       #
@@ -170,14 +192,26 @@ module Lithic
         required :type, String
 
         # @!method initialize(token:, amount:, created:, detailed_results:, memo:, result:, subtype:, type:)
-        #   @param token [String]
-        #   @param amount [Integer]
-        #   @param created [Time]
-        #   @param detailed_results [Array<Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResult>]
-        #   @param memo [String]
-        #   @param result [Symbol, Lithic::Models::BookTransferResponse::Event::Result]
-        #   @param subtype [String]
-        #   @param type [String]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::BookTransferResponse::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 detailed_results [Array<Symbol, Lithic::Models::BookTransferResponse::Event::DetailedResult>] Detailed Results
+        #
+        #   @param memo [String] Memo for the transfer.
+        #
+        #   @param result [Symbol, Lithic::Models::BookTransferResponse::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
+        #   ...
+        #
+        #   @param subtype [String] The program specific subtype code for the specified category/type.
+        #
+        #   @param type [String] Type of the book transfer
 
         module DetailedResult
           extend Lithic::Internal::Type::Enum

data/lib/lithic/models/book_transfer_reverse_params.rb

@@ -14,7 +14,8 @@ module Lithic
       optional :memo, String
 
       # @!method initialize(memo: nil, request_options: {})
-      #   @param memo [String]
+      #   @param memo [String] Optional descriptor for the reversal.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/card.rb

@@ -19,10 +19,15 @@ module Lithic
       optional :pan, String
 
       # @!method initialize(cvv: nil, pan: nil)
+      #   Some parameter documentations has been truncated, see {Lithic::Models::Card} for
+      #   more details.
+      #
       #   Card details with potentially PCI sensitive information for Enterprise customers
       #
-      #   @param cvv [String]
-      #   @param pan [String]
+      #   @param cvv [String] Three digit cvv printed on the back of the card.
+      #
+      #   @param pan [String] Primary Account Number (PAN) (i.e. the card number). Customers must be PCI compl
+      #   ...
     end
   end
 end

data/lib/lithic/models/card_convert_physical_params.rb

@@ -45,10 +45,18 @@ module Lithic
       optional :shipping_method, enum: -> { Lithic::Models::CardConvertPhysicalParams::ShippingMethod }
 
       # @!method initialize(shipping_address:, carrier: nil, product_id: nil, shipping_method: nil, request_options: {})
-      #   @param shipping_address [Lithic::Models::ShippingAddress]
-      #   @param carrier [Lithic::Models::Carrier]
-      #   @param product_id [String]
-      #   @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardConvertPhysicalParams} for more details.
+      #
+      #   @param shipping_address [Lithic::Models::ShippingAddress] The shipping address this card will be sent to.
+      #
+      #   @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
+      #
+      #   @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
+      #   ...
+      #
+      #   @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of

data/lib/lithic/models/card_create_params.rb

@@ -177,23 +177,53 @@ module Lithic
       optional :state, enum: -> { Lithic::Models::CardCreateParams::State }
 
       # @!method initialize(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_for: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
-      #   @param type [Symbol, Lithic::Models::CardCreateParams::Type]
-      #   @param account_token [String]
-      #   @param card_program_token [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardCreateParams} for more details.
+      #
+      #   @param type [Symbol, Lithic::Models::CardCreateParams::Type] Card types: ...
+      #
+      #   @param account_token [String] Globally unique identifier for the account that the card will be associated with
+      #   ...
+      #
+      #   @param card_program_token [String] For card programs with more than one BIN range. This must be configured with Lit
+      #   ...
+      #
       #   @param carrier [Lithic::Models::Carrier]
-      #   @param digital_card_art_token [String]
-      #   @param exp_month [String]
-      #   @param exp_year [String]
-      #   @param memo [String]
-      #   @param pin [String]
-      #   @param product_id [String]
-      #   @param replacement_account_token [String]
-      #   @param replacement_for [String]
+      #
+      #   @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. If neither `exp_month` nor `exp_year` is provided,
+      #   ...
+      #
+      #   @param exp_year [String] Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is provided
+      #   ...
+      #
+      #   @param memo [String] Friendly name to identify the card.
+      #
+      #   @param pin [String] Encrypted PIN block (in base64). Applies to cards of type `PHYSICAL` and `VIRTUA
+      #   ...
+      #
+      #   @param product_id [String] Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
+      #   ...
+      #
+      #   @param replacement_account_token [String] Restricted field limited to select use cases. Lithic will reach out directly if
+      #   ...
+      #
+      #   @param replacement_for [String] Globally unique identifier for the card that this card will replace. If the card
+      #   ...
+      #
       #   @param shipping_address [Lithic::Models::ShippingAddress]
-      #   @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod]
-      #   @param spend_limit [Integer]
-      #   @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
-      #   @param state [Symbol, Lithic::Models::CardCreateParams::State]
+      #
+      #   @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
+      #   @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::SpendLimitDuration] Spend limit duration values: ...
+      #
+      #   @param state [Symbol, Lithic::Models::CardCreateParams::State] Card state values: ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Card types:

data/lib/lithic/models/card_embed_params.rb

@@ -20,8 +20,10 @@ module Lithic
       required :hmac, String
 
       # @!method initialize(embed_request:, hmac:, request_options: {})
-      #   @param embed_request [String]
-      #   @param hmac [String]
+      #   @param embed_request [String] A base64 encoded JSON string of an EmbedRequest to specify which card to load.
+      #
+      #   @param hmac [String] SHA256 HMAC of the embed_request JSON string with base64 digest.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/card_list_params.rb

@@ -54,13 +54,27 @@ module Lithic
       optional :state, enum: -> { Lithic::Models::CardListParams::State }
 
       # @!method initialize(account_token: nil, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
-      #   @param account_token [String]
-      #   @param begin_ [Time]
-      #   @param end_ [Time]
-      #   @param ending_before [String]
-      #   @param page_size [Integer]
-      #   @param starting_after [String]
-      #   @param state [Symbol, Lithic::Models::CardListParams::State]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardListParams} for more details.
+      #
+      #   @param account_token [String] Returns cards associated with the specified account. ...
+      #
+      #   @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 state [Symbol, Lithic::Models::CardListParams::State] Returns cards with the specified state. ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Returns cards with the specified state.

data/lib/lithic/models/card_program.rb

@@ -48,13 +48,23 @@ module Lithic
       optional :settlement_currencies, Lithic::Internal::Type::ArrayOf[String]
 
       # @!method initialize(token:, created:, name:, pan_range_end:, pan_range_start:, cardholder_currency: nil, settlement_currencies: nil)
-      #   @param token [String]
-      #   @param created [Time]
-      #   @param name [String]
-      #   @param pan_range_end [String]
-      #   @param pan_range_start [String]
-      #   @param cardholder_currency [String]
-      #   @param settlement_currencies [Array<String>]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardProgram} for more details.
+      #
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param created [Time] Timestamp of when the card program was created.
+      #
+      #   @param name [String] The name of the card program.
+      #
+      #   @param pan_range_end [String] The first digits of the card number that this card program ends with.
+      #
+      #   @param pan_range_start [String] The first digits of the card number that this card program starts with.
+      #
+      #   @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
+      #
+      #   @param settlement_currencies [Array<String>] List of 3-character alphabetic ISO 4217 codes for the currencies that the card p
+      #   ...
     end
   end
 end

data/lib/lithic/models/card_program_list_params.rb

@@ -28,9 +28,17 @@ module Lithic
       optional :starting_after, String
 
       # @!method initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
-      #   @param ending_before [String]
-      #   @param page_size [Integer]
-      #   @param starting_after [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardProgramListParams} for more details.
+      #
+      #   @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/card_provision_params.rb

@@ -55,12 +55,26 @@ module Lithic
       optional :nonce_signature, String
 
       # @!method initialize(certificate: nil, client_device_id: nil, client_wallet_account_id: nil, digital_wallet: nil, nonce: nil, nonce_signature: nil, request_options: {})
-      #   @param certificate [String]
-      #   @param client_device_id [String]
-      #   @param client_wallet_account_id [String]
-      #   @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
-      #   @param nonce [String]
-      #   @param nonce_signature [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardProvisionParams} for more details.
+      #
+      #   @param certificate [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
+      #   ...
+      #
+      #   @param client_device_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
+      #   ...
+      #
+      #   @param client_wallet_account_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
+      #   ...
+      #
+      #   @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet] Name of digital wallet provider.
+      #
+      #   @param nonce [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
+      #   ...
+      #
+      #   @param nonce_signature [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
+      #   ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Name of digital wallet provider.

data/lib/lithic/models/card_reissue_params.rb

@@ -45,10 +45,18 @@ module Lithic
       optional :shipping_method, enum: -> { Lithic::Models::CardReissueParams::ShippingMethod }
 
       # @!method initialize(carrier: nil, product_id: nil, shipping_address: nil, shipping_method: nil, request_options: {})
-      #   @param carrier [Lithic::Models::Carrier]
-      #   @param product_id [String]
-      #   @param shipping_address [Lithic::Models::ShippingAddress]
-      #   @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardReissueParams} for more details.
+      #
+      #   @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
+      #
+      #   @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
+      #   ...
+      #
+      #   @param shipping_address [Lithic::Models::ShippingAddress] If omitted, the previous shipping address will be used.
+      #
+      #   @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of

data/lib/lithic/models/card_renew_params.rb

@@ -59,12 +59,24 @@ module Lithic
       optional :shipping_method, enum: -> { Lithic::Models::CardRenewParams::ShippingMethod }
 
       # @!method initialize(shipping_address:, carrier: nil, exp_month: nil, exp_year: nil, product_id: nil, shipping_method: nil, request_options: {})
-      #   @param shipping_address [Lithic::Models::ShippingAddress]
-      #   @param carrier [Lithic::Models::Carrier]
-      #   @param exp_month [String]
-      #   @param exp_year [String]
-      #   @param product_id [String]
-      #   @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardRenewParams} for more details.
+      #
+      #   @param shipping_address [Lithic::Models::ShippingAddress] The shipping address this card will be sent to.
+      #
+      #   @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
+      #
+      #   @param exp_month [String] Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
+      #   ...
+      #
+      #   @param exp_year [String] Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is provided
+      #   ...
+      #
+      #   @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
+      #   ...
+      #
+      #   @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of

data/lib/lithic/models/card_search_by_pan_params.rb

@@ -14,7 +14,8 @@ module Lithic
       required :pan, String
 
       # @!method initialize(pan:, request_options: {})
-      #   @param pan [String]
+      #   @param pan [String] The PAN for the card being retrieved.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/card_spend_limits.rb

@@ -48,9 +48,17 @@ module Lithic
         optional :monthly, Integer
 
         # @!method initialize(annually: nil, forever: nil, monthly: nil)
-        #   @param annually [Integer]
-        #   @param forever [Integer]
-        #   @param monthly [Integer]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::CardSpendLimits::AvailableSpendLimit} for more details.
+        #
+        #   @param annually [Integer] The available spend limit (in cents) relative to the annual limit configured on
+        #   ...
+        #
+        #   @param forever [Integer] The available spend limit (in cents) relative to the forever limit configured on
+        #   ...
+        #
+        #   @param monthly [Integer] The available spend limit (in cents) relative to the monthly limit configured on
+        #   ...
       end
 
       # @see Lithic::Models::CardSpendLimits#spend_limit
@@ -74,9 +82,11 @@ module Lithic
         optional :monthly, Integer
 
         # @!method initialize(annually: nil, forever: nil, monthly: nil)
-        #   @param annually [Integer]
-        #   @param forever [Integer]
-        #   @param monthly [Integer]
+        #   @param annually [Integer] The configured annual spend limit (in cents) on the Card.
+        #
+        #   @param forever [Integer] The configured forever spend limit (in cents) on the Card.
+        #
+        #   @param monthly [Integer] The configured monthly spend limit (in cents) on the Card.
       end
 
       # @see Lithic::Models::CardSpendLimits#spend_velocity
@@ -103,9 +113,17 @@ module Lithic
         optional :monthly, Integer
 
         # @!method initialize(annually: nil, forever: nil, monthly: nil)
-        #   @param annually [Integer]
-        #   @param forever [Integer]
-        #   @param monthly [Integer]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::CardSpendLimits::SpendVelocity} for more details.
+        #
+        #   @param annually [Integer] Current annual spend velocity (in cents) on the Card. Present if annual spend li
+        #   ...
+        #
+        #   @param forever [Integer] Current forever spend velocity (in cents) on the Card. Present if forever spend
+        #   ...
+        #
+        #   @param monthly [Integer] Current monthly spend velocity (in cents) on the Card. Present if monthly spend
+        #   ...
       end
     end
   end

data/lib/lithic/models/card_update_params.rb

@@ -78,13 +78,27 @@ module Lithic
       optional :state, enum: -> { Lithic::Models::CardUpdateParams::State }
 
       # @!method initialize(digital_card_art_token: nil, memo: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
-      #   @param digital_card_art_token [String]
-      #   @param memo [String]
-      #   @param pin [String]
-      #   @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus]
-      #   @param spend_limit [Integer]
-      #   @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
-      #   @param state [Symbol, Lithic::Models::CardUpdateParams::State]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::CardUpdateParams} for more details.
+      #
+      #   @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
+      #   ...
+      #
+      #   @param memo [String] Friendly name to identify the card.
+      #
+      #   @param pin [String] Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `V
+      #   ...
+      #
+      #   @param pin_status [Symbol, Lithic::Models::CardUpdateParams::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::SpendLimitDuration] Spend limit duration values: ...
+      #
+      #   @param state [Symbol, Lithic::Models::CardUpdateParams::State] Card state values: ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect

data/lib/lithic/models/cards/aggregate_balance_list_params.rb

@@ -21,8 +21,10 @@ module Lithic
         optional :business_account_token, String
 
         # @!method initialize(account_token: nil, business_account_token: nil, request_options: {})
-        #   @param account_token [String]
-        #   @param business_account_token [String]
+        #   @param account_token [String] Cardholder to retrieve aggregate balances for.
+        #
+        #   @param business_account_token [String] Business to retrieve aggregate balances for.
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/lithic/models/cards/aggregate_balance_list_response.rb

@@ -64,17 +64,32 @@ module Lithic
         required :updated, Time
 
         # @!method initialize(available_amount:, created:, currency:, last_card_token:, last_transaction_event_token:, last_transaction_token:, pending_amount:, total_amount:, updated:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::Cards::AggregateBalanceListResponse} for more details.
+        #
         #   Card Aggregate Balance across all end-user accounts
         #
-        #   @param available_amount [Integer]
-        #   @param created [Time]
-        #   @param currency [String]
-        #   @param last_card_token [String]
-        #   @param last_transaction_event_token [String]
-        #   @param last_transaction_token [String]
-        #   @param pending_amount [Integer]
-        #   @param total_amount [Integer]
-        #   @param updated [Time]
+        #   @param available_amount [Integer] Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+        #
+        #   @param created [Time] Date and time for when the balance was first created.
+        #
+        #   @param currency [String] 3-character alphabetic ISO 4217 code for the local currency of the balance.
+        #
+        #   @param last_card_token [String] Globally unique identifier for the card that had its balance updated most recent
+        #   ...
+        #
+        #   @param last_transaction_event_token [String] Globally unique identifier for the last transaction event that impacted this bal
+        #   ...
+        #
+        #   @param last_transaction_token [String] Globally unique identifier for the last transaction that impacted this balance
+        #
+        #   @param pending_amount [Integer] Funds not available for spend due to card authorizations or pending ACH release.
+        #   ...
+        #
+        #   @param total_amount [Integer] The sum of available and pending balance in the currency's smallest unit (e.g.,
+        #   ...
+        #
+        #   @param updated [Time] Date and time for when the balance was last updated.
       end
     end
   end

data/lib/lithic/models/cards/balance_list_params.rb

@@ -23,8 +23,13 @@ module Lithic
         optional :last_transaction_event_token, String
 
         # @!method initialize(balance_date: nil, last_transaction_event_token: nil, request_options: {})
-        #   @param balance_date [Time]
-        #   @param last_transaction_event_token [String]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::Cards::BalanceListParams} for more details.
+        #
+        #   @param balance_date [Time] UTC date of the balance to retrieve. Defaults to latest available balance
+        #
+        #   @param last_transaction_event_token [String] Balance after a given financial event occured. ...
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/lithic/models/cards/balance_list_response.rb

@@ -70,18 +70,34 @@ module Lithic
         required :updated, Time
 
         # @!method initialize(token:, available_amount:, created:, currency:, last_transaction_event_token:, last_transaction_token:, pending_amount:, total_amount:, type:, updated:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::Cards::BalanceListResponse} for more details.
+        #
         #   Balance of a Financial Account
         #
-        #   @param token [String]
-        #   @param available_amount [Integer]
-        #   @param created [Time]
-        #   @param currency [String]
-        #   @param last_transaction_event_token [String]
-        #   @param last_transaction_token [String]
-        #   @param pending_amount [Integer]
-        #   @param total_amount [Integer]
-        #   @param type [Symbol, Lithic::Models::Cards::BalanceListResponse::Type]
-        #   @param updated [Time]
+        #   @param token [String] Globally unique identifier for the financial account that holds this balance.
+        #
+        #   @param available_amount [Integer] Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+        #
+        #   @param created [Time] Date and time for when the balance was first created.
+        #
+        #   @param currency [String] 3-character alphabetic ISO 4217 code for the local currency of the balance.
+        #
+        #   @param last_transaction_event_token [String] Globally unique identifier for the last financial transaction event that impacte
+        #   ...
+        #
+        #   @param last_transaction_token [String] Globally unique identifier for the last financial transaction that impacted this
+        #   ...
+        #
+        #   @param pending_amount [Integer] Funds not available for spend due to card authorizations or pending ACH release.
+        #   ...
+        #
+        #   @param total_amount [Integer] The sum of available and pending balance in the currency's smallest unit (e.g.,
+        #   ...
+        #
+        #   @param type [Symbol, Lithic::Models::Cards::BalanceListResponse::Type] Type of financial account.
+        #
+        #   @param updated [Time] Date and time for when the balance was last updated.
 
         # Type of financial account.
         #