Class: FdxV660Api::Error3

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/fdx_v660_api/models/error3.rb

Overview

Present if an error was encountered while retrieving this account

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(code: SKIP, message: SKIP, debug_message: SKIP, additional_properties: nil) ⇒ Error3

Returns a new instance of Error3.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/fdx_v660_api/models/error3.rb', line 52

def initialize(code: SKIP, message: SKIP, debug_message: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @code = code unless code == SKIP
  @message = message unless message == SKIP
  @debug_message = debug_message unless debug_message == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#code ⇒ String

Error code defined by FDX API Specification or Data Provider indicating the error situation which has occurred

Returns:

  • (String) 


15
16
17
 
# File 'lib/fdx_v660_api/models/error3.rb', line 15

def code
  @code
end

#debug_message ⇒ String

Message used to debug the root cause of the error. Contents should not be used in consumer's business logic. Can change at any time and should only be used for consumer to communicate with the data provider about an issue. Provider can include an error GUID in message for their use.

Returns:

  • (String) 


27
28
29
 
# File 'lib/fdx_v660_api/models/error3.rb', line 27

def debug_message
  @debug_message
end

#message ⇒ String

End user displayable information which might help the customer diagnose an error

Returns:

  • (String) 


20
21
22
 
# File 'lib/fdx_v660_api/models/error3.rb', line 20

def message
  @message
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/fdx_v660_api/models/error3.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  code = hash.key?('code') ? hash['code'] : SKIP
  message = hash.key?('message') ? hash['message'] : SKIP
  debug_message = hash.key?('debugMessage') ? hash['debugMessage'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Error3.new(code: code,
             message: message,
             debug_message: debug_message,
             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



30
31
32
33
34
35
36
 
# File 'lib/fdx_v660_api/models/error3.rb', line 30

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['code'] = 'code'
  @_hash['message'] = 'message'
  @_hash['debug_message'] = 'debugMessage'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



48
49
50
 
# File 'lib/fdx_v660_api/models/error3.rb', line 48

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
 
# File 'lib/fdx_v660_api/models/error3.rb', line 39

def self.optionals
  %w[
    code
    message
    debug_message
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (Error3 | Hash) —

    value against the validation is performed.



88
89
90
91
92
93
94
 
# File 'lib/fdx_v660_api/models/error3.rb', line 88

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



104
105
106
107
108
 
# File 'lib/fdx_v660_api/models/error3.rb', line 104

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} code: #{@code.inspect}, message: #{@message.inspect}, debug_message:"\
  " #{@debug_message.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



97
98
99
100
101
 
# File 'lib/fdx_v660_api/models/error3.rb', line 97

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} code: #{@code}, message: #{@message}, debug_message: #{@debug_message},"\
  " additional_properties: #{@additional_properties}>"
end