Module: BookingSync::API::Client::ReservationsRequests

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

Instance Method Summary collapse

Instance Method Details

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

Create a new reservations request

Parameters:

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

    Reservations request attributes.

Returns:



30
31
32
 
# File 'lib/bookingsync/api/client/reservations_requests.rb', line 30

def create_reservation_request(options = {})
  post("reservations/requests", requests: [options]).pop
end

#delete_reservation_request(id) ⇒ NilClass

Delete a reservations request

Soft-cancels the given reservations request.

Parameters:

Returns:

  • (NilClass) —

    Returns nil on success.



51
52
53
 
# File 'lib/bookingsync/api/client/reservations_requests.rb', line 51

def delete_reservation_request(id)
  delete "reservations/requests/#{id}"
end

#patch_reservation_request(id, options = {}) ⇒ BookingSync::API::Resource

Edit a reservations request

Parameters:

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

    Reservations request or ID of the reservations request to be updated.

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

    Reservations request attributes to be updated.

Returns:



41
42
43
 
# File 'lib/bookingsync/api/client/reservations_requests.rb', line 41

def patch_reservation_request(id, options = {})
  patch("reservations/requests/#{id}", requests: [options]).pop
end

#reservations_request(id, options = {}) ⇒ BookingSync::API::Resource

Get a single reservations request

Parameters:

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

    Reservations request or ID of the reservations request.

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

    A customizable set of query options.

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

Returns:



22
23
24
 
# File 'lib/bookingsync/api/client/reservations_requests.rb', line 22

def reservations_request(id, options = {})
  get("reservations/requests/#{id}", options).pop
end

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

List reservations requests

Returns reservations requests for the current account.

Parameters:

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

    A customizable set of query options.

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

Returns:

See Also:



11
12
13
 
# File 'lib/bookingsync/api/client/reservations_requests.rb', line 11

def reservations_requests(options = {}, &block)
  paginate "reservations/requests", options, &block
end