Class: TalonOne::History

Inherits:
ApiModelBase show all
Defined in:
lib/talon_one_sdk/models/history.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ History

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/talon_one_sdk/models/history.rb', line 86

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'observed_at')
    self.observed_at = attributes[:'observed_at']
  else
    self.observed_at = nil
  end

  if attributes.key?(:'context_ids')
    if (value = attributes[:'context_ids']).is_a?(Array)
      self.context_ids = value
    end
  else
    self.context_ids = nil
  end

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  else
    self.price = nil
  end

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  else
    self.metadata = nil
  end

  if attributes.key?(:'target')
    self.target = attributes[:'target']
  else
    self.target = nil
  end

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

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

Instance Attribute Details

#context_ids ⇒ Object

The identifiers of the relevant context at the time the price was observed. Includes the context IDs of any price adjustments and of the campaigns that influenced the final price.



25
26
27
 
# File 'lib/talon_one_sdk/models/history.rb', line 25

def context_ids
  @context_ids
end

#excluded_at ⇒ Object

The date and time when the historical price ID was excluded.



35
36
37
 
# File 'lib/talon_one_sdk/models/history.rb', line 35

def excluded_at
  @excluded_at
end

#exclusion_reason ⇒ Object

The reason for excluding this historical price ID.



38
39
40
 
# File 'lib/talon_one_sdk/models/history.rb', line 38

def exclusion_reason
  @exclusion_reason
end

#id ⇒ Object

The ID of the historical price.



19
20
21
 
# File 'lib/talon_one_sdk/models/history.rb', line 19

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



30
31
32
 
# File 'lib/talon_one_sdk/models/history.rb', line 30

def metadata
  @metadata
end

#observed_at ⇒ Object

The date and time when the price was observed.



22
23
24
 
# File 'lib/talon_one_sdk/models/history.rb', line 22

def observed_at
  @observed_at
end

#price ⇒ Object

Price of the item.



28
29
30
 
# File 'lib/talon_one_sdk/models/history.rb', line 28

def price
  @price
end

#target ⇒ Object

Returns the value of attribute target.



32
33
34
 
# File 'lib/talon_one_sdk/models/history.rb', line 32

def target
  @target
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



55
56
57
 
# File 'lib/talon_one_sdk/models/history.rb', line 55

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/talon_one_sdk/models/history.rb', line 60

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/talon_one_sdk/models/history.rb', line 41

def self.attribute_map
  {
    :'id' => :'id',
    :'observed_at' => :'observedAt',
    :'context_ids' => :'contextIds',
    :'price' => :'price',
    :'metadata' => :'metadata',
    :'target' => :'target',
    :'excluded_at' => :'excludedAt',
    :'exclusion_reason' => :'exclusionReason'
  }
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/talon_one_sdk/models/history.rb', line 282

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/talon_one_sdk/models/history.rb', line 79

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/talon_one_sdk/models/history.rb', line 65

def self.openapi_types
  {
    :'id' => :'Integer',
    :'observed_at' => :'Time',
    :'context_ids' => :'Array<String>',
    :'price' => :'Float',
    :'metadata' => :'BestPriorPriceMetadata',
    :'target' => :'LabelTarget',
    :'excluded_at' => :'Time',
    :'exclusion_reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/talon_one_sdk/models/history.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      observed_at == o.observed_at &&
      context_ids == o.context_ids &&
      price == o.price &&
      metadata == o.metadata &&
      target == o.target &&
      excluded_at == o.excluded_at &&
      exclusion_reason == o.exclusion_reason
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/talon_one_sdk/models/history.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/talon_one_sdk/models/history.rb', line 275

def hash
  [id, observed_at, context_ids, price, metadata, target, excluded_at, exclusion_reason].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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/talon_one_sdk/models/history.rb', line 149

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/talon_one_sdk/models/history.rb', line 304

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
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
190
 
# File 'lib/talon_one_sdk/models/history.rb', line 181

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @observed_at.nil?
  return false if @context_ids.nil?
  return false if @price.nil?
  return false if @metadata.nil?
  return false if @target.nil?
  true
end