purecloudplatformclientv2 86.0.0 → 91.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/ApiUsageQuery.md +16 -0
- data/docs/ApiUsageQueryResult.md +14 -0
- data/docs/ApiUsageRow.md +25 -0
- data/docs/ArchitectApi.md +132 -0
- data/docs/AuditApi.md +60 -0
- data/docs/AuditQueryEntity.md +14 -0
- data/docs/AuditQueryExecutionStatusResponse.md +1 -0
- data/docs/AuditQueryRequest.md +1 -0
- data/docs/AuditQueryService.md +14 -0
- data/docs/AuditQueryServiceMapping.md +13 -0
- data/docs/AuditQuerySort.md +14 -0
- data/docs/BuAgentScheduleActivity.md +2 -0
- data/docs/BuRescheduleRequest.md +2 -2
- data/docs/CoachingAnnotation.md +21 -0
- data/docs/CoachingAnnotationCreateRequest.md +14 -0
- data/docs/CoachingAnnotationList.md +22 -0
- data/docs/CoachingApi.md +1132 -0
- data/docs/CoachingAppointmentReference.md +14 -0
- data/docs/CoachingAppointmentResponse.md +27 -0
- data/docs/CoachingAppointmentResponseList.md +22 -0
- data/docs/CoachingAppointmentStatusDto.md +16 -0
- data/docs/CoachingAppointmentStatusDtoList.md +17 -0
- data/docs/CoachingNotification.md +23 -0
- data/docs/CoachingNotificationList.md +22 -0
- data/docs/ConversationAggregationQuery.md +1 -1
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +1 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +1 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationReference.md +14 -0
- data/docs/CreateCoachingAppointmentRequest.md +20 -0
- data/docs/CreateQueueRequest.md +1 -0
- data/docs/DocumentReference.md +14 -0
- data/docs/EntityListing.md +5 -1
- data/docs/EvaluationAggregationQuery.md +1 -1
- data/docs/ExternalContact.md +2 -0
- data/docs/ExternalOrganization.md +2 -0
- data/docs/FlowAggregationQuery.md +1 -1
- data/docs/FlowExecutionLaunchRequest.md +16 -0
- data/docs/FlowExecutionLaunchResponse.md +16 -0
- data/docs/FlowRuntimeExecution.md +23 -0
- data/docs/GenericSAML.md +22 -0
- data/docs/GroupsApi.md +4 -4
- data/docs/IdentityProviderApi.md +187 -0
- data/docs/IpAddressAuthentication.md +13 -0
- data/docs/KnowledgeSearchResponse.md +1 -1
- data/docs/NluDomainVersion.md +1 -0
- data/docs/OAuthApi.md +208 -0
- data/docs/OrganizationApi.md +126 -0
- data/docs/Prompt.md +2 -2
- data/docs/Queue.md +1 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +1 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/QueueRequest.md +1 -0
- data/docs/RecordingApi.md +12 -0
- data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
- data/docs/ScimEmail.md +1 -1
- data/docs/SurveyAggregationQuery.md +1 -1
- data/docs/UpdateCoachingAppointmentRequest.md +18 -0
- data/docs/UploadUrlRequest.md +1 -0
- data/docs/UsageApi.md +144 -0
- data/docs/UsageExecutionResult.md +14 -0
- data/docs/UserAggregationQuery.md +1 -1
- data/docs/UserQueue.md +1 -0
- data/docs/UsersApi.md +5 -5
- data/docs/ViewFilter.md +2 -0
- data/docs/VoicemailMessagesTopicOwner.md +13 -0
- data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
- data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
- data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
- data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
- data/docs/WorkforceManagementApi.md +3 -3
- data/lib/purecloudplatformclientv2.rb +44 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
- data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
- data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
- data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
- data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
- data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
- data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
- data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
- data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
- data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
- data/lib/purecloudplatformclientv2/models/coaching_annotation.rb +429 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto.rb +299 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto_list.rb +303 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +426 -0
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/document_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
- data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
- data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
- data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
- data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +41 -1
- data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
- data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
- data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +337 -0
- data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
- data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb +228 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +90 -2
@@ -27,6 +27,8 @@ module PureCloud
|
|
27
27
|
# The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds
|
28
28
|
attr_accessor :signed_url_timeout_seconds
|
29
29
|
|
30
|
+
attr_accessor :server_side_encryption
|
31
|
+
|
30
32
|
# Attribute mapping from ruby-style variable name to JSON key.
|
31
33
|
def self.attribute_map
|
32
34
|
{
|
@@ -35,7 +37,9 @@ module PureCloud
|
|
35
37
|
|
36
38
|
:'content_md5' => :'contentMd5',
|
37
39
|
|
38
|
-
:'signed_url_timeout_seconds' => :'signedUrlTimeoutSeconds'
|
40
|
+
:'signed_url_timeout_seconds' => :'signedUrlTimeoutSeconds',
|
41
|
+
|
42
|
+
:'server_side_encryption' => :'serverSideEncryption'
|
39
43
|
|
40
44
|
}
|
41
45
|
end
|
@@ -48,7 +52,9 @@ module PureCloud
|
|
48
52
|
|
49
53
|
:'content_md5' => :'String',
|
50
54
|
|
51
|
-
:'signed_url_timeout_seconds' => :'Integer'
|
55
|
+
:'signed_url_timeout_seconds' => :'Integer',
|
56
|
+
|
57
|
+
:'server_side_encryption' => :'String'
|
52
58
|
|
53
59
|
}
|
54
60
|
end
|
@@ -89,6 +95,15 @@ module PureCloud
|
|
89
95
|
end
|
90
96
|
|
91
97
|
|
98
|
+
if attributes.has_key?(:'serverSideEncryption')
|
99
|
+
|
100
|
+
|
101
|
+
self.server_side_encryption = attributes[:'serverSideEncryption']
|
102
|
+
|
103
|
+
|
104
|
+
end
|
105
|
+
|
106
|
+
|
92
107
|
end
|
93
108
|
|
94
109
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -116,6 +131,15 @@ module PureCloud
|
|
116
131
|
|
117
132
|
|
118
133
|
|
134
|
+
|
135
|
+
|
136
|
+
allowed_values = ["AES256"]
|
137
|
+
if @server_side_encryption && !allowed_values.include?(@server_side_encryption)
|
138
|
+
return false
|
139
|
+
end
|
140
|
+
|
141
|
+
|
142
|
+
|
119
143
|
end
|
120
144
|
|
121
145
|
|
@@ -134,6 +158,20 @@ module PureCloud
|
|
134
158
|
|
135
159
|
|
136
160
|
|
161
|
+
|
162
|
+
# Custom attribute writer method checking allowed values (enum).
|
163
|
+
# @param [Object] server_side_encryption Object to be assigned
|
164
|
+
def server_side_encryption=(server_side_encryption)
|
165
|
+
allowed_values = ["AES256"]
|
166
|
+
if server_side_encryption && !allowed_values.include?(server_side_encryption)
|
167
|
+
fail ArgumentError, "invalid value for 'server_side_encryption', must be one of #{allowed_values}."
|
168
|
+
end
|
169
|
+
@server_side_encryption = server_side_encryption
|
170
|
+
end
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
137
175
|
# Checks equality by comparing each attribute.
|
138
176
|
# @param [Object] Object to be compared
|
139
177
|
def ==(o)
|
@@ -141,7 +179,8 @@ module PureCloud
|
|
141
179
|
self.class == o.class &&
|
142
180
|
file_name == o.file_name &&
|
143
181
|
content_md5 == o.content_md5 &&
|
144
|
-
signed_url_timeout_seconds == o.signed_url_timeout_seconds
|
182
|
+
signed_url_timeout_seconds == o.signed_url_timeout_seconds &&
|
183
|
+
server_side_encryption == o.server_side_encryption
|
145
184
|
end
|
146
185
|
|
147
186
|
# @see the `==` method
|
@@ -153,7 +192,7 @@ module PureCloud
|
|
153
192
|
# Calculates hash code according to all attributes.
|
154
193
|
# @return [Fixnum] Hash code
|
155
194
|
def hash
|
156
|
-
[file_name, content_md5, signed_url_timeout_seconds].hash
|
195
|
+
[file_name, content_md5, signed_url_timeout_seconds, server_side_encryption].hash
|
157
196
|
end
|
158
197
|
|
159
198
|
# build the object from hash
|
@@ -0,0 +1,228 @@
|
|
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: UNLICENSED
|
11
|
+
https://help.mypurecloud.com/articles/terms-and-conditions/
|
12
|
+
|
13
|
+
Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require 'date'
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class UsageExecutionResult
|
21
|
+
# The id of the query execution
|
22
|
+
attr_accessor :execution_id
|
23
|
+
|
24
|
+
# URI where the query results can be retrieved
|
25
|
+
attr_accessor :results_uri
|
26
|
+
|
27
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
28
|
+
def self.attribute_map
|
29
|
+
{
|
30
|
+
|
31
|
+
:'execution_id' => :'executionId',
|
32
|
+
|
33
|
+
:'results_uri' => :'resultsUri'
|
34
|
+
|
35
|
+
}
|
36
|
+
end
|
37
|
+
|
38
|
+
# Attribute type mapping.
|
39
|
+
def self.swagger_types
|
40
|
+
{
|
41
|
+
|
42
|
+
:'execution_id' => :'String',
|
43
|
+
|
44
|
+
:'results_uri' => :'String'
|
45
|
+
|
46
|
+
}
|
47
|
+
end
|
48
|
+
|
49
|
+
# Initializes the object
|
50
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
51
|
+
def initialize(attributes = {})
|
52
|
+
return unless attributes.is_a?(Hash)
|
53
|
+
|
54
|
+
# convert string to symbol for hash key
|
55
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
56
|
+
|
57
|
+
|
58
|
+
if attributes.has_key?(:'executionId')
|
59
|
+
|
60
|
+
|
61
|
+
self.execution_id = attributes[:'executionId']
|
62
|
+
|
63
|
+
|
64
|
+
end
|
65
|
+
|
66
|
+
|
67
|
+
if attributes.has_key?(:'resultsUri')
|
68
|
+
|
69
|
+
|
70
|
+
self.results_uri = attributes[:'resultsUri']
|
71
|
+
|
72
|
+
|
73
|
+
end
|
74
|
+
|
75
|
+
|
76
|
+
end
|
77
|
+
|
78
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
79
|
+
# @return Array for valid properies with the reasons
|
80
|
+
def list_invalid_properties
|
81
|
+
invalid_properties = Array.new
|
82
|
+
|
83
|
+
|
84
|
+
return invalid_properties
|
85
|
+
end
|
86
|
+
|
87
|
+
# Check to see if the all the properties in the model are valid
|
88
|
+
# @return true if the model is valid
|
89
|
+
def valid?
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
|
99
|
+
end
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
# Checks equality by comparing each attribute.
|
113
|
+
# @param [Object] Object to be compared
|
114
|
+
def ==(o)
|
115
|
+
return true if self.equal?(o)
|
116
|
+
self.class == o.class &&
|
117
|
+
execution_id == o.execution_id &&
|
118
|
+
results_uri == o.results_uri
|
119
|
+
end
|
120
|
+
|
121
|
+
# @see the `==` method
|
122
|
+
# @param [Object] Object to be compared
|
123
|
+
def eql?(o)
|
124
|
+
self == o
|
125
|
+
end
|
126
|
+
|
127
|
+
# Calculates hash code according to all attributes.
|
128
|
+
# @return [Fixnum] Hash code
|
129
|
+
def hash
|
130
|
+
[execution_id, results_uri].hash
|
131
|
+
end
|
132
|
+
|
133
|
+
# build the object from hash
|
134
|
+
def build_from_hash(attributes)
|
135
|
+
return nil unless attributes.is_a?(Hash)
|
136
|
+
self.class.swagger_types.each_pair do |key, type|
|
137
|
+
if type =~ /^Array<(.*)>/i
|
138
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
139
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
140
|
+
else
|
141
|
+
#TODO show warning in debug mode
|
142
|
+
end
|
143
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
144
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
145
|
+
else
|
146
|
+
# data not found in attributes(hash), not an issue as the data can be optional
|
147
|
+
end
|
148
|
+
end
|
149
|
+
|
150
|
+
self
|
151
|
+
end
|
152
|
+
|
153
|
+
def _deserialize(type, value)
|
154
|
+
case type.to_sym
|
155
|
+
when :DateTime
|
156
|
+
DateTime.parse(value)
|
157
|
+
when :Date
|
158
|
+
Date.parse(value)
|
159
|
+
when :String
|
160
|
+
value.to_s
|
161
|
+
when :Integer
|
162
|
+
value.to_i
|
163
|
+
when :Float
|
164
|
+
value.to_f
|
165
|
+
when :BOOLEAN
|
166
|
+
if value.to_s =~ /^(true|t|yes|y|1)$/i
|
167
|
+
true
|
168
|
+
else
|
169
|
+
false
|
170
|
+
end
|
171
|
+
when :Object
|
172
|
+
# generic object (usually a Hash), return directly
|
173
|
+
value
|
174
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
175
|
+
inner_type = Regexp.last_match[:inner_type]
|
176
|
+
value.map { |v| _deserialize(inner_type, v) }
|
177
|
+
when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
|
178
|
+
k_type = Regexp.last_match[:k_type]
|
179
|
+
v_type = Regexp.last_match[:v_type]
|
180
|
+
{}.tap do |hash|
|
181
|
+
value.each do |k, v|
|
182
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
183
|
+
end
|
184
|
+
end
|
185
|
+
else # model
|
186
|
+
_model = Object.const_get("PureCloud").const_get(type).new
|
187
|
+
_model.build_from_hash(value)
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
def to_s
|
192
|
+
to_hash.to_s
|
193
|
+
end
|
194
|
+
|
195
|
+
# to_body is an alias to to_body (backward compatibility))
|
196
|
+
def to_body
|
197
|
+
to_hash
|
198
|
+
end
|
199
|
+
|
200
|
+
# return the object in the form of hash
|
201
|
+
def to_hash
|
202
|
+
hash = {}
|
203
|
+
self.class.attribute_map.each_pair do |attr, param|
|
204
|
+
value = self.send(attr)
|
205
|
+
next if value.nil?
|
206
|
+
hash[param] = _to_hash(value)
|
207
|
+
end
|
208
|
+
hash
|
209
|
+
end
|
210
|
+
|
211
|
+
# Method to output non-array value in the form of hash
|
212
|
+
# For object, use to_hash. Otherwise, just return the value
|
213
|
+
def _to_hash(value)
|
214
|
+
if value.is_a?(Array)
|
215
|
+
value.compact.map{ |v| _to_hash(v) }
|
216
|
+
elsif value.is_a?(Hash)
|
217
|
+
{}.tap do |hash|
|
218
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
219
|
+
end
|
220
|
+
elsif value.respond_to? :to_hash
|
221
|
+
value.to_hash
|
222
|
+
else
|
223
|
+
value
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
end
|
228
|
+
end
|
@@ -24,7 +24,7 @@ module PureCloud
|
|
24
24
|
# Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
|
25
25
|
attr_accessor :granularity
|
26
26
|
|
27
|
-
#
|
27
|
+
# Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
|
28
28
|
attr_accessor :time_zone
|
29
29
|
|
30
30
|
# Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
|
@@ -47,6 +47,9 @@ module PureCloud
|
|
47
47
|
# The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM
|
48
48
|
attr_accessor :media_settings
|
49
49
|
|
50
|
+
# The routing rules for the queue, used for routing to known or preferred agents.
|
51
|
+
attr_accessor :routing_rules
|
52
|
+
|
50
53
|
# The bulls-eye settings for the queue.
|
51
54
|
attr_accessor :bullseye
|
52
55
|
|
@@ -105,6 +108,8 @@ module PureCloud
|
|
105
108
|
|
106
109
|
:'media_settings' => :'mediaSettings',
|
107
110
|
|
111
|
+
:'routing_rules' => :'routingRules',
|
112
|
+
|
108
113
|
:'bullseye' => :'bullseye',
|
109
114
|
|
110
115
|
:'acw_settings' => :'acwSettings',
|
@@ -156,6 +161,8 @@ module PureCloud
|
|
156
161
|
|
157
162
|
:'media_settings' => :'Hash<String, MediaSetting>',
|
158
163
|
|
164
|
+
:'routing_rules' => :'Array<RoutingRule>',
|
165
|
+
|
159
166
|
:'bullseye' => :'Bullseye',
|
160
167
|
|
161
168
|
:'acw_settings' => :'AcwSettings',
|
@@ -281,6 +288,17 @@ module PureCloud
|
|
281
288
|
|
282
289
|
|
283
290
|
|
291
|
+
end
|
292
|
+
|
293
|
+
|
294
|
+
if attributes.has_key?(:'routingRules')
|
295
|
+
|
296
|
+
if (value = attributes[:'routingRules']).is_a?(Array)
|
297
|
+
self.routing_rules = value
|
298
|
+
end
|
299
|
+
|
300
|
+
|
301
|
+
|
284
302
|
end
|
285
303
|
|
286
304
|
|
@@ -454,6 +472,10 @@ module PureCloud
|
|
454
472
|
|
455
473
|
|
456
474
|
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
|
457
479
|
|
458
480
|
|
459
481
|
|
@@ -560,6 +582,11 @@ module PureCloud
|
|
560
582
|
|
561
583
|
|
562
584
|
|
585
|
+
|
586
|
+
|
587
|
+
|
588
|
+
|
589
|
+
|
563
590
|
|
564
591
|
|
565
592
|
|
@@ -639,6 +666,7 @@ module PureCloud
|
|
639
666
|
created_by == o.created_by &&
|
640
667
|
member_count == o.member_count &&
|
641
668
|
media_settings == o.media_settings &&
|
669
|
+
routing_rules == o.routing_rules &&
|
642
670
|
bullseye == o.bullseye &&
|
643
671
|
acw_settings == o.acw_settings &&
|
644
672
|
skill_evaluation_method == o.skill_evaluation_method &&
|
@@ -662,7 +690,7 @@ module PureCloud
|
|
662
690
|
# Calculates hash code according to all attributes.
|
663
691
|
# @return [Fixnum] Hash code
|
664
692
|
def hash
|
665
|
-
[id, name, division, description, date_created, date_modified, modified_by, created_by, member_count, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper_prompt, calling_party_name, calling_party_number, default_scripts, outbound_messaging_addresses, outbound_email_address, joined, self_uri].hash
|
693
|
+
[id, name, division, description, date_created, date_modified, modified_by, created_by, member_count, media_settings, routing_rules, bullseye, acw_settings, skill_evaluation_method, queue_flow, whisper_prompt, calling_party_name, calling_party_number, default_scripts, outbound_messaging_addresses, outbound_email_address, joined, self_uri].hash
|
666
694
|
end
|
667
695
|
|
668
696
|
# build the object from hash
|
@@ -252,6 +252,12 @@ module PureCloud
|
|
252
252
|
# A list of providers
|
253
253
|
attr_accessor :provider_list
|
254
254
|
|
255
|
+
# A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"])
|
256
|
+
attr_accessor :callback_number_list
|
257
|
+
|
258
|
+
# An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
259
|
+
attr_accessor :callback_interval
|
260
|
+
|
255
261
|
# Attribute mapping from ruby-style variable name to JSON key.
|
256
262
|
def self.attribute_map
|
257
263
|
{
|
@@ -410,7 +416,11 @@ module PureCloud
|
|
410
416
|
|
411
417
|
:'flow_out_types' => :'flowOutTypes',
|
412
418
|
|
413
|
-
:'provider_list' => :'providerList'
|
419
|
+
:'provider_list' => :'providerList',
|
420
|
+
|
421
|
+
:'callback_number_list' => :'callbackNumberList',
|
422
|
+
|
423
|
+
:'callback_interval' => :'callbackInterval'
|
414
424
|
|
415
425
|
}
|
416
426
|
end
|
@@ -573,7 +583,11 @@ module PureCloud
|
|
573
583
|
|
574
584
|
:'flow_out_types' => :'Array<String>',
|
575
585
|
|
576
|
-
:'provider_list' => :'Array<String>'
|
586
|
+
:'provider_list' => :'Array<String>',
|
587
|
+
|
588
|
+
:'callback_number_list' => :'Array<String>',
|
589
|
+
|
590
|
+
:'callback_interval' => :'String'
|
577
591
|
|
578
592
|
}
|
579
593
|
end
|
@@ -1403,6 +1417,26 @@ module PureCloud
|
|
1403
1417
|
end
|
1404
1418
|
|
1405
1419
|
|
1420
|
+
if attributes.has_key?(:'callbackNumberList')
|
1421
|
+
|
1422
|
+
if (value = attributes[:'callbackNumberList']).is_a?(Array)
|
1423
|
+
self.callback_number_list = value
|
1424
|
+
end
|
1425
|
+
|
1426
|
+
|
1427
|
+
|
1428
|
+
end
|
1429
|
+
|
1430
|
+
|
1431
|
+
if attributes.has_key?(:'callbackInterval')
|
1432
|
+
|
1433
|
+
|
1434
|
+
self.callback_interval = attributes[:'callbackInterval']
|
1435
|
+
|
1436
|
+
|
1437
|
+
end
|
1438
|
+
|
1439
|
+
|
1406
1440
|
end
|
1407
1441
|
|
1408
1442
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -1721,6 +1755,14 @@ module PureCloud
|
|
1721
1755
|
|
1722
1756
|
|
1723
1757
|
|
1758
|
+
|
1759
|
+
|
1760
|
+
|
1761
|
+
|
1762
|
+
|
1763
|
+
|
1764
|
+
|
1765
|
+
|
1724
1766
|
|
1725
1767
|
|
1726
1768
|
|
@@ -2112,6 +2154,16 @@ module PureCloud
|
|
2112
2154
|
|
2113
2155
|
|
2114
2156
|
|
2157
|
+
|
2158
|
+
|
2159
|
+
|
2160
|
+
|
2161
|
+
|
2162
|
+
|
2163
|
+
|
2164
|
+
|
2165
|
+
|
2166
|
+
|
2115
2167
|
|
2116
2168
|
|
2117
2169
|
|
@@ -2205,7 +2257,9 @@ module PureCloud
|
|
2205
2257
|
reports_tos == o.reports_tos &&
|
2206
2258
|
location_ids == o.location_ids &&
|
2207
2259
|
flow_out_types == o.flow_out_types &&
|
2208
|
-
provider_list == o.provider_list
|
2260
|
+
provider_list == o.provider_list &&
|
2261
|
+
callback_number_list == o.callback_number_list &&
|
2262
|
+
callback_interval == o.callback_interval
|
2209
2263
|
end
|
2210
2264
|
|
2211
2265
|
# @see the `==` method
|
@@ -2217,7 +2271,7 @@ module PureCloud
|
|
2217
2271
|
# Calculates hash code according to all attributes.
|
2218
2272
|
# @return [Fixnum] Hash code
|
2219
2273
|
def hash
|
2220
|
-
[media_types, queue_ids, skill_ids, skill_groups, language_ids, language_groups, directions, originating_directions, wrap_up_codes, dnis_list, session_dnis_list, filter_queues_by_user_ids, filter_users_by_queue_ids, user_ids, address_tos, address_froms, outbound_campaign_ids, outbound_contact_list_ids, contact_ids, external_contact_ids, external_org_ids, ani_list, durations_milliseconds, acd_durations_milliseconds, talk_durations_milliseconds, acw_durations_milliseconds, handle_durations_milliseconds, hold_durations_milliseconds, abandon_durations_milliseconds, evaluation_score, evaluation_critical_score, evaluation_form_ids, evaluated_agent_ids, evaluator_ids, transferred, abandoned, answered, message_types, division_ids, survey_form_ids, survey_total_score, survey_nps_score, mos, survey_question_group_score, survey_promoter_score, survey_form_context_ids, conversation_ids, sip_call_ids, is_ended, is_surveyed, survey_scores, promoter_scores, is_campaign, survey_statuses, conversation_properties, is_blind_transferred, is_consulted, is_consult_transferred, remote_participants, flow_ids, flow_outcome_ids, flow_outcome_values, flow_destination_types, flow_disconnect_reasons, flow_types, flow_entry_types, flow_entry_reasons, flow_versions, group_ids, has_journey_customer_id, has_journey_action_map_id, has_journey_visit_id, has_media, role_ids, reports_tos, location_ids, flow_out_types, provider_list].hash
|
2274
|
+
[media_types, queue_ids, skill_ids, skill_groups, language_ids, language_groups, directions, originating_directions, wrap_up_codes, dnis_list, session_dnis_list, filter_queues_by_user_ids, filter_users_by_queue_ids, user_ids, address_tos, address_froms, outbound_campaign_ids, outbound_contact_list_ids, contact_ids, external_contact_ids, external_org_ids, ani_list, durations_milliseconds, acd_durations_milliseconds, talk_durations_milliseconds, acw_durations_milliseconds, handle_durations_milliseconds, hold_durations_milliseconds, abandon_durations_milliseconds, evaluation_score, evaluation_critical_score, evaluation_form_ids, evaluated_agent_ids, evaluator_ids, transferred, abandoned, answered, message_types, division_ids, survey_form_ids, survey_total_score, survey_nps_score, mos, survey_question_group_score, survey_promoter_score, survey_form_context_ids, conversation_ids, sip_call_ids, is_ended, is_surveyed, survey_scores, promoter_scores, is_campaign, survey_statuses, conversation_properties, is_blind_transferred, is_consulted, is_consult_transferred, remote_participants, flow_ids, flow_outcome_ids, flow_outcome_values, flow_destination_types, flow_disconnect_reasons, flow_types, flow_entry_types, flow_entry_reasons, flow_versions, group_ids, has_journey_customer_id, has_journey_action_map_id, has_journey_visit_id, has_media, role_ids, reports_tos, location_ids, flow_out_types, provider_list, callback_number_list, callback_interval].hash
|
2221
2275
|
end
|
2222
2276
|
|
2223
2277
|
# build the object from hash
|