lithic 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.7

data/lib/lithic/models/financial_accounts/loan_tape.rb

@@ -35,8 +35,8 @@ module Lithic
 
         # @!attribute credit_limit
         #   For prepay accounts, this is the minimum prepay balance that must be maintained.
-        #     For charge card accounts, this is the maximum credit balance extended by a
-        #     lender
+        #   For charge card accounts, this is the maximum credit balance extended by a
+        #   lender
         #
         #   @return [Integer]
         required :credit_limit, Integer
@@ -66,8 +66,8 @@ module Lithic
 
         # @!attribute excess_credits
         #   Excess credits in the form of provisional credits, payments, or purchase
-        #     refunds. If positive, the account is in net credit state with no outstanding
-        #     balances. An overpayment could land an account in this state
+        #   refunds. If positive, the account is in net credit state with no outstanding
+        #   balances. An overpayment could land an account in this state
         #
         #   @return [Integer]
         required :excess_credits, Integer
@@ -231,7 +231,7 @@ module Lithic
           #   Whether the account currently has grace or not
           #
           #   @return [Boolean]
-          required :has_grace, Lithic::Internal::Type::BooleanModel
+          required :has_grace, Lithic::Internal::Type::Boolean
 
           # @!attribute period_number
           #   Current overall period number
@@ -280,21 +280,21 @@ module Lithic
             required :status,
                      enum: -> { Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Status }
 
-            # @!attribute status_change_reason
-            #   Reason for the financial account status change
+            # @!attribute substatus
+            #   Substatus for the financial account
             #
-            #   @return [Symbol, Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::StatusChangeReason, nil]
-            optional :status_change_reason,
-                     enum: -> { Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::StatusChangeReason },
+            #   @return [Symbol, Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Substatus, nil]
+            optional :substatus,
+                     enum: -> { Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Substatus },
                      nil?: true
 
             # @!parse
             #   # Information about the financial account state
             #   #
             #   # @param status [Symbol, Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Status]
-            #   # @param status_change_reason [Symbol, Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::StatusChangeReason, nil]
+            #   # @param substatus [Symbol, Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState::Substatus, nil]
             #   #
-            #   def initialize(status:, status_change_reason: nil, **) = super
+            #   def initialize(status:, substatus: nil, **) = super
 
             # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
@@ -316,10 +316,10 @@ module Lithic
               #   def self.values; end
             end
 
-            # Reason for the financial account status change
+            # Substatus for the financial account
             #
-            # @see Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState#status_change_reason
-            module StatusChangeReason
+            # @see Lithic::Models::FinancialAccounts::LoanTape::AccountStanding::FinancialAccountState#substatus
+            module Substatus
               extend Lithic::Internal::Type::Enum
 
               CHARGED_OFF_DELINQUENT = :CHARGED_OFF_DELINQUENT
@@ -356,15 +356,15 @@ module Lithic
         class Balances < Lithic::Internal::Type::BaseModel
           # @!attribute due
           #   Amount due for the prior billing cycle. Any amounts not fully paid off on this
-          #     due date will be considered past due the next day
+          #   due date will be considered past due the next day
           #
           #   @return [Lithic::Models::FinancialAccounts::LoanTape::Balances::Due]
           required :due, -> { Lithic::Models::FinancialAccounts::LoanTape::Balances::Due }
 
           # @!attribute next_statement_due
           #   Amount due for the current billing cycle. Any amounts not paid off by early
-          #     payments or credits will be considered due at the end of the current billing
-          #     period
+          #   payments or credits will be considered due at the end of the current billing
+          #   period
           #
           #   @return [Lithic::Models::FinancialAccounts::LoanTape::Balances::NextStatementDue]
           required :next_statement_due,
@@ -412,7 +412,7 @@ module Lithic
 
             # @!parse
             #   # Amount due for the prior billing cycle. Any amounts not fully paid off on this
-            #   #   due date will be considered past due the next day
+            #   # due date will be considered past due the next day
             #   #
             #   # @param fees [Integer]
             #   # @param interest [Integer]
@@ -442,8 +442,8 @@ module Lithic
 
             # @!parse
             #   # Amount due for the current billing cycle. Any amounts not paid off by early
-            #   #   payments or credits will be considered due at the end of the current billing
-            #   #   period
+            #   # payments or credits will be considered due at the end of the current billing
+            #   # period
             #   #
             #   # @param fees [Integer]
             #   # @param interest [Integer]
@@ -529,7 +529,7 @@ module Lithic
 
           # @!attribute credits
           #   Volume of credit management operation transactions less any balance transfers in
-          #     cents
+          #   cents
           #
           #   @return [Integer]
           required :credits, Integer
@@ -796,7 +796,7 @@ module Lithic
 
           # @!attribute credits
           #   Volume of credit management operation transactions less any balance transfers in
-          #     cents
+          #   cents
           #
           #   @return [Integer]
           required :credits, Integer
@@ -876,7 +876,7 @@ module Lithic
 
           # @!attribute credits
           #   Volume of credit management operation transactions less any balance transfers in
-          #     cents
+          #   cents
           #
           #   @return [Integer]
           required :credits, Integer

data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb

@@ -11,10 +11,10 @@ module Lithic
 
         # @!attribute [r] begin_
         #   Date string in RFC 3339 format. Only entries created after the specified date
-        #     will be included.
+        #   will be included.
         #
         #   @return [Date, nil]
-        optional :begin_, Date, api_name: :begin
+        optional :begin_, Date
 
         # @!parse
         #   # @return [Date]
@@ -22,10 +22,10 @@ module Lithic
 
         # @!attribute [r] end_
         #   Date string in RFC 3339 format. Only entries created before the specified date
-        #     will be included.
+        #   will be included.
         #
         #   @return [Date, nil]
-        optional :end_, Date, api_name: :end
+        optional :end_, Date
 
         # @!parse
         #   # @return [Date]
@@ -33,7 +33,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
@@ -54,7 +54,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

data/lib/lithic/models/financial_accounts/statement.rb

@@ -53,7 +53,7 @@ module Lithic
 
         # @!attribute ending_balance
         #   Balance at the end of the billing period. For charge cards, this should be the
-        #     same at the statement amount due in cents
+        #   same at the statement amount due in cents
         #
         #   @return [Integer]
         required :ending_balance, Integer
@@ -225,7 +225,7 @@ module Lithic
           #   Whether the account currently has grace or not
           #
           #   @return [Boolean]
-          required :has_grace, Lithic::Internal::Type::BooleanModel
+          required :has_grace, Lithic::Internal::Type::Boolean
 
           # @!attribute period_number
           #   Current overall period number
@@ -274,21 +274,21 @@ module Lithic
             required :status,
                      enum: -> { Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Status }
 
-            # @!attribute status_change_reason
-            #   Reason for the financial account status change
+            # @!attribute substatus
+            #   Substatus for the financial account
             #
-            #   @return [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::StatusChangeReason, nil]
-            optional :status_change_reason,
-                     enum: -> { Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::StatusChangeReason },
+            #   @return [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Substatus, nil]
+            optional :substatus,
+                     enum: -> { Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Substatus },
                      nil?: true
 
             # @!parse
             #   # Information about the financial account state
             #   #
             #   # @param status [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Status]
-            #   # @param status_change_reason [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::StatusChangeReason, nil]
+            #   # @param substatus [Symbol, Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState::Substatus, nil]
             #   #
-            #   def initialize(status:, status_change_reason: nil, **) = super
+            #   def initialize(status:, substatus: nil, **) = super
 
             # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
 
@@ -310,10 +310,10 @@ module Lithic
               #   def self.values; end
             end
 
-            # Reason for the financial account status change
+            # Substatus for the financial account
             #
-            # @see Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState#status_change_reason
-            module StatusChangeReason
+            # @see Lithic::Models::FinancialAccounts::Statement::AccountStanding::FinancialAccountState#substatus
+            module Substatus
               extend Lithic::Internal::Type::Enum
 
               CHARGED_OFF_DELINQUENT = :CHARGED_OFF_DELINQUENT
@@ -350,9 +350,9 @@ module Lithic
         class AmountDue < Lithic::Internal::Type::BaseModel
           # @!attribute amount
           #   Payment due at the end of the billing period in cents. Negative amount indicates
-          #     something is owed. If the amount owed is positive there was a net credit. If
-          #     auto-collections are enabled this is the amount that will be requested on the
-          #     payment due date
+          #   something is owed. If the amount owed is positive there was a net credit. If
+          #   auto-collections are enabled this is the amount that will be requested on the
+          #   payment due date
           #
           #   @return [Integer]
           required :amount, Integer
@@ -388,7 +388,7 @@ module Lithic
 
           # @!attribute credits
           #   Volume of credit management operation transactions less any balance transfers in
-          #     cents
+          #   cents
           #
           #   @return [Integer]
           required :credits, Integer
@@ -462,7 +462,7 @@ module Lithic
 
           # @!attribute credits
           #   Volume of credit management operation transactions less any balance transfers in
-          #     cents
+          #   cents
           #
           #   @return [Integer]
           required :credits, Integer

data/lib/lithic/models/financial_accounts/statement_list_params.rb

@@ -11,10 +11,10 @@ module Lithic
 
         # @!attribute [r] begin_
         #   Date string in RFC 3339 format. Only entries created after the specified date
-        #     will be included.
+        #   will be included.
         #
         #   @return [Date, nil]
-        optional :begin_, Date, api_name: :begin
+        optional :begin_, Date
 
         # @!parse
         #   # @return [Date]
@@ -22,10 +22,10 @@ module Lithic
 
         # @!attribute [r] end_
         #   Date string in RFC 3339 format. Only entries created before the specified date
-        #     will be included.
+        #   will be included.
         #
         #   @return [Date, nil]
-        optional :end_, Date, api_name: :end
+        optional :end_, Date
 
         # @!parse
         #   # @return [Date]
@@ -33,7 +33,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
@@ -46,7 +46,7 @@ module Lithic
         #   Whether to include the initial statement. It is not included by default.
         #
         #   @return [Boolean, nil]
-        optional :include_initial_statements, Lithic::Internal::Type::BooleanModel
+        optional :include_initial_statements, Lithic::Internal::Type::Boolean
 
         # @!parse
         #   # @return [Boolean]
@@ -64,7 +64,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

data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb

@@ -18,7 +18,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
@@ -39,7 +39,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

data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb

@@ -14,7 +14,7 @@ module Lithic
           # @!attribute has_more
           #
           #   @return [Boolean]
-          required :has_more, Lithic::Internal::Type::BooleanModel
+          required :has_more, Lithic::Internal::Type::Boolean
 
           # @!parse
           #   # @param data [Array<Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data>]
@@ -51,7 +51,7 @@ module Lithic
 
             # @!attribute currency
             #   3-character alphabetic ISO 4217 code for the settling currency of the
-            #     transaction
+            #   transaction
             #
             #   @return [String]
             required :currency, String
@@ -222,6 +222,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

data/lib/lithic/models/financial_accounts/statements.rb

@@ -12,7 +12,7 @@ module Lithic
         # @!attribute has_more
         #
         #   @return [Boolean]
-        required :has_more, Lithic::Internal::Type::BooleanModel
+        required :has_more, Lithic::Internal::Type::Boolean
 
         # @!parse
         #   # @param data [Array<Lithic::Models::FinancialAccounts::Statement>]

data/lib/lithic/models/financial_transaction.rb

@@ -12,11 +12,11 @@ module Lithic
       # @!attribute category
       #   Status types:
       #
-      #     - `CARD` - Issuing card transaction.
-      #     - `ACH` - Transaction over ACH.
-      #     - `INTERNAL` - Transaction for internal adjustment.
-      #     - `TRANSFER` - Internal transfer of funds between financial accounts in your
-      #       program.
+      #   - `CARD` - Issuing card transaction.
+      #   - `ACH` - Transaction over ACH.
+      #   - `INTERNAL` - Transaction for internal adjustment.
+      #   - `TRANSFER` - Internal transfer of funds between financial accounts in your
+      #     program.
       #
       #   @return [Symbol, Lithic::Models::FinancialTransaction::Category]
       required :category, enum: -> { Lithic::Models::FinancialTransaction::Category }
@@ -29,14 +29,14 @@ module Lithic
 
       # @!attribute currency
       #   3-character alphabetic ISO 4217 code for the settling currency of the
-      #     transaction.
+      #   transaction.
       #
       #   @return [String]
       required :currency, String
 
       # @!attribute descriptor
       #   A string that provides a description of the financial transaction; may be useful
-      #     to display to users.
+      #   to display to users.
       #
       #   @return [String]
       required :descriptor, String
@@ -49,22 +49,22 @@ module Lithic
 
       # @!attribute 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]
       required :pending_amount, Integer
 
       # @!attribute 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::FinancialTransaction::Result]
       required :result, enum: -> { Lithic::Models::FinancialTransaction::Result }
 
       # @!attribute settled_amount
       #   Amount of the transaction that has been settled in the currency's smallest unit
-      #     (e.g., cents), including any acquirer fees. This may change over time.
+      #   (e.g., cents), including any acquirer fees. This may change over time.
       #
       #   @return [Integer]
       required :settled_amount, Integer
@@ -72,13 +72,13 @@ module Lithic
       # @!attribute status
       #   Status types:
       #
-      #     - `DECLINED` - The transaction was declined.
-      #     - `EXPIRED` - The authorization as it has passed its expiration time. Card
-      #       transaction only.
-      #     - `PENDING` - The transaction is expected to settle.
-      #     - `RETURNED` - The transaction has been returned.
-      #     - `SETTLED` - The transaction is completed.
-      #     - `VOIDED` - The transaction was voided. Card transaction only.
+      #   - `DECLINED` - The transaction was declined.
+      #   - `EXPIRED` - The authorization as it has passed its expiration time. Card
+      #     transaction only.
+      #   - `PENDING` - The transaction is expected to settle.
+      #   - `RETURNED` - The transaction has been returned.
+      #   - `SETTLED` - The transaction is completed.
+      #   - `VOIDED` - The transaction was voided. Card transaction only.
       #
       #   @return [Symbol, Lithic::Models::FinancialTransaction::Status]
       required :status, enum: -> { Lithic::Models::FinancialTransaction::Status }
@@ -123,11 +123,11 @@ module Lithic
 
       # Status types:
       #
-      #   - `CARD` - Issuing card transaction.
-      #   - `ACH` - Transaction over ACH.
-      #   - `INTERNAL` - Transaction for internal adjustment.
-      #   - `TRANSFER` - Internal transfer of funds between financial accounts in your
-      #     program.
+      # - `CARD` - Issuing card transaction.
+      # - `ACH` - Transaction over ACH.
+      # - `INTERNAL` - Transaction for internal adjustment.
+      # - `TRANSFER` - Internal transfer of funds between financial accounts in your
+      #   program.
       #
       # @see Lithic::Models::FinancialTransaction#category
       module Category
@@ -158,7 +158,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
@@ -179,7 +179,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::FinancialTransaction::Event::Result, nil]
         optional :result, enum: -> { Lithic::Models::FinancialTransaction::Event::Result }
@@ -209,7 +209,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::FinancialTransaction::Event#result
         module Result
@@ -285,6 +285,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
@@ -303,7 +304,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::FinancialTransaction#result
       module Result
@@ -321,13 +322,13 @@ module Lithic
 
       # Status types:
       #
-      #   - `DECLINED` - The transaction was declined.
-      #   - `EXPIRED` - The authorization as it has passed its expiration time. Card
-      #     transaction only.
-      #   - `PENDING` - The transaction is expected to settle.
-      #   - `RETURNED` - The transaction has been returned.
-      #   - `SETTLED` - The transaction is completed.
-      #   - `VOIDED` - The transaction was voided. Card transaction only.
+      # - `DECLINED` - The transaction was declined.
+      # - `EXPIRED` - The authorization as it has passed its expiration time. Card
+      #   transaction only.
+      # - `PENDING` - The transaction is expected to settle.
+      # - `RETURNED` - The transaction has been returned.
+      # - `SETTLED` - The transaction is completed.
+      # - `VOIDED` - The transaction was voided. Card transaction only.
       #
       # @see Lithic::Models::FinancialTransaction#status
       module Status