Class: Lithic::Models::FinancialAccounts::StatementListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/financial_accounts/statement_list_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::FinancialAccounts::StatementListParams for more details.

Parameters:

  • begin_ (Date) (defaults to: nil) —

    Date string in RFC 3339 format. Only entries created after the specified date wi

  • end_ (Date) (defaults to: nil) —

    Date string in RFC 3339 format. Only entries created before the specified date w

  • ending_before (String) (defaults to: nil) —

    A cursor representing an item’s token before which a page of results should end.

  • include_initial_statements (Boolean) (defaults to: nil) —

    Whether to include the initial statement. It is not included by default.

  • page_size (Integer) (defaults to: nil) —

    Page size (for pagination).

  • starting_after (String) (defaults to: nil) —

    A cursor representing an item’s token after which a page of results should begin

  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/lithic/models/financial_accounts/statement_list_params.rb', line 51

Instance Attribute Details

#begin_ ⇒ Date?

Date string in RFC 3339 format. Only entries created after the specified date will be included.

Returns:

  • (Date, nil) 


16
 
# File 'lib/lithic/models/financial_accounts/statement_list_params.rb', line 16

optional :begin_, Date

#end_ ⇒ Date?

Date string in RFC 3339 format. Only entries created before the specified date will be included.

Returns:

  • (Date, nil) 


23
 
# File 'lib/lithic/models/financial_accounts/statement_list_params.rb', line 23

optional :end_, Date

#ending_before ⇒ String?

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.

Returns:

  • (String, nil) 


30
 
# File 'lib/lithic/models/financial_accounts/statement_list_params.rb', line 30

optional :ending_before, String

#include_initial_statements ⇒ Boolean?

Whether to include the initial statement. It is not included by default.

Returns:

  • (Boolean, nil) 


36
 
# File 'lib/lithic/models/financial_accounts/statement_list_params.rb', line 36

optional :include_initial_statements, Lithic::Internal::Type::Boolean

#page_size ⇒ Integer?

Page size (for pagination).

Returns:

  • (Integer, nil) 


42
 
# File 'lib/lithic/models/financial_accounts/statement_list_params.rb', line 42

optional :page_size, Integer

#starting_after ⇒ String?

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.

Returns:

  • (String, nil) 


49
 
# File 'lib/lithic/models/financial_accounts/statement_list_params.rb', line 49

optional :starting_after, String