Class: PinterestSdkClient::AdResponseAllOf1

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdResponseAllOf1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 121

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::AdResponseAllOf1` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::AdResponseAllOf1`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ad_account_id ⇒ Object

The ID of the advertiser that this ad belongs to.



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

def 
  @ad_account_id
end

#campaign_id ⇒ Object

ID of the ad campaign that contains this ad.



22
23
24
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 22

def campaign_id
  @campaign_id
end

#collection_items_destination_url_template ⇒ Object

Destination URL template for all items within a collections drawer.



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

def collection_items_destination_url_template
  @collection_items_destination_url_template
end

#created_time ⇒ Object

Pin creation time. Unix timestamp in seconds.



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

def created_time
  @created_time
end

#id ⇒ Object

The ID of this ad.



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

def id
  @id
end

#rejected_reasons ⇒ Object

Enum reason why the pin was rejected. Returned if review_status is "REJECTED".



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

def rejected_reasons
  @rejected_reasons
end

#rejection_labels ⇒ Object

Text reason why the pin was rejected. Returned if review_status is "REJECTED".



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

def rejection_labels
  @rejection_labels
end

#review_status ⇒ Object

Ad review status



40
41
42
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 40

def review_status
  @review_status
end

#summary_status ⇒ Object

Ad summary status



49
50
51
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 49

def summary_status
  @summary_status
end

#type ⇒ Object

Always "ad".



43
44
45
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 43

def type
  @type
end

#updated_time ⇒ Object

Last update time. Unix timestamp in seconds.



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

def updated_time
  @updated_time
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 74

def self.attribute_map
  {
    :'ad_account_id' => :'ad_account_id',
    :'campaign_id' => :'campaign_id',
    :'collection_items_destination_url_template' => :'collection_items_destination_url_template',
    :'created_time' => :'created_time',
    :'id' => :'id',
    :'rejected_reasons' => :'rejected_reasons',
    :'rejection_labels' => :'rejection_labels',
    :'review_status' => :'review_status',
    :'type' => :'type',
    :'updated_time' => :'updated_time',
    :'summary_status' => :'summary_status'
  }
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
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 292

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 113

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 96

def self.openapi_types
  {
    :'ad_account_id' => :'String',
    :'campaign_id' => :'String',
    :'collection_items_destination_url_template' => :'String',
    :'created_time' => :'Integer',
    :'id' => :'String',
    :'rejected_reasons' => :'Array<String>',
    :'rejection_labels' => :'Array<String>',
    :'review_status' => :'String',
    :'type' => :'String',
    :'updated_time' => :'Integer',
    :'summary_status' => :'PinPromotionSummaryStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      campaign_id == o.campaign_id &&
      collection_items_destination_url_template == o.collection_items_destination_url_template &&
      created_time == o.created_time &&
      id == o.id &&
      rejected_reasons == o.rejected_reasons &&
      rejection_labels == o.rejection_labels &&
      review_status == o.review_status &&
      type == o.type &&
      updated_time == o.updated_time &&
      summary_status == o.summary_status
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 322

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = PinterestSdkClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 393

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 299

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.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/ad_response_all_of1.rb', line 285

def hash
  [, campaign_id, collection_items_destination_url_template, created_time, id, rejected_reasons, rejection_labels, review_status, type, updated_time, summary_status].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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 185

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



369
370
371
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 369

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 375

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



363
364
365
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 363

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



207
208
209
210
211
212
213
214
 
# File 'lib/pinterest_sdk/models/ad_response_all_of1.rb', line 207

def valid?
  return false if !@ad_account_id.nil? && @ad_account_id !~ Regexp.new(/^\d+$/)
  return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/^\d+$/)
  return false if !@id.nil? && @id !~ Regexp.new(/^\d+$/)
  review_status_validator = EnumAttributeValidator.new('String', ["OTHER", "PENDING", "REJECTED", "APPROVED"])
  return false unless review_status_validator.valid?(@review_status)
  true
end