Class: PinterestSdkClient::CatalogsRetailProductGroupProductCounts

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

Overview

Product counts for a Retail CatalogsProductGroup

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 95

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

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

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

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

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

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

Instance Attribute Details

#catalog_type ⇒ Object

Returns the value of attribute catalog_type.



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

def catalog_type
  @catalog_type
end

#in_stock ⇒ Object

Returns the value of attribute in_stock.



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

def in_stock
  @in_stock
end

#out_of_stock ⇒ Object

Returns the value of attribute out_of_stock.



23
24
25
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 23

def out_of_stock
  @out_of_stock
end

#preorder ⇒ Object

Returns the value of attribute preorder.



25
26
27
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 25

def preorder
  @preorder
end

#total ⇒ Object

Returns the value of attribute total.



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

def total
  @total
end

#videos ⇒ Object

Returns the value of attribute videos.



29
30
31
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 29

def videos
  @videos
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 54

def self.attribute_map
  {
    :'catalog_type' => :'catalog_type',
    :'in_stock' => :'in_stock',
    :'out_of_stock' => :'out_of_stock',
    :'preorder' => :'preorder',
    :'total' => :'total',
    :'videos' => :'videos'
  }
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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 319

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



88
89
90
91
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 88

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 76

def self.openapi_types
  {
    :'catalog_type' => :'String',
    :'in_stock' => :'Float',
    :'out_of_stock' => :'Float',
    :'preorder' => :'Float',
    :'total' => :'Float',
    :'videos' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_type == o.catalog_type &&
      in_stock == o.in_stock &&
      out_of_stock == o.out_of_stock &&
      preorder == o.preorder &&
      total == o.total &&
      videos == o.videos
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 312

def hash
  [catalog_type, in_stock, out_of_stock, preorder, total, videos].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



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
186
187
188
189
190
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 146

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

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

  if @in_stock < 0
    invalid_properties.push('invalid value for "in_stock", must be greater than or equal to 0.')
  end

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

  if @out_of_stock < 0
    invalid_properties.push('invalid value for "out_of_stock", must be greater than or equal to 0.')
  end

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

  if @preorder < 0
    invalid_properties.push('invalid value for "preorder", must be greater than or equal to 0.')
  end

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

  if @total < 0
    invalid_properties.push('invalid value for "total", must be greater than or equal to 0.')
  end

  if !@videos.nil? && @videos < 0
    invalid_properties.push('invalid value for "videos", must be greater than or equal to 0.')
  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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 341

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group_product_counts.rb', line 194

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @catalog_type.nil?
  catalog_type_validator = EnumAttributeValidator.new('String', ["RETAIL"])
  return false unless catalog_type_validator.valid?(@catalog_type)
  return false if @in_stock.nil?
  return false if @in_stock < 0
  return false if @out_of_stock.nil?
  return false if @out_of_stock < 0
  return false if @preorder.nil?
  return false if @preorder < 0
  return false if @total.nil?
  return false if @total < 0
  return false if !@videos.nil? && @videos < 0
  true
end