Class: NucleusApi::TransactionCode

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionCode

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 110

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?(:'is_buy')
    self.is_buy = attributes[:'is_buy']
  end

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

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

  if attributes.has_key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  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?(:'transaction_code')
    self.transaction_code = attributes[:'transaction_code']
  end

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

  if attributes.has_key?(:'transaction_type')
    self.transaction_type = attributes[:'transaction_type']
  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/transaction_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/transaction_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/transaction_code.rb', line 22

def id
  @id
end

#is_buy ⇒ Object

Returns the value of attribute is_buy.



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

def is_buy
  @is_buy
end

#is_fee ⇒ Object

Returns the value of attribute is_fee.



26
27
28
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 26

def is_fee
  @is_fee
end

#is_transfer ⇒ Object

Returns the value of attribute is_transfer.



28
29
30
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 28

def is_transfer
  @is_transfer
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



32
33
34
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 32

def secondary_id
  @secondary_id
end

#subcategory ⇒ Object

subcategory



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

def subcategory
  @subcategory
end

#transaction_code ⇒ Object

transactionCode



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

def transaction_code
  @transaction_code
end

#transaction_code_description ⇒ Object

transactionCodeDescription



41
42
43
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 41

def transaction_code_description
  @transaction_code_description
end

#transaction_type ⇒ Object

transactionType



44
45
46
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 44

def transaction_type
  @transaction_type
end

#update_date ⇒ Object

Returns the value of attribute update_date.



46
47
48
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 46

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 71

def self.attribute_map
  {
    :'category' => :'category',
    :'create_date' => :'create_date',
    :'id' => :'id',
    :'is_buy' => :'is_buy',
    :'is_fee' => :'is_fee',
    :'is_transfer' => :'is_transfer',
    :'metadata' => :'metadata',
    :'secondary_id' => :'secondary_id',
    :'subcategory' => :'subcategory',
    :'transaction_code' => :'transaction_code',
    :'transaction_code_description' => :'transaction_code_description',
    :'transaction_type' => :'transaction_type',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 90

def self.swagger_types
  {
    :'category' => :'String',
    :'create_date' => :'DateTime',
    :'id' => :'String',
    :'is_buy' => :'String',
    :'is_fee' => :'String',
    :'is_transfer' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'secondary_id' => :'String',
    :'subcategory' => :'String',
    :'transaction_code' => :'String',
    :'transaction_code_description' => :'String',
    :'transaction_type' => :'String',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      category == o.category &&
      create_date == o.create_date &&
      id == o.id &&
      is_buy == o.is_buy &&
      is_fee == o.is_fee &&
      is_transfer == o.is_transfer &&
      metadata == o.metadata &&
      secondary_id == o.secondary_id &&
      subcategory == o.subcategory &&
      transaction_code == o.transaction_code &&
      transaction_code_description == o.transaction_code_description &&
      transaction_type == o.transaction_type &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 281

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
    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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 347

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


247
248
249
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 253

def hash
  [category, create_date, id, is_buy, is_fee, is_transfer, metadata, secondary_id, subcategory, transaction_code, transaction_code_description, transaction_type, 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



173
174
175
176
177
178
179
180
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 173

def list_invalid_properties
  invalid_properties = Array.new
  if @transaction_code.nil?
    invalid_properties.push('invalid value for "transaction_code", transaction_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



327
328
329
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 327

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



333
334
335
336
337
338
339
340
341
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 333

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

Returns:

  • (String) —

    String presentation of the object



321
322
323
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 321

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



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/nucleus_api/models/transaction_code.rb', line 184

def valid?
  is_buy_validator = EnumAttributeValidator.new('String', ['true', 'false', 'null'])
  return false unless is_buy_validator.valid?(@is_buy)
  is_fee_validator = EnumAttributeValidator.new('String', ['true', 'false', 'null'])
  return false unless is_fee_validator.valid?(@is_fee)
  is_transfer_validator = EnumAttributeValidator.new('String', ['true', 'false', 'null'])
  return false unless is_transfer_validator.valid?(@is_transfer)
  return false if @transaction_code.nil?
  true
end