Class: PinterestSdkClient::CatalogsRetailProductMetadata

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

Overview

Retail product metadata entity

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 101

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

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  else
    self.currency = nil
  end

  if attributes.key?(:'item_group_id')
    self.item_group_id = attributes[:'item_group_id']
  else
    self.item_group_id = nil
  end

  if attributes.key?(:'item_id')
    self.item_id = attributes[:'item_id']
  else
    self.item_id = nil
  end

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  else
    self.price = nil
  end

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

Instance Attribute Details

#availability ⇒ Object

Returns the value of attribute availability.



19
20
21
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 19

def availability
  @availability
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#item_group_id ⇒ Object

The parent ID of the product.



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

def item_group_id
  @item_group_id
end

#item_id ⇒ Object

The user-created unique ID that represents the product.



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

def item_id
  @item_id
end

#price ⇒ Object

The price of the product.



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

def price
  @price
end

#sale_price ⇒ Object

The discounted price of the product.



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

def sale_price
  @sale_price
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.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/pinterest_sdk/models/catalogs_retail_product_metadata.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.



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 58

def self.attribute_map
  {
    :'availability' => :'availability',
    :'currency' => :'currency',
    :'item_group_id' => :'item_group_id',
    :'item_id' => :'item_id',
    :'price' => :'price',
    :'sale_price' => :'sale_price'
  }
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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 255

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



92
93
94
95
96
97
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 80

def self.openapi_types
  {
    :'availability' => :'NonNullableProductAvailabilityType',
    :'currency' => :'NonNullableCatalogsCurrency',
    :'item_group_id' => :'String',
    :'item_id' => :'String',
    :'price' => :'Float',
    :'sale_price' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      availability == o.availability &&
      currency == o.currency &&
      item_group_id == o.item_group_id &&
      item_id == o.item_id &&
      price == o.price &&
      sale_price == o.sale_price
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


242
243
244
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 248

def hash
  [availability, currency, item_group_id, item_id, price, sale_price].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 154

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @availability.nil?
    invalid_properties.push('invalid value for "availability", availability cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @item_id.nil?
    invalid_properties.push('invalid value for "item_id", item_id cannot be nil.')
  end

  if @price.nil?
    invalid_properties.push('invalid value for "price", price cannot be nil.')
  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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 277

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



178
179
180
181
182
183
184
185
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_metadata.rb', line 178

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @availability.nil?
  return false if @currency.nil?
  return false if @item_id.nil?
  return false if @price.nil?
  true
end