Class: PureCloud::DialerContact

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/dialer_contact.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DialerContact

Returns a new instance of DialerContact.



82
83
84
85
86
87
88
89
90
91
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
# File 'lib/purecloud/models/dialer_contact.rb', line 82

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

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

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'contactListId']
    self.contact_list_id = attributes[:'contactListId']
  end
  
  if attributes[:'data']
    if (value = attributes[:'data']).is_a?(Array)
      self.data = value
    end
  end
  
  if attributes[:'callRecords']
    if (value = attributes[:'callRecords']).is_a?(Array)
      self.call_records = value
    end
  end
  
  if attributes[:'callable']
    self.callable = attributes[:'callable']
  else
    self.callable = false
  end
  
  if attributes[:'phoneNumberStatus']
    if (value = attributes[:'phoneNumberStatus']).is_a?(Array)
      self.phone_number_status = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#call_recordsObject

A map of call records for the contact phone columns



33
34
35
# File 'lib/purecloud/models/dialer_contact.rb', line 33

def call_records
  @call_records
end

#callableObject

false if the contact is not to be called



36
37
38
# File 'lib/purecloud/models/dialer_contact.rb', line 36

def callable
  @callable
end

#contact_list_idObject

Identifier of the contact list containing this contact



27
28
29
# File 'lib/purecloud/models/dialer_contact.rb', line 27

def contact_list_id
  @contact_list_id
end

#dataObject

An ordered map of the contact’s data attributes and values



30
31
32
# File 'lib/purecloud/models/dialer_contact.rb', line 30

def data
  @data
end

#idObject

The globally unique identifier for the object.



22
23
24
# File 'lib/purecloud/models/dialer_contact.rb', line 22

def id
  @id
end

#nameObject

Returns the value of attribute name.



24
25
26
# File 'lib/purecloud/models/dialer_contact.rb', line 24

def name
  @name
end

#phone_number_statusObject

A map of statuses for the contact phone columns



39
40
41
# File 'lib/purecloud/models/dialer_contact.rb', line 39

def phone_number_status
  @phone_number_status
end

#self_uriObject

The URI for this object



42
43
44
# File 'lib/purecloud/models/dialer_contact.rb', line 42

def self_uri
  @self_uri
end

Class Method Details

.attribute_mapObject

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/purecloud/models/dialer_contact.rb', line 45

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'contact_list_id' => :'contactListId',
    
    :'data' => :'data',
    
    :'call_records' => :'callRecords',
    
    :'callable' => :'callable',
    
    :'phone_number_status' => :'phoneNumberStatus',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/purecloud/models/dialer_contact.rb', line 68

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'contact_list_id' => :'String',
    :'data' => :'Hash<String, Object>',
    :'call_records' => :'Hash<String, CallRecord>',
    :'callable' => :'BOOLEAN',
    :'phone_number_status' => :'Hash<String, PhoneNumberStatus>',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/purecloud/models/dialer_contact.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      contact_list_id == o.contact_list_id &&
      data == o.data &&
      call_records == o.call_records &&
      callable == o.callable &&
      phone_number_status == o.phone_number_status &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/purecloud/models/dialer_contact.rb', line 175

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



235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/purecloud/models/dialer_contact.rb', line 235

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/purecloud/models/dialer_contact.rb', line 156

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

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
# File 'lib/purecloud/models/dialer_contact.rb', line 146

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



151
152
153
# File 'lib/purecloud/models/dialer_contact.rb', line 151

def hash
  [id, name, contact_list_id, data, call_records, callable, phone_number_status, self_uri].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



218
219
220
# File 'lib/purecloud/models/dialer_contact.rb', line 218

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



223
224
225
226
227
228
229
230
231
# File 'lib/purecloud/models/dialer_contact.rb', line 223

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



213
214
215
# File 'lib/purecloud/models/dialer_contact.rb', line 213

def to_s
  to_hash.to_s
end