Class: TalonOne::BestPriorPriceMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/best_prior_price_metadata.rb

Overview

Auxiliary data for found price observation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BestPriorPriceMetadata

Initializes the object



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 47

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::BestPriorPriceMetadata` 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 `TalonOne::BestPriorPriceMetadata`. 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?(:'influencing_campaign_i_ds')
    if (value = attributes[:'influencing_campaign_i_ds']).is_a?(Array)
      self.influencing_campaign_i_ds = value
    end
  end

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

Instance Attribute Details

#adjustment_reference_id ⇒ Object

Identifier related to the ‘referenceId` used during a `ADD_PRICE_ADJUSTMENT` action using the [Sync cart item catalog endpoint](docs.talon.one/integration-api#tag/Catalogs/operation/syncCatalog).



21
22
23
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 21

def adjustment_reference_id
  @adjustment_reference_id
end

#influencing_campaign_i_ds ⇒ Object

Returns the value of attribute influencing_campaign_i_ds.



18
19
20
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 18

def influencing_campaign_i_ds
  @influencing_campaign_i_ds
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 24

def self.attribute_map
  {
    :'influencing_campaign_i_ds' => :'influencingCampaignIDs',
    :'adjustment_reference_id' => :'adjustmentReferenceID'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



108
109
110
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 108

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



40
41
42
43
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 40

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

.openapi_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 32

def self.openapi_types
  {
    :'influencing_campaign_i_ds' => :'Array<Integer>',
    :'adjustment_reference_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



86
87
88
89
90
91
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 86

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      influencing_campaign_i_ds == o.influencing_campaign_i_ds &&
      adjustment_reference_id == o.adjustment_reference_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
170
171
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 136

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



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 205

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 115

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


95
96
97
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 95

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



101
102
103
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 101

def hash
  [influencing_campaign_i_ds, adjustment_reference_id].hash
end

#list_invalid_properties ⇒ Object

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



73
74
75
76
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 73

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



181
182
183
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 181

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 187

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

#to_s ⇒ String

Returns the string representation of the object



175
176
177
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 175

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



80
81
82
 
# File 'lib/talon_one/models/best_prior_price_metadata.rb', line 80

def valid?
  true
end