class Lithic::Resources::Reports::Settlement::NetworkTotals

def initialize(client:)

Parameters:
  • client (Lithic::Client) --

Other tags:
    Api: - private 
def initialize(client:)
  @client = client
end

def list(params = {})

Other tags:
    See: Lithic::Models::Reports::Settlement::NetworkTotalListParams -

Returns:
  • (Lithic::Internal::CursorPage) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • starting_after (String) -- A cursor representing an item's token after which a page of results should begin
  • settlement_institution_id (String) -- Settlement institution ID to filter on.
  • report_date_end (Date) -- Latest report date to filter on, inclusive (YYYY-MM-DD).
  • report_date_begin (Date) -- Earliest report date to filter on, inclusive (YYYY-MM-DD).
  • report_date (Date) -- Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjuncti
  • page_size (Integer) -- Number of records per page.
  • network (Symbol, Lithic::Reports::Settlement::NetworkTotalListParams::Network) -- Network to filter on.
  • institution_id (String) -- Institution ID to filter on.
  • ending_before (String) -- A cursor representing an item's token before which a page of results should end.
  • end_ (Time) -- Datetime in RFC 3339 format. Only entries created before the specified time will
  • begin_ (Time) -- Datetime in RFC 3339 format. Only entries created after the specified time will

Overloads:
  • 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: {}) 
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::Models::Reports::Settlement::NetworkTotalListResponse,
    options: options
  )
end

def retrieve(token, params = {})

Other tags:
    See: Lithic::Models::Reports::Settlement::NetworkTotalRetrieveParams -

Returns:
  • (Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • token (String) -- Token of the network total record to retrieve

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