lithic 0.21.0 → 0.22.0

data/lib/lithic/models/auth_rules/v2_update_params.rb

@@ -14,32 +14,123 @@ module Lithic
         required :auth_rule_token, String
 
         # @!attribute body
+        #   Replaces the rule's existing entities with the provided `include` and `exclude`
+        #   lists. A missing list is treated as empty, so `include` must always be provided.
         #
-        #   @return [Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule]
+        #   @return [Lithic::Models::AuthRules::V2UpdateParams::Body::Rule, Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule]
         required :body, union: -> { Lithic::AuthRules::V2UpdateParams::Body }
 
         # @!method initialize(auth_rule_token:, body:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::AuthRules::V2UpdateParams} for more details.
+        #
         #   @param auth_rule_token [String]
-        #   @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule]
+        #
+        #   @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::Rule, Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule] Replaces the rule's existing entities with the provided `include` and `exclude`
+        #
         #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
+        # Replaces the rule's existing entities with the provided `include` and `exclude`
+        # lists. A missing list is treated as empty, so `include` must always be provided.
         module Body
           extend Lithic::Internal::Type::Union
 
+          # Replaces the rule's existing entities with the provided `include` and `exclude` lists. A missing list is treated as empty, so `include` must always be provided.
+          variant -> { Lithic::AuthRules::V2UpdateParams::Body::Rule }
+
+          # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
           variant -> { Lithic::AuthRules::V2UpdateParams::Body::AccountLevelRule }
 
+          # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
           variant -> { Lithic::AuthRules::V2UpdateParams::Body::CardLevelRule }
 
+          # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
           variant -> { Lithic::AuthRules::V2UpdateParams::Body::ProgramLevelRule }
 
+          class Rule < Lithic::Internal::Type::BaseModel
+            # @!attribute entities
+            #   The entities an Auth Rule applies to (`include`) and does not apply to
+            #   (`exclude`). An exclusion overrides an inclusion, so a card excluded here is
+            #   skipped even when the program, its account or one of its tags is included.
+            #
+            #   The rule's resulting entities must satisfy these constraints after any write:
+            #
+            #   - `include` must contain at least one entity.
+            #   - If `PROGRAM` is included, it must be the only included entity.
+            #   - `PROGRAM` cannot be excluded.
+            #   - An entity cannot appear in both `include` and `exclude`, or twice in the same
+            #     list.
+            #   - A rule can have at most 1,000 entities across `include` and `exclude`, not
+            #     counting `PROGRAM`.
+            #   - Entity types must be valid for the rule's event stream.
+            #   - `CARD`, `ACCOUNT` and `BUSINESS_ACCOUNT` tokens must belong to your program.
+            #
+            #   @return [Lithic::Models::AuthRules::AuthRuleEntities, nil]
+            optional :entities, -> { Lithic::AuthRules::AuthRuleEntities }
+
+            # @!attribute name
+            #   Auth Rule Name
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute state
+            #   The desired state of the Auth Rule.
+            #
+            #   Note that only deactivating an Auth Rule through this endpoint is supported at
+            #   this time. If you need to (re-)activate an Auth Rule the /promote endpoint
+            #   should be used to promote a draft to the currently active version.
+            #
+            #   @return [Symbol, Lithic::Models::AuthRules::V2UpdateParams::Body::Rule::State, nil]
+            optional :state, enum: -> { Lithic::AuthRules::V2UpdateParams::Body::Rule::State }
+
+            # @!method initialize(entities: nil, name: nil, state: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Lithic::Models::AuthRules::V2UpdateParams::Body::Rule} for more details.
+            #
+            #   Replaces the rule's existing entities with the provided `include` and `exclude`
+            #   lists. A missing list is treated as empty, so `include` must always be provided.
+            #
+            #   @param entities [Lithic::Models::AuthRules::AuthRuleEntities] The entities an Auth Rule applies to (`include`) and does not apply to (`exclude
+            #
+            #   @param name [String, nil] Auth Rule Name
+            #
+            #   @param state [Symbol, Lithic::Models::AuthRules::V2UpdateParams::Body::Rule::State] The desired state of the Auth Rule.
+
+            # The desired state of the Auth Rule.
+            #
+            # Note that only deactivating an Auth Rule through this endpoint is supported at
+            # this time. If you need to (re-)activate an Auth Rule the /promote endpoint
+            # should be used to promote a draft to the currently active version.
+            #
+            # @see Lithic::Models::AuthRules::V2UpdateParams::Body::Rule#state
+            module State
+              extend Lithic::Internal::Type::Enum
+
+              INACTIVE = :INACTIVE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @deprecated
           class AccountLevelRule < Lithic::Internal::Type::BaseModel
             # @!attribute account_tokens
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with `ACCOUNT` entities instead.
+            #
             #   Account tokens to which the Auth Rule applies.
             #
             #   @return [Array<String>, nil]
             optional :account_tokens, Lithic::Internal::Type::ArrayOf[String]
 
             # @!attribute business_account_tokens
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with `BUSINESS_ACCOUNT` entities instead.
+            #
             #   Business Account tokens to which the Auth Rule applies.
             #
             #   @return [Array<String>, nil]
@@ -66,9 +157,11 @@ module Lithic
             #   {Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule} for more
             #   details.
             #
-            #   @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
+            #   Deprecated: Use `entities` instead. Cannot be combined with `entities`.
             #
-            #   @param business_account_tokens [Array<String>] Business Account tokens to which the Auth Rule applies.
+            #   @param account_tokens [Array<String>] Deprecated: Use `entities.include` with `ACCOUNT` entities instead.
+            #
+            #   @param business_account_tokens [Array<String>] Deprecated: Use `entities.include` with `BUSINESS_ACCOUNT` entities instead.
             #
             #   @param name [String, nil] Auth Rule Name
             #
@@ -91,9 +184,15 @@ module Lithic
             end
           end
 
+          # @deprecated
           class CardLevelRule < Lithic::Internal::Type::BaseModel
             # @!attribute card_tokens
-            #   Card tokens to which the Auth Rule applies.
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with `CARD` entities instead.
+            #
+            #   Card tokens to which the Auth Rule applies. Cards the rule applies to through a
+            #   `CARD_TAG` entity are not listed.
             #
             #   @return [Array<String>, nil]
             optional :card_tokens, Lithic::Internal::Type::ArrayOf[String]
@@ -119,7 +218,9 @@ module Lithic
             #   {Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule} for more
             #   details.
             #
-            #   @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
+            #   Deprecated: Use `entities` instead. Cannot be combined with `entities`.
+            #
+            #   @param card_tokens [Array<String>] Deprecated: Use `entities.include` with `CARD` entities instead.
             #
             #   @param name [String, nil] Auth Rule Name
             #
@@ -142,21 +243,35 @@ module Lithic
             end
           end
 
+          # @deprecated
           class ProgramLevelRule < Lithic::Internal::Type::BaseModel
             # @!attribute excluded_account_tokens
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.exclude` with `ACCOUNT` entities instead.
+            #
             #   Account tokens to which the Auth Rule does not apply.
             #
             #   @return [Array<String>, nil]
             optional :excluded_account_tokens, Lithic::Internal::Type::ArrayOf[String]
 
             # @!attribute excluded_business_account_tokens
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.exclude` with `BUSINESS_ACCOUNT` entities instead.
+            #
             #   Business account tokens to which the Auth Rule does not apply.
             #
             #   @return [Array<String>, nil]
             optional :excluded_business_account_tokens, Lithic::Internal::Type::ArrayOf[String]
 
             # @!attribute excluded_card_tokens
-            #   Card tokens to which the Auth Rule does not apply.
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.exclude` with `CARD` entities instead.
+            #
+            #   Card tokens to which the Auth Rule does not apply. Cards excluded through a
+            #   `CARD_TAG` entity are not listed.
             #
             #   @return [Array<String>, nil]
             optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
@@ -168,6 +283,10 @@ module Lithic
             optional :name, String, nil?: true
 
             # @!attribute program_level
+            #   @deprecated
+            #
+            #   Deprecated: Use `entities.include` with a `PROGRAM` entity instead.
+            #
             #   Whether the Auth Rule applies to all authorizations on the card program.
             #
             #   @return [Boolean, nil]
@@ -188,15 +307,17 @@ module Lithic
             #   {Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule} for more
             #   details.
             #
-            #   @param excluded_account_tokens [Array<String>] Account tokens to which the Auth Rule does not apply.
+            #   Deprecated: Use `entities` instead. Cannot be combined with `entities`.
+            #
+            #   @param excluded_account_tokens [Array<String>] Deprecated: Use `entities.exclude` with `ACCOUNT` entities instead.
             #
-            #   @param excluded_business_account_tokens [Array<String>] Business account tokens to which the Auth Rule does not apply.
+            #   @param excluded_business_account_tokens [Array<String>] Deprecated: Use `entities.exclude` with `BUSINESS_ACCOUNT` entities instead.
             #
-            #   @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
+            #   @param excluded_card_tokens [Array<String>] Deprecated: Use `entities.exclude` with `CARD` entities instead.
             #
             #   @param name [String, nil] Auth Rule Name
             #
-            #   @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
+            #   @param program_level [Boolean] Deprecated: Use `entities.include` with a `PROGRAM` entity instead.
             #
             #   @param state [Symbol, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule::State] The desired state of the Auth Rule.
 
@@ -218,7 +339,7 @@ module Lithic
           end
 
           # @!method self.variants
-          #   @return [Array(Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule)]
+          #   @return [Array(Lithic::Models::AuthRules::V2UpdateParams::Body::Rule, Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule)]
         end
       end
     end

data/lib/lithic/models/card_authorization.rb

@@ -532,12 +532,20 @@ module Lithic
         #   @return [Symbol, Lithic::Models::CardAuthorization::Card::State]
         required :state, enum: -> { Lithic::CardAuthorization::Card::State }
 
+        # @!attribute tags
+        #   Key-value pairs for tagging resources. Tags allow you to associate arbitrary
+        #   metadata with a resource for your own purposes. A resource can have at most 50
+        #   tags, with keys up to 40 characters and values up to 500 characters
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :tags, Lithic::Internal::Type::HashOf[String]
+
         # @!attribute type
         #
         #   @return [Symbol, Lithic::Models::CardAuthorization::Card::Type]
         required :type, enum: -> { Lithic::CardAuthorization::Card::Type }
 
-        # @!method initialize(token:, last_four:, memo:, spend_limit:, spend_limit_duration:, state:, type:)
+        # @!method initialize(token:, last_four:, memo:, spend_limit:, spend_limit_duration:, state:, tags:, type:)
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::CardAuthorization::Card} for more details.
         #
@@ -555,6 +563,8 @@ module Lithic
         #
         #   @param state [Symbol, Lithic::Models::CardAuthorization::Card::State]
         #
+        #   @param tags [Hash{Symbol=>String}] Key-value pairs for tagging resources. Tags allow you to associate arbitrary met
+        #
         #   @param type [Symbol, Lithic::Models::CardAuthorization::Card::Type]
 
         # Note that to support recurring monthly payments, which can occur on different

data/lib/lithic/models/card_create_params.rb

@@ -229,12 +229,20 @@ module Lithic
       #   @return [Symbol, Lithic::Models::CardCreateParams::State, nil]
       optional :state, enum: -> { Lithic::CardCreateParams::State }
 
+      # @!attribute tags
+      #   Key-value pairs to tag the card with. A replacement card does not inherit tags
+      #   from the card it replaces. A card can have at most 50 tags, with keys up to 40
+      #   characters and values up to 500 characters
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :tags, Lithic::Internal::Type::HashOf[String]
+
       # @!attribute idempotency_key
       #
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!method initialize(type:, account_token: nil, bulk_order_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_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, idempotency_key: nil, request_options: {})
+      # @!method initialize(type:, account_token: nil, bulk_order_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_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, tags: nil, idempotency_key: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::CardCreateParams} for more details.
       #
@@ -278,6 +286,8 @@ module Lithic
       #
       #   @param state [Symbol, Lithic::Models::CardCreateParams::State] Card state values:
       #
+      #   @param tags [Hash{Symbol=>String}] Key-value pairs to tag the card with. A replacement card does not inherit tags f
+      #
       #   @param idempotency_key [String]
       #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]

data/lib/lithic/models/card_update_params.rb

@@ -127,7 +127,16 @@ module Lithic
       #   @return [Symbol, Lithic::Models::CardUpdateParams::Substatus, nil]
       optional :substatus, enum: -> { Lithic::CardUpdateParams::Substatus }
 
-      # @!method initialize(card_token:, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, request_options: {})
+      # @!attribute tags
+      #   Key-value pairs to merge into the card's tags. Supplied keys are added or
+      #   overwritten, a key with a `null` value is removed, and omitted keys remain
+      #   unchanged. A card can have at most 50 tags, with keys up to 40 characters and
+      #   values up to 500 characters
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :tags, Lithic::Internal::Type::HashOf[String, nil?: true]
+
+      # @!method initialize(card_token:, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, tags: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::CardUpdateParams} for more details.
       #
@@ -153,6 +162,8 @@ module Lithic
       #
       #   @param substatus [Symbol, Lithic::Models::CardUpdateParams::Substatus] Card state substatus values:
       #
+      #   @param tags [Hash{Symbol=>String, nil}] Key-value pairs to merge into the card's tags. Supplied keys are added or overwr
+      #
       #   @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/financial_accounts/installment_plans/installment_plan_statement.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module FinancialAccounts
+      module InstallmentPlans
+        # @see Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements#retrieve
+        class InstallmentPlanStatement < Lithic::Internal::Type::BaseModel
+          # @!attribute token
+          #   Globally unique identifier for this snapshot, which is the token of the
+          #   statement it is attached to. A plan is snapshotted at most once per statement,
+          #   so the statement identifies the snapshot within the plan. Pass it as a
+          #   pagination cursor
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute fee_amount
+          #   Enrollment fee charged when the plan was created in cents
+          #
+          #   @return [Integer]
+          required :fee_amount, Integer
+
+          # @!attribute installment_plan_token
+          #   Globally unique identifier for the installment plan this snapshot is of
+          #
+          #   @return [String]
+          required :installment_plan_token, String
+
+          # @!attribute installment_plan_total
+          #   Total owed on the plan in cents, the principal amount plus the enrollment fee
+          #
+          #   @return [Integer]
+          required :installment_plan_total, Integer
+
+          # @!attribute installments
+          #   Installments that make up the plan, oldest first
+          #
+          #   @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment>]
+          required :installments,
+                   -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment] }
+
+          # @!attribute installments_outstanding
+          #   Number of installments that still carried a balance as of this statement
+          #
+          #   @return [Integer]
+          required :installments_outstanding, Integer
+
+          # @!attribute installments_paid
+          #   Number of installments that had been paid off as of this statement
+          #
+          #   @return [Integer]
+          required :installments_paid, Integer
+
+          # @!attribute num_installments
+          #   Number of installments the plan is broken into
+          #
+          #   @return [Integer]
+          required :num_installments, Integer
+
+          # @!attribute principal_amount
+          #   Balance the plan was opened on in cents, excluding the enrollment fee
+          #
+          #   @return [Integer]
+          required :principal_amount, Integer
+
+          # @!attribute source_type
+          #
+          #   @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
+          required :source_type,
+                   enum: -> { Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType }
+
+          # @!attribute start_date
+          #   Date the plan was created
+          #
+          #   @return [Date]
+          required :start_date, Date
+
+          # @!attribute state
+          #   State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
+          #   tapes are being rebuilt, during which its payment totals are being recomputed
+          #   and should not be treated as final
+          #
+          #   @return [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State]
+          required :state, enum: -> { Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State }
+
+          # @!attribute total_paid
+          #   Amount paid towards the plan as of this statement in cents
+          #
+          #   @return [Integer]
+          required :total_paid, Integer
+
+          # @!method initialize(token:, fee_amount:, installment_plan_token:, installment_plan_total:, installments:, installments_outstanding:, installments_paid:, num_installments:, principal_amount:, source_type:, start_date:, state:, total_paid:)
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement}
+          #   for more details.
+          #
+          #   An immutable snapshot of an installment plan as of the statement it is attached
+          #   to. Lithic cuts one per open plan when a statement is generated and never
+          #   reissues it
+          #
+          #   @param token [String] Globally unique identifier for this snapshot, which is the token of the statemen
+          #
+          #   @param fee_amount [Integer] Enrollment fee charged when the plan was created in cents
+          #
+          #   @param installment_plan_token [String] Globally unique identifier for the installment plan this snapshot is of
+          #
+          #   @param installment_plan_total [Integer] Total owed on the plan in cents, the principal amount plus the enrollment fee
+          #
+          #   @param installments [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment>] Installments that make up the plan, oldest first
+          #
+          #   @param installments_outstanding [Integer] Number of installments that still carried a balance as of this statement
+          #
+          #   @param installments_paid [Integer] Number of installments that had been paid off as of this statement
+          #
+          #   @param num_installments [Integer] Number of installments the plan is broken into
+          #
+          #   @param principal_amount [Integer] Balance the plan was opened on in cents, excluding the enrollment fee
+          #
+          #   @param source_type [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::SourceType]
+          #
+          #   @param start_date [Date] Date the plan was created
+          #
+          #   @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::State] State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan tape
+          #
+          #   @param total_paid [Integer] Amount paid towards the plan as of this statement in cents
+
+          class Installment < Lithic::Internal::Type::BaseModel
+            # @!attribute amount_due
+            #   Amount the installment was opened for in cents
+            #
+            #   @return [Integer]
+            required :amount_due, Integer
+
+            # @!attribute amount_due_details
+            #
+            #   @return [Lithic::Models::FinancialAccounts::CategoryBalances]
+            required :amount_due_details, -> { Lithic::FinancialAccounts::CategoryBalances }
+
+            # @!attribute amount_outstanding
+            #   Amount still owed on the installment in cents
+            #
+            #   @return [Integer]
+            required :amount_outstanding, Integer
+
+            # @!attribute amount_outstanding_details
+            #
+            #   @return [Lithic::Models::FinancialAccounts::CategoryBalances]
+            required :amount_outstanding_details, -> { Lithic::FinancialAccounts::CategoryBalances }
+
+            # @!attribute amount_paid
+            #   Amount paid towards the installment in cents
+            #
+            #   @return [Integer]
+            required :amount_paid, Integer
+
+            # @!attribute amount_paid_details
+            #
+            #   @return [Lithic::Models::FinancialAccounts::CategoryBalances]
+            required :amount_paid_details, -> { Lithic::FinancialAccounts::CategoryBalances }
+
+            # @!attribute date_assessed
+            #   Date the installment was actually assessed onto the account, or null if it had
+            #   not been assessed as of this statement
+            #
+            #   @return [Date, nil]
+            required :date_assessed, Date, nil?: true
+
+            # @!attribute due_date
+            #   Date the installment is scheduled to be assessed onto the account
+            #
+            #   @return [Date]
+            required :due_date, Date
+
+            # @!attribute installment_num
+            #   Position of this installment within the plan, starting at 0
+            #
+            #   @return [Integer]
+            required :installment_num, Integer
+
+            # @!attribute payment_due_date
+            #   Date the installment must be paid by before it is considered past due
+            #
+            #   @return [Date]
+            required :payment_due_date, Date
+
+            # @!attribute payments
+            #   Payments applied to this installment, oldest first
+            #
+            #   @return [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment>]
+            required :payments,
+                     -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment] }
+
+            # @!method initialize(amount_due:, amount_due_details:, amount_outstanding:, amount_outstanding_details:, amount_paid:, amount_paid_details:, date_assessed:, due_date:, installment_num:, payment_due_date:, payments:)
+            #   Some parameter documentations has been truncated, see
+            #   {Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment}
+            #   for more details.
+            #
+            #   One installment of a plan as of the statement. Amounts are totalled across
+            #   transaction categories rather than broken out by them, which the installment
+            #   plan endpoint does
+            #
+            #   @param amount_due [Integer] Amount the installment was opened for in cents
+            #
+            #   @param amount_due_details [Lithic::Models::FinancialAccounts::CategoryBalances]
+            #
+            #   @param amount_outstanding [Integer] Amount still owed on the installment in cents
+            #
+            #   @param amount_outstanding_details [Lithic::Models::FinancialAccounts::CategoryBalances]
+            #
+            #   @param amount_paid [Integer] Amount paid towards the installment in cents
+            #
+            #   @param amount_paid_details [Lithic::Models::FinancialAccounts::CategoryBalances]
+            #
+            #   @param date_assessed [Date, nil] Date the installment was actually assessed onto the account, or null if it had n
+            #
+            #   @param due_date [Date] Date the installment is scheduled to be assessed onto the account
+            #
+            #   @param installment_num [Integer] Position of this installment within the plan, starting at 0
+            #
+            #   @param payment_due_date [Date] Date the installment must be paid by before it is considered past due
+            #
+            #   @param payments [Array<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement::Installment::Payment>] Payments applied to this installment, oldest first
+
+            class Payment < Lithic::Internal::Type::BaseModel
+              # @!attribute amount
+              #   Amount applied to the installment in cents
+              #
+              #   @return [Integer]
+              required :amount, Integer
+
+              # @!attribute date
+              #   Date the payment was applied to the installment
+              #
+              #   @return [Date]
+              required :date, Date
+
+              # @!method initialize(amount:, date:)
+              #   @param amount [Integer] Amount applied to the installment in cents
+              #
+              #   @param date [Date] Date the payment was applied to the installment
+            end
+          end
+
+          # @see Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement#source_type
+          module SourceType
+            extend Lithic::Internal::Type::Enum
+
+            UNPAID_BALANCE = :UNPAID_BALANCE
+            TRANSACTION = :TRANSACTION
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # State of the installment plan. A plan is REBUILD_IN_PROGRESS while its loan
+          # tapes are being rebuilt, during which its payment totals are being recomputed
+          # and should not be treated as final
+          #
+          # @see Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement#state
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            PENDING = :PENDING
+            ACTIVE = :ACTIVE
+            REBUILD_IN_PROGRESS = :REBUILD_IN_PROGRESS
+            FULLY_PAID = :FULLY_PAID
+            CANCELLED = :CANCELLED
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      InstallmentPlanStatement = InstallmentPlans::InstallmentPlanStatement
+    end
+  end
+end