Class: Hungrytable::ReservationCancel

Inherits:

Object

• Object
• Hungrytable::ReservationCancel

Includes:

RequestExtensions

Defined in:

lib/hungrytable/reservation_cancel.rb

Overview

Cancels an existing restaurant reservation

Instance Attribute Summary

• #opts ⇒ Object readonly

  Returns the value of attribute opts.

Instance Method Summary

• #error_message ⇒ String^?

  Get error messages if cancellation failed.

• #initialize(opts = {}) ⇒ ReservationCancel constructor

  A new instance of ReservationCancel.

• #successful? ⇒ Boolean

  Check if the cancellation was successful.

Constructor Details

#initialize(opts = {}) ⇒ ReservationCancel

Returns a new instance of ReservationCancel.

# File 'lib/hungrytable/reservation_cancel.rb', line 10

def initialize(opts = {})
  @opts = opts
  ensure_required_opts
  @requester = opts[:requester] || GetRequest
end

Instance Attribute Details

#opts ⇒ Object (readonly)

Returns the value of attribute opts.

# File 'lib/hungrytable/reservation_cancel.rb', line 8

def opts
  @opts
end

Instance Method Details

#error_message ⇒ String^?

Get error messages if cancellation failed

Returns:

• (String, nil) —

  error message or nil

# File 'lib/hungrytable/reservation_cancel.rb', line 24

def error_message
  details['ns:ErrorMessage']
end

#successful? ⇒ Boolean

Check if the cancellation was successful

Returns:

• (Boolean) —

  true if no errors

# File 'lib/hungrytable/reservation_cancel.rb', line 18

def successful?
  details['ns:ErrorID'].to_s == '0'
end