Class: MessenteApi::ErrorItemNumberLookupError

Inherits:
Object
  • Object
show all
Defined in:
lib/messente_api/models/error_item_number_lookup_error.rb

Overview

Error fields container

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ErrorItemNumberLookupError

Initializes the object



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 42

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MessenteApi::ErrorItemNumberLookupError` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MessenteApi::ErrorItemNumberLookupError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  end
end

Instance Attribute Details

#code ⇒ Object

Matches the following error title. This field is a constant * 101 - Unauthorized * 102 - Invalid arguments or parameters * 103 - Server error * 104 - Crediting error #1 * 105 - Crediting error #2 * 106 - Client error



22
23
24
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 22

def code
  @code
end

#description ⇒ Object

Error description



19
20
21
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 19

def description
  @description
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



25
26
27
28
29
30
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 25

def self.attribute_map
  {
    :'description' => :'description',
    :'code' => :'code'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



139
140
141
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 139

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 33

def self.openapi_types
  {
    :'description' => :'String',
    :'code' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



117
118
119
120
121
122
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 117

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      code == o.code
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 167

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    MessenteApi.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 232

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 146

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


126
127
128
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 126

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



132
133
134
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 132

def hash
  [description, code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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

def list_invalid_properties
  invalid_properties = Array.new
  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  end

  if @code > 106
    invalid_properties.push('invalid value for "code", must be smaller than or equal to 106.')
  end

  if @code < 101
    invalid_properties.push('invalid value for "code", must be greater than or equal to 101.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



212
213
214
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 212

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



218
219
220
221
222
223
224
225
226
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 218

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



206
207
208
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 206

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



89
90
91
92
93
94
95
 
# File 'lib/messente_api/models/error_item_number_lookup_error.rb', line 89

def valid?
  return false if @description.nil?
  return false if @code.nil?
  return false if @code > 106
  return false if @code < 101
  true
end