Class: Zernio::ConversionEventUser

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/conversion_event_user.rb

Overview

User identity fields. More signals mean higher match rates.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#city ⇒ Object

Meta advanced matching (ct). Plaintext city; normalized + SHA-256 hashed server-side. Meta only.



44
45
46
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 44

def city
  @city
end

#click_ids ⇒ Object

Returns the value of attribute click_ids.



58
59
60
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 58

def click_ids
  @click_ids
end

#country ⇒ Object

ISO 3166-1 alpha-2 country code, e.g. 'us'.



41
42
43
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 41

def country
  @country
end

#dob ⇒ Object

Meta advanced matching (db). YYYYMMDD; hashed server-side. Meta only.



53
54
55
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 53

def dob
  @dob
end

#email ⇒ Object

Plaintext email. Hashed server-side.



20
21
22
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 20

def email
  @email
end

#external_id ⇒ Object

Stable customer identifier (e.g. CRM user ID). Hashed server-side for Meta and Google. Sent as plaintext to LinkedIn (LinkedIn's Conversions API spec requires the raw value). Maximum effective list size on LinkedIn is 1.



32
33
34
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 32

def external_id
  @external_id
end

#first_name ⇒ Object

Plaintext first name. Hashed server-side.



26
27
28
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 26

def first_name
  @first_name
end

#gender ⇒ Object

Meta advanced matching (ge). 'f' or 'm'; hashed server-side. Meta only.



56
57
58
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 56

def gender
  @gender
end

#ip_address ⇒ Object

Client IP address. Sent plaintext.



35
36
37
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 35

def ip_address
  @ip_address
end

#last_name ⇒ Object

Plaintext last name. Hashed server-side.



29
30
31
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 29

def last_name
  @last_name
end

#phone ⇒ Object

Phone number, ideally E.164. Hashed server-side.



23
24
25
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 23

def phone
  @phone
end

#state ⇒ Object

Meta advanced matching (st). 2-letter ANSI for US; hashed server-side. Meta only.



47
48
49
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 47

def state
  @state
end

#user_agent ⇒ Object

Client user-agent string. Sent plaintext.



38
39
40
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 38

def user_agent
  @user_agent
end

#zip ⇒ Object

Meta advanced matching (zp). US uses first 5 digits; hashed server-side. Meta only.



50
51
52
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 50

def zip
  @zip
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



81
82
83
 
# File 'lib/zernio-sdk/models/conversion_event_user.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/zernio-sdk/models/conversion_event_user.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.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 61

def self.attribute_map
  {
    :'email' => :'email',
    :'phone' => :'phone',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'external_id' => :'externalId',
    :'ip_address' => :'ipAddress',
    :'user_agent' => :'userAgent',
    :'country' => :'country',
    :'city' => :'city',
    :'state' => :'state',
    :'zip' => :'zip',
    :'dob' => :'dob',
    :'gender' => :'gender',
    :'click_ids' => :'clickIds'
  }
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 240

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



111
112
113
114
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 91

def self.openapi_types
  {
    :'email' => :'String',
    :'phone' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'external_id' => :'String',
    :'ip_address' => :'String',
    :'user_agent' => :'String',
    :'country' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'dob' => :'String',
    :'gender' => :'String',
    :'click_ids' => :'ConversionEventUserClickIds'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      phone == o.phone &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      external_id == o.external_id &&
      ip_address == o.ip_address &&
      user_agent == o.user_agent &&
      country == o.country &&
      city == o.city &&
      state == o.state &&
      zip == o.zip &&
      dob == o.dob &&
      gender == o.gender &&
      click_ids == o.click_ids
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 233

def hash
  [email, phone, first_name, last_name, external_id, ip_address, user_agent, country, city, state, zip, dob, gender, click_ids].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



191
192
193
194
195
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 191

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 262

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



199
200
201
202
 
# File 'lib/zernio-sdk/models/conversion_event_user.rb', line 199

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