Module: BookingSync::API::Client::ChangeOvers

Included in:

BookingSync::API::Client

Defined in:

lib/bookingsync/api/client/change_overs.rb

Instance Method Summary

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

  Get a single change_over.

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

  List change_overs.

Instance Method Details

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

Get a single change_over

Parameters:

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

  ChangeOver or ID of the change_over.

Returns:

• (BookingSync::API::Resource)

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

def change_over(change_over)
  get("change_overs/#{change_over}").pop
end

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

List change_overs

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

Examples:

Get the list of change_overs for the current account

change_overs = @api.change_overs
change_overs.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 change_overs.

See Also:

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

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

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