Class: Lithic::Resources::Reports::Settlement::NetworkTotals

Inherits:
Object
  • Object
show all
Defined in:
lib/lithic/resources/reports/settlement/network_totals.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ NetworkTotals

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of NetworkTotals.

Parameters:



77
78
79
 
# File 'lib/lithic/resources/reports/settlement/network_totals.rb', line 77

def initialize(client:)
  @client = client
end

Instance Method Details

#list(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: {}) ⇒ Lithic::Internal::CursorPage<Lithic::Models::NetworkTotal>

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

List network total records with optional filters. Not available in sandbox.

Parameters:

  • begin_ (Time) —

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

  • end_ (Time) —

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

  • ending_before (String) —

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

  • institution_id (String) —

    Institution ID to filter on.

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

    Network to filter on.

  • page_size (Integer) —

    Number of records per page.

  • report_date (Date) —

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

  • report_date_begin (Date) —

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

  • report_date_end (Date) —

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

  • settlement_institution_id (String) —

    Settlement institution ID to filter on.

  • starting_after (String) —

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

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

Returns:

See Also:



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/lithic/resources/reports/settlement/network_totals.rb', line 62

def list(params = {})
  parsed, options = Lithic::Reports::Settlement::NetworkTotalListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/reports/settlement/network_totals",
    query: parsed.transform_keys(begin_: "begin", end_: "end"),
    page: Lithic::Internal::CursorPage,
    model: Lithic::NetworkTotal,
    options: options
  )
end

#retrieve(token, request_options: {}) ⇒ Lithic::Models::NetworkTotal

Retrieve a specific network total record by token. Not available in sandbox.

Parameters:

  • token (String) —

    Token of the network total record to retrieve

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

Returns:

See Also:



19
20
21
22
23
24
25
26
 
# File 'lib/lithic/resources/reports/settlement/network_totals.rb', line 19

def retrieve(token, params = {})
  @client.request(
    method: :get,
    path: ["v1/reports/settlement/network_totals/%1$s", token],
    model: Lithic::NetworkTotal,
    options: params[:request_options]
  )
end