Class: PureCloud::TwitterId

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/twitter_id.rb

Overview

User information for a twitter account

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TwitterId

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 61

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

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

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'screenName')
    self.screen_name = attributes[:'screenName']
  end

  if attributes.has_key?(:'verified')
    self.verified = attributes[:'verified']
  end

  if attributes.has_key?(:'profileUrl')
    self.profile_url = attributes[:'profileUrl']
  end

end

Instance Attribute Details

#idObject

twitter user.id_str



23
24
25
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 23

def id
  @id
end

#nameObject

twitter user.name



26
27
28
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 26

def name
  @name
end

#profile_urlObject

url of user’s twitter profile



35
36
37
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 35

def profile_url
  @profile_url
end

#screen_nameObject

twitter user.screen_name



29
30
31
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 29

def screen_name
  @screen_name
end

#verifiedObject

whether this data has been verified using the twitter API



32
33
34
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 32

def verified
  @verified
end

Class Method Details

.attribute_mapObject

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



38
39
40
41
42
43
44
45
46
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 38

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'screen_name' => :'screenName',
    :'verified' => :'verified',
    :'profile_url' => :'profileUrl'
  }
end

.swagger_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
57
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 49

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'screen_name' => :'String',
    :'verified' => :'BOOLEAN',
    :'profile_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



103
104
105
106
107
108
109
110
111
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 103

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      screen_name == o.screen_name &&
      verified == o.verified &&
      profile_url == o.profile_url
end

#_deserialize(type, value) ⇒ Object



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
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 145

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 205

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

#build_from_hash(attributes) ⇒ Object

build the object from hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 126

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


115
116
117
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 115

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



121
122
123
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 121

def hash
  [id, name, screen_name, verified, profile_url].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



91
92
93
94
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 91

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



188
189
190
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 188

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



193
194
195
196
197
198
199
200
201
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 193

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sObject



183
184
185
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 183

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



98
99
# File 'lib/purecloudplatformclientv2/models/twitter_id.rb', line 98

def valid?
end