Class: ShellSmartPayApi::Fault

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_smart_pay_api/models/fault.rb

Overview

Fault Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(faultstring = SKIP, detail = SKIP) ⇒ Fault

Returns a new instance of Fault.



41
42
43
44
# File 'lib/shell_smart_pay_api/models/fault.rb', line 41

def initialize(faultstring = SKIP, detail = SKIP)
  @faultstring = faultstring unless faultstring == SKIP
  @detail = detail unless detail == SKIP
end

Instance Attribute Details

#detailDetail

The description of the error.

Returns:



18
19
20
# File 'lib/shell_smart_pay_api/models/fault.rb', line 18

def detail
  @detail
end

#faultstringString

The description of the error.

Returns:



14
15
16
# File 'lib/shell_smart_pay_api/models/fault.rb', line 14

def faultstring
  @faultstring
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
# File 'lib/shell_smart_pay_api/models/fault.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  faultstring = hash.key?('faultstring') ? hash['faultstring'] : SKIP
  detail = Detail.from_hash(hash['detail']) if hash['detail']

  # Create object from extracted values.
  Fault.new(faultstring,
            detail)
end

.namesObject

A mapping from model property names to API property names.



21
22
23
24
25
26
# File 'lib/shell_smart_pay_api/models/fault.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['faultstring'] = 'faultstring'
  @_hash['detail'] = 'detail'
  @_hash
end

.nullablesObject

An array for nullable fields



37
38
39
# File 'lib/shell_smart_pay_api/models/fault.rb', line 37

def self.nullables
  []
end

.optionalsObject

An array for optional fields



29
30
31
32
33
34
# File 'lib/shell_smart_pay_api/models/fault.rb', line 29

def self.optionals
  %w[
    faultstring
    detail
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



66
67
68
69
# File 'lib/shell_smart_pay_api/models/fault.rb', line 66

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} faultstring: #{@faultstring.inspect}, detail: #{@detail.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



60
61
62
63
# File 'lib/shell_smart_pay_api/models/fault.rb', line 60

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} faultstring: #{@faultstring}, detail: #{@detail}>"
end