Class: NucleusApi::ReasonCode

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/reason_code.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReasonCode

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/nucleus_api/models/reason_code.rb', line 76

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.has_key?(:'reason_code')
    self.reason_code = attributes[:'reason_code']
  end

  if attributes.has_key?(:'reason_code_description')
    self.reason_code_description = attributes[:'reason_code_description']
  end

  if attributes.has_key?(:'reason_type')
    self.reason_type = attributes[:'reason_type']
  end

  if attributes.has_key?(:'secondary_id')
    self.secondary_id = attributes[:'secondary_id']
  end

  if attributes.has_key?(:'subcategory')
    self.subcategory = attributes[:'subcategory']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end
end

Instance Attribute Details

#category ⇒ Object

category



18
19
20
 
# File 'lib/nucleus_api/models/reason_code.rb', line 18

def category
  @category
end

#create_date ⇒ Object

Returns the value of attribute create_date.



20
21
22
 
# File 'lib/nucleus_api/models/reason_code.rb', line 20

def create_date
  @create_date
end

#id ⇒ Object

Returns the value of attribute id.



22
23
24
 
# File 'lib/nucleus_api/models/reason_code.rb', line 22

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



24
25
26
 
# File 'lib/nucleus_api/models/reason_code.rb', line 24

def metadata
  @metadata
end

#reason_code ⇒ Object

reasonCode



27
28
29
 
# File 'lib/nucleus_api/models/reason_code.rb', line 27

def reason_code
  @reason_code
end

#reason_code_description ⇒ Object

reasonCodeDescription



30
31
32
 
# File 'lib/nucleus_api/models/reason_code.rb', line 30

def reason_code_description
  @reason_code_description
end

#reason_type ⇒ Object

reasonType



33
34
35
 
# File 'lib/nucleus_api/models/reason_code.rb', line 33

def reason_type
  @reason_type
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



35
36
37
 
# File 'lib/nucleus_api/models/reason_code.rb', line 35

def secondary_id
  @secondary_id
end

#subcategory ⇒ Object

subcategory



38
39
40
 
# File 'lib/nucleus_api/models/reason_code.rb', line 38

def subcategory
  @subcategory
end

#update_date ⇒ Object

Returns the value of attribute update_date.



40
41
42
 
# File 'lib/nucleus_api/models/reason_code.rb', line 40

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/nucleus_api/models/reason_code.rb', line 43

def self.attribute_map
  {
    :'category' => :'category',
    :'create_date' => :'create_date',
    :'id' => :'id',
    :'metadata' => :'metadata',
    :'reason_code' => :'reason_code',
    :'reason_code_description' => :'reason_code_description',
    :'reason_type' => :'reason_type',
    :'secondary_id' => :'secondary_id',
    :'subcategory' => :'subcategory',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/nucleus_api/models/reason_code.rb', line 59

def self.swagger_types
  {
    :'category' => :'String',
    :'create_date' => :'DateTime',
    :'id' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'reason_code' => :'String',
    :'reason_code_description' => :'String',
    :'reason_type' => :'String',
    :'secondary_id' => :'String',
    :'subcategory' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/nucleus_api/models/reason_code.rb', line 145

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      category == o.category &&
      create_date == o.create_date &&
      id == o.id &&
      metadata == o.metadata &&
      reason_code == o.reason_code &&
      reason_code_description == o.reason_code_description &&
      reason_type == o.reason_type &&
      secondary_id == o.secondary_id &&
      subcategory == o.subcategory &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/nucleus_api/models/reason_code.rb', line 194

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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
    temp_model = NucleusApi.const_get(type).new
    temp_model.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/nucleus_api/models/reason_code.rb', line 260

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/nucleus_api/models/reason_code.rb', line 175

def build_from_hash(attributes)
  self.class.swagger_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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
 
# File 'lib/nucleus_api/models/reason_code.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/nucleus_api/models/reason_code.rb', line 168

def hash
  [category, create_date, id, metadata, reason_code, reason_code_description, reason_type, secondary_id, subcategory, update_date].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



127
128
129
130
131
132
133
134
 
# File 'lib/nucleus_api/models/reason_code.rb', line 127

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
 
# File 'lib/nucleus_api/models/reason_code.rb', line 241

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
250
251
252
253
254
 
# File 'lib/nucleus_api/models/reason_code.rb', line 247

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/nucleus_api/models/reason_code.rb', line 235

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



138
139
140
141
 
# File 'lib/nucleus_api/models/reason_code.rb', line 138

def valid?
  return false if @reason_code.nil?
  true
end