Class: PinterestSdkClient::CatalogsCreativeAssetsProductGroup

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/catalogs_creative_assets_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 = {}) ⇒ CatalogsCreativeAssetsProductGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 108

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  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?(:'name')
    self.name = attributes[:'name']
  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 creative assets product group.



19
20
21
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_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_creative_assets_product_group.rb', line 21

def catalog_type
  @catalog_type
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#id ⇒ Object

ID of the creative assets product group.



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

def id
  @id
end

#name ⇒ Object

Name of creative assets product group



34
35
36
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 34

def name
  @name
end

#updated_at ⇒ Object

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



37
38
39
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 37

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 62

def self.attribute_map
  {
    :'catalog_id' => :'catalog_id',
    :'catalog_type' => :'catalog_type',
    :'created_at' => :'created_at',
    :'description' => :'description',
    :'filters' => :'filters',
    :'id' => :'id',
    :'name' => :'name',
    :'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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 292

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



100
101
102
103
104
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 86

def self.openapi_types
  {
    :'catalog_id' => :'String',
    :'catalog_type' => :'String',
    :'created_at' => :'Integer',
    :'description' => :'String',
    :'filters' => :'CatalogsCreativeAssetsProductGroupFilters',
    :'id' => :'String',
    :'name' => :'String',
    :'updated_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_id == o.catalog_id &&
      catalog_type == o.catalog_type &&
      created_at == o.created_at &&
      description == o.description &&
      filters == o.filters &&
      id == o.id &&
      name == o.name &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



285
286
287
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 285

def hash
  [catalog_id, catalog_type, created_at, description, filters, id, name, 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



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

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

  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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 314

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



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/pinterest_sdk/models/catalogs_creative_assets_product_group.rb', line 199

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', ["CREATIVE_ASSETS"])
  return false unless catalog_type_validator.valid?(@catalog_type)
  return false if @filters.nil?
  return false if @id.nil?
  return false if @id !~ Regexp.new(/^\d+$/)
  true
end