Module: BookingSync::API::Client::RentalAgreements

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

Instance Method Summary collapse

Instance Method Details

#create_rental_agreement(options = {}) ⇒ BookingSync::API::Response

Create a new rental agreement for an account



45
46
47
 
# File 'lib/bookingsync/api/client/rental_agreements.rb', line 45

def create_rental_agreement(options = {})
  post(:rental_agreements, rental_agreements: [options]).pop
end

#create_rental_agreement_for_booking(booking_id, options = {}) ⇒ BookingSync::API::Response

Create a new rental agreement for a booking



26
27
28
29
 
# File 'lib/bookingsync/api/client/rental_agreements.rb', line 26

def create_rental_agreement_for_booking(booking_id, options = {})
  post(:rental_agreements, booking_id: booking_id,
       rental_agreements: [options]).pop
end

#create_rental_agreement_for_rental(rental_id, options = {}) ⇒ BookingSync::API::Response

Create a new rental agreement for a rental



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

def create_rental_agreement_for_rental(rental_id, options = {})
  post(:rental_agreements, rental_id: rental_id,
       rental_agreements: [options]).pop
end

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

List rental agreements

Returns rental agreements for the rentals of the account user is authenticated with.

Examples:

Get the list of rental agreements for the current account

agreement = @api.rental_agreements
agreement.first.body # => "My rental agreement"

Get the list of rental agreements only with body for smaller response

@api.rentals(fields: :body)

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

See Also:



17
18
19
 
# File 'lib/bookingsync/api/client/rental_agreements.rb', line 17

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