Module: BookingSync::API::Client::Bookings

Included in:
BookingSync::API::Client
Defined in:
lib/bookingsync/api/client/bookings.rb

Instance Method Summary collapse

Instance Method Details

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

List bookings

Return public future bookings for the account user is authenticated with.

Examples:

@api.bookings(months: 12, states: [:booked, :unavailable], include_canceled: true)

Pagination

@api.bookings(per_page: 10) do |batch|
  # do something with ten bookings
end

Parameters:

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

    A customizable set of query options.

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

  • from: (Time) —

    Select bookings ending after given date.

  • until: (Time) —

    Select bookings starting before given date.

  • months: (Integer) —

    Select bookings starting before :from + months, if :from is blank, current time is taken.

  • include_canceled: (Boolean) —

    If true canceled bookings are shown, otherwise they are hidden.

  • status: (Array) —

    Array of booking states. If specyfied bookings with given states are shown. Possible statuses: :booked, :unavailable and :tentative

Returns:

See Also:



29
30
31
 
# File 'lib/bookingsync/api/client/bookings.rb', line 29

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

#cancel_booking(booking, options = {}) ⇒ Array

Cancel a booking

Parameters:

Returns:

  • (Array) —

    An empty Array on success, exception is raised otherwise



59
60
61
 
# File 'lib/bookingsync/api/client/bookings.rb', line 59

def cancel_booking(booking, options = {})
  delete "bookings/#{booking}"
end

#create_booking(options = {}) ⇒ BookingSync::API::Resource

Create a booking

Parameters:

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

    Booking attributes

Returns:



37
38
39
 
# File 'lib/bookingsync/api/client/bookings.rb', line 37

def create_booking(options = {})
  post(:bookings, bookings: [options]).pop
end

#edit_booking(booking, options = {}) ⇒ BookingSync::API::Resource

Edit a booking

Examples:

booking = @api.bookings.first
@api.edit_booking(booking, { adults: 1 })

Parameters:

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

    Booking or ID of the booking to be updated

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

    Booking attributes to be updated

Returns:



50
51
52
 
# File 'lib/bookingsync/api/client/bookings.rb', line 50

def edit_booking(booking, options = {})
  put("bookings/#{booking}", bookings: [options]).pop
end