# frozen_string_literal: true

module Lithic
  module Models
    module FinancialAccounts
      # @see Lithic::Resources::FinancialAccounts::Statements#list
      class StatementListParams < Lithic::Internal::Type::BaseModel
        extend Lithic::Internal::Type::RequestParameters::Converter
        include Lithic::Internal::Type::RequestParameters

        # @!attribute begin_
        #   Date string in RFC 3339 format. Only entries created after the specified date
        #   will be included.
        #
        #   @return [Date, nil]
        optional :begin_, Date

        # @!attribute end_
        #   Date string in RFC 3339 format. Only entries created before the specified date
        #   will be included.
        #
        #   @return [Date, nil]
        optional :end_, Date

        # @!attribute 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.
        #
        #   @return [String, nil]
        optional :ending_before, String

        # @!attribute include_initial_statements
        #   Whether to include the initial statement. It is not included by default.
        #
        #   @return [Boolean, nil]
        optional :include_initial_statements, Lithic::Internal::Type::Boolean

        # @!attribute page_size
        #   Page size (for pagination).
        #
        #   @return [Integer, nil]
        optional :page_size, Integer

        # @!attribute 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.
        #
        #   @return [String, nil]
        optional :starting_after, String

        # @!method initialize(begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {})
        #   Some parameter documentations has been truncated, see
        #   {Lithic::Models::FinancialAccounts::StatementListParams} for more details.
        #
        #   @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
        #
        #   @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
        #
        #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
        #
        #   @param include_initial_statements [Boolean] Whether to include the initial statement. It is not included by default.
        #
        #   @param page_size [Integer] Page size (for pagination).
        #
        #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
        #
        #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
      end
    end
  end
end