Class: TripletexRubyClient::Deviation

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/deviation.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Deviation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
108
109
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
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#actionObject

Returns the value of attribute action.



29
30
31
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 29

def action
  @action
end

#causeObject

Returns the value of attribute cause.



27
28
29
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 27

def cause
  @cause
end

#changesObject

Returns the value of attribute changes.



19
20
21
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 19

def changes
  @changes
end

#commentObject

Returns the value of attribute comment.



31
32
33
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 31

def comment
  @comment
end

#dateObject

Returns the value of attribute date.



25
26
27
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 25

def date
  @date
end

#deviationObject

Returns the value of attribute deviation.



39
40
41
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 39

def deviation
  @deviation
end

#idObject

Returns the value of attribute id.



15
16
17
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 15

def id
  @id
end

#purchase_order_lineObject

Returns the value of attribute purchase_order_line.



23
24
25
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 23

def purchase_order_line
  @purchase_order_line
end

#quantity_orderedObject

Returns the value of attribute quantity_ordered.



35
36
37
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 35

def quantity_ordered
  @quantity_ordered
end

#quantity_receivedObject

Returns the value of attribute quantity_received.



37
38
39
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 37

def quantity_received
  @quantity_received
end

#received_byObject

Returns the value of attribute received_by.



33
34
35
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 33

def received_by
  @received_by
end

#urlObject

Returns the value of attribute url.



21
22
23
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 21

def url
  @url
end

#versionObject

Returns the value of attribute version.



17
18
19
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 17

def version
  @version
end

Class Method Details

.attribute_mapObject

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'purchase_order_line' => :'purchaseOrderLine',
    :'date' => :'date',
    :'cause' => :'cause',
    :'action' => :'action',
    :'comment' => :'comment',
    :'received_by' => :'receivedBy',
    :'quantity_ordered' => :'quantityOrdered',
    :'quantity_received' => :'quantityReceived',
    :'deviation' => :'deviation'
  }
end

.swagger_typesObject

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 83

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'purchase_order_line' => :'PurchaseOrderline',
    :'date' => :'String',
    :'cause' => :'String',
    :'action' => :'String',
    :'comment' => :'String',
    :'received_by' => :'String',
    :'quantity_ordered' => :'Float',
    :'quantity_received' => :'Float',
    :'deviation' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      purchase_order_line == o.purchase_order_line &&
      date == o.date &&
      cause == o.cause &&
      action == o.action &&
      comment == o.comment &&
      received_by == o.received_by &&
      quantity_ordered == o.quantity_ordered &&
      quantity_received == o.quantity_received &&
      deviation == o.deviation
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 267

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 = TripletexRubyClient.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



333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 333

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 246

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


233
234
235
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 233

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



239
240
241
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 239

def hash
  [id, version, changes, url, purchase_order_line, date, cause, action, comment, received_by, quantity_ordered, quantity_received, deviation].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 166

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



313
314
315
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 313

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 319

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



307
308
309
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 307

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



181
182
183
184
185
186
187
188
189
# File 'lib/tripletex_ruby_client/models/deviation.rb', line 181

def valid?
  return false if @purchase_order_line.nil?
  return false if @date.nil?
  cause_validator = EnumAttributeValidator.new('String', ['CAUSE_DEFECT', 'CAUSE_TOO_FEW', 'CAUSE_TOO_MANY', 'CAUSE_REPLACEMENT'])
  return false unless cause_validator.valid?(@cause)
  action_validator = EnumAttributeValidator.new('String', ['ACTION_IGNORE', 'ACTION_GENERATE_RESTORDER', 'ACTION_RETURN', 'ACTION_RETURN_GENERATE_RESTORDER'])
  return false unless action_validator.valid?(@action)
  true
end