Module: BookingSync::API::Client::ReviewReplies

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

Instance Method Summary collapse

Instance Method Details

#create_guest_review_reply(review, options = {}) ⇒ BookingSync::API::Resource

Create a new review reply

Parameters:

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

    Review or ID of the review for which a reply will be created.

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

    Review’s attributes.

Returns:



38
39
40
 
# File 'lib/bookingsync/api/client/review_replies.rb', line 38

def create_guest_review_reply(review, options = {})
  post("reviews/#{review}/reply", review_replies: [options]).pop
end

#create_host_review_reply(host_review, options = {}) ⇒ BookingSync::API::Resource

Create a new host review reply

Parameters:

  • host —

    review [BookingSync::API::Resource|Integer] HostReview or ID of the host review for which a reply will be created.

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

    Review’s attributes.

Returns:



48
49
50
 
# File 'lib/bookingsync/api/client/review_replies.rb', line 48

def create_host_review_reply(host_review, options = {})
  post("host_reviews/#{host_review}/reply", review_replies: [options]).pop
end

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

List review replies

Returns review replies for the account user is authenticated with.

Examples:

Get the list of review replies for the current account

review_replies = @api.review_replies
review_replies.first.message # => "Thanks for the feedback!"

Get the list of review_replies only with message and submitted_at for smaller response

@api.review_replies(fields: [:message, :submitted_at])

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

Returns:

See Also:



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

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

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

Get a single review reply

Parameters:

  • review —

    reply [BookingSync::API::Resource|String] Review Reply or ID of the review reply.

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

    A customizable set of query options.

Options Hash (options):

  • fields: (Array) —

    List of fields to be fetched.

Returns:



28
29
30
 
# File 'lib/bookingsync/api/client/review_replies.rb', line 28

def review_reply(review_reply, options = {})
  get("review_replies/#{review_reply}", options).pop
end