class DuffelAPI::Services::OffersService
Public Instance Methods
all(options = {})
click to toggle source
Returns an ‘Enumerator` which can automatically cycle through multiple pages of `Resources::Offers`s.
By default, this will use pages of 200 results under the hood, but this can be customised by specifying the ‘:limit` option in the `:params`.
@param options [Hash] options passed to ‘#list`, for example `:params` to
send an HTTP querystring with filters
@return [Enumerator] @raise [Errors::Error] when the Duffel API returns an error
# File lib/duffel_api/services/offers_service.rb, line 34 def all(options = {}) options[:params] = DEFAULT_ALL_PARAMS.merge(options[:params] || {}) Paginator.new( service: self, options: options, ).enumerator end
get(id, options = {})
click to toggle source
Retrieves a single offer by ID
@param id [String] @return [Resources::Offer] @raise [Errors::Error] when the Duffel API returns an error
# File lib/duffel_api/services/offers_service.rb, line 48 def get(id, options = {}) path = substitute_url_pattern("/air/offers/:id", "id" => id) response = make_request(:get, path, options) return if response.raw_body.nil? Resources::Offer.new(unenvelope_body(response.parsed_body), response) end
list(options = {})
click to toggle source
Lists offers, returning a single page of results.
@option [required, Hash] :params Parameters to include in the HTTP querystring,
including any filters
@return [ListResponse] @raise [Errors::Error] when the Duffel API returns an error
# File lib/duffel_api/services/offers_service.rb, line 12 def list(options = {}) path = "/air/offers" response = make_request(:get, path, options) ListResponse.new( response: response, unenveloped_body: unenvelope_body(response.parsed_body), resource_class: Resources::Offer, ) end