Class: DuffelAPI::Services::AircraftService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/duffel_api/services/aircraft_service.rb

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from DuffelAPI::Services::BaseService

Instance Method Details

#all(options = {}) ⇒ Enumerator

Returns an Enumerator which can automatically cycle through multiple pages of ‘Resources;:Aircraft`

Parameters:

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

    options passed to #list, for example :params to send an HTTP querystring with filters

Returns:

  • (Enumerator)

Raises:



31
32
33
34
35
36
 
# File 'lib/duffel_api/services/aircraft_service.rb', line 31

def all(options = {})
  DuffelAPI::Paginator.new(
    service: self,
    options: options,
  ).enumerator
end

#get(id, options = {}) ⇒ Resources::Aircraft

Retrieves a single aircraft by ID

Parameters:

  • id (String)

Returns:

Raises:



43
44
45
46
47
48
49
50
51
 
# File 'lib/duffel_api/services/aircraft_service.rb', line 43

def get(id, options = {})
  path = substitute_url_pattern("/air/aircraft/:id", "id" => id)

  response = make_request(:get, path, options)

  return if response.raw_body.nil?

  Resources::Aircraft.new(unenvelope_body(response.parsed_body), response)
end

#list(options = {}) ⇒ ListResponse

Lists aircraft, returning a single page of results

Parameters:

  • [Hash] (Hash) —

    a customizable set of options

Returns:

Raises:



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/duffel_api/services/aircraft_service.rb', line 12

def list(options = {})
  path = "/air/aircraft"

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.parsed_body),
    resource_class: Resources::Aircraft,
  )
end