lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.18

data/lib/lithic/models/transaction_simulate_authorization_params.rb

@@ -93,16 +93,33 @@ module Lithic
       optional :status, enum: -> { Lithic::Models::TransactionSimulateAuthorizationParams::Status }
 
       # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
-      #   @param amount [Integer]
-      #   @param descriptor [String]
-      #   @param pan [String]
-      #   @param mcc [String]
-      #   @param merchant_acceptor_id [String]
-      #   @param merchant_amount [Integer]
-      #   @param merchant_currency [String]
-      #   @param partial_approval_capable [Boolean]
-      #   @param pin [String]
-      #   @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransactionSimulateAuthorizationParams} for more details.
+      #
+      #   @param amount [Integer] Amount (in cents) to authorize. For credit authorizations and financial credit a
+      #   ...
+      #
+      #   @param descriptor [String] Merchant descriptor.
+      #
+      #   @param pan [String] Sixteen digit card number.
+      #
+      #   @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
+      #   ...
+      #
+      #   @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
+      #
+      #   @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
+      #   ...
+      #
+      #   @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
+      #   ...
+      #
+      #   @param partial_approval_capable [Boolean] Set to true if the terminal is capable of partial approval otherwise false. ...
+      #
+      #   @param pin [String] Simulate entering a PIN. If omitted, PIN check will not be performed.
+      #
+      #   @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status] Type of event to simulate. ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Type of event to simulate.

data/lib/lithic/models/transaction_simulate_authorization_response.rb

@@ -18,8 +18,13 @@ module Lithic
       optional :debugging_request_id, String
 
       # @!method initialize(token: nil, debugging_request_id: nil)
-      #   @param token [String]
-      #   @param debugging_request_id [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransactionSimulateAuthorizationResponse} for more details.
+      #
+      #   @param token [String] A unique token to reference this transaction with later calls to void or clear t
+      #   ...
+      #
+      #   @param debugging_request_id [String] Debugging request ID to share with Lithic Support team.
     end
   end
 end

data/lib/lithic/models/transaction_simulate_clearing_params.rb

@@ -28,8 +28,14 @@ module Lithic
       optional :amount, Integer
 
       # @!method initialize(token:, amount: nil, request_options: {})
-      #   @param token [String]
-      #   @param amount [Integer]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransactionSimulateClearingParams} for more details.
+      #
+      #   @param token [String] The transaction token returned from the /v1/simulate/authorize response.
+      #
+      #   @param amount [Integer] Amount (in cents) to clear. Typically this will match the amount in the original
+      #   ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/transaction_simulate_clearing_response.rb

@@ -11,7 +11,7 @@ module Lithic
       optional :debugging_request_id, String
 
       # @!method initialize(debugging_request_id: nil)
-      #   @param debugging_request_id [String]
+      #   @param debugging_request_id [String] Debugging request ID to share with Lithic Support team.
     end
   end
 end

data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb

@@ -42,11 +42,21 @@ module Lithic
       optional :merchant_acceptor_id, String
 
       # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, request_options: {})
-      #   @param amount [Integer]
-      #   @param descriptor [String]
-      #   @param pan [String]
-      #   @param mcc [String]
-      #   @param merchant_acceptor_id [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransactionSimulateCreditAuthorizationParams} for more details.
+      #
+      #   @param amount [Integer] Amount (in cents). Any value entered will be converted into a negative amount in
+      #   ...
+      #
+      #   @param descriptor [String] Merchant descriptor.
+      #
+      #   @param pan [String] Sixteen digit card number.
+      #
+      #   @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
+      #   ...
+      #
+      #   @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb

@@ -17,8 +17,9 @@ module Lithic
       optional :debugging_request_id, String
 
       # @!method initialize(token: nil, debugging_request_id: nil)
-      #   @param token [String]
-      #   @param debugging_request_id [String]
+      #   @param token [String] A unique token to reference this transaction.
+      #
+      #   @param debugging_request_id [String] Debugging request ID to share with Lithic Support team.
     end
   end
 end

data/lib/lithic/models/transaction_simulate_return_params.rb

@@ -26,9 +26,12 @@ module Lithic
       required :pan, String
 
       # @!method initialize(amount:, descriptor:, pan:, request_options: {})
-      #   @param amount [Integer]
-      #   @param descriptor [String]
-      #   @param pan [String]
+      #   @param amount [Integer] Amount (in cents) to authorize.
+      #
+      #   @param descriptor [String] Merchant descriptor.
+      #
+      #   @param pan [String] Sixteen digit card number.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/transaction_simulate_return_response.rb

@@ -17,8 +17,9 @@ module Lithic
       optional :debugging_request_id, String
 
       # @!method initialize(token: nil, debugging_request_id: nil)
-      #   @param token [String]
-      #   @param debugging_request_id [String]
+      #   @param token [String] A unique token to reference this transaction.
+      #
+      #   @param debugging_request_id [String] Debugging request ID to share with Lithic Support team.
     end
   end
 end

data/lib/lithic/models/transaction_simulate_return_reversal_params.rb

@@ -14,7 +14,8 @@ module Lithic
       required :token, String
 
       # @!method initialize(token:, request_options: {})
-      #   @param token [String]
+      #   @param token [String] The transaction token returned from the /v1/simulate/authorize response.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/transaction_simulate_return_reversal_response.rb

@@ -11,7 +11,7 @@ module Lithic
       optional :debugging_request_id, String
 
       # @!method initialize(debugging_request_id: nil)
-      #   @param debugging_request_id [String]
+      #   @param debugging_request_id [String] Debugging request ID to share with Lithic Support team.
     end
   end
 end

data/lib/lithic/models/transaction_simulate_void_params.rb

@@ -31,9 +31,16 @@ module Lithic
       optional :type, enum: -> { Lithic::Models::TransactionSimulateVoidParams::Type }
 
       # @!method initialize(token:, amount: nil, type: nil, request_options: {})
-      #   @param token [String]
-      #   @param amount [Integer]
-      #   @param type [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransactionSimulateVoidParams} for more details.
+      #
+      #   @param token [String] The transaction token returned from the /v1/simulate/authorize response.
+      #
+      #   @param amount [Integer] Amount (in cents) to void. Typically this will match the amount in the original
+      #   ...
+      #
+      #   @param type [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type] Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`. ...
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       # Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.

data/lib/lithic/models/transaction_simulate_void_response.rb

@@ -11,7 +11,7 @@ module Lithic
       optional :debugging_request_id, String
 
       # @!method initialize(debugging_request_id: nil)
-      #   @param debugging_request_id [String]
+      #   @param debugging_request_id [String] Debugging request ID to share with Lithic Support team.
     end
   end
 end

data/lib/lithic/models/transactions/events/enhanced_data.rb

@@ -36,11 +36,15 @@ module Lithic
           required :transaction_token, String
 
           # @!method initialize(token:, common:, event_token:, fleet:, transaction_token:)
-          #   @param token [String]
+          #   @param token [String] A unique identifier for the enhanced commercial data.
+          #
           #   @param common [Lithic::Models::Transactions::Events::EnhancedData::Common]
-          #   @param event_token [String]
+          #
+          #   @param event_token [String] The token of the event that the enhanced data is associated with.
+          #
           #   @param fleet [Array<Lithic::Models::Transactions::Events::EnhancedData::Fleet>]
-          #   @param transaction_token [String]
+          #
+          #   @param transaction_token [String] The token of the transaction that the enhanced data is associated with.
 
           # @see Lithic::Models::Transactions::Events::EnhancedData#common
           class Common < Lithic::Internal::Type::BaseModel
@@ -75,10 +79,14 @@ module Lithic
 
             # @!method initialize(line_items:, tax:, customer_reference_number: nil, merchant_reference_number: nil, order_date: nil)
             #   @param line_items [Array<Lithic::Models::Transactions::Events::EnhancedData::Common::LineItem>]
+            #
             #   @param tax [Lithic::Models::Transactions::Events::EnhancedData::Common::Tax]
-            #   @param customer_reference_number [String]
-            #   @param merchant_reference_number [String]
-            #   @param order_date [Date]
+            #
+            #   @param customer_reference_number [String] A customer identifier.
+            #
+            #   @param merchant_reference_number [String] A merchant identifier.
+            #
+            #   @param order_date [Date] The date of the order.
 
             class LineItem < Lithic::Internal::Type::BaseModel
               # @!attribute amount
@@ -108,10 +116,13 @@ module Lithic
               # @!method initialize(amount: nil, description: nil, product_code: nil, quantity: nil)
               #   An L2/L3 enhanced commercial data line item.
               #
-              #   @param amount [Float]
-              #   @param description [String]
-              #   @param product_code [String]
-              #   @param quantity [Float]
+              #   @param amount [Float] The price of the item purchased in merchant currency.
+              #
+              #   @param description [String] A human-readable description of the item.
+              #
+              #   @param product_code [String] An identifier for the item purchased.
+              #
+              #   @param quantity [Float] The quantity of the item purchased.
             end
 
             # @see Lithic::Models::Transactions::Events::EnhancedData::Common#tax
@@ -135,9 +146,11 @@ module Lithic
               optional :merchant_tax_id, String
 
               # @!method initialize(amount: nil, exempt: nil, merchant_tax_id: nil)
-              #   @param amount [Integer]
-              #   @param exempt [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::Exempt]
-              #   @param merchant_tax_id [String]
+              #   @param amount [Integer] The amount of tax collected.
+              #
+              #   @param exempt [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::Exempt] A flag indicating whether the transaction is tax exempt or not.
+              #
+              #   @param merchant_tax_id [String] The tax ID of the merchant.
 
               # A flag indicating whether the transaction is tax exempt or not.
               #
@@ -194,12 +207,22 @@ module Lithic
             optional :vehicle_number, String
 
             # @!method initialize(amount_totals:, fuel:, driver_number: nil, odometer: nil, service_type: nil, vehicle_number: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Lithic::Models::Transactions::Events::EnhancedData::Fleet} for more details.
+            #
             #   @param amount_totals [Lithic::Models::Transactions::Events::EnhancedData::Fleet::AmountTotals]
+            #
             #   @param fuel [Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel]
-            #   @param driver_number [String]
-            #   @param odometer [Integer]
-            #   @param service_type [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::ServiceType]
-            #   @param vehicle_number [String]
+            #
+            #   @param driver_number [String] The driver number entered into the terminal at the time of sale, with leading ze
+            #   ...
+            #
+            #   @param odometer [Integer] The odometer reading entered into the terminal at the time of sale.
+            #
+            #   @param service_type [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::ServiceType] The type of fuel service.
+            #
+            #   @param vehicle_number [String] The vehicle number entered into the terminal at the time of sale, with leading z
+            #   ...
 
             # @see Lithic::Models::Transactions::Events::EnhancedData::Fleet#amount_totals
             class AmountTotals < Lithic::Internal::Type::BaseModel
@@ -222,9 +245,11 @@ module Lithic
               optional :net_sale, Integer
 
               # @!method initialize(discount: nil, gross_sale: nil, net_sale: nil)
-              #   @param discount [Integer]
-              #   @param gross_sale [Integer]
-              #   @param net_sale [Integer]
+              #   @param discount [Integer] The discount applied to the gross sale amount.
+              #
+              #   @param gross_sale [Integer] The gross sale amount.
+              #
+              #   @param net_sale [Integer] The amount after discount.
             end
 
             # @see Lithic::Models::Transactions::Events::EnhancedData::Fleet#fuel
@@ -255,10 +280,13 @@ module Lithic
               optional :unit_price, Integer
 
               # @!method initialize(quantity: nil, type: nil, unit_of_measure: nil, unit_price: nil)
-              #   @param quantity [Float]
-              #   @param type [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::Type]
-              #   @param unit_of_measure [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure]
-              #   @param unit_price [Integer]
+              #   @param quantity [Float] The quantity of fuel purchased.
+              #
+              #   @param type [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::Type] The type of fuel purchased.
+              #
+              #   @param unit_of_measure [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure] Unit of measure for fuel disbursement.
+              #
+              #   @param unit_price [Integer] The price per unit of fuel.
 
               # The type of fuel purchased.
               #

data/lib/lithic/models/transfer.rb

@@ -98,19 +98,39 @@ module Lithic
       optional :updated, Time
 
       # @!method initialize(token: nil, category: nil, created: nil, currency: nil, descriptor: nil, events: nil, from_balance: nil, pending_amount: nil, result: nil, settled_amount: nil, status: nil, to_balance: nil, updated: nil)
-      #   @param token [String]
-      #   @param category [Symbol, Lithic::Models::Transfer::Category]
-      #   @param created [Time]
-      #   @param currency [String]
-      #   @param descriptor [String]
-      #   @param events [Array<Lithic::Models::Transfer::Event>]
-      #   @param from_balance [Array<Lithic::Models::Balance>]
-      #   @param pending_amount [Integer]
-      #   @param result [Symbol, Lithic::Models::Transfer::Result]
-      #   @param settled_amount [Integer]
-      #   @param status [Symbol, Lithic::Models::Transfer::Status]
-      #   @param to_balance [Array<Lithic::Models::Balance>]
-      #   @param updated [Time]
+      #   Some parameter documentations has been truncated, see {Lithic::Models::Transfer}
+      #   for more details.
+      #
+      #   @param token [String] Globally unique identifier for the transfer event.
+      #
+      #   @param category [Symbol, Lithic::Models::Transfer::Category] Status types: ...
+      #
+      #   @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 descriptor [String] A string that provides a description of the transfer; may be useful to display t
+      #   ...
+      #
+      #   @param events [Array<Lithic::Models::Transfer::Event>] A list of all financial events that have modified this trasnfer.
+      #
+      #   @param from_balance [Array<Lithic::Models::Balance>] The updated balance of the sending financial account.
+      #
+      #   @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
+      #   ...
+      #
+      #   @param result [Symbol, Lithic::Models::Transfer::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::Transfer::Status] Status types: ...
+      #
+      #   @param to_balance [Array<Lithic::Models::Balance>] The updated balance of the receiving financial account.
+      #
+      #   @param updated [Time] Date and time when the financial transaction was last updated. UTC time zone.
 
       # Status types:
       #
@@ -160,10 +180,19 @@ module Lithic
         optional :type, enum: -> { Lithic::Models::Transfer::Event::Type }
 
         # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
-        #   @param token [String]
-        #   @param amount [Integer]
-        #   @param created [Time]
-        #   @param result [Symbol, Lithic::Models::Transfer::Event::Result]
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::Transfer::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::Transfer::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
+        #   ...
+        #
         #   @param type [Symbol, Lithic::Models::Transfer::Event::Type]
 
         # APPROVED financial events were successful while DECLINED financial events were

data/lib/lithic/models/transfer_create_params.rb

@@ -42,11 +42,23 @@ module Lithic
       optional :memo, String
 
       # @!method initialize(amount:, from:, to:, token: nil, memo: nil, request_options: {})
-      #   @param amount [Integer]
-      #   @param from [String]
-      #   @param to [String]
-      #   @param token [String]
-      #   @param memo [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransferCreateParams} for more details.
+      #
+      #   @param amount [Integer] Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
+      #   ...
+      #
+      #   @param from [String] Globally unique identifier for the financial account or card that will send the
+      #   ...
+      #
+      #   @param to [String] Globally unique identifier for the financial account or card that will receive t
+      #   ...
+      #
+      #   @param token [String] Customer-provided token that will serve as an idempotency token. This token will
+      #   ...
+      #
+      #   @param memo [String] Optional descriptor for the transfer.
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end