lithic 0.1.0.pre.alpha.6 → 0.1.0.pre.alpha.7

data/lib/lithic/models/transaction_list_params.rb

@@ -20,10 +20,10 @@ module Lithic
 
       # @!attribute [r] begin_
       #   Date string in RFC 3339 format. Only entries created after the specified time
-      #     will be included. UTC time zone.
+      #   will be included. UTC time zone.
       #
       #   @return [Time, nil]
-      optional :begin_, Time, api_name: :begin
+      optional :begin_, Time
 
       # @!parse
       #   # @return [Time]
@@ -41,10 +41,10 @@ module Lithic
 
       # @!attribute [r] end_
       #   Date string in RFC 3339 format. Only entries created before the specified time
-      #     will be included. UTC time zone.
+      #   will be included. UTC time zone.
       #
       #   @return [Time, nil]
-      optional :end_, Time, api_name: :end
+      optional :end_, Time
 
       # @!parse
       #   # @return [Time]
@@ -52,7 +52,7 @@ module Lithic
 
       # @!attribute [r] ending_before
       #   A cursor representing an item's token before which a page of results should end.
-      #     Used to retrieve the previous page of results before this item.
+      #   Used to retrieve the previous page of results before this item.
       #
       #   @return [String, nil]
       optional :ending_before, String
@@ -73,7 +73,7 @@ module Lithic
 
       # @!attribute [r] result
       #   Filters for transactions using transaction result field. Can filter by
-      #     `APPROVED`, and `DECLINED`.
+      #   `APPROVED`, and `DECLINED`.
       #
       #   @return [Symbol, Lithic::Models::TransactionListParams::Result, nil]
       optional :result, enum: -> { Lithic::Models::TransactionListParams::Result }
@@ -84,7 +84,7 @@ module Lithic
 
       # @!attribute [r] starting_after
       #   A cursor representing an item's token after which a page of results should
-      #     begin. Used to retrieve the next page of results after this item.
+      #   begin. Used to retrieve the next page of results after this item.
       #
       #   @return [String, nil]
       optional :starting_after, String
@@ -134,7 +134,7 @@ module Lithic
       # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
       # Filters for transactions using transaction result field. Can filter by
-      #   `APPROVED`, and `DECLINED`.
+      # `APPROVED`, and `DECLINED`.
       module Result
         extend Lithic::Internal::Type::Enum
 

data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb

@@ -16,7 +16,7 @@ module Lithic
 
       # @!attribute amount
       #   Amount (in cents) to authorize. This amount will override the transaction's
-      #     amount that was originally set by /v1/simulate/authorize.
+      #   amount that was originally set by /v1/simulate/authorize.
       #
       #   @return [Integer]
       required :amount, Integer

data/lib/lithic/models/transaction_simulate_authorization_params.rb

@@ -10,10 +10,10 @@ module Lithic
 
       # @!attribute amount
       #   Amount (in cents) to authorize. For credit authorizations and financial credit
-      #     authorizations, any value entered will be converted into a negative amount in
-      #     the simulated transaction. For example, entering 100 in this field will result
-      #     in a -100 amount in the transaction. For balance inquiries, this field must be
-      #     set to 0.
+      #   authorizations, any value entered will be converted into a negative amount in
+      #   the simulated transaction. For example, entering 100 in this field will result
+      #   in a -100 amount in the transaction. For balance inquiries, this field must be
+      #   set to 0.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -32,8 +32,8 @@ module Lithic
 
       # @!attribute [r] mcc
       #   Merchant category code for the transaction to be simulated. A four-digit number
-      #     listed in ISO 18245. Supported merchant category codes can be found
-      #     [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
+      #   listed in ISO 18245. Supported merchant category codes can be found
+      #   [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
       #
       #   @return [String, nil]
       optional :mcc, String
@@ -54,7 +54,7 @@ module Lithic
 
       # @!attribute [r] merchant_amount
       #   Amount of the transaction to be simulated in currency specified in
-      #     merchant_currency, including any acquirer fees.
+      #   merchant_currency, including any acquirer fees.
       #
       #   @return [Integer, nil]
       optional :merchant_amount, Integer
@@ -65,7 +65,7 @@ module Lithic
 
       # @!attribute [r] merchant_currency
       #   3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
-      #     GBP, EUR and defaults to GBP if another ISO 4217 code is provided
+      #   GBP, EUR and defaults to GBP if another ISO 4217 code is provided
       #
       #   @return [String, nil]
       optional :merchant_currency, String
@@ -76,8 +76,8 @@ module Lithic
 
       # @!attribute [r] partial_approval_capable
       #   Set to true if the terminal is capable of partial approval otherwise false.
-      #     Partial approval is when part of a transaction is approved and another payment
-      #     must be used for the remainder.
+      #   Partial approval is when part of a transaction is approved and another payment
+      #   must be used for the remainder.
       #
       #   @return [Boolean, nil]
       optional :partial_approval_capable, Lithic::Internal::Type::Boolean
@@ -99,20 +99,20 @@ module Lithic
       # @!attribute [r] status
       #   Type of event to simulate.
       #
-      #     - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
-      #       clearing step is required to settle the transaction.
-      #     - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
-      #       card, and is most often observed when a cardholder requests to view a card's
-      #       balance at an ATM.
-      #     - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
-      #       a refund, meaning a subsequent clearing step is required to settle the
-      #       transaction.
-      #     - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
-      #       funds immediately (such as an ATM withdrawal), and no subsequent clearing is
-      #       required to settle the transaction.
-      #     - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
-      #       to credit funds immediately, and no subsequent clearing is required to settle
-      #       the transaction.
+      #   - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
+      #     clearing step is required to settle the transaction.
+      #   - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
+      #     card, and is most often observed when a cardholder requests to view a card's
+      #     balance at an ATM.
+      #   - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
+      #     a refund, meaning a subsequent clearing step is required to settle the
+      #     transaction.
+      #   - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
+      #     funds immediately (such as an ATM withdrawal), and no subsequent clearing is
+      #     required to settle the transaction.
+      #   - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
+      #     to credit funds immediately, and no subsequent clearing is required to settle
+      #     the transaction.
       #
       #   @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status, nil]
       optional :status, enum: -> { Lithic::Models::TransactionSimulateAuthorizationParams::Status }
@@ -155,20 +155,20 @@ module Lithic
 
       # Type of event to simulate.
       #
-      #   - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
-      #     clearing step is required to settle the transaction.
-      #   - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
-      #     card, and is most often observed when a cardholder requests to view a card's
-      #     balance at an ATM.
-      #   - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
-      #     a refund, meaning a subsequent clearing step is required to settle the
-      #     transaction.
-      #   - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
-      #     funds immediately (such as an ATM withdrawal), and no subsequent clearing is
-      #     required to settle the transaction.
-      #   - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
-      #     to credit funds immediately, and no subsequent clearing is required to settle
-      #     the transaction.
+      # - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
+      #   clearing step is required to settle the transaction.
+      # - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
+      #   card, and is most often observed when a cardholder requests to view a card's
+      #   balance at an ATM.
+      # - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
+      #   a refund, meaning a subsequent clearing step is required to settle the
+      #   transaction.
+      # - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
+      #   funds immediately (such as an ATM withdrawal), and no subsequent clearing is
+      #   required to settle the transaction.
+      # - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
+      #   to credit funds immediately, and no subsequent clearing is required to settle
+      #   the transaction.
       module Status
         extend Lithic::Internal::Type::Enum
 

data/lib/lithic/models/transaction_simulate_authorization_response.rb

@@ -6,7 +6,7 @@ module Lithic
     class TransactionSimulateAuthorizationResponse < Lithic::Internal::Type::BaseModel
       # @!attribute [r] token
       #   A unique token to reference this transaction with later calls to void or clear
-      #     the authorization.
+      #   the authorization.
       #
       #   @return [String, nil]
       optional :token, String

data/lib/lithic/models/transaction_simulate_clearing_params.rb

@@ -16,14 +16,14 @@ module Lithic
 
       # @!attribute [r] amount
       #   Amount (in cents) to clear. Typically this will match the amount in the original
-      #     authorization, but can be higher or lower. The sign of this amount will
-      #     automatically match the sign of the original authorization's amount. For
-      #     example, entering 100 in this field will result in a -100 amount in the
-      #     transaction, if the original authorization is a credit authorization.
+      #   authorization, but can be higher or lower. The sign of this amount will
+      #   automatically match the sign of the original authorization's amount. For
+      #   example, entering 100 in this field will result in a -100 amount in the
+      #   transaction, if the original authorization is a credit authorization.
       #
-      #     If `amount` is not set, the full amount of the transaction will be cleared.
-      #     Transactions that have already cleared, either partially or fully, cannot be
-      #     cleared again using this endpoint.
+      #   If `amount` is not set, the full amount of the transaction will be cleared.
+      #   Transactions that have already cleared, either partially or fully, cannot be
+      #   cleared again using this endpoint.
       #
       #   @return [Integer, nil]
       optional :amount, Integer

data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb

@@ -10,8 +10,8 @@ module Lithic
 
       # @!attribute amount
       #   Amount (in cents). Any value entered will be converted into a negative amount in
-      #     the simulated transaction. For example, entering 100 in this field will appear
-      #     as a -100 amount in the transaction.
+      #   the simulated transaction. For example, entering 100 in this field will appear
+      #   as a -100 amount in the transaction.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -30,8 +30,8 @@ module Lithic
 
       # @!attribute [r] mcc
       #   Merchant category code for the transaction to be simulated. A four-digit number
-      #     listed in ISO 18245. Supported merchant category codes can be found
-      #     [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
+      #   listed in ISO 18245. Supported merchant category codes can be found
+      #   [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
       #
       #   @return [String, nil]
       optional :mcc, String

data/lib/lithic/models/transaction_simulate_void_params.rb

@@ -16,7 +16,7 @@ module Lithic
 
       # @!attribute [r] amount
       #   Amount (in cents) to void. Typically this will match the amount in the original
-      #     authorization, but can be less.
+      #   authorization, but can be less.
       #
       #   @return [Integer, nil]
       optional :amount, Integer
@@ -28,9 +28,9 @@ module Lithic
       # @!attribute [r] type
       #   Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
       #
-      #     - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
-      #       by Lithic.
-      #     - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
+      #   - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
+      #     by Lithic.
+      #   - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
       #
       #   @return [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type, nil]
       optional :type, enum: -> { Lithic::Models::TransactionSimulateVoidParams::Type }
@@ -51,9 +51,9 @@ module Lithic
 
       # Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
       #
-      #   - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
-      #     by Lithic.
-      #   - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
+      # - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
+      #   by Lithic.
+      # - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
       module Type
         extend Lithic::Internal::Type::Enum
 

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

@@ -227,7 +227,7 @@ module Lithic
 
             # @!attribute [r] driver_number
             #   The driver number entered into the terminal at the time of sale, with leading
-            #     zeros stripped.
+            #   zeros stripped.
             #
             #   @return [String, nil]
             optional :driver_number, String
@@ -259,7 +259,7 @@ module Lithic
 
             # @!attribute [r] vehicle_number
             #   The vehicle number entered into the terminal at the time of sale, with leading
-            #     zeros stripped.
+            #   zeros stripped.
             #
             #   @return [String, nil]
             optional :vehicle_number, String

data/lib/lithic/models/transfer.rb

@@ -17,8 +17,8 @@ module Lithic
       # @!attribute [r] category
       #   Status types:
       #
-      #     - `TRANSFER` - Internal transfer of funds between financial accounts in your
-      #       program.
+      #   - `TRANSFER` - Internal transfer of funds between financial accounts in your
+      #     program.
       #
       #   @return [Symbol, Lithic::Models::Transfer::Category, nil]
       optional :category, enum: -> { Lithic::Models::Transfer::Category }
@@ -39,7 +39,7 @@ module Lithic
 
       # @!attribute [r] currency
       #   3-character alphabetic ISO 4217 code for the settling currency of the
-      #     transaction.
+      #   transaction.
       #
       #   @return [String, nil]
       optional :currency, String
@@ -50,7 +50,7 @@ module Lithic
 
       # @!attribute [r] descriptor
       #   A string that provides a description of the transfer; may be useful to display
-      #     to users.
+      #   to users.
       #
       #   @return [String, nil]
       optional :descriptor, String
@@ -81,8 +81,8 @@ module Lithic
 
       # @!attribute [r] pending_amount
       #   Pending amount of the transaction in the currency's smallest unit (e.g., cents),
-      #     including any acquirer fees. The value of this field will go to zero over time
-      #     once the financial transaction is settled.
+      #   including any acquirer fees. The value of this field will go to zero over time
+      #   once the financial transaction is settled.
       #
       #   @return [Integer, nil]
       optional :pending_amount, Integer
@@ -93,7 +93,7 @@ module Lithic
 
       # @!attribute [r] result
       #   APPROVED transactions were successful while DECLINED transactions were declined
-      #     by user, Lithic, or the network.
+      #   by user, Lithic, or the network.
       #
       #   @return [Symbol, Lithic::Models::Transfer::Result, nil]
       optional :result, enum: -> { Lithic::Models::Transfer::Result }
@@ -104,7 +104,7 @@ module Lithic
 
       # @!attribute [r] settled_amount
       #   Amount of the transaction that has been settled in the currency's smallest unit
-      #     (e.g., cents).
+      #   (e.g., cents).
       #
       #   @return [Integer, nil]
       optional :settled_amount, Integer
@@ -116,11 +116,11 @@ module Lithic
       # @!attribute [r] status
       #   Status types:
       #
-      #     - `DECLINED` - The transfer was declined.
-      #     - `EXPIRED` - The transfer was held in pending for too long and expired.
-      #     - `PENDING` - The transfer is pending release from a hold.
-      #     - `SETTLED` - The transfer is completed.
-      #     - `VOIDED` - The transfer was reversed before it settled.
+      #   - `DECLINED` - The transfer was declined.
+      #   - `EXPIRED` - The transfer was held in pending for too long and expired.
+      #   - `PENDING` - The transfer is pending release from a hold.
+      #   - `SETTLED` - The transfer is completed.
+      #   - `VOIDED` - The transfer was reversed before it settled.
       #
       #   @return [Symbol, Lithic::Models::Transfer::Status, nil]
       optional :status, enum: -> { Lithic::Models::Transfer::Status }
@@ -187,8 +187,8 @@ module Lithic
 
       # Status types:
       #
-      #   - `TRANSFER` - Internal transfer of funds between financial accounts in your
-      #     program.
+      # - `TRANSFER` - Internal transfer of funds between financial accounts in your
+      #   program.
       #
       # @see Lithic::Models::Transfer#category
       module Category
@@ -216,7 +216,7 @@ module Lithic
 
         # @!attribute [r] amount
         #   Amount of the financial event that has been settled in the currency's smallest
-        #     unit (e.g., cents).
+        #   unit (e.g., cents).
         #
         #   @return [Integer, nil]
         optional :amount, Integer
@@ -237,7 +237,7 @@ module Lithic
 
         # @!attribute [r] result
         #   APPROVED financial events were successful while DECLINED financial events were
-        #     declined by user, Lithic, or the network.
+        #   declined by user, Lithic, or the network.
         #
         #   @return [Symbol, Lithic::Models::Transfer::Event::Result, nil]
         optional :result, enum: -> { Lithic::Models::Transfer::Event::Result }
@@ -267,7 +267,7 @@ module Lithic
         # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
         # APPROVED financial events were successful while DECLINED financial events were
-        #   declined by user, Lithic, or the network.
+        # declined by user, Lithic, or the network.
         #
         # @see Lithic::Models::Transfer::Event#result
         module Result
@@ -343,6 +343,7 @@ module Lithic
           INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
           LATE_PAYMENT = :LATE_PAYMENT
           LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
+          LOSS_WRITE_OFF = :LOSS_WRITE_OFF
           PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
           PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
           RETURN = :RETURN
@@ -361,7 +362,7 @@ module Lithic
       end
 
       # APPROVED transactions were successful while DECLINED transactions were declined
-      #   by user, Lithic, or the network.
+      # by user, Lithic, or the network.
       #
       # @see Lithic::Models::Transfer#result
       module Result
@@ -379,11 +380,11 @@ module Lithic
 
       # Status types:
       #
-      #   - `DECLINED` - The transfer was declined.
-      #   - `EXPIRED` - The transfer was held in pending for too long and expired.
-      #   - `PENDING` - The transfer is pending release from a hold.
-      #   - `SETTLED` - The transfer is completed.
-      #   - `VOIDED` - The transfer was reversed before it settled.
+      # - `DECLINED` - The transfer was declined.
+      # - `EXPIRED` - The transfer was held in pending for too long and expired.
+      # - `PENDING` - The transfer is pending release from a hold.
+      # - `SETTLED` - The transfer is completed.
+      # - `VOIDED` - The transfer was reversed before it settled.
       #
       # @see Lithic::Models::Transfer#status
       module Status

data/lib/lithic/models/transfer_create_params.rb

@@ -10,28 +10,28 @@ module Lithic
 
       # @!attribute amount
       #   Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
-      #     This should always be a positive value.
+      #   This should always be a positive value.
       #
       #   @return [Integer]
       required :amount, Integer
 
       # @!attribute from
       #   Globally unique identifier for the financial account or card that will send the
-      #     funds. Accepted type dependent on the program's use case.
+      #   funds. Accepted type dependent on the program's use case.
       #
       #   @return [String]
       required :from, String
 
       # @!attribute to
       #   Globally unique identifier for the financial account or card that will receive
-      #     the funds. Accepted type dependent on the program's use case.
+      #   the funds. Accepted type dependent on the program's use case.
       #
       #   @return [String]
       required :to, String
 
       # @!attribute [r] token
       #   Customer-provided token that will serve as an idempotency token. This token will
-      #     become the transaction token.
+      #   become the transaction token.
       #
       #   @return [String, nil]
       optional :token, String

data/lib/lithic/request_options.rb

@@ -2,10 +2,10 @@
 
 module Lithic
   # Specify HTTP behaviour to use for a specific request. These options supplement
-  #   or override those provided at the client level.
+  # or override those provided at the client level.
   #
-  #   When making a request, you can pass an actual {RequestOptions} instance, or
-  #   simply pass a Hash with symbol keys matching the attributes on this class.
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
   class RequestOptions < Lithic::Internal::Type::BaseModel
     # @api private
     #
@@ -27,28 +27,28 @@ module Lithic
 
     # @!attribute idempotency_key
     #   Idempotency key to send with request and all associated retries. Will only be
-    #     sent for write requests.
+    #   sent for write requests.
     #
     #   @return [String, nil]
     optional :idempotency_key, String
 
     # @!attribute extra_query
     #   Extra query params to send with the request. These are `.merge`’d into any
-    #     `query` given at the client level.
+    #   `query` given at the client level.
     #
     #   @return [Hash{String=>Array<String>, String, nil}, nil]
     optional :extra_query, Lithic::Internal::Type::HashOf[Lithic::Internal::Type::ArrayOf[String]]
 
     # @!attribute extra_headers
     #   Extra headers to send with the request. These are `.merged`’d into any
-    #     `extra_headers` given at the client level.
+    #   `extra_headers` given at the client level.
     #
     #   @return [Hash{String=>String, nil}, nil]
     optional :extra_headers, Lithic::Internal::Type::HashOf[String, nil?: true]
 
     # @!attribute extra_body
     #   Extra data to send with the request. These are deep merged into any data
-    #     generated as part of the normal request.
+    #   generated as part of the normal request.
     #
     #   @return [Object, nil]
     optional :extra_body, Lithic::Internal::Type::HashOf[Lithic::Internal::Type::Unknown]