Class: PinterestSdkClient::CatalogsItemValidationIssues

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 67

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

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

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

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

Instance Attribute Details

#errorsObject

Returns the value of attribute errors.



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

def errors
  @errors
end

#item_idObject

The merchant-created unique ID that represents the product.



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

def item_id
  @item_id
end

#item_numberObject

Item number based on order of appearance in the Catalogs Feed. For example, ‘0’ refers to first item found in a feed that was downloaded from a ‘location’ specified during feed creation.



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

def item_number
  @item_number
end

#warningsObject

Returns the value of attribute warnings.



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

def warnings
  @warnings
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



29
30
31
32
33
34
35
36
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 29

def self.attribute_map
  {
    :'errors' => :'errors',
    :'item_id' => :'item_id',
    :'item_number' => :'item_number',
    :'warnings' => :'warnings'
  }
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



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

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_nullableObject

List of attributes with nullable: true



59
60
61
62
63
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 59

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

.openapi_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 49

def self.openapi_types
  {
    :'errors' => :'CatalogsItemValidationErrors',
    :'item_id' => :'String',
    :'item_number' => :'Integer',
    :'warnings' => :'CatalogsItemValidationWarnings'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



168
169
170
171
172
173
174
175
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      errors == o.errors &&
      item_id == o.item_id &&
      item_number == o.item_number &&
      warnings == o.warnings
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 179

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



185
186
187
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 185

def hash
  [errors, item_id, item_number, warnings].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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

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

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

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

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 214

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



128
129
130
131
132
133
134
# File 'lib/pinterest_sdk/models/catalogs_item_validation_issues.rb', line 128

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @errors.nil?
  return false if @item_number.nil?
  return false if @warnings.nil?
  true
end