Class: Repull::MarketsOverviewResponse

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

Overview

Overview of every market the customer operates in, plus auxiliary discovery slices. Wraps the canonical ‘{ data, pagination }` envelope around the per-city KPI list (`data`) so SDK consumers see the same shape they get from every other list endpoint. Auxiliary fields (`totals`, `myListings`, `browse`, `freeMarket`, `subscriptions`, `tier`) are returned as siblings because they are NOT paginated. The overview returns every market in one shot — `nextCursor` is always `null` and `hasMore` is always `false`.

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

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
129
130
131
132
133
134
 
# File 'lib/repull/models/markets_overview_response.rb', line 85

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

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

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

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

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

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

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

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

Instance Attribute Details

#browse ⇒ Object

Returns the value of attribute browse.



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

def browse
  @browse
end

#data ⇒ Object

Per-city KPIs for every market the customer operates in.



20
21
22
 
# File 'lib/repull/models/markets_overview_response.rb', line 20

def data
  @data
end

#free_market ⇒ Object

City auto-assigned as the customer’s free market (largest by listing count). Null for customers with no listings.



29
30
31
 
# File 'lib/repull/models/markets_overview_response.rb', line 29

def free_market
  @free_market
end

#my_listings ⇒ Object

Returns the value of attribute my_listings.



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

def my_listings
  @my_listings
end

#pagination ⇒ Object

Returns the value of attribute pagination.



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

def pagination
  @pagination
end

#subscriptions ⇒ Object

Returns the value of attribute subscriptions.



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

def subscriptions
  @subscriptions
end

#tier ⇒ Object

Resolved Repull tier (free / pro / scale).



34
35
36
 
# File 'lib/repull/models/markets_overview_response.rb', line 34

def tier
  @tier
end

#totals ⇒ Object

Returns the value of attribute totals.



24
25
26
 
# File 'lib/repull/models/markets_overview_response.rb', line 24

def totals
  @totals
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



53
54
55
 
# File 'lib/repull/models/markets_overview_response.rb', line 53

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/repull/models/markets_overview_response.rb', line 58

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
50
 
# File 'lib/repull/models/markets_overview_response.rb', line 39

def self.attribute_map
  {
    :'data' => :'data',
    :'pagination' => :'pagination',
    :'totals' => :'totals',
    :'my_listings' => :'myListings',
    :'free_market' => :'freeMarket',
    :'subscriptions' => :'subscriptions',
    :'tier' => :'tier',
    :'browse' => :'browse'
  }
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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/repull/models/markets_overview_response.rb', line 181

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'data' => :'Array<MarketSummary>',
    :'pagination' => :'Pagination',
    :'totals' => :'MarketsOverviewResponseTotals',
    :'my_listings' => :'Array<MarketMyListing>',
    :'free_market' => :'String',
    :'subscriptions' => :'MarketsOverviewResponseSubscriptions',
    :'tier' => :'String',
    :'browse' => :'MarketsOverviewResponseBrowse'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/repull/models/markets_overview_response.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data == o.data &&
      pagination == o.pagination &&
      totals == o.totals &&
      my_listings == o.my_listings &&
      free_market == o.free_market &&
      subscriptions == o.subscriptions &&
      tier == o.tier &&
      browse == o.browse
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/repull/models/markets_overview_response.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/repull/models/markets_overview_response.rb', line 174

def hash
  [data, pagination, totals, my_listings, free_market, subscriptions, tier, browse].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



138
139
140
141
142
 
# File 'lib/repull/models/markets_overview_response.rb', line 138

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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/repull/models/markets_overview_response.rb', line 203

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



146
147
148
149
 
# File 'lib/repull/models/markets_overview_response.rb', line 146

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