Class: Repull::ListingContent

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

Overview

Rich multilingual content slab for a listing — guest-facing copy sourced from ‘listings_descriptions` (the `en` row when surfaced via `?include=content`). Also returned as the AI-generated payload from `POST /v1/listings/id/generate-content` (where `title` and `amenities` are populated). All fields are individually nullable.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/repull/models/listing_content.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_rules ⇒ Object

Structured supplementary rules (JSON; shape evolves with the listings_descriptions schema).



40
41
42
 
# File 'lib/repull/models/listing_content.rb', line 40

def additional_rules
  @additional_rules
end

#amenities ⇒ Object

Free-text amenity strings. Populated only by ‘generate-content`; the `?include=amenities` expansion returns the structured `ListingAmenity[]` instead.



48
49
50
 
# File 'lib/repull/models/listing_content.rb', line 48

def amenities
  @amenities
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#getting_around ⇒ Object

Free-text directions for getting to + around the property (e.g. "Take Highway 95 north for 12 miles").



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

def getting_around
  @getting_around
end

#guest_access ⇒ Object

Returns the value of attribute guest_access.



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

def guest_access
  @guest_access
end

#house_rules ⇒ Object

Returns the value of attribute house_rules.



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

def house_rules
  @house_rules
end

#interaction_with_guests ⇒ Object

Host’s description of how they engage with guests (e.g. "Self check-in, available via message").



45
46
47
 
# File 'lib/repull/models/listing_content.rb', line 45

def interaction_with_guests
  @interaction_with_guests
end

#neighborhood_overview ⇒ Object

Returns the value of attribute neighborhood_overview.



30
31
32
 
# File 'lib/repull/models/listing_content.rb', line 30

def neighborhood_overview
  @neighborhood_overview
end

#notes ⇒ Object

Returns the value of attribute notes.



42
43
44
 
# File 'lib/repull/models/listing_content.rb', line 42

def notes
  @notes
end

#space ⇒ Object

Returns the value of attribute space.



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

def space
  @space
end

#summary ⇒ Object

Returns the value of attribute summary.



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

def summary
  @summary
end

#title ⇒ Object

Public listing title. Populated only by ‘generate-content`; not stored on `listings_descriptions`.



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

def title
  @title
end

#transit ⇒ Object

Returns the value of attribute transit.



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

def transit
  @transit
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/repull/models/listing_content.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/repull/models/listing_content.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/repull/models/listing_content.rb', line 51

def self.attribute_map
  {
    :'title' => :'title',
    :'summary' => :'summary',
    :'description' => :'description',
    :'space' => :'space',
    :'guest_access' => :'guestAccess',
    :'neighborhood_overview' => :'neighborhoodOverview',
    :'getting_around' => :'gettingAround',
    :'transit' => :'transit',
    :'house_rules' => :'houseRules',
    :'additional_rules' => :'additionalRules',
    :'notes' => :'notes',
    :'interaction_with_guests' => :'interactionWithGuests',
    :'amenities' => :'amenities'
  }
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/repull/models/listing_content.rb', line 252

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/repull/models/listing_content.rb', line 99

def self.openapi_nullable
  Set.new([
    :'title',
    :'summary',
    :'description',
    :'space',
    :'guest_access',
    :'neighborhood_overview',
    :'getting_around',
    :'transit',
    :'house_rules',
    :'additional_rules',
    :'notes',
    :'interaction_with_guests',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/repull/models/listing_content.rb', line 80

def self.openapi_types
  {
    :'title' => :'String',
    :'summary' => :'String',
    :'description' => :'String',
    :'space' => :'String',
    :'guest_access' => :'String',
    :'neighborhood_overview' => :'String',
    :'getting_around' => :'String',
    :'transit' => :'String',
    :'house_rules' => :'String',
    :'additional_rules' => :'Object',
    :'notes' => :'String',
    :'interaction_with_guests' => :'String',
    :'amenities' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/repull/models/listing_content.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      summary == o.summary &&
      description == o.description &&
      space == o.space &&
      guest_access == o.guest_access &&
      neighborhood_overview == o.neighborhood_overview &&
      getting_around == o.getting_around &&
      transit == o.transit &&
      house_rules == o.house_rules &&
      additional_rules == o.additional_rules &&
      notes == o.notes &&
      interaction_with_guests == o.interaction_with_guests &&
      amenities == o.amenities
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


239
240
241
 
# File 'lib/repull/models/listing_content.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/repull/models/listing_content.rb', line 245

def hash
  [title, summary, description, space, guest_access, neighborhood_overview, getting_around, transit, house_rules, additional_rules, notes, interaction_with_guests, amenities].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



189
190
191
192
193
194
195
196
197
 
# File 'lib/repull/models/listing_content.rb', line 189

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 50
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 50.')
  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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/repull/models/listing_content.rb', line 274

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



201
202
203
204
205
 
# File 'lib/repull/models/listing_content.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@title.nil? && @title.to_s.length > 50
  true
end