Class: PinterestSdkClient::ConversionTagCreate

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

Overview

Resource create operation model.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 102

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

  if attributes.key?(:'aem_enabled')
    self.aem_enabled = attributes[:'aem_enabled']
  else
    self.aem_enabled = false
  end

  if attributes.key?(:'aem_external_id_enabled')
    self.aem_external_id_enabled = attributes[:'aem_external_id_enabled']
  else
    self.aem_external_id_enabled = false
  end

  if attributes.key?(:'aem_fnln_enabled')
    self.aem_fnln_enabled = attributes[:'aem_fnln_enabled']
  else
    self.aem_fnln_enabled = false
  end

  if attributes.key?(:'aem_ge_enabled')
    self.aem_ge_enabled = attributes[:'aem_ge_enabled']
  else
    self.aem_ge_enabled = false
  end

  if attributes.key?(:'aem_loc_enabled')
    self.aem_loc_enabled = attributes[:'aem_loc_enabled']
  else
    self.aem_loc_enabled = false
  end

  if attributes.key?(:'aem_ph_enabled')
    self.aem_ph_enabled = attributes[:'aem_ph_enabled']
  else
    self.aem_ph_enabled = false
  end

  if attributes.key?(:'md_frequency')
    self.md_frequency = attributes[:'md_frequency']
  else
    self.md_frequency = 1
  end

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

Instance Attribute Details

#aem_db_enabled ⇒ Object

Whether Automatic Enhanced Match birthdate is enabled. See [Enhanced match](help.pinterest.com/en/business/article/enhanced-match) for more information.



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

def aem_db_enabled
  @aem_db_enabled
end

#aem_enabled ⇒ Object

Whether Automatic Enhanced Match email is enabled. See [Enhanced match](help.pinterest.com/en/business/article/enhanced-match) for more information.



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

def aem_enabled
  @aem_enabled
end

#aem_external_id_enabled ⇒ Object

Whether Automatic Enhanced Match location is enabled. See [Enhanced match](help.pinterest.com/en/business/article/enhanced-match) for more information.



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

def aem_external_id_enabled
  @aem_external_id_enabled
end

#aem_fnln_enabled ⇒ Object

Whether Automatic Enhanced Match name is enabled. See [Enhanced match](help.pinterest.com/en/business/article/enhanced-match) for more information.



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

def aem_fnln_enabled
  @aem_fnln_enabled
end

#aem_ge_enabled ⇒ Object

Whether Automatic Enhanced Match gender is enabled. See [Enhanced match](help.pinterest.com/en/business/article/enhanced-match) for more information.



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

def aem_ge_enabled
  @aem_ge_enabled
end

#aem_loc_enabled ⇒ Object

Whether Automatic Enhanced Match location is enabled. See [Enhanced match](help.pinterest.com/en/business/article/enhanced-match) for more information.



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

def aem_loc_enabled
  @aem_loc_enabled
end

#aem_ph_enabled ⇒ Object

Whether Automatic Enhanced Match phone is enabled. See [Enhanced match](help.pinterest.com/en/business/article/enhanced-match) for more information.



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

def aem_ph_enabled
  @aem_ph_enabled
end

#md_frequency ⇒ Object

Metadata ingestion frequency.



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

def md_frequency
  @md_frequency
end

#name ⇒ Object

Conversion tag name.



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

def name
  @name
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 47

def self.attribute_map
  {
    :'aem_db_enabled' => :'aem_db_enabled',
    :'aem_enabled' => :'aem_enabled',
    :'aem_external_id_enabled' => :'aem_external_id_enabled',
    :'aem_fnln_enabled' => :'aem_fnln_enabled',
    :'aem_ge_enabled' => :'aem_ge_enabled',
    :'aem_loc_enabled' => :'aem_loc_enabled',
    :'aem_ph_enabled' => :'aem_ph_enabled',
    :'md_frequency' => :'md_frequency',
    :'name' => :'name'
  }
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 232

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



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 87

def self.openapi_nullable
  Set.new([
    :'aem_db_enabled',
    :'aem_enabled',
    :'aem_external_id_enabled',
    :'aem_fnln_enabled',
    :'aem_ge_enabled',
    :'aem_loc_enabled',
    :'aem_ph_enabled',
    :'md_frequency',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 72

def self.openapi_types
  {
    :'aem_db_enabled' => :'Boolean',
    :'aem_enabled' => :'Boolean',
    :'aem_external_id_enabled' => :'Boolean',
    :'aem_fnln_enabled' => :'Boolean',
    :'aem_ge_enabled' => :'Boolean',
    :'aem_loc_enabled' => :'Boolean',
    :'aem_ph_enabled' => :'Boolean',
    :'md_frequency' => :'Float',
    :'name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aem_db_enabled == o.aem_db_enabled &&
      aem_enabled == o.aem_enabled &&
      aem_external_id_enabled == o.aem_external_id_enabled &&
      aem_fnln_enabled == o.aem_fnln_enabled &&
      aem_ge_enabled == o.aem_ge_enabled &&
      aem_loc_enabled == o.aem_loc_enabled &&
      aem_ph_enabled == o.aem_ph_enabled &&
      md_frequency == o.md_frequency &&
      name == o.name
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


219
220
221
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 225

def hash
  [aem_db_enabled, aem_enabled, aem_external_id_enabled, aem_fnln_enabled, aem_ge_enabled, aem_loc_enabled, aem_ph_enabled, md_frequency, name].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



173
174
175
176
177
178
179
180
181
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 173

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 254

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



185
186
187
188
189
 
# File 'lib/pinterest_sdk/models/conversion_tag_create.rb', line 185

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