Class: PinterestSdkClient::ConversionTag

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ad_account_id ⇒ Object

Ad account ID.



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

def 
  
end

#code_snippet ⇒ Object

Tag code snippet.



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

def code_snippet
  @code_snippet
end

#configs ⇒ Object

Returns the value of attribute configs.



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

def configs
  @configs
end

#enhanced_match_status ⇒ Object

The enhanced match status of the tag



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

def enhanced_match_status
  @enhanced_match_status
end

#id ⇒ Object

Tag ID.



27
28
29
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 27

def id
  @id
end

#last_fired_time_ms ⇒ Object

Time for the last event fired.



30
31
32
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 30

def last_fired_time_ms
  @last_fired_time_ms
end

#name ⇒ Object

Conversion tag name.



33
34
35
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 33

def name
  @name
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#version ⇒ Object

Version number.



36
37
38
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 36

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 86

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 66

def self.attribute_map
  {
    :'code_snippet' => :'code_snippet',
    :'configs' => :'configs',
    :'enhanced_match_status' => :'enhanced_match_status',
    :'id' => :'id',
    :'last_fired_time_ms' => :'last_fired_time_ms',
    :'name' => :'name',
    :'version' => :'version',
    :'ad_account_id' => :'ad_account_id',
    :'status' => :'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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 253

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



114
115
116
117
118
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 114

def self.openapi_all_of
  [
  :'ConversionTagCommon'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
110
111
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 91

def self.openapi_types
  {
    :'code_snippet' => :'String',
    :'configs' => :'ConversionTagConfigs',
    :'enhanced_match_status' => :'EnhancedMatchStatusType',
    :'id' => :'String',
    :'last_fired_time_ms' => :'Float',
    :'name' => :'String',
    :'version' => :'String',
    :'ad_account_id' => :'String',
    :'status' => :'EntityStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code_snippet == o.code_snippet &&
      configs == o.configs &&
      enhanced_match_status == o.enhanced_match_status &&
      id == o.id &&
      last_fired_time_ms == o.last_fired_time_ms &&
      name == o.name &&
      version == o.version &&
       == o. &&
      status == o.status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


240
241
242
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



246
247
248
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 246

def hash
  [code_snippet, configs, enhanced_match_status, id, last_fired_time_ms, name, version, , 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



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 179

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

  if .nil?
    invalid_properties.push('invalid value for "ad_account_id", ad_account_id cannot be nil.')
  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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 275

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



195
196
197
198
199
200
 
# File 'lib/pinterest_sdk/models/conversion_tag.rb', line 195

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