Module: IdbusApi::Endpoint::Fares

Included in:
Client
Defined in:
lib/idbus_api/endpoint/fares.rb

Overview

Methods of the Fares API

Instance Method Summary collapse

Instance Method Details

#fares(parameters = {}) ⇒ Array<Sawyer::Resource>

Make a call to the GET /fares endpoint

Parameters:

  • parameters (Hash) (defaults to: {}) —

    optional parameters to pass to the request

Returns:

  • (Array<Sawyer::Resource>) 


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/idbus_api/endpoint/fares.rb', line 12

def fares(parameters = {})
  allowed_parameters = %i(
    origin_id
    destination_id
    date
    start_date
    end_date
    currencies
    updated_after
  )

  wrong_parameters = parameters.keys - allowed_parameters
  fail IdbusApi::WrongParameters, wrong_parameters unless wrong_parameters.empty?

  paginate("/fares", parameters).fares
end