Class: PinterestSdkClient::CatalogsRetailProductGroup

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#catalog_id ⇒ Object

Catalog id pertaining to the retail product group.



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

def catalog_id
  @catalog_id
end

#catalog_type ⇒ Object

Returns the value of attribute catalog_type.



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

def catalog_type
  @catalog_type
end

#country ⇒ Object

Returns the value of attribute country.



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

def country
  @country
end

#created_at ⇒ Object

Unix timestamp in seconds of when catalog product group was created.



26
27
28
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 26

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



28
29
30
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 28

def description
  @description
end

#feed_id ⇒ Object

id of the catalogs feed belonging to this catalog product group



31
32
33
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 31

def feed_id
  @feed_id
end

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#id ⇒ Object

ID of the catalog product group.



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

def id
  @id
end

#is_featured ⇒ Object

boolean indicator of whether the product group is being featured or not



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

def is_featured
  @is_featured
end

#locale ⇒ Object

Returns the value of attribute locale.



41
42
43
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 41

def locale
  @locale
end

#name ⇒ Object

Name of catalog product group



44
45
46
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 44

def name
  @name
end

#status ⇒ Object

Returns the value of attribute status.



46
47
48
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 46

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



48
49
50
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 48

def type
  @type
end

#updated_at ⇒ Object

Unix timestamp in seconds of last time catalog product group was updated.



51
52
53
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 51

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



96
97
98
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 96

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 101

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'catalog_id' => :'catalog_id',
    :'catalog_type' => :'catalog_type',
    :'country' => :'country',
    :'created_at' => :'created_at',
    :'description' => :'description',
    :'feed_id' => :'feed_id',
    :'filters' => :'filters',
    :'id' => :'id',
    :'is_featured' => :'is_featured',
    :'locale' => :'locale',
    :'name' => :'name',
    :'status' => :'status',
    :'type' => :'type',
    :'updated_at' => :'updated_at'
  }
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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 387

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



126
127
128
129
130
131
132
133
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 126

def self.openapi_nullable
  Set.new([
    :'country',
    :'description',
    :'feed_id',
    :'locale',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 106

def self.openapi_types
  {
    :'catalog_id' => :'String',
    :'catalog_type' => :'String',
    :'country' => :'String',
    :'created_at' => :'Integer',
    :'description' => :'String',
    :'feed_id' => :'String',
    :'filters' => :'CatalogsProductGroupFilters',
    :'id' => :'String',
    :'is_featured' => :'Boolean',
    :'locale' => :'String',
    :'name' => :'String',
    :'status' => :'CatalogsProductGroupStatus',
    :'type' => :'CatalogsProductGroupType',
    :'updated_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 353

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_id == o.catalog_id &&
      catalog_type == o.catalog_type &&
      country == o.country &&
      created_at == o.created_at &&
      description == o.description &&
      feed_id == o.feed_id &&
      filters == o.filters &&
      id == o.id &&
      is_featured == o.is_featured &&
      locale == o.locale &&
      name == o.name &&
      status == o.status &&
      type == o.type &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


374
375
376
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 374

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



380
381
382
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 380

def hash
  [catalog_id, catalog_type, country, created_at, description, feed_id, filters, id, is_featured, locale, name, status, type, updated_at].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



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
256
257
258
259
260
261
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 222

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

  pattern = Regexp.new(/^\d+$/)
  if @catalog_id !~ pattern
    invalid_properties.push("invalid value for \"catalog_id\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/^\d+$/)
  if @feed_id !~ pattern
    invalid_properties.push("invalid value for \"feed_id\", must conform to the pattern #{pattern}.")
  end

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

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

  pattern = Regexp.new(/^\d+$/)
  if @id !~ pattern
    invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
  end

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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 409

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/pinterest_sdk/models/catalogs_retail_product_group.rb', line 265

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @catalog_id.nil?
  return false if @catalog_id !~ Regexp.new(/^\d+$/)
  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 @feed_id !~ Regexp.new(/^\d+$/)
  return false if @filters.nil?
  return false if @id.nil?
  return false if @id !~ Regexp.new(/^\d+$/)
  return false if @type.nil?
  true
end