Class: Repull::ListingPricingHistoryEntry

Inherits:
ApiModelBase show all
Defined in:
lib/repull/models/listing_pricing_history_entry.rb

Overview

One date in the recommendation-vs-applied audit trail.

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 = {}) ⇒ ListingPricingHistoryEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
124
125
126
127
128
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 85

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

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

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

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

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

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

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

Instance Attribute Details

#applied_at ⇒ Object

Returns the value of attribute applied_at.



33
34
35
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 33

def applied_at
  @applied_at
end

#applied_by ⇒ Object

Who applied it (e.g. ‘auto`, `api`, `user`).



36
37
38
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 36

def applied_by
  @applied_by
end

#applied_rate ⇒ Object

Price actually written to the calendar. ‘null` when status is `pending` or `declined`. For now, when `status=applied` this equals `recommended_rate` because the apply path writes the recommendation verbatim.



25
26
27
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 25

def applied_rate
  @applied_rate
end

#date ⇒ Object

Returns the value of attribute date.



19
20
21
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 19

def date
  @date
end

#recommendation_factors ⇒ Object

Raw model factors (comp distance, event boost, weekend, demand, etc.).



31
32
33
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 31

def recommendation_factors
  @recommendation_factors
end

#recommended_rate ⇒ Object

The Atlas model’s recommended price for the date.



22
23
24
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 22

def recommended_rate
  @recommended_rate
end

#status ⇒ Object

‘overridden` is reserved for a future signal — it never appears today.



28
29
30
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 28

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



52
53
54
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 52

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 57

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 39

def self.attribute_map
  {
    :'date' => :'date',
    :'recommended_rate' => :'recommendedRate',
    :'applied_rate' => :'appliedRate',
    :'status' => :'status',
    :'recommendation_factors' => :'recommendationFactors',
    :'applied_at' => :'appliedAt',
    :'applied_by' => :'appliedBy'
  }
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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 174

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



75
76
77
78
79
80
81
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 75

def self.openapi_nullable
  Set.new([
    :'applied_rate',
    :'applied_at',
    :'applied_by'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 62

def self.openapi_types
  {
    :'date' => :'Date',
    :'recommended_rate' => :'Float',
    :'applied_rate' => :'Float',
    :'status' => :'String',
    :'recommendation_factors' => :'Hash<String, Object>',
    :'applied_at' => :'Time',
    :'applied_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      recommended_rate == o.recommended_rate &&
      applied_rate == o.applied_rate &&
      status == o.status &&
      recommendation_factors == o.recommendation_factors &&
      applied_at == o.applied_at &&
      applied_by == o.applied_by
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 167

def hash
  [date, recommended_rate, applied_rate, status, recommendation_factors, applied_at, applied_by].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



132
133
134
135
136
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 132

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 196

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



140
141
142
143
 
# File 'lib/repull/models/listing_pricing_history_entry.rb', line 140

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end