Class: PinterestSdkClient::CreativeAssetsProcessingRecord

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

Overview

Object describing an item processing record

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
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
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 90

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

  if attributes.key?(:'errors')
    if (value = attributes[:'errors']).is_a?(Array)
      self.errors = value
    end
  end

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

  if attributes.key?(:'warnings')
    if (value = attributes[:'warnings']).is_a?(Array)
      self.warnings = value
    end
  end
end

Instance Attribute Details

#creative_assets_id ⇒ Object

The catalog creative assets id in the merchant namespace



20
21
22
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 20

def creative_assets_id
  @creative_assets_id
end

#errors ⇒ Object

Array with the validation errors for the item processing record. A non empty errors list causes the item processing to fail.



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

def errors
  @errors
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#warnings ⇒ Object

Array with the validation warnings for the item processing record



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

def warnings
  @warnings
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



63
64
65
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 63

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 53

def self.attribute_map
  {
    :'creative_assets_id' => :'creative_assets_id',
    :'errors' => :'errors',
    :'status' => :'status',
    :'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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 166

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



83
84
85
86
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 73

def self.openapi_types
  {
    :'creative_assets_id' => :'String',
    :'errors' => :'Array<ItemValidationEvent>',
    :'status' => :'ItemProcessingStatus',
    :'warnings' => :'Array<ItemValidationEvent>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



142
143
144
145
146
147
148
149
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 142

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


153
154
155
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 153

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



159
160
161
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 159

def hash
  [creative_assets_id, errors, status, warnings].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



127
128
129
130
131
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 127

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 188

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



135
136
137
138
 
# File 'lib/pinterest_sdk/models/creative_assets_processing_record.rb', line 135

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end