Class: Lithic::Models::Reports::Settlement::NetworkTotalListParams

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

Overview

See Also:

Defined Under Namespace

Modules: Network

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, institution_id: nil, network: nil, page_size: nil, report_date: nil, report_date_begin: nil, report_date_end: nil, settlement_institution_id: nil, starting_after: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::Reports::Settlement::NetworkTotalListParams for more details.

Parameters:

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

    Datetime in RFC 3339 format. Only entries created after the specified time will

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

    Datetime in RFC 3339 format. Only entries created before the specified time will

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

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

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

    Institution ID to filter on.

  • network (Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListParams::Network) (defaults to: nil) —

    Network to filter on.

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

    Number of records per page.

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

    Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjuncti

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

    Earliest report date to filter on, inclusive (YYYY-MM-DD).

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

    Latest report date to filter on, inclusive (YYYY-MM-DD).

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

    Settlement institution ID to filter on.

  • 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/reports/settlement/network_total_list_params.rb', line 83

Instance Attribute Details

#begin_ ⇒ Time?

Datetime in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

Returns:

  • (Time, nil) 


17
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 17

optional :begin_, Time

#end_ ⇒ Time?

Datetime in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

Returns:

  • (Time, nil) 


24
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 24

optional :end_, Time

#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) 


31
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 31

optional :ending_before, String

#institution_id ⇒ String?

Institution ID to filter on.

Returns:

  • (String, nil) 


37
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 37

optional :institution_id, String

#network ⇒ Symbol, ...

Network to filter on.

Returns:



43
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 43

optional :network, enum: -> { Lithic::Reports::Settlement::NetworkTotalListParams::Network }

#page_size ⇒ Integer?

Number of records per page.

Returns:

  • (Integer, nil) 


49
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 49

optional :page_size, Integer

#report_date ⇒ Date?

Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjunction with report_date_begin or report_date_end.

Returns:

  • (Date, nil) 


56
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 56

optional :report_date, Date

#report_date_begin ⇒ Date?

Earliest report date to filter on, inclusive (YYYY-MM-DD).

Returns:

  • (Date, nil) 


62
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 62

optional :report_date_begin, Date

#report_date_end ⇒ Date?

Latest report date to filter on, inclusive (YYYY-MM-DD).

Returns:

  • (Date, nil) 


68
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 68

optional :report_date_end, Date

#settlement_institution_id ⇒ String?

Settlement institution ID to filter on.

Returns:

  • (String, nil) 


74
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 74

optional :settlement_institution_id, String

#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) 


81
 
# File 'lib/lithic/models/reports/settlement/network_total_list_params.rb', line 81

optional :starting_after, String