Class: Repull::ListingSegmentsResponse

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

Overview

Returned by ‘GET /v1/listings/id/segments`. Honest about DNA coverage — when no comps in the scope have been DNA-scored, returns `totalCompsAnalyzed: 0` plus a `low_dna_coverage` recommendation rather than fabricated data.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/repull/models/listing_segments_response.rb', line 89

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#level ⇒ Object

Returns the value of attribute level.



21
22
23
 
# File 'lib/repull/models/listing_segments_response.rb', line 21

def level
  @level
end

#listing_id ⇒ Object

Returns the value of attribute listing_id.



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

def listing_id
  @listing_id
end

#my_quality_tier ⇒ Object

Returns the value of attribute my_quality_tier.



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

def my_quality_tier
  @my_quality_tier
end

#my_segment ⇒ Object

The source listing’s own ‘ai_segment` (or null if not yet scored).



26
27
28
 
# File 'lib/repull/models/listing_segments_response.rb', line 26

def my_segment
  @my_segment
end

#quality_tiers ⇒ Object

Returns the value of attribute quality_tiers.



35
36
37
 
# File 'lib/repull/models/listing_segments_response.rb', line 35

def quality_tiers
  @quality_tiers
end

#recommendations ⇒ Object

Returns the value of attribute recommendations.



37
38
39
 
# File 'lib/repull/models/listing_segments_response.rb', line 37

def recommendations
  @recommendations
end

#scope ⇒ Object

Returns the value of attribute scope.



23
24
25
 
# File 'lib/repull/models/listing_segments_response.rb', line 23

def scope
  @scope
end

#segments ⇒ Object

Returns the value of attribute segments.



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

def segments
  @segments
end

#total_comps_analyzed ⇒ Object

Number of comps in scope that have a DNA score. ‘0` is a coverage signal, not an error.



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

def total_comps_analyzed
  @total_comps_analyzed
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



55
56
57
 
# File 'lib/repull/models/listing_segments_response.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/repull/models/listing_segments_response.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.



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

def self.attribute_map
  {
    :'listing_id' => :'listingId',
    :'level' => :'level',
    :'scope' => :'scope',
    :'my_segment' => :'mySegment',
    :'my_quality_tier' => :'myQualityTier',
    :'total_comps_analyzed' => :'totalCompsAnalyzed',
    :'segments' => :'segments',
    :'quality_tiers' => :'qualityTiers',
    :'recommendations' => :'recommendations'
  }
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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/repull/models/listing_segments_response.rb', line 192

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



80
81
82
83
84
85
 
# File 'lib/repull/models/listing_segments_response.rb', line 80

def self.openapi_nullable
  Set.new([
    :'my_segment',
    :'my_quality_tier',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'listing_id' => :'String',
    :'level' => :'String',
    :'scope' => :'ListingSegmentsResponseScope',
    :'my_segment' => :'String',
    :'my_quality_tier' => :'String',
    :'total_comps_analyzed' => :'Integer',
    :'segments' => :'Array<ListingSegment>',
    :'quality_tiers' => :'Array<ListingQualityTier>',
    :'recommendations' => :'Array<ListingSegmentRecommendation>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/repull/models/listing_segments_response.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      listing_id == o.listing_id &&
      level == o.level &&
      scope == o.scope &&
      my_segment == o.my_segment &&
      my_quality_tier == o.my_quality_tier &&
      total_comps_analyzed == o.total_comps_analyzed &&
      segments == o.segments &&
      quality_tiers == o.quality_tiers &&
      recommendations == o.recommendations
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
 
# File 'lib/repull/models/listing_segments_response.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



185
186
187
 
# File 'lib/repull/models/listing_segments_response.rb', line 185

def hash
  [listing_id, level, scope, my_segment, my_quality_tier, total_comps_analyzed, segments, quality_tiers, recommendations].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



148
149
150
151
152
 
# File 'lib/repull/models/listing_segments_response.rb', line 148

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/repull/models/listing_segments_response.rb', line 214

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



156
157
158
159
 
# File 'lib/repull/models/listing_segments_response.rb', line 156

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