Class: ConstantContactClient::PContactOpenTrackingActivity

Inherits:
Object
  • Object
show all
Defined in:
lib/constant_contact_client/models/p_contact_open_tracking_activity.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PContactOpenTrackingActivity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
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
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 92

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

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

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

  if attributes.key?(:'email_address')
    self.email_address = attributes[:'email_address']
  else
    self.email_address = nil
  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?(:'device_type')
    self.device_type = attributes[:'device_type']
  end

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

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

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

Instance Attribute Details

#campaign_activity_id ⇒ Object

The unique ID that identifies of the campaign activity to use.



22
23
24
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 22

def campaign_activity_id
  @campaign_activity_id
end

#contact_id ⇒ Object

The unique ID that identifies the contact.



19
20
21
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 19

def contact_id
  @contact_id
end

#created_time ⇒ Object

The time the tracking activity occurred.



40
41
42
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 40

def created_time
  @created_time
end

#deleted_at ⇒ Object

The time the Contact was deleted



43
44
45
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 43

def deleted_at
  @deleted_at
end

#device_type ⇒ Object

The type of device that was used to open the link.



37
38
39
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 37

def device_type
  @device_type
end

#email_address ⇒ Object

The email address for the contact and tracking activity.



28
29
30
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 28

def email_address
  @email_address
end

#first_name ⇒ Object

The first name of the contact.



31
32
33
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 31

def first_name
  @first_name
end

#last_name ⇒ Object

The last name of the contact.



34
35
36
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 34

def last_name
  @last_name
end

#sms_channel ⇒ Object

Returns the value of attribute sms_channel.



45
46
47
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 45

def sms_channel
  @sms_channel
end

#tracking_activity_type ⇒ Object

The tracked activity event type.



25
26
27
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 25

def tracking_activity_type
  @tracking_activity_type
end

Class Method Details

._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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 252

def self._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 = ConstantContactClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 48

def self.attribute_map
  {
    :'contact_id' => :'contact_id',
    :'campaign_activity_id' => :'campaign_activity_id',
    :'tracking_activity_type' => :'tracking_activity_type',
    :'email_address' => :'email_address',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'device_type' => :'device_type',
    :'created_time' => :'created_time',
    :'deleted_at' => :'deleted_at',
    :'sms_channel' => :'sms_channel'
  }
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 228

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



85
86
87
88
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 69

def self.openapi_types
  {
    :'contact_id' => :'String',
    :'campaign_activity_id' => :'String',
    :'tracking_activity_type' => :'String',
    :'email_address' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'device_type' => :'String',
    :'created_time' => :'Time',
    :'deleted_at' => :'Date',
    :'sms_channel' => :'GetUniqueContactClicks200ResponseTrackingActivitiesInnerSmsChannel'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact_id == o.contact_id &&
      campaign_activity_id == o.campaign_activity_id &&
      tracking_activity_type == o.tracking_activity_type &&
      email_address == o.email_address &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      device_type == o.device_type &&
      created_time == o.created_time &&
      deleted_at == o.deleted_at &&
      sms_channel == o.sms_channel
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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 323

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


215
216
217
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 221

def hash
  [contact_id, campaign_activity_id, tracking_activity_type, email_address, first_name, last_name, device_type, created_time, deleted_at, sms_channel].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



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
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 158

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

  if @campaign_activity_id.nil?
    invalid_properties.push('invalid value for "campaign_activity_id", campaign_activity_id cannot be nil.')
  end

  if @tracking_activity_type.nil?
    invalid_properties.push('invalid value for "tracking_activity_type", tracking_activity_type cannot be nil.')
  end

  if @email_address.nil?
    invalid_properties.push('invalid value for "email_address", email_address cannot be nil.')
  end

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



299
300
301
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 299

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 305

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



293
294
295
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 293

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



186
187
188
189
190
191
192
193
194
 
# File 'lib/constant_contact_client/models/p_contact_open_tracking_activity.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @contact_id.nil?
  return false if @campaign_activity_id.nil?
  return false if @tracking_activity_type.nil?
  return false if @email_address.nil?
  return false if @created_time.nil?
  true
end