Class: ConstantContactClient::GetSmsEngagementHistory200ResponseInnerHistoryDetails

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

Overview

Additional details about the SMS consent actions (opt-in, opt-out) in JSON format. The consent_action_type and the method used to add or update a contacts SMS details determines which properties are returned in the results.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetSmsEngagementHistory200ResponseInnerHistoryDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
155
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 99

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#advertised_frequency ⇒ Object

If applicable, the advertising numeric component used to advertise to the contact.. For example, if advertised_frequency is set to 2 , and advertised_interval is set to M, the contact receives advertisements twice a month.



47
48
49
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 47

def advertised_frequency
  @advertised_frequency
end

#advertised_interval ⇒ Object

If applicable, the interval component used to advertise to the contact. For example, if advertised_frequency is set to 2 , and advertised_interval is set to M, the contact receives advertisements twice a month.



50
51
52
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 50

def advertised_interval
  @advertised_interval
end

#consent_action_time ⇒ Object

The date and time that SMS engagement data was last updated, in ISO-8601 format. System generated.



29
30
31
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 29

def consent_action_time
  @consent_action_time
end

#consent_action_type ⇒ Object

The type of consent action provided.



32
33
34
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 32

def consent_action_type
  @consent_action_type
end

#consent_medium_type ⇒ Object

The code representing the medium used to provide consent. Medium types include mobile device (MD). lead generation form(LF), deactivation by carrier(CD), import_file:(FI), and system (SY).



35
36
37
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 35

def consent_medium_type
  @consent_medium_type
end

#consent_type ⇒ Object

The type of SMS consent used.



26
27
28
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 26

def consent_type
  @consent_type
end

#source ⇒ Object

The code representing the consent source type, including A for Account, C for Contact, and S‘ for System.



23
24
25
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 23

def source
  @source
end

#source_consent_timestamp ⇒ Object

The time that SMS consent was last updated.



38
39
40
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 38

def source_consent_timestamp
  @source_consent_timestamp
end

#source_ip ⇒ Object

If applicable, the IP address from which the consent came.



41
42
43
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 41

def source_ip
  @source_ip
end

#source_sms_number ⇒ Object

If applicable, the SMS consent number associated with the source.



44
45
46
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 44

def source_sms_number
  @source_sms_number
end

#state ⇒ Object

The code representing the consent state, including E for optin and O for Optin.



20
21
22
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 20

def state
  @state
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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 229

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



70
71
72
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 53

def self.attribute_map
  {
    :'state' => :'state',
    :'source' => :'source',
    :'consent_type' => :'consent_type',
    :'consent_action_time' => :'consent_action_time',
    :'consent_action_type' => :'consent_action_type',
    :'consent_medium_type' => :'consent_medium_type',
    :'source_consent_timestamp' => :'source_consent_timestamp',
    :'source_ip' => :'source_ip',
    :'source_sms_number' => :'source_sms_number',
    :'advertised_frequency' => :'advertised_frequency',
    :'advertised_interval' => :'advertised_interval'
  }
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



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

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



92
93
94
95
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 75

def self.openapi_types
  {
    :'state' => :'String',
    :'source' => :'String',
    :'consent_type' => :'String',
    :'consent_action_time' => :'Time',
    :'consent_action_type' => :'String',
    :'consent_medium_type' => :'String',
    :'source_consent_timestamp' => :'String',
    :'source_ip' => :'String',
    :'source_sms_number' => :'String',
    :'advertised_frequency' => :'Integer',
    :'advertised_interval' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      source == o.source &&
      consent_type == o.consent_type &&
      consent_action_time == o.consent_action_time &&
      consent_action_type == o.consent_action_type &&
      consent_medium_type == o.consent_medium_type &&
      source_consent_timestamp == o.source_consent_timestamp &&
      source_ip == o.source_ip &&
      source_sms_number == o.source_sms_number &&
      advertised_frequency == o.advertised_frequency &&
      advertised_interval == o.advertised_interval
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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 300

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


192
193
194
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



198
199
200
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 198

def hash
  [state, source, consent_type, consent_action_time, consent_action_type, consent_medium_type, source_consent_timestamp, source_ip, source_sms_number, advertised_frequency, advertised_interval].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



159
160
161
162
163
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



276
277
278
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 276

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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 282

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



270
271
272
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 270

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



167
168
169
170
 
# File 'lib/constant_contact_client/models/get_sms_engagement_history200_response_inner_history_details.rb', line 167

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