Module: BookingSync::API::Client::Availabilities

Included in:

BookingSync::API::Client

Defined in:

lib/bookingsync/api/client/availabilities.rb

Instance Method Summary

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

  List availabilities.

• #availability(availability) ⇒ BookingSync::API::Resource

  Get a single availability.

Instance Method Details

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

List availabilities

Returns availabilities for the rentals of the account, user is authenticated with.

Examples:

Get the list of availabilities for the current account

availabilities = @api.availabilities
availabilities.first.start_date # => "2014-05-30"

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 availabilities.

See Also:

• http://developers.bookingsync.com/reference/endpoints/availabilities/#list-availabilities

# File 'lib/bookingsync/api/client/availabilities.rb', line 15

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

#availability(availability) ⇒ BookingSync::API::Resource

Get a single availability

Parameters:

• availability (BookingSync::API::Resource|Integer) —

  Availability or ID of the availability.

Returns:

• (BookingSync::API::Resource)

# File 'lib/bookingsync/api/client/availabilities.rb', line 24

def availability(availability)
  get("availabilities/#{availability}").pop
end