module ShipCompliant::BaseResult
ShipCompliant::BaseResult
¶ ↑
This class provides methods to are relevant to every API request. All requests made through the ShipCompliant
API client include these methods.
Public Instance Methods
errors()
click to toggle source
An array of ErrorResult
items or an empty array if the response was successful.
result.errors.each do |error| puts "#{error.message} [#error.key]" end
# File lib/ship_compliant/base_result.rb, line 29 def errors return [] if success? @errors ||= Array.wrap(response[:errors]).map do |error| ErrorResult.new(error[:error]) end end
errors_count()
click to toggle source
The number of errors in the response.
# File lib/ship_compliant/base_result.rb, line 37 def errors_count errors.length end
Also aliased as: error_count
failure?()
click to toggle source
Returns true if order failed to be voided.
puts "FAILED" if result.failure?
# File lib/ship_compliant/base_result.rb, line 19 def failure? !success? end
success?()
click to toggle source
Returns boolean whether order was successfully voided.
puts "SUCCESS" if result.success?
# File lib/ship_compliant/base_result.rb, line 12 def success? response[:response_status] == "Success" end