Module: BookingSync::API::Client::Amenities

Included in:

BookingSync::API::Client

Defined in:

lib/bookingsync/api/client/amenities.rb

Instance Method Summary

• #amenities(options = {}, &block) ⇒ Array<BookingSync::API::Resource>

  List amenities.

Instance Method Details

#amenities(options = {}, &block) ⇒ Array<BookingSync::API::Resource>

List amenities

Returns amenities for the account user is authenticated with.

Examples:

Get the list of amenities for the current account

amenities = @api.amenities
amenities.first.title # => "Internet"

Get the list of amenities only with title and rental_id for smaller response

@api.amenities(fields: [:title, :rental_id])

Parameters:

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

  A customizable set of options.

Options Hash (options):

• fields: (Array) —

  List of fields to be fetched.

Returns:

• (Array<BookingSync::API::Resource>) —

  Array of amenities.

See Also:

• http://docs.api.bookingsync.com/reference/endpoints/amenities/#list-amenities

# File 'lib/bookingsync/api/client/amenities.rb', line 17

def amenities(options = {}, &block)
  paginate :amenities, options, &block
end