purecloudplatformclientv2 44.0.0 → 45.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.
Files changed (97) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ADFS.md +1 -1
  4. data/docs/AnalyticsEvaluation.md +1 -1
  5. data/docs/AnalyticsSurvey.md +2 -1
  6. data/docs/ArchitectApi.md +52 -127
  7. data/docs/ContactListDivisionView.md +20 -0
  8. data/docs/ContactListDivisionViewListing.md +22 -0
  9. data/docs/ContactListNotification.md +1 -0
  10. data/docs/ConversationQuery.md +1 -1
  11. data/docs/CreateOutboundMessagingConversationRequest.md +1 -1
  12. data/docs/CreateWorkPlan.md +2 -0
  13. data/docs/CustomerInteractionCenter.md +1 -1
  14. data/docs/DataExportNotificationNotification.md +1 -0
  15. data/docs/DncListNotification.md +1 -0
  16. data/docs/DncListNotificationUriReference.md +14 -0
  17. data/docs/GSuite.md +1 -1
  18. data/docs/HelpLink.md +15 -0
  19. data/docs/IdentityNow.md +1 -1
  20. data/docs/IntegrationType.md +8 -0
  21. data/docs/IntradayDataUpdateNotification.md +2 -2
  22. data/docs/Okta.md +1 -1
  23. data/docs/OneLogin.md +1 -1
  24. data/docs/OutboundApi.md +152 -0
  25. data/docs/PingIdentity.md +1 -1
  26. data/docs/QualityApi.md +66 -0
  27. data/docs/ReportingExportJobResponse.md +1 -0
  28. data/docs/RoutingApi.md +74 -0
  29. data/docs/Salesforce.md +1 -1
  30. data/docs/UserScheduleAdherenceUpdateNotification.md +2 -2
  31. data/docs/WfmAgentScheduleUpdateNotificationNotification.md +18 -0
  32. data/docs/WfmAgentScheduleUpdateNotificationNotificationActivities.md +18 -0
  33. data/docs/WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers.md +19 -0
  34. data/docs/WfmAgentScheduleUpdateNotificationNotificationShifts.md +15 -0
  35. data/docs/WfmAgentScheduleUpdateNotificationNotificationUpdates.md +14 -0
  36. data/docs/WfmAgentScheduleUpdateNotificationNotificationUserReference.md +13 -0
  37. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmAgentScheduleUpdate.md +14 -0
  38. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmFullDayTimeOffMarker.md +19 -0
  39. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleActivity.md +18 -0
  40. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleShift.md +15 -0
  41. data/docs/WfmScheduleNotificationNotification.md +1 -0
  42. data/docs/WorkPlan.md +2 -0
  43. data/docs/WorkPlanListItemResponse.md +16 -5
  44. data/docs/WorkforceManagementApi.md +2 -2
  45. data/lib/purecloudplatformclientv2.rb +14 -3
  46. data/lib/purecloudplatformclientv2/api/outbound_api.rb +230 -0
  47. data/lib/purecloudplatformclientv2/api/quality_api.rb +66 -0
  48. data/lib/purecloudplatformclientv2/api/routing_api.rb +100 -0
  49. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -7
  50. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  51. data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
  52. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  53. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +2 -2
  54. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
  55. data/lib/purecloudplatformclientv2/models/analytics_survey.rb +34 -8
  56. data/lib/purecloudplatformclientv2/models/contact_list_division_view.rb +397 -0
  57. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +428 -0
  58. data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +26 -1
  59. data/lib/purecloudplatformclientv2/models/conversation_query.rb +1 -1
  60. data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +1 -1
  61. data/lib/purecloudplatformclientv2/models/create_work_plan.rb +53 -1
  62. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
  63. data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +31 -6
  64. data/lib/purecloudplatformclientv2/models/dnc_list_notification.rb +26 -1
  65. data/lib/purecloudplatformclientv2/models/dnc_list_notification_uri_reference.rb +226 -0
  66. data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
  67. data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
  68. data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_date_time.rb → help_link.rb} +24 -45
  69. data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
  70. data/lib/purecloudplatformclientv2/models/integration_type.rb +211 -1
  71. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +2 -2
  72. data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
  73. data/lib/purecloudplatformclientv2/models/message_details.rb +2 -2
  74. data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
  75. data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
  76. data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
  77. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +34 -3
  78. data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
  79. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +2 -2
  80. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification.rb +332 -0
  81. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_activities.rb +326 -0
  82. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_full_day_time_off_markers.rb +351 -0
  83. data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_start_date.rb → wfm_agent_schedule_update_notification_notification_shifts.rb} +22 -45
  84. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_updates.rb +242 -0
  85. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_user_reference.rb +201 -0
  86. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_agent_schedule_update.rb +242 -0
  87. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_full_day_time_off_marker.rb +351 -0
  88. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_schedule_activity.rb +326 -0
  89. data/lib/purecloudplatformclientv2/models/{user_schedule_adherence_update_notification_date_time.rb → wfm_agent_schedule_update_notification_notification_wfm_schedule_shift.rb} +22 -45
  90. data/lib/purecloudplatformclientv2/models/wfm_schedule_notification_notification.rb +28 -3
  91. data/lib/purecloudplatformclientv2/models/work_plan.rb +53 -1
  92. data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +313 -18
  93. data/lib/purecloudplatformclientv2/version.rb +1 -1
  94. metadata +30 -8
  95. data/docs/IntradayDataUpdateNotificationDateTime.md +0 -16
  96. data/docs/IntradayDataUpdateNotificationStartDate.md +0 -16
  97. data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +0 -16
@@ -2288,6 +2288,72 @@ module PureCloud
2288
2288
  return data, status_code, headers
2289
2289
  end
2290
2290
 
2291
+ # Retrieve a list of survey forms by their ids
2292
+ #
2293
+ # @param ids A comma-delimited list of valid survey form ids
2294
+ # @param [Hash] opts the optional parameters
2295
+ # @return [SurveyFormEntityListing]
2296
+ def get_quality_forms_surveys_bulk(ids, opts = {})
2297
+ data, _status_code, _headers = get_quality_forms_surveys_bulk_with_http_info(ids, opts)
2298
+ return data
2299
+ end
2300
+
2301
+ # Retrieve a list of survey forms by their ids
2302
+ #
2303
+ # @param ids A comma-delimited list of valid survey form ids
2304
+ # @param [Hash] opts the optional parameters
2305
+ # @return [Array<(SurveyFormEntityListing, Fixnum, Hash)>] SurveyFormEntityListing data, response status code and response headers
2306
+ def get_quality_forms_surveys_bulk_with_http_info(ids, opts = {})
2307
+ if @api_client.config.debugging
2308
+ @api_client.config.logger.debug "Calling API: QualityApi.get_quality_forms_surveys_bulk ..."
2309
+ end
2310
+
2311
+
2312
+ # verify the required parameter 'ids' is set
2313
+ fail ArgumentError, "Missing the required parameter 'ids' when calling QualityApi.get_quality_forms_surveys_bulk" if ids.nil?
2314
+
2315
+
2316
+
2317
+
2318
+
2319
+ # resource path
2320
+ local_var_path = "/api/v2/quality/forms/surveys/bulk".sub('{format}','json')
2321
+
2322
+ # query parameters
2323
+ query_params = {}
2324
+ query_params[:'ids'] = @api_client.build_collection_param(ids, :multi)
2325
+
2326
+ # header parameters
2327
+ header_params = {}
2328
+
2329
+ # HTTP header 'Accept' (if needed)
2330
+ local_header_accept = ['application/json']
2331
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2332
+
2333
+ # HTTP header 'Content-Type'
2334
+ local_header_content_type = ['application/json']
2335
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2336
+
2337
+ # form parameters
2338
+ form_params = {}
2339
+
2340
+ # http body (model)
2341
+ post_body = nil
2342
+
2343
+ auth_names = ['PureCloud Auth']
2344
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2345
+ :header_params => header_params,
2346
+ :query_params => query_params,
2347
+ :form_params => form_params,
2348
+ :body => post_body,
2349
+ :auth_names => auth_names,
2350
+ :return_type => 'SurveyFormEntityListing')
2351
+ if @api_client.config.debugging
2352
+ @api_client.config.logger.debug "API called: QualityApi#get_quality_forms_surveys_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2353
+ end
2354
+ return data, status_code, headers
2355
+ end
2356
+
2291
2357
  # Get a keywordSet by id.
2292
2358
  #
2293
2359
  # @param keyword_set_id KeywordSet ID
@@ -2039,6 +2039,106 @@ module PureCloud
2039
2039
  return data, status_code, headers
2040
2040
  end
2041
2041
 
2042
+ # Get a paged listing of queues the user is a member of.
2043
+ #
2044
+ # @param [Hash] opts the optional parameters
2045
+ # @option opts [BOOLEAN] :joined Joined
2046
+ # @option opts [Integer] :page_size Page size (default to 25)
2047
+ # @option opts [Integer] :page_number Page number (default to 1)
2048
+ # @option opts [String] :sort_by Sort by (default to name)
2049
+ # @option opts [String] :sort_order Sort order (default to asc)
2050
+ # @return [UserQueueEntityListing]
2051
+ def get_routing_queues_me(opts = {})
2052
+ data, _status_code, _headers = get_routing_queues_me_with_http_info(opts)
2053
+ return data
2054
+ end
2055
+
2056
+ # Get a paged listing of queues the user is a member of.
2057
+ #
2058
+ # @param [Hash] opts the optional parameters
2059
+ # @option opts [BOOLEAN] :joined Joined
2060
+ # @option opts [Integer] :page_size Page size
2061
+ # @option opts [Integer] :page_number Page number
2062
+ # @option opts [String] :sort_by Sort by
2063
+ # @option opts [String] :sort_order Sort order
2064
+ # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
2065
+ def get_routing_queues_me_with_http_info(opts = {})
2066
+ if @api_client.config.debugging
2067
+ @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queues_me ..."
2068
+ end
2069
+
2070
+
2071
+
2072
+
2073
+
2074
+
2075
+
2076
+
2077
+
2078
+
2079
+
2080
+
2081
+
2082
+
2083
+
2084
+
2085
+
2086
+
2087
+
2088
+
2089
+
2090
+
2091
+
2092
+
2093
+
2094
+
2095
+
2096
+
2097
+
2098
+
2099
+
2100
+ # resource path
2101
+ local_var_path = "/api/v2/routing/queues/me".sub('{format}','json')
2102
+
2103
+ # query parameters
2104
+ query_params = {}
2105
+ query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
2106
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2107
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2108
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
2109
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
2110
+
2111
+ # header parameters
2112
+ header_params = {}
2113
+
2114
+ # HTTP header 'Accept' (if needed)
2115
+ local_header_accept = ['application/json']
2116
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2117
+
2118
+ # HTTP header 'Content-Type'
2119
+ local_header_content_type = ['application/json']
2120
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2121
+
2122
+ # form parameters
2123
+ form_params = {}
2124
+
2125
+ # http body (model)
2126
+ post_body = nil
2127
+
2128
+ auth_names = ['PureCloud Auth']
2129
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2130
+ :header_params => header_params,
2131
+ :query_params => query_params,
2132
+ :form_params => form_params,
2133
+ :body => post_body,
2134
+ :auth_names => auth_names,
2135
+ :return_type => 'UserQueueEntityListing')
2136
+ if @api_client.config.debugging
2137
+ @api_client.config.logger.debug "API called: RoutingApi#get_routing_queues_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2138
+ end
2139
+ return data, status_code, headers
2140
+ end
2141
+
2042
2142
  # Get Routing Skill
2043
2143
  #
2044
2144
  # @param skill_id Skill ID
@@ -2156,7 +2156,7 @@ module PureCloud
2156
2156
  #
2157
2157
  # @param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2158
2158
  # @param [Hash] opts the optional parameters
2159
- # @option opts [String] :expand
2159
+ # @option opts [Array<String>] :expand
2160
2160
  # @return [WorkPlanListResponse]
2161
2161
  def get_workforcemanagement_managementunit_workplans(management_unit_id, opts = {})
2162
2162
  data, _status_code, _headers = get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts)
@@ -2167,7 +2167,7 @@ module PureCloud
2167
2167
  #
2168
2168
  # @param management_unit_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
2169
2169
  # @param [Hash] opts the optional parameters
2170
- # @option opts [String] :expand
2170
+ # @option opts [Array<String>] :expand
2171
2171
  # @return [Array<(WorkPlanListResponse, Fixnum, Hash)>] WorkPlanListResponse data, response status code and response headers
2172
2172
  def get_workforcemanagement_managementunit_workplans_with_http_info(management_unit_id, opts = {})
2173
2173
  if @api_client.config.debugging
@@ -2185,10 +2185,6 @@ module PureCloud
2185
2185
 
2186
2186
 
2187
2187
 
2188
- if opts[:'expand'] && !['agentCount'].include?(opts[:'expand'])
2189
- fail ArgumentError, 'invalid value for "expand", must be one of agentCount'
2190
- end
2191
-
2192
2188
 
2193
2189
 
2194
2190
 
@@ -2197,7 +2193,7 @@ module PureCloud
2197
2193
 
2198
2194
  # query parameters
2199
2195
  query_params = {}
2200
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2196
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
2201
2197
 
2202
2198
  # header parameters
2203
2199
  header_params = {}
@@ -76,7 +76,7 @@ module PureCloud
76
76
  http_method = http_method.to_sym.downcase
77
77
 
78
78
  header_params = @default_headers.merge(opts[:header_params] || {})
79
- header_params['purecloud-sdk'] = '44.0.0'
79
+ header_params['purecloud-sdk'] = '45.0.0'
80
80
  query_params = opts[:query_params] || {}
81
81
  form_params = opts[:form_params] || {}
82
82
 
@@ -27,10 +27,10 @@ module PureCloud
27
27
 
28
28
  attr_accessor :certificate
29
29
 
30
- attr_accessor :issuer_uri
31
-
32
30
  attr_accessor :sso_target_uri
33
31
 
32
+ attr_accessor :issuer_uri
33
+
34
34
  attr_accessor :disabled
35
35
 
36
36
  # The URI for this object
@@ -48,10 +48,10 @@ module PureCloud
48
48
 
49
49
  :'certificate' => :'certificate',
50
50
 
51
- :'issuer_uri' => :'issuerURI',
52
-
53
51
  :'sso_target_uri' => :'ssoTargetURI',
54
52
 
53
+ :'issuer_uri' => :'issuerURI',
54
+
55
55
  :'disabled' => :'disabled',
56
56
 
57
57
  :'self_uri' => :'selfUri'
@@ -71,10 +71,10 @@ module PureCloud
71
71
 
72
72
  :'certificate' => :'String',
73
73
 
74
- :'issuer_uri' => :'String',
75
-
76
74
  :'sso_target_uri' => :'String',
77
75
 
76
+ :'issuer_uri' => :'String',
77
+
78
78
  :'disabled' => :'BOOLEAN',
79
79
 
80
80
  :'self_uri' => :'String'
@@ -127,19 +127,19 @@ module PureCloud
127
127
  end
128
128
 
129
129
 
130
- if attributes.has_key?(:'issuerURI')
130
+ if attributes.has_key?(:'ssoTargetURI')
131
131
 
132
132
 
133
- self.issuer_uri = attributes[:'issuerURI']
133
+ self.sso_target_uri = attributes[:'ssoTargetURI']
134
134
 
135
135
 
136
136
  end
137
137
 
138
138
 
139
- if attributes.has_key?(:'ssoTargetURI')
139
+ if attributes.has_key?(:'issuerURI')
140
140
 
141
141
 
142
- self.sso_target_uri = attributes[:'ssoTargetURI']
142
+ self.issuer_uri = attributes[:'issuerURI']
143
143
 
144
144
 
145
145
  end
@@ -262,8 +262,8 @@ module PureCloud
262
262
  name == o.name &&
263
263
  relying_party_identifier == o.relying_party_identifier &&
264
264
  certificate == o.certificate &&
265
- issuer_uri == o.issuer_uri &&
266
265
  sso_target_uri == o.sso_target_uri &&
266
+ issuer_uri == o.issuer_uri &&
267
267
  disabled == o.disabled &&
268
268
  self_uri == o.self_uri
269
269
  end
@@ -277,7 +277,7 @@ module PureCloud
277
277
  # Calculates hash code according to all attributes.
278
278
  # @return [Fixnum] Hash code
279
279
  def hash
280
- [id, name, relying_party_identifier, certificate, issuer_uri, sso_target_uri, disabled, self_uri].hash
280
+ [id, name, relying_party_identifier, certificate, sso_target_uri, issuer_uri, disabled, self_uri].hash
281
281
  end
282
282
 
283
283
  # build the object from hash
@@ -103,7 +103,7 @@ module PureCloud
103
103
 
104
104
 
105
105
 
106
- allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
106
+ allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nBlindTransferred", "nConsultTransferred", "nConsult", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
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", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
128
+ allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nBlindTransferred", "nConsultTransferred", "nConsult", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
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
@@ -27,7 +27,7 @@ module PureCloud
27
27
  # Unique identifier for the user being evaluated
28
28
  attr_accessor :user_id
29
29
 
30
- # Specifies when an evaluation occurred
30
+ # Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
31
31
  attr_accessor :event_time
32
32
 
33
33
  # Unique identifier for the queue the conversation was on
@@ -85,7 +85,7 @@ module PureCloud
85
85
 
86
86
  :'user_id' => :'String',
87
87
 
88
- :'event_time' => :'String',
88
+ :'event_time' => :'DateTime',
89
89
 
90
90
  :'queue_id' => :'String',
91
91
 
@@ -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", "divisionId", "flaggedReason", "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", "surveyId", "surveyFormContextId", "surveyFormId", "surveyAnswerId", "surveyQuestionId", "surveyQuestionGroupId", "systemPresence", "organizationPresenceId", "routingStatus", "flowId", "flowName", "flowVersion", "flowType", "exitReason", "transferType", "transferTargetName", "transferTargetAddress", "issuedCallback", "startingLanguage", "endingLanguage", "flowOutcomeId", "flowOutcomeValue", "flowOutcome"]
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", "divisionId", "flaggedReason", "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", "surveyId", "surveyFormContextId", "surveyFormId", "surveyAnswerId", "surveyQuestionId", "surveyQuestionGroupId", "surveyPromoterScore", "surveyCompletedDate", "systemPresence", "organizationPresenceId", "routingStatus", "flowId", "flowName", "flowVersion", "flowType", "exitReason", "transferType", "transferTargetName", "transferTargetAddress", "issuedCallback", "startingLanguage", "endingLanguage", "flowOutcomeId", "flowOutcomeValue", "flowOutcome"]
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", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
220
+ allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nBlindTransferred", "nConsultTransferred", "nConsult", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
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", "divisionId", "flaggedReason", "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", "surveyId", "surveyFormContextId", "surveyFormId", "surveyAnswerId", "surveyQuestionId", "surveyQuestionGroupId", "systemPresence", "organizationPresenceId", "routingStatus", "flowId", "flowName", "flowVersion", "flowType", "exitReason", "transferType", "transferTargetName", "transferTargetAddress", "issuedCallback", "startingLanguage", "endingLanguage", "flowOutcomeId", "flowOutcomeValue", "flowOutcome"]
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", "divisionId", "flaggedReason", "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", "surveyId", "surveyFormContextId", "surveyFormId", "surveyAnswerId", "surveyQuestionId", "surveyQuestionGroupId", "surveyPromoterScore", "surveyCompletedDate", "systemPresence", "organizationPresenceId", "routingStatus", "flowId", "flowName", "flowVersion", "flowType", "exitReason", "transferType", "transferTargetName", "transferTargetAddress", "issuedCallback", "startingLanguage", "endingLanguage", "flowOutcomeId", "flowOutcomeValue", "flowOutcome"]
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", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
298
+ allowed_values = ["tSegmentDuration", "tConversationDuration", "oTotalCriticalScore", "oTotalScore", "nEvaluations", "tAbandon", "tIvr", "tAnswered", "tFlowOut", "tAcd", "tTalk", "tHeld", "tTalkComplete", "tHeldComplete", "tAcw", "tHandle", "tContacting", "tDialing", "tWait", "tAgentRoutingStatus", "tOrganizationPresence", "tSystemPresence", "tUserResponseTime", "tAgentResponseTime", "tVoicemail", "nStateTransitionError", "nOffered", "nOverSla", "nTransferred", "nBlindTransferred", "nConsultTransferred", "nConsult", "tAlert", "tNotResponding", "nOutbound", "nOutboundAttempted", "nOutboundConnected", "nOutboundAbandoned", "nError", "oServiceTarget", "oServiceLevel", "tActive", "tInactive", "oActiveUsers", "oMemberUsers", "oActiveQueues", "oMemberQueues", "oInteracting", "oWaiting", "oOnQueueUsers", "oOffQueueUsers", "oUserPresences", "oUserRoutingStatuses", "nSurveysSent", "nSurveysStarted", "nSurveysAbandoned", "nSurveysExpired", "nSurveysBounced", "nSurveyResponses", "nSurveyAnswerResponses", "oSurveyTotalScore", "oSurveyQuestionGroupScore", "nSurveyQuestionGroupResponses", "oSurveyQuestionScore", "nSurveyQuestionResponses", "nSurveyNpsResponses", "nSurveyNpsPromoters", "nSurveyNpsDetractors", "nFlow", "tFlowHangUp", "tFlowExit", "tFlow", "tFlowOutcome", "nFlowOutcome"]
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
@@ -27,6 +27,9 @@ module PureCloud
27
27
  # Unique identifier for the survey form, regardless of version
28
28
  attr_accessor :survey_form_context_id
29
29
 
30
+ # Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
31
+ attr_accessor :event_time
32
+
30
33
  # A unique identifier of the PureCloud user
31
34
  attr_accessor :user_id
32
35
 
@@ -42,8 +45,8 @@ module PureCloud
42
45
  # NPS score of the survey
43
46
  attr_accessor :survey_promoter_score
44
47
 
45
- # Completion time of the survey, in ms since the epoch, 1970-01-01T00:00:00.000Z
46
- attr_accessor :survey_completed_time
48
+ # Completion date/time of the survey. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
49
+ attr_accessor :getsurvey_completed_date
47
50
 
48
51
  # Media types associated with the conversation
49
52
  attr_accessor :media_types
@@ -64,6 +67,8 @@ module PureCloud
64
67
 
65
68
  :'survey_form_context_id' => :'surveyFormContextId',
66
69
 
70
+ :'event_time' => :'eventTime',
71
+
67
72
  :'user_id' => :'userId',
68
73
 
69
74
  :'queue_id' => :'queueId',
@@ -74,7 +79,7 @@ module PureCloud
74
79
 
75
80
  :'survey_promoter_score' => :'surveyPromoterScore',
76
81
 
77
- :'survey_completed_time' => :'surveyCompletedTime',
82
+ :'getsurvey_completed_date' => :'getsurveyCompletedDate',
78
83
 
79
84
  :'media_types' => :'mediaTypes',
80
85
 
@@ -95,6 +100,8 @@ module PureCloud
95
100
 
96
101
  :'survey_form_context_id' => :'String',
97
102
 
103
+ :'event_time' => :'DateTime',
104
+
98
105
  :'user_id' => :'String',
99
106
 
100
107
  :'queue_id' => :'String',
@@ -105,7 +112,7 @@ module PureCloud
105
112
 
106
113
  :'survey_promoter_score' => :'Integer',
107
114
 
108
- :'survey_completed_time' => :'Integer',
115
+ :'getsurvey_completed_date' => :'DateTime',
109
116
 
110
117
  :'media_types' => :'Array<String>',
111
118
 
@@ -152,6 +159,15 @@ module PureCloud
152
159
  end
153
160
 
154
161
 
162
+ if attributes.has_key?(:'eventTime')
163
+
164
+
165
+ self.event_time = attributes[:'eventTime']
166
+
167
+
168
+ end
169
+
170
+
155
171
  if attributes.has_key?(:'userId')
156
172
 
157
173
 
@@ -197,10 +213,10 @@ module PureCloud
197
213
  end
198
214
 
199
215
 
200
- if attributes.has_key?(:'surveyCompletedTime')
216
+ if attributes.has_key?(:'getsurveyCompletedDate')
201
217
 
202
218
 
203
- self.survey_completed_time = attributes[:'surveyCompletedTime']
219
+ self.getsurvey_completed_date = attributes[:'getsurveyCompletedDate']
204
220
 
205
221
 
206
222
  end
@@ -297,6 +313,10 @@ module PureCloud
297
313
 
298
314
 
299
315
 
316
+
317
+
318
+
319
+
300
320
 
301
321
 
302
322
 
@@ -359,6 +379,11 @@ module PureCloud
359
379
 
360
380
 
361
381
 
382
+
383
+
384
+
385
+
386
+
362
387
 
363
388
 
364
389
 
@@ -373,12 +398,13 @@ module PureCloud
373
398
  survey_id == o.survey_id &&
374
399
  survey_form_id == o.survey_form_id &&
375
400
  survey_form_context_id == o.survey_form_context_id &&
401
+ event_time == o.event_time &&
376
402
  user_id == o.user_id &&
377
403
  queue_id == o.queue_id &&
378
404
  status == o.status &&
379
405
  geto_survey_total_score == o.geto_survey_total_score &&
380
406
  survey_promoter_score == o.survey_promoter_score &&
381
- survey_completed_time == o.survey_completed_time &&
407
+ getsurvey_completed_date == o.getsurvey_completed_date &&
382
408
  media_types == o.media_types &&
383
409
  language_ids == o.language_ids &&
384
410
  skill_ids == o.skill_ids
@@ -393,7 +419,7 @@ module PureCloud
393
419
  # Calculates hash code according to all attributes.
394
420
  # @return [Fixnum] Hash code
395
421
  def hash
396
- [survey_id, survey_form_id, survey_form_context_id, user_id, queue_id, status, geto_survey_total_score, survey_promoter_score, survey_completed_time, media_types, language_ids, skill_ids].hash
422
+ [survey_id, survey_form_id, survey_form_context_id, event_time, user_id, queue_id, status, geto_survey_total_score, survey_promoter_score, getsurvey_completed_date, media_types, language_ids, skill_ids].hash
397
423
  end
398
424
 
399
425
  # build the object from hash