Class: PinterestSdkClient::CatalogsHotelAttributes

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/catalogs_hotel_attributes.rb

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 162

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

<p><= 2000 characters</p> <p>The links to additional images for your hotel. Up to ten additional images can be used to show a hotel from different angles. Must begin with http:// or https://.</p>



68
69
70
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 68

def additional_image_link
  @additional_image_link
end

#address ⇒ Object

Returns the value of attribute address.



18
19
20
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 18

def address
  @address
end

#base_price ⇒ Object

Base price of the hotel room per night followed by the ISO currency code



21
22
23
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 21

def base_price
  @base_price
end

#brand ⇒ Object

The brand to which this hotel belongs to.



24
25
26
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 24

def brand
  @brand
end

#category ⇒ Object

The type of property. The category can be any type of internal description desired.



27
28
29
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 27

def category
  @category
end

#custom_label_0 ⇒ Object

Custom grouping of hotels



30
31
32
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 30

def custom_label_0
  @custom_label_0
end

#custom_label_1 ⇒ Object

Custom grouping of hotels



33
34
35
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 33

def custom_label_1
  @custom_label_1
end

#custom_label_2 ⇒ Object

Custom grouping of hotels



36
37
38
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 36

def custom_label_2
  @custom_label_2
end

#custom_label_3 ⇒ Object

Custom grouping of hotels



39
40
41
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 39

def custom_label_3
  @custom_label_3
end

#custom_label_4 ⇒ Object

Custom grouping of hotels



42
43
44
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 42

def custom_label_4
  @custom_label_4
end

#description ⇒ Object

Brief description of the hotel.



45
46
47
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 45

def description
  @description
end

#guest_ratings ⇒ Object

Returns the value of attribute guest_ratings.



47
48
49
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 47

def guest_ratings
  @guest_ratings
end

#latitude ⇒ Object

Latitude of the hotel.



50
51
52
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 50

def latitude
  @latitude
end

#link ⇒ Object

Link to the product page



53
54
55
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 53

def link
  @link
end

#longitude ⇒ Object

Longitude of the hotel.



56
57
58
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 56

def longitude
  @longitude
end

#main_image ⇒ Object

Returns the value of attribute main_image.



70
71
72
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 70

def main_image
  @main_image
end

#name ⇒ Object

The hotel’s name.



59
60
61
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 59

def name
  @name
end

#neighborhood ⇒ Object

A list of neighborhoods where the hotel is located



62
63
64
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 62

def neighborhood
  @neighborhood
end

#sale_price ⇒ Object

Sale price of a hotel room per night. Used to advertise discounts off the regular price of the hotel.



65
66
67
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 65

def sale_price
  @sale_price
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



98
99
100
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 98

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 103

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 73

def self.attribute_map
  {
    :'address' => :'address',
    :'base_price' => :'base_price',
    :'brand' => :'brand',
    :'category' => :'category',
    :'custom_label_0' => :'custom_label_0',
    :'custom_label_1' => :'custom_label_1',
    :'custom_label_2' => :'custom_label_2',
    :'custom_label_3' => :'custom_label_3',
    :'custom_label_4' => :'custom_label_4',
    :'description' => :'description',
    :'guest_ratings' => :'guest_ratings',
    :'latitude' => :'latitude',
    :'link' => :'link',
    :'longitude' => :'longitude',
    :'name' => :'name',
    :'neighborhood' => :'neighborhood',
    :'sale_price' => :'sale_price',
    :'additional_image_link' => :'additional_image_link',
    :'main_image' => :'main_image'
  }
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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 313

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



154
155
156
157
158
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 154

def self.openapi_all_of
  [
  :'CatalogsUpdatableHotelAttributes'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 133

def self.openapi_nullable
  Set.new([
    :'base_price',
    :'brand',
    :'category',
    :'custom_label_0',
    :'custom_label_1',
    :'custom_label_2',
    :'custom_label_3',
    :'custom_label_4',
    :'description',
    :'link',
    :'longitude',
    :'name',
    :'neighborhood',
    :'sale_price',
    :'additional_image_link',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 108

def self.openapi_types
  {
    :'address' => :'CatalogsHotelAddress',
    :'base_price' => :'String',
    :'brand' => :'String',
    :'category' => :'String',
    :'custom_label_0' => :'String',
    :'custom_label_1' => :'String',
    :'custom_label_2' => :'String',
    :'custom_label_3' => :'String',
    :'custom_label_4' => :'String',
    :'description' => :'String',
    :'guest_ratings' => :'CatalogsHotelGuestRatings',
    :'latitude' => :'Float',
    :'link' => :'String',
    :'longitude' => :'Float',
    :'name' => :'String',
    :'neighborhood' => :'Array<String>',
    :'sale_price' => :'String',
    :'additional_image_link' => :'Array<String>',
    :'main_image' => :'CatalogsHotelAttributesAllOfMainImage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 274

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      base_price == o.base_price &&
      brand == o.brand &&
      category == o.category &&
      custom_label_0 == o.custom_label_0 &&
      custom_label_1 == o.custom_label_1 &&
      custom_label_2 == o.custom_label_2 &&
      custom_label_3 == o.custom_label_3 &&
      custom_label_4 == o.custom_label_4 &&
      description == o.description &&
      guest_ratings == o.guest_ratings &&
      latitude == o.latitude &&
      link == o.link &&
      longitude == o.longitude &&
      name == o.name &&
      neighborhood == o.neighborhood &&
      sale_price == o.sale_price &&
      additional_image_link == o.additional_image_link &&
      main_image == o.main_image
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


300
301
302
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 300

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



306
307
308
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 306

def hash
  [address, base_price, brand, category, custom_label_0, custom_label_1, custom_label_2, custom_label_3, custom_label_4, description, guest_ratings, latitude, link, longitude, name, neighborhood, sale_price, additional_image_link, main_image].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



259
260
261
262
263
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 259

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 335

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



267
268
269
270
 
# File 'lib/pinterest_sdk/models/catalogs_hotel_attributes.rb', line 267

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