Class: PureCloud::CreateCallRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCallRequest

Returns a new instance of CreateCallRequest.



73
74
75
76
77
78
79
80
81
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
 
# File 'lib/purecloud/models/create_call_request.rb', line 73

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[:'phoneNumber']
    self.phone_number = attributes[:'phoneNumber']
  end
  
  if attributes[:'callFromQueueId']
    self.call_from_queue_id = attributes[:'callFromQueueId']
  end
  
  if attributes[:'callQueueId']
    self.call_queue_id = attributes[:'callQueueId']
  end
  
  if attributes[:'callUserId']
    self.call_user_id = attributes[:'callUserId']
  end
  
  if attributes[:'priority']
    self.priority = attributes[:'priority']
  end
  
  if attributes[:'languageId']
    self.language_id = attributes[:'languageId']
  end
  
  if attributes[:'routingSkillsIds']
    if (value = attributes[:'routingSkillsIds']).is_a?(Array)
      self.routing_skills_ids = value
    end
  end
  
  if attributes[:'conversationIds']
    if (value = attributes[:'conversationIds']).is_a?(Array)
      self.conversation_ids = value
    end
  end
  
  if attributes[:'participants']
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
  end
  
end

Instance Attribute Details

#call_from_queue_id ⇒ Object

The queue ID to call on behalf of.



9
10
11
 
# File 'lib/purecloud/models/create_call_request.rb', line 9

def call_from_queue_id
  @call_from_queue_id
end

#call_queue_id ⇒ Object

The queue ID to call.



12
13
14
 
# File 'lib/purecloud/models/create_call_request.rb', line 12

def call_queue_id
  @call_queue_id
end

#call_user_id ⇒ Object

The user ID to call.



15
16
17
 
# File 'lib/purecloud/models/create_call_request.rb', line 15

def call_user_id
  @call_user_id
end

#conversation_ids ⇒ Object

The list of existing call conversations to merge into a new ad-hoc conference.



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

def conversation_ids
  @conversation_ids
end

#language_id ⇒ Object

The language skill ID to use for routing this call (if calling a queue).



21
22
23
 
# File 'lib/purecloud/models/create_call_request.rb', line 21

def language_id
  @language_id
end

#participants ⇒ Object

The list of participants to call to create a new ad-hoc conference.



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

def participants
  @participants
end

#phone_number ⇒ Object

The phone number to dial.



6
7
8
 
# File 'lib/purecloud/models/create_call_request.rb', line 6

def phone_number
  @phone_number
end

#priority ⇒ Object

The priority to assign to this call (if calling a queue).



18
19
20
 
# File 'lib/purecloud/models/create_call_request.rb', line 18

def priority
  @priority
end

#routing_skills_ids ⇒ Object

The skill ID’s to use for routing this call (if calling a queue).



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

def routing_skills_ids
  @routing_skills_ids
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/purecloud/models/create_call_request.rb', line 33

def self.attribute_map
  {
    
    :'phone_number' => :'phoneNumber',
    
    :'call_from_queue_id' => :'callFromQueueId',
    
    :'call_queue_id' => :'callQueueId',
    
    :'call_user_id' => :'callUserId',
    
    :'priority' => :'priority',
    
    :'language_id' => :'languageId',
    
    :'routing_skills_ids' => :'routingSkillsIds',
    
    :'conversation_ids' => :'conversationIds',
    
    :'participants' => :'participants'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloud/models/create_call_request.rb', line 58

def self.swagger_types
  {
    :'phone_number' => :'String',
    :'call_from_queue_id' => :'String',
    :'call_queue_id' => :'String',
    :'call_user_id' => :'String',
    :'priority' => :'Integer',
    :'language_id' => :'String',
    :'routing_skills_ids' => :'Array<String>',
    :'conversation_ids' => :'Array<String>',
    :'participants' => :'Array<Destination>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/purecloud/models/create_call_request.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone_number == o.phone_number &&
      call_from_queue_id == o.call_from_queue_id &&
      call_queue_id == o.call_queue_id &&
      call_user_id == o.call_user_id &&
      priority == o.priority &&
      language_id == o.language_id &&
      routing_skills_ids == o.routing_skills_ids &&
      conversation_ids == o.conversation_ids &&
      participants == o.participants
end

#_deserialize(type, value) ⇒ Object 



169
170
171
172
173
174
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
 
# File 'lib/purecloud/models/create_call_request.rb', line 169

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/purecloud/models/create_call_request.rb', line 226

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/purecloud/models/create_call_request.rb', line 150

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


140
141
142
 
# File 'lib/purecloud/models/create_call_request.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



145
146
147
 
# File 'lib/purecloud/models/create_call_request.rb', line 145

def hash
  [phone_number, call_from_queue_id, call_queue_id, call_user_id, priority, language_id, routing_skills_ids, conversation_ids, participants].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



209
210
211
 
# File 'lib/purecloud/models/create_call_request.rb', line 209

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



214
215
216
217
218
219
220
221
222
 
# File 'lib/purecloud/models/create_call_request.rb', line 214

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_s ⇒ Object 



204
205
206
 
# File 'lib/purecloud/models/create_call_request.rb', line 204

def to_s
  to_hash.to_s
end