Class: PinterestSdkClient::AdResponseAllOf

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

Overview

Creation fields

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdResponseAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 154

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ad_group_id ⇒ Object

ID of the ad group that contains the ad.



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

def ad_group_id
  @ad_group_id
end

#android_deep_link ⇒ Object

Deep link URL for Android devices. Not currently available. Using this field will generate an error.



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

def android_deep_link
  @android_deep_link
end

#carousel_android_deep_links ⇒ Object

Comma-separated deep links for the carousel pin on Android.



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

def carousel_android_deep_links
  @carousel_android_deep_links
end

#carousel_destination_urls ⇒ Object

Comma-separated destination URLs for the carousel pin to promote.



29
30
31
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 29

def carousel_destination_urls
  @carousel_destination_urls
end

#carousel_ios_deep_links ⇒ Object

Comma-separated deep links for the carousel pin on iOS.



32
33
34
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 32

def carousel_ios_deep_links
  @carousel_ios_deep_links
end

#click_tracking_url ⇒ Object

Tracking url for the ad clicks.



35
36
37
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 35

def click_tracking_url
  @click_tracking_url
end

#creative_type ⇒ Object

Ad creative type enum



38
39
40
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 38

def creative_type
  @creative_type
end

#destination_url ⇒ Object

Destination URL.



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

def destination_url
  @destination_url
end

#ios_deep_link ⇒ Object

Deep link URL for iOS devices. Not currently available. Using this field will generate an error.



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

def ios_deep_link
  @ios_deep_link
end

#is_pin_deleted ⇒ Object

Is original pin deleted?



47
48
49
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 47

def is_pin_deleted
  @is_pin_deleted
end

#is_removable ⇒ Object

Is pin repinnable?



50
51
52
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 50

def is_removable
  @is_removable
end

#name ⇒ Object

Name of the ad - 255 chars max.



53
54
55
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 53

def name
  @name
end

#pin_id ⇒ Object

Pin ID.



56
57
58
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 56

def pin_id
  @pin_id
end

#status ⇒ Object

Returns the value of attribute status.



58
59
60
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 58

def status
  @status
end

#tracking_urls ⇒ Object

Returns the value of attribute tracking_urls.



60
61
62
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 60

def tracking_urls
  @tracking_urls
end

#view_tracking_url ⇒ Object

Tracking URL for ad impressions.



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

def view_tracking_url
  @view_tracking_url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



110
111
112
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 88

def self.attribute_map
  {
    :'ad_group_id' => :'ad_group_id',
    :'android_deep_link' => :'android_deep_link',
    :'carousel_android_deep_links' => :'carousel_android_deep_links',
    :'carousel_destination_urls' => :'carousel_destination_urls',
    :'carousel_ios_deep_links' => :'carousel_ios_deep_links',
    :'click_tracking_url' => :'click_tracking_url',
    :'creative_type' => :'creative_type',
    :'destination_url' => :'destination_url',
    :'ios_deep_link' => :'ios_deep_link',
    :'is_pin_deleted' => :'is_pin_deleted',
    :'is_removable' => :'is_removable',
    :'name' => :'name',
    :'pin_id' => :'pin_id',
    :'status' => :'status',
    :'tracking_urls' => :'tracking_urls',
    :'view_tracking_url' => :'view_tracking_url'
  }
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



338
339
340
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 338

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 137

def self.openapi_nullable
  Set.new([
    :'android_deep_link',
    :'carousel_android_deep_links',
    :'carousel_destination_urls',
    :'carousel_ios_deep_links',
    :'click_tracking_url',
    :'destination_url',
    :'ios_deep_link',
    :'name',
    :'tracking_urls',
    :'view_tracking_url'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 115

def self.openapi_types
  {
    :'ad_group_id' => :'String',
    :'android_deep_link' => :'String',
    :'carousel_android_deep_links' => :'Array<String>',
    :'carousel_destination_urls' => :'Array<String>',
    :'carousel_ios_deep_links' => :'Array<String>',
    :'click_tracking_url' => :'String',
    :'creative_type' => :'String',
    :'destination_url' => :'String',
    :'ios_deep_link' => :'String',
    :'is_pin_deleted' => :'Boolean',
    :'is_removable' => :'Boolean',
    :'name' => :'String',
    :'pin_id' => :'String',
    :'status' => :'EntityStatus',
    :'tracking_urls' => :'TrackingUrls',
    :'view_tracking_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 302

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ad_group_id == o.ad_group_id &&
      android_deep_link == o.android_deep_link &&
      carousel_android_deep_links == o.carousel_android_deep_links &&
      carousel_destination_urls == o.carousel_destination_urls &&
      carousel_ios_deep_links == o.carousel_ios_deep_links &&
      click_tracking_url == o.click_tracking_url &&
      creative_type == o.creative_type &&
      destination_url == o.destination_url &&
      ios_deep_link == o.ios_deep_link &&
      is_pin_deleted == o.is_pin_deleted &&
      is_removable == o.is_removable &&
      name == o.name &&
      pin_id == o.pin_id &&
      status == o.status &&
      tracking_urls == o.tracking_urls &&
      view_tracking_url == o.view_tracking_url
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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 368

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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 439

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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 345

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


325
326
327
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 325

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



331
332
333
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 331

def hash
  [ad_group_id, android_deep_link, carousel_android_deep_links, carousel_destination_urls, carousel_ios_deep_links, click_tracking_url, creative_type, destination_url, ios_deep_link, is_pin_deleted, is_removable, name, pin_id, status, tracking_urls, view_tracking_url].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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 243

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

  pattern = Regexp.new(/^\d+$/)
  if !@pin_id.nil? && @pin_id !~ pattern
    invalid_properties.push("invalid value for \"pin_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



415
416
417
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 415

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 421

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



409
410
411
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 409

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



260
261
262
263
264
265
266
 
# File 'lib/pinterest_sdk/models/ad_response_all_of.rb', line 260

def valid?
  return false if !@ad_group_id.nil? && @ad_group_id !~ Regexp.new(/^\d+$/)
  creative_type_validator = EnumAttributeValidator.new('String', ["REGULAR", "VIDEO", "SHOPPING", "CAROUSEL", "MAX_VIDEO", "SHOP_THE_PIN", "STORY"])
  return false unless creative_type_validator.valid?(@creative_type)
  return false if !@pin_id.nil? && @pin_id !~ Regexp.new(/^\d+$/)
  true
end