purecloudplatformclientv2 20.0.0 → 21.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AdherenceSettings.md +18 -0
- data/docs/AgentManagementUnitReference.md +14 -0
- data/docs/AnalyticsSession.md +1 -0
- data/docs/AnalyticsView.md +1 -1
- data/docs/ArchitectApi.md +19 -15
- data/docs/CallForwarding.md +4 -2
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallRoute.md +14 -0
- data/docs/CallTarget.md +14 -0
- data/docs/Contact.md +1 -1
- data/docs/ConversationNotificationMessage.md +3 -0
- data/docs/ConversationNotificationMessageDetails.md +2 -0
- data/docs/ConversationNotificationMessages.md +2 -0
- data/docs/ConversationNotificationMessages1.md +3 -0
- data/docs/ConversationsApi.md +196 -0
- data/docs/CreateEmailRequest.md +2 -0
- data/docs/CreateQueueRequest.md +2 -0
- data/docs/CreateSecureSession.md +16 -0
- data/docs/ExternalContact.md +1 -0
- data/docs/ImportScriptStatusResponse.md +15 -0
- data/docs/InboundRoute.md +1 -0
- data/docs/JsonNode.md +1 -1
- data/docs/ManagementUnit.md +5 -3
- data/docs/ManagementUnitReference.md +14 -0
- data/docs/ManagementUnitSettings.md +19 -0
- data/docs/Message.md +3 -0
- data/docs/MessageConversationNotificationMessageDetails.md +2 -0
- data/docs/MessageConversationNotificationMessageMediaParticipant.md +3 -0
- data/docs/MessageConversationNotificationMessages.md +2 -0
- data/docs/MessageConversationNotificationParticipants.md +3 -0
- data/docs/MessageDetails.md +2 -0
- data/docs/QualityApi.md +3 -1
- data/docs/Queue.md +2 -0
- data/docs/SchedulingSettings.md +14 -0
- data/docs/ScriptsApi.md +64 -0
- data/docs/SecureSession.md +19 -0
- data/docs/SecureSessionEntityListing.md +13 -0
- data/docs/ShortTermForecastingSettings.md +13 -0
- data/docs/SignedData.md +13 -0
- data/docs/SignedDataApi.md +73 -0
- data/docs/TimeOffRequestSettings.md +15 -0
- data/docs/UpdateUser.md +2 -2
- data/docs/UserConversationSummaryNotification.md +1 -0
- data/docs/UserQueue.md +2 -0
- data/docs/UserReference.md +14 -0
- data/docs/WorkforceManagementApi.md +61 -0
- data/lib/purecloudplatformclientv2.rb +16 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +243 -0
- data/lib/purecloudplatformclientv2/api/quality_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/scripts_api.rb +74 -0
- data/lib/purecloudplatformclientv2/api/signed_data_api.rb +90 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/adherence_settings.rb +335 -0
- data/lib/purecloudplatformclientv2/models/agent_management_unit_reference.rb +229 -0
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +41 -1
- data/lib/purecloudplatformclientv2/models/analytics_view.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_forwarding.rb +71 -1
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_route.rb +230 -0
- data/lib/purecloudplatformclientv2/models/call_target.rb +242 -0
- data/lib/purecloudplatformclientv2/models/contact.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_message.rb +90 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_message_details.rb +68 -4
- data/lib/purecloudplatformclientv2/models/conversation_notification_messages.rb +68 -4
- data/lib/purecloudplatformclientv2/models/conversation_notification_messages_1.rb +90 -1
- data/lib/purecloudplatformclientv2/models/create_email_request.rb +56 -4
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/create_secure_session.rb +290 -0
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
- data/lib/purecloudplatformclientv2/models/import_script_status_response.rb +251 -0
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +27 -1
- data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/json_node.rb +17 -17
- data/lib/purecloudplatformclientv2/models/management_unit.rb +59 -7
- data/lib/purecloudplatformclientv2/models/management_unit_reference.rb +229 -0
- data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +364 -0
- data/lib/purecloudplatformclientv2/models/message.rb +93 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_details.rb +68 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +93 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_messages.rb +68 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +93 -4
- data/lib/purecloudplatformclientv2/models/message_details.rb +67 -1
- data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue.rb +53 -1
- data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +229 -0
- data/lib/purecloudplatformclientv2/models/secure_session.rb +382 -0
- data/lib/purecloudplatformclientv2/models/secure_session_entity_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/short_term_forecasting_settings.rb +203 -0
- data/lib/purecloudplatformclientv2/models/signed_data.rb +201 -0
- data/lib/purecloudplatformclientv2/models/time_off_request_settings.rb +255 -0
- data/lib/purecloudplatformclientv2/models/update_user.rb +2 -1
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +53 -1
- data/lib/purecloudplatformclientv2/models/user_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +34 -2
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
PureCloud Platform API
|
|
3
|
+
|
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: v2
|
|
7
|
+
Contact: DeveloperEvangelists@genesys.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
|
|
10
|
+
License: ININ
|
|
11
|
+
http://www.inin.com
|
|
12
|
+
|
|
13
|
+
Terms of Service: https://developer.mypurecloud.com/tos
|
|
14
|
+
|
|
15
|
+
=end
|
|
16
|
+
|
|
17
|
+
require 'date'
|
|
18
|
+
|
|
19
|
+
module PureCloud
|
|
20
|
+
# A reference from agent to management unit
|
|
21
|
+
class AgentManagementUnitReference
|
|
22
|
+
# The user (agent) for whom the management unit was requested
|
|
23
|
+
attr_accessor :user
|
|
24
|
+
|
|
25
|
+
# The management to which the user (agent) belongs
|
|
26
|
+
attr_accessor :management_unit
|
|
27
|
+
|
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
29
|
+
def self.attribute_map
|
|
30
|
+
{
|
|
31
|
+
|
|
32
|
+
:'user' => :'user',
|
|
33
|
+
|
|
34
|
+
:'management_unit' => :'managementUnit'
|
|
35
|
+
|
|
36
|
+
}
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Attribute type mapping.
|
|
40
|
+
def self.swagger_types
|
|
41
|
+
{
|
|
42
|
+
|
|
43
|
+
:'user' => :'UserReference',
|
|
44
|
+
|
|
45
|
+
:'management_unit' => :'ManagementUnitReference'
|
|
46
|
+
|
|
47
|
+
}
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Initializes the object
|
|
51
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
52
|
+
def initialize(attributes = {})
|
|
53
|
+
return unless attributes.is_a?(Hash)
|
|
54
|
+
|
|
55
|
+
# convert string to symbol for hash key
|
|
56
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
if attributes.has_key?(:'user')
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
self.user = attributes[:'user']
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
if attributes.has_key?(:'managementUnit')
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
self.management_unit = attributes[:'managementUnit']
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
80
|
+
# @return Array for valid properies with the reasons
|
|
81
|
+
def list_invalid_properties
|
|
82
|
+
invalid_properties = Array.new
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
return invalid_properties
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Check to see if the all the properties in the model are valid
|
|
89
|
+
# @return true if the model is valid
|
|
90
|
+
def valid?
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
# Checks equality by comparing each attribute.
|
|
114
|
+
# @param [Object] Object to be compared
|
|
115
|
+
def ==(o)
|
|
116
|
+
return true if self.equal?(o)
|
|
117
|
+
self.class == o.class &&
|
|
118
|
+
user == o.user &&
|
|
119
|
+
management_unit == o.management_unit
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
# @see the `==` method
|
|
123
|
+
# @param [Object] Object to be compared
|
|
124
|
+
def eql?(o)
|
|
125
|
+
self == o
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Calculates hash code according to all attributes.
|
|
129
|
+
# @return [Fixnum] Hash code
|
|
130
|
+
def hash
|
|
131
|
+
[user, management_unit].hash
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# build the object from hash
|
|
135
|
+
def build_from_hash(attributes)
|
|
136
|
+
return nil unless attributes.is_a?(Hash)
|
|
137
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
138
|
+
if type =~ /^Array<(.*)>/i
|
|
139
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
140
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
|
141
|
+
else
|
|
142
|
+
#TODO show warning in debug mode
|
|
143
|
+
end
|
|
144
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
145
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
146
|
+
else
|
|
147
|
+
# data not found in attributes(hash), not an issue as the data can be optional
|
|
148
|
+
end
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
self
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
def _deserialize(type, value)
|
|
155
|
+
case type.to_sym
|
|
156
|
+
when :DateTime
|
|
157
|
+
DateTime.parse(value)
|
|
158
|
+
when :Date
|
|
159
|
+
Date.parse(value)
|
|
160
|
+
when :String
|
|
161
|
+
value.to_s
|
|
162
|
+
when :Integer
|
|
163
|
+
value.to_i
|
|
164
|
+
when :Float
|
|
165
|
+
value.to_f
|
|
166
|
+
when :BOOLEAN
|
|
167
|
+
if value.to_s =~ /^(true|t|yes|y|1)$/i
|
|
168
|
+
true
|
|
169
|
+
else
|
|
170
|
+
false
|
|
171
|
+
end
|
|
172
|
+
when :Object
|
|
173
|
+
# generic object (usually a Hash), return directly
|
|
174
|
+
value
|
|
175
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
176
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
177
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
178
|
+
when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
|
|
179
|
+
k_type = Regexp.last_match[:k_type]
|
|
180
|
+
v_type = Regexp.last_match[:v_type]
|
|
181
|
+
{}.tap do |hash|
|
|
182
|
+
value.each do |k, v|
|
|
183
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
else # model
|
|
187
|
+
_model = Object.const_get("PureCloud").const_get(type).new
|
|
188
|
+
_model.build_from_hash(value)
|
|
189
|
+
end
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
def to_s
|
|
193
|
+
to_hash.to_s
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
# to_body is an alias to to_body (backward compatibility))
|
|
197
|
+
def to_body
|
|
198
|
+
to_hash
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# return the object in the form of hash
|
|
202
|
+
def to_hash
|
|
203
|
+
hash = {}
|
|
204
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
205
|
+
value = self.send(attr)
|
|
206
|
+
next if value.nil?
|
|
207
|
+
hash[param] = _to_hash(value)
|
|
208
|
+
end
|
|
209
|
+
hash
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
# Method to output non-array value in the form of hash
|
|
213
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
214
|
+
def _to_hash(value)
|
|
215
|
+
if value.is_a?(Array)
|
|
216
|
+
value.compact.map{ |v| _to_hash(v) }
|
|
217
|
+
elsif value.is_a?(Hash)
|
|
218
|
+
{}.tap do |hash|
|
|
219
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
220
|
+
end
|
|
221
|
+
elsif value.respond_to? :to_hash
|
|
222
|
+
value.to_hash
|
|
223
|
+
else
|
|
224
|
+
value
|
|
225
|
+
end
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
end
|
|
229
|
+
end
|
|
@@ -103,7 +103,7 @@ module PureCloud
|
|
|
103
103
|
|
|
104
104
|
|
|
105
105
|
|
|
106
|
-
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
106
|
+
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
107
107
|
if @metric && !allowed_values.include?(@metric)
|
|
108
108
|
return false
|
|
109
109
|
end
|
|
@@ -125,7 +125,7 @@ module PureCloud
|
|
|
125
125
|
# Custom attribute writer method checking allowed values (enum).
|
|
126
126
|
# @param [Object] metric Object to be assigned
|
|
127
127
|
def metric=(metric)
|
|
128
|
-
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
128
|
+
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
129
129
|
if metric && !allowed_values.include?(metric)
|
|
130
130
|
fail ArgumentError, "invalid value for 'metric', must be one of #{allowed_values}."
|
|
131
131
|
end
|
|
@@ -476,7 +476,7 @@ module PureCloud
|
|
|
476
476
|
|
|
477
477
|
|
|
478
478
|
|
|
479
|
-
allowed_values = ["unknown", "alert", "system", "delay", "hold", "interact", "ivr", "dialing", "wrapup", "voicemail", "scheduled"]
|
|
479
|
+
allowed_values = ["unknown", "alert", "system", "delay", "hold", "interact", "ivr", "dialing", "wrapup", "voicemail", "scheduled", "contacting", "transmitting", "converting", "uploading", "sharing"]
|
|
480
480
|
if @segment_type && !allowed_values.include?(@segment_type)
|
|
481
481
|
return false
|
|
482
482
|
end
|
|
@@ -599,7 +599,7 @@ module PureCloud
|
|
|
599
599
|
# Custom attribute writer method checking allowed values (enum).
|
|
600
600
|
# @param [Object] segment_type Object to be assigned
|
|
601
601
|
def segment_type=(segment_type)
|
|
602
|
-
allowed_values = ["unknown", "alert", "system", "delay", "hold", "interact", "ivr", "dialing", "wrapup", "voicemail", "scheduled"]
|
|
602
|
+
allowed_values = ["unknown", "alert", "system", "delay", "hold", "interact", "ivr", "dialing", "wrapup", "voicemail", "scheduled", "contacting", "transmitting", "converting", "uploading", "sharing"]
|
|
603
603
|
if segment_type && !allowed_values.include?(segment_type)
|
|
604
604
|
fail ArgumentError, "invalid value for 'segment_type', must be one of #{allowed_values}."
|
|
605
605
|
end
|
|
@@ -195,7 +195,7 @@ module PureCloud
|
|
|
195
195
|
|
|
196
196
|
|
|
197
197
|
|
|
198
|
-
allowed_values = ["conversationId", "sessionId", "mediaType", "queueId", "userId", "participantId", "participantName", "direction", "wrapUpCode", "wrapUpNote", "interactionType", "requestedRoutingSkillId", "requestedLanguageId", "requestedRoutingUserIds", "purpose", "participantType", "segmentType", "disconnectType", "errorCode", "conversationEnd", "segmentEnd", "externalContactId", "externalOrganizationId", "convertedFrom", "convertedTo", "stationId", "edgeId", "dnis", "ani", "outboundCampaignId", "outboundContactId", "outboundContactListId", "monitoredParticipantId", "sourceSessionId", "destinationSessionId", "sourceConversationId", "destinationConversationId", "remoteNameDisplayable", "sipResponseCode", "q850ResponseCode", "conference", "groupId", "roomId", "addressFrom", "addressTo", "addressSelf", "addressOther", "subject", "peerId", "scriptId", "evaluationId", "evaluatorId", "contextId", "formId", "formName", "eventTime", "systemPresence", "organizationPresenceId", "routingStatus"]
|
|
198
|
+
allowed_values = ["conversationId", "sessionId", "mediaType", "queueId", "userId", "participantId", "participantName", "direction", "wrapUpCode", "wrapUpNote", "interactionType", "requestedRoutingSkillId", "requestedLanguageId", "requestedRoutingUserIds", "purpose", "participantType", "segmentType", "disconnectType", "errorCode", "conversationEnd", "segmentEnd", "externalContactId", "externalOrganizationId", "convertedFrom", "convertedTo", "stationId", "edgeId", "dnis", "ani", "outboundCampaignId", "outboundContactId", "outboundContactListId", "monitoredParticipantId", "sourceSessionId", "destinationSessionId", "sourceConversationId", "destinationConversationId", "remoteNameDisplayable", "sipResponseCode", "q850ResponseCode", "conference", "groupId", "roomId", "addressFrom", "addressTo", "addressSelf", "addressOther", "subject", "messageType", "peerId", "scriptId", "evaluationId", "evaluatorId", "contextId", "formId", "formName", "eventTime", "systemPresence", "organizationPresenceId", "routingStatus"]
|
|
199
199
|
if @dimension && !allowed_values.include?(@dimension)
|
|
200
200
|
return false
|
|
201
201
|
end
|
|
@@ -217,7 +217,7 @@ module PureCloud
|
|
|
217
217
|
|
|
218
218
|
|
|
219
219
|
|
|
220
|
-
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
220
|
+
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
221
221
|
if @metric && !allowed_values.include?(@metric)
|
|
222
222
|
return false
|
|
223
223
|
end
|
|
@@ -262,7 +262,7 @@ module PureCloud
|
|
|
262
262
|
# Custom attribute writer method checking allowed values (enum).
|
|
263
263
|
# @param [Object] dimension Object to be assigned
|
|
264
264
|
def dimension=(dimension)
|
|
265
|
-
allowed_values = ["conversationId", "sessionId", "mediaType", "queueId", "userId", "participantId", "participantName", "direction", "wrapUpCode", "wrapUpNote", "interactionType", "requestedRoutingSkillId", "requestedLanguageId", "requestedRoutingUserIds", "purpose", "participantType", "segmentType", "disconnectType", "errorCode", "conversationEnd", "segmentEnd", "externalContactId", "externalOrganizationId", "convertedFrom", "convertedTo", "stationId", "edgeId", "dnis", "ani", "outboundCampaignId", "outboundContactId", "outboundContactListId", "monitoredParticipantId", "sourceSessionId", "destinationSessionId", "sourceConversationId", "destinationConversationId", "remoteNameDisplayable", "sipResponseCode", "q850ResponseCode", "conference", "groupId", "roomId", "addressFrom", "addressTo", "addressSelf", "addressOther", "subject", "peerId", "scriptId", "evaluationId", "evaluatorId", "contextId", "formId", "formName", "eventTime", "systemPresence", "organizationPresenceId", "routingStatus"]
|
|
265
|
+
allowed_values = ["conversationId", "sessionId", "mediaType", "queueId", "userId", "participantId", "participantName", "direction", "wrapUpCode", "wrapUpNote", "interactionType", "requestedRoutingSkillId", "requestedLanguageId", "requestedRoutingUserIds", "purpose", "participantType", "segmentType", "disconnectType", "errorCode", "conversationEnd", "segmentEnd", "externalContactId", "externalOrganizationId", "convertedFrom", "convertedTo", "stationId", "edgeId", "dnis", "ani", "outboundCampaignId", "outboundContactId", "outboundContactListId", "monitoredParticipantId", "sourceSessionId", "destinationSessionId", "sourceConversationId", "destinationConversationId", "remoteNameDisplayable", "sipResponseCode", "q850ResponseCode", "conference", "groupId", "roomId", "addressFrom", "addressTo", "addressSelf", "addressOther", "subject", "messageType", "peerId", "scriptId", "evaluationId", "evaluatorId", "contextId", "formId", "formName", "eventTime", "systemPresence", "organizationPresenceId", "routingStatus"]
|
|
266
266
|
if dimension && !allowed_values.include?(dimension)
|
|
267
267
|
fail ArgumentError, "invalid value for 'dimension', must be one of #{allowed_values}."
|
|
268
268
|
end
|
|
@@ -295,7 +295,7 @@ module PureCloud
|
|
|
295
295
|
# Custom attribute writer method checking allowed values (enum).
|
|
296
296
|
# @param [Object] metric Object to be assigned
|
|
297
297
|
def metric=(metric)
|
|
298
|
-
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
298
|
+
allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses"]
|
|
299
299
|
if metric && !allowed_values.include?(metric)
|
|
300
300
|
fail ArgumentError, "invalid value for 'metric', must be one of #{allowed_values}."
|
|
301
301
|
end
|
|
@@ -32,6 +32,9 @@ module PureCloud
|
|
|
32
32
|
|
|
33
33
|
attr_accessor :address_to
|
|
34
34
|
|
|
35
|
+
# Message type for messaging services such as sms
|
|
36
|
+
attr_accessor :message_type
|
|
37
|
+
|
|
35
38
|
# Automatic Number Identification (caller's number)
|
|
36
39
|
attr_accessor :ani
|
|
37
40
|
|
|
@@ -132,6 +135,8 @@ module PureCloud
|
|
|
132
135
|
|
|
133
136
|
:'address_to' => :'addressTo',
|
|
134
137
|
|
|
138
|
+
:'message_type' => :'messageType',
|
|
139
|
+
|
|
135
140
|
:'ani' => :'ani',
|
|
136
141
|
|
|
137
142
|
:'direction' => :'direction',
|
|
@@ -209,6 +214,8 @@ module PureCloud
|
|
|
209
214
|
|
|
210
215
|
:'address_to' => :'String',
|
|
211
216
|
|
|
217
|
+
:'message_type' => :'String',
|
|
218
|
+
|
|
212
219
|
:'ani' => :'String',
|
|
213
220
|
|
|
214
221
|
:'direction' => :'String',
|
|
@@ -333,6 +340,15 @@ module PureCloud
|
|
|
333
340
|
end
|
|
334
341
|
|
|
335
342
|
|
|
343
|
+
if attributes.has_key?(:'messageType')
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
self.message_type = attributes[:'messageType']
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
|
|
336
352
|
if attributes.has_key?(:'ani')
|
|
337
353
|
|
|
338
354
|
|
|
@@ -639,6 +655,15 @@ module PureCloud
|
|
|
639
655
|
|
|
640
656
|
|
|
641
657
|
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
allowed_values = ["sms"]
|
|
664
|
+
if @message_type && !allowed_values.include?(@message_type)
|
|
665
|
+
return false
|
|
666
|
+
end
|
|
642
667
|
|
|
643
668
|
|
|
644
669
|
|
|
@@ -807,6 +832,20 @@ module PureCloud
|
|
|
807
832
|
|
|
808
833
|
|
|
809
834
|
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
840
|
+
# @param [Object] message_type Object to be assigned
|
|
841
|
+
def message_type=(message_type)
|
|
842
|
+
allowed_values = ["sms"]
|
|
843
|
+
if message_type && !allowed_values.include?(message_type)
|
|
844
|
+
fail ArgumentError, "invalid value for 'message_type', must be one of #{allowed_values}."
|
|
845
|
+
end
|
|
846
|
+
@message_type = message_type
|
|
847
|
+
end
|
|
848
|
+
|
|
810
849
|
|
|
811
850
|
|
|
812
851
|
|
|
@@ -984,6 +1023,7 @@ module PureCloud
|
|
|
984
1023
|
address_self == o.address_self &&
|
|
985
1024
|
address_from == o.address_from &&
|
|
986
1025
|
address_to == o.address_to &&
|
|
1026
|
+
message_type == o.message_type &&
|
|
987
1027
|
ani == o.ani &&
|
|
988
1028
|
direction == o.direction &&
|
|
989
1029
|
dnis == o.dnis &&
|
|
@@ -1024,7 +1064,7 @@ module PureCloud
|
|
|
1024
1064
|
# Calculates hash code according to all attributes.
|
|
1025
1065
|
# @return [Fixnum] Hash code
|
|
1026
1066
|
def hash
|
|
1027
|
-
[media_type, session_id, address_other, address_self, address_from, address_to, ani, direction, dnis, outbound_campaign_id, outbound_contact_id, outbound_contact_list_id, disposition_analyzer, disposition_name, edge_id, remote_name_displayable, room_id, monitored_session_id, monitored_participant_id, callback_user_name, callback_numbers, callback_scheduled_time, script_id, peer_id, skip_enabled, timeout_seconds, cobrowse_role, cobrowse_room_id, media_bridge_id, screen_share_address_self, sharing_screen, screen_share_room_id, video_room_id, video_address_self, segments].hash
|
|
1067
|
+
[media_type, session_id, address_other, address_self, address_from, address_to, message_type, ani, direction, dnis, outbound_campaign_id, outbound_contact_id, outbound_contact_list_id, disposition_analyzer, disposition_name, edge_id, remote_name_displayable, room_id, monitored_session_id, monitored_participant_id, callback_user_name, callback_numbers, callback_scheduled_time, script_id, peer_id, skip_enabled, timeout_seconds, cobrowse_role, cobrowse_room_id, media_bridge_id, screen_share_address_self, sharing_screen, screen_share_room_id, video_room_id, video_address_self, segments].hash
|
|
1028
1068
|
end
|
|
1029
1069
|
|
|
1030
1070
|
# build the object from hash
|
|
@@ -25,10 +25,18 @@ module PureCloud
|
|
|
25
25
|
|
|
26
26
|
attr_accessor :user
|
|
27
27
|
|
|
28
|
+
# Whether or not CallForwarding is enabled
|
|
28
29
|
attr_accessor :enabled
|
|
29
30
|
|
|
31
|
+
# This property is deprecated. Please use the calls property
|
|
30
32
|
attr_accessor :phone_number
|
|
31
33
|
|
|
34
|
+
# An ordered list of CallRoutes to be executed when CallForwarding is enabled
|
|
35
|
+
attr_accessor :calls
|
|
36
|
+
|
|
37
|
+
# The type of voicemail to use with the callForwarding configuration
|
|
38
|
+
attr_accessor :voicemail
|
|
39
|
+
|
|
32
40
|
# Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
|
|
33
41
|
attr_accessor :modified_date
|
|
34
42
|
|
|
@@ -49,6 +57,10 @@ module PureCloud
|
|
|
49
57
|
|
|
50
58
|
:'phone_number' => :'phoneNumber',
|
|
51
59
|
|
|
60
|
+
:'calls' => :'calls',
|
|
61
|
+
|
|
62
|
+
:'voicemail' => :'voicemail',
|
|
63
|
+
|
|
52
64
|
:'modified_date' => :'modifiedDate',
|
|
53
65
|
|
|
54
66
|
:'self_uri' => :'selfUri'
|
|
@@ -70,6 +82,10 @@ module PureCloud
|
|
|
70
82
|
|
|
71
83
|
:'phone_number' => :'String',
|
|
72
84
|
|
|
85
|
+
:'calls' => :'Array<CallRoute>',
|
|
86
|
+
|
|
87
|
+
:'voicemail' => :'String',
|
|
88
|
+
|
|
73
89
|
:'modified_date' => :'DateTime',
|
|
74
90
|
|
|
75
91
|
:'self_uri' => :'String'
|
|
@@ -131,6 +147,26 @@ module PureCloud
|
|
|
131
147
|
end
|
|
132
148
|
|
|
133
149
|
|
|
150
|
+
if attributes.has_key?(:'calls')
|
|
151
|
+
|
|
152
|
+
if (value = attributes[:'calls']).is_a?(Array)
|
|
153
|
+
self.calls = value
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
if attributes.has_key?(:'voicemail')
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
self.voicemail = attributes[:'voicemail']
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
|
|
134
170
|
if attributes.has_key?(:'modifiedDate')
|
|
135
171
|
|
|
136
172
|
|
|
@@ -183,6 +219,19 @@ module PureCloud
|
|
|
183
219
|
|
|
184
220
|
|
|
185
221
|
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
allowed_values = ["PURECLOUD", "LASTCALL", "NONE"]
|
|
230
|
+
if @voicemail && !allowed_values.include?(@voicemail)
|
|
231
|
+
return false
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
|
|
186
235
|
|
|
187
236
|
|
|
188
237
|
|
|
@@ -217,6 +266,25 @@ module PureCloud
|
|
|
217
266
|
|
|
218
267
|
|
|
219
268
|
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
279
|
+
# @param [Object] voicemail Object to be assigned
|
|
280
|
+
def voicemail=(voicemail)
|
|
281
|
+
allowed_values = ["PURECLOUD", "LASTCALL", "NONE"]
|
|
282
|
+
if voicemail && !allowed_values.include?(voicemail)
|
|
283
|
+
fail ArgumentError, "invalid value for 'voicemail', must be one of #{allowed_values}."
|
|
284
|
+
end
|
|
285
|
+
@voicemail = voicemail
|
|
286
|
+
end
|
|
287
|
+
|
|
220
288
|
|
|
221
289
|
|
|
222
290
|
|
|
@@ -240,6 +308,8 @@ module PureCloud
|
|
|
240
308
|
user == o.user &&
|
|
241
309
|
enabled == o.enabled &&
|
|
242
310
|
phone_number == o.phone_number &&
|
|
311
|
+
calls == o.calls &&
|
|
312
|
+
voicemail == o.voicemail &&
|
|
243
313
|
modified_date == o.modified_date &&
|
|
244
314
|
self_uri == o.self_uri
|
|
245
315
|
end
|
|
@@ -253,7 +323,7 @@ module PureCloud
|
|
|
253
323
|
# Calculates hash code according to all attributes.
|
|
254
324
|
# @return [Fixnum] Hash code
|
|
255
325
|
def hash
|
|
256
|
-
[id, name, user, enabled, phone_number, modified_date, self_uri].hash
|
|
326
|
+
[id, name, user, enabled, phone_number, calls, voicemail, modified_date, self_uri].hash
|
|
257
327
|
end
|
|
258
328
|
|
|
259
329
|
# build the object from hash
|