purecloudplatformclientv2 86.0.0 → 91.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 (241) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/ApiUsageQuery.md +16 -0
  5. data/docs/ApiUsageQueryResult.md +14 -0
  6. data/docs/ApiUsageRow.md +25 -0
  7. data/docs/ArchitectApi.md +132 -0
  8. data/docs/AuditApi.md +60 -0
  9. data/docs/AuditQueryEntity.md +14 -0
  10. data/docs/AuditQueryExecutionStatusResponse.md +1 -0
  11. data/docs/AuditQueryRequest.md +1 -0
  12. data/docs/AuditQueryService.md +14 -0
  13. data/docs/AuditQueryServiceMapping.md +13 -0
  14. data/docs/AuditQuerySort.md +14 -0
  15. data/docs/BuAgentScheduleActivity.md +2 -0
  16. data/docs/BuRescheduleRequest.md +2 -2
  17. data/docs/CoachingAnnotation.md +21 -0
  18. data/docs/CoachingAnnotationCreateRequest.md +14 -0
  19. data/docs/CoachingAnnotationList.md +22 -0
  20. data/docs/CoachingApi.md +1132 -0
  21. data/docs/CoachingAppointmentReference.md +14 -0
  22. data/docs/CoachingAppointmentResponse.md +27 -0
  23. data/docs/CoachingAppointmentResponseList.md +22 -0
  24. data/docs/CoachingAppointmentStatusDto.md +16 -0
  25. data/docs/CoachingAppointmentStatusDtoList.md +17 -0
  26. data/docs/CoachingNotification.md +23 -0
  27. data/docs/CoachingNotificationList.md +22 -0
  28. data/docs/ConversationAggregationQuery.md +1 -1
  29. data/docs/ConversationEventTopicCall.md +1 -0
  30. data/docs/ConversationEventTopicCallback.md +1 -0
  31. data/docs/ConversationEventTopicChat.md +1 -0
  32. data/docs/ConversationEventTopicCobrowse.md +1 -0
  33. data/docs/ConversationEventTopicEmail.md +1 -0
  34. data/docs/ConversationEventTopicMessage.md +1 -0
  35. data/docs/ConversationEventTopicScreenshare.md +1 -0
  36. data/docs/ConversationEventTopicSocialExpression.md +1 -0
  37. data/docs/ConversationEventTopicVideo.md +1 -0
  38. data/docs/ConversationReference.md +14 -0
  39. data/docs/CreateCoachingAppointmentRequest.md +20 -0
  40. data/docs/CreateQueueRequest.md +1 -0
  41. data/docs/DocumentReference.md +14 -0
  42. data/docs/EntityListing.md +5 -1
  43. data/docs/EvaluationAggregationQuery.md +1 -1
  44. data/docs/ExternalContact.md +2 -0
  45. data/docs/ExternalOrganization.md +2 -0
  46. data/docs/FlowAggregationQuery.md +1 -1
  47. data/docs/FlowExecutionLaunchRequest.md +16 -0
  48. data/docs/FlowExecutionLaunchResponse.md +16 -0
  49. data/docs/FlowRuntimeExecution.md +23 -0
  50. data/docs/GenericSAML.md +22 -0
  51. data/docs/GroupsApi.md +4 -4
  52. data/docs/IdentityProviderApi.md +187 -0
  53. data/docs/IpAddressAuthentication.md +13 -0
  54. data/docs/KnowledgeSearchResponse.md +1 -1
  55. data/docs/NluDomainVersion.md +1 -0
  56. data/docs/OAuthApi.md +208 -0
  57. data/docs/OrganizationApi.md +126 -0
  58. data/docs/Prompt.md +2 -2
  59. data/docs/Queue.md +1 -0
  60. data/docs/QueueConversationEventTopicCall.md +1 -0
  61. data/docs/QueueConversationEventTopicCallback.md +1 -0
  62. data/docs/QueueConversationEventTopicChat.md +1 -0
  63. data/docs/QueueConversationEventTopicCobrowse.md +1 -0
  64. data/docs/QueueConversationEventTopicEmail.md +1 -0
  65. data/docs/QueueConversationEventTopicMessage.md +1 -0
  66. data/docs/QueueConversationEventTopicScreenshare.md +1 -0
  67. data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
  68. data/docs/QueueConversationEventTopicVideo.md +1 -0
  69. data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
  70. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  71. data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
  72. data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
  73. data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
  74. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
  75. data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
  76. data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
  77. data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
  78. data/docs/QueueConversationVideoEventTopicCall.md +1 -0
  79. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  80. data/docs/QueueConversationVideoEventTopicChat.md +1 -0
  81. data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
  82. data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
  83. data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
  84. data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
  85. data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
  86. data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
  87. data/docs/QueueRequest.md +1 -0
  88. data/docs/RecordingApi.md +12 -0
  89. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  90. data/docs/ScimEmail.md +1 -1
  91. data/docs/SurveyAggregationQuery.md +1 -1
  92. data/docs/UpdateCoachingAppointmentRequest.md +18 -0
  93. data/docs/UploadUrlRequest.md +1 -0
  94. data/docs/UsageApi.md +144 -0
  95. data/docs/UsageExecutionResult.md +14 -0
  96. data/docs/UserAggregationQuery.md +1 -1
  97. data/docs/UserQueue.md +1 -0
  98. data/docs/UsersApi.md +5 -5
  99. data/docs/ViewFilter.md +2 -0
  100. data/docs/VoicemailMessagesTopicOwner.md +13 -0
  101. data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
  102. data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
  103. data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
  104. data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
  105. data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
  106. data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
  107. data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
  108. data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
  109. data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
  110. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
  111. data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
  112. data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
  113. data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
  114. data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
  115. data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
  116. data/docs/WorkforceManagementApi.md +3 -3
  117. data/lib/purecloudplatformclientv2.rb +44 -0
  118. data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
  119. data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
  120. data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
  121. data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
  122. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
  123. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
  124. data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
  125. data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
  126. data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
  127. data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
  128. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
  129. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  130. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  131. data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
  132. data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
  133. data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
  134. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  135. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
  136. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
  137. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
  138. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
  139. data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
  140. data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
  141. data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
  142. data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
  143. data/lib/purecloudplatformclientv2/models/coaching_annotation.rb +429 -0
  144. data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
  145. data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
  146. data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
  147. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
  148. data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
  149. data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto.rb +299 -0
  150. data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto_list.rb +303 -0
  151. data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
  152. data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
  153. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  154. data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
  155. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +2 -2
  156. data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
  157. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  158. data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
  159. data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
  160. data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
  161. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
  162. data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
  163. data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
  164. data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
  165. data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
  166. data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +426 -0
  167. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
  168. data/lib/purecloudplatformclientv2/models/document_reference.rb +228 -0
  169. data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
  170. data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
  171. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  172. data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
  173. data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
  174. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  175. data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
  176. data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
  177. data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
  178. data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
  179. data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
  180. data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
  181. data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
  182. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +41 -1
  183. data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
  184. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
  185. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
  186. data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
  187. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
  188. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  189. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
  190. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
  191. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
  192. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
  193. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
  194. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
  195. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
  196. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
  197. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  198. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
  199. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
  200. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
  201. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
  202. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
  203. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
  204. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
  205. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
  206. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  207. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
  208. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
  209. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
  210. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
  211. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
  212. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
  213. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
  214. data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
  215. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
  216. data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
  217. data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
  218. data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +337 -0
  219. data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
  220. data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
  221. data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
  222. data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
  223. data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
  224. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
  225. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
  226. data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
  227. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb +228 -0
  228. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
  229. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
  230. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
  231. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_module_reference.rb +226 -0
  232. data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_user_reference.rb +201 -0
  233. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
  234. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
  235. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
  236. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
  237. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
  238. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
  239. data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
  240. data/lib/purecloudplatformclientv2/version.rb +1 -1
  241. metadata +90 -2
@@ -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 DocumentReference
21
+ # The globally unique identifier for the object.
22
+ attr_accessor :id
23
+
24
+ # The URI for this object
25
+ attr_accessor :self_uri
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+
31
+ :'id' => :'id',
32
+
33
+ :'self_uri' => :'selfUri'
34
+
35
+ }
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.swagger_types
40
+ {
41
+
42
+ :'id' => :'String',
43
+
44
+ :'self_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?(:'id')
59
+
60
+
61
+ self.id = attributes[:'id']
62
+
63
+
64
+ end
65
+
66
+
67
+ if attributes.has_key?(:'selfUri')
68
+
69
+
70
+ self.self_uri = attributes[:'selfUri']
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
+ id == o.id &&
118
+ self_uri == o.self_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
+ [id, self_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
@@ -20,11 +20,27 @@ module PureCloud
20
20
  class EntityListing
21
21
  attr_accessor :entities
22
22
 
23
+ attr_accessor :page_size
24
+
25
+ attr_accessor :page_number
26
+
27
+ attr_accessor :total
28
+
29
+ attr_accessor :page_count
30
+
23
31
  # Attribute mapping from ruby-style variable name to JSON key.
24
32
  def self.attribute_map
25
33
  {
26
34
 
27
- :'entities' => :'entities'
35
+ :'entities' => :'entities',
36
+
37
+ :'page_size' => :'pageSize',
38
+
39
+ :'page_number' => :'pageNumber',
40
+
41
+ :'total' => :'total',
42
+
43
+ :'page_count' => :'pageCount'
28
44
 
29
45
  }
30
46
  end
@@ -33,7 +49,15 @@ module PureCloud
33
49
  def self.swagger_types
34
50
  {
35
51
 
36
- :'entities' => :'Array<Object>'
52
+ :'entities' => :'Array<DataTableImportJob>',
53
+
54
+ :'page_size' => :'Integer',
55
+
56
+ :'page_number' => :'Integer',
57
+
58
+ :'total' => :'Integer',
59
+
60
+ :'page_count' => :'Integer'
37
61
 
38
62
  }
39
63
  end
@@ -58,6 +82,42 @@ module PureCloud
58
82
  end
59
83
 
60
84
 
85
+ if attributes.has_key?(:'pageSize')
86
+
87
+
88
+ self.page_size = attributes[:'pageSize']
89
+
90
+
91
+ end
92
+
93
+
94
+ if attributes.has_key?(:'pageNumber')
95
+
96
+
97
+ self.page_number = attributes[:'pageNumber']
98
+
99
+
100
+ end
101
+
102
+
103
+ if attributes.has_key?(:'total')
104
+
105
+
106
+ self.total = attributes[:'total']
107
+
108
+
109
+ end
110
+
111
+
112
+ if attributes.has_key?(:'pageCount')
113
+
114
+
115
+ self.page_count = attributes[:'pageCount']
116
+
117
+
118
+ end
119
+
120
+
61
121
  end
62
122
 
63
123
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -72,6 +132,22 @@ module PureCloud
72
132
  # Check to see if the all the properties in the model are valid
73
133
  # @return true if the model is valid
74
134
  def valid?
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
75
151
 
76
152
 
77
153
 
@@ -84,13 +160,37 @@ module PureCloud
84
160
 
85
161
 
86
162
 
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
87
183
 
88
184
  # Checks equality by comparing each attribute.
89
185
  # @param [Object] Object to be compared
90
186
  def ==(o)
91
187
  return true if self.equal?(o)
92
188
  self.class == o.class &&
93
- entities == o.entities
189
+ entities == o.entities &&
190
+ page_size == o.page_size &&
191
+ page_number == o.page_number &&
192
+ total == o.total &&
193
+ page_count == o.page_count
94
194
  end
95
195
 
96
196
  # @see the `==` method
@@ -102,7 +202,7 @@ module PureCloud
102
202
  # Calculates hash code according to all attributes.
103
203
  # @return [Fixnum] Hash code
104
204
  def hash
105
- [entities].hash
205
+ [entities, page_size, page_number, total, page_count].hash
106
206
  end
107
207
 
108
208
  # build the object from hash
@@ -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
- # Sets the time zone for the query interval, defaults to 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
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.
@@ -152,7 +152,7 @@ module PureCloud
152
152
 
153
153
 
154
154
 
155
- allowed_values = ["APPROACHING_CONTACT_LIMIT", "APPROACHING_ENTITY_LIMIT", "AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID", "CAMPAIGN_START_ERROR", "CAMPAIGN_RULE_START_ERROR", "CAMPAIGN_SET_DIALING_MODE_ERROR", "CAMPAIGN_STOPPED", "CAMPAIGN_THROTTLED", "INVALID_CALLABLE_TIME_ZONE", "CALLBACK_CREATION_INVALID_NUMBER", "CALL_RULE_INVALID_CONTACT_COLUMN", "CALL_RULE_MISSING_DATA_ACTION_INPUT", "CALL_RULE_MISMATCH_TYPE", "CALL_RULE_INVALID_OPERATOR", "CALL_RULE_NO_DNC_LISTS_CONFIGURED", "CALL_RULE_UPDATED_PHONE_COLUMN", "CONTACT_LIST_FILTER_EVALUATION_FAILED", "CONTACT_LIST_FILTER_INTERNAL_ERROR", "CONTACT_COLUMNS_LIMIT_EXCEEDED", "CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED", "CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED", "CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "DATA_ACTION_EXECUTION_FAILED", "DATA_ACTION_AUTHENTICATION_FAILURE", "DATA_ACTION_NOT_FOUND", "DNC_AUTHENTICATION_FAILURE", "EXCEEDED_CONTACT_LIMIT", "INACTIVE_EDGES_FAILED_PLACE_CALLS", "INACTIVE_EDGES_TURNED_CAMPAIGN_OFF", "INVALID_PHONE_NUMBER", "IMPORT_FAILED_TO_READ_HEADERS", "IMPORT_COULD_NOT_PARSE_AN_ENTRY", "IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT", "IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS", "IMPORT_INVALID_CUSTOM_ID", "IMPORT_INVALID_DATA", "IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT", "IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT", "IMPORT_MISSING_CUSTOM_ID", "IMPORT_NO_COLUMNS_DEFINED", "IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST", "IMPORT_LIST_NO_LONGER_EXISTS", "IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "IMPORT_TOO_MANY_COLUMNS", "ORGANIZATION_HAS_NO_DOMAIN_SET", "RECYCLE_CAMPAIGN"]
155
+ allowed_values = ["APPROACHING_CONTACT_LIMIT", "APPROACHING_ENTITY_LIMIT", "AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID", "CAMPAIGN_START_ERROR", "CAMPAIGN_RULE_START_ERROR", "CAMPAIGN_SET_DIALING_MODE_ERROR", "CAMPAIGN_STOPPED", "CAMPAIGN_THROTTLED", "CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED", "INVALID_CALLABLE_TIME_ZONE", "CALLBACK_CREATION_INVALID_NUMBER", "CALL_RULE_INVALID_CONTACT_COLUMN", "CALL_RULE_MISSING_DATA_ACTION_INPUT", "CALL_RULE_MISMATCH_TYPE", "CALL_RULE_INVALID_OPERATOR", "CALL_RULE_NO_DNC_LISTS_CONFIGURED", "CALL_RULE_UPDATED_PHONE_COLUMN", "CONTACT_LIST_FILTER_EVALUATION_FAILED", "CONTACT_LIST_FILTER_INTERNAL_ERROR", "CONTACT_COLUMNS_LIMIT_EXCEEDED", "CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED", "CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED", "CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "DATA_ACTION_EXECUTION_FAILED", "DATA_ACTION_AUTHENTICATION_FAILURE", "DATA_ACTION_NOT_FOUND", "DNC_AUTHENTICATION_FAILURE", "EXCEEDED_CONTACT_LIMIT", "INACTIVE_EDGES_FAILED_PLACE_CALLS", "INACTIVE_EDGES_TURNED_CAMPAIGN_OFF", "INVALID_PHONE_NUMBER", "IMPORT_FAILED_TO_READ_HEADERS", "IMPORT_COULD_NOT_PARSE_AN_ENTRY", "IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT", "IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS", "IMPORT_INVALID_CUSTOM_ID", "IMPORT_INVALID_DATA", "IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT", "IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT", "IMPORT_MISSING_CUSTOM_ID", "IMPORT_NO_COLUMNS_DEFINED", "IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST", "IMPORT_LIST_NO_LONGER_EXISTS", "IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "IMPORT_TOO_MANY_COLUMNS", "ORGANIZATION_HAS_NO_DOMAIN_SET", "RECYCLE_CAMPAIGN"]
156
156
  if @code && !allowed_values.include?(@code)
157
157
  return false
158
158
  end
@@ -186,7 +186,7 @@ module PureCloud
186
186
  # Custom attribute writer method checking allowed values (enum).
187
187
  # @param [Object] code Object to be assigned
188
188
  def code=(code)
189
- allowed_values = ["APPROACHING_CONTACT_LIMIT", "APPROACHING_ENTITY_LIMIT", "AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID", "CAMPAIGN_START_ERROR", "CAMPAIGN_RULE_START_ERROR", "CAMPAIGN_SET_DIALING_MODE_ERROR", "CAMPAIGN_STOPPED", "CAMPAIGN_THROTTLED", "INVALID_CALLABLE_TIME_ZONE", "CALLBACK_CREATION_INVALID_NUMBER", "CALL_RULE_INVALID_CONTACT_COLUMN", "CALL_RULE_MISSING_DATA_ACTION_INPUT", "CALL_RULE_MISMATCH_TYPE", "CALL_RULE_INVALID_OPERATOR", "CALL_RULE_NO_DNC_LISTS_CONFIGURED", "CALL_RULE_UPDATED_PHONE_COLUMN", "CONTACT_LIST_FILTER_EVALUATION_FAILED", "CONTACT_LIST_FILTER_INTERNAL_ERROR", "CONTACT_COLUMNS_LIMIT_EXCEEDED", "CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED", "CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED", "CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "DATA_ACTION_EXECUTION_FAILED", "DATA_ACTION_AUTHENTICATION_FAILURE", "DATA_ACTION_NOT_FOUND", "DNC_AUTHENTICATION_FAILURE", "EXCEEDED_CONTACT_LIMIT", "INACTIVE_EDGES_FAILED_PLACE_CALLS", "INACTIVE_EDGES_TURNED_CAMPAIGN_OFF", "INVALID_PHONE_NUMBER", "IMPORT_FAILED_TO_READ_HEADERS", "IMPORT_COULD_NOT_PARSE_AN_ENTRY", "IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT", "IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS", "IMPORT_INVALID_CUSTOM_ID", "IMPORT_INVALID_DATA", "IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT", "IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT", "IMPORT_MISSING_CUSTOM_ID", "IMPORT_NO_COLUMNS_DEFINED", "IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST", "IMPORT_LIST_NO_LONGER_EXISTS", "IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "IMPORT_TOO_MANY_COLUMNS", "ORGANIZATION_HAS_NO_DOMAIN_SET", "RECYCLE_CAMPAIGN"]
189
+ allowed_values = ["APPROACHING_CONTACT_LIMIT", "APPROACHING_ENTITY_LIMIT", "AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID", "CAMPAIGN_START_ERROR", "CAMPAIGN_RULE_START_ERROR", "CAMPAIGN_SET_DIALING_MODE_ERROR", "CAMPAIGN_STOPPED", "CAMPAIGN_THROTTLED", "CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED", "INVALID_CALLABLE_TIME_ZONE", "CALLBACK_CREATION_INVALID_NUMBER", "CALL_RULE_INVALID_CONTACT_COLUMN", "CALL_RULE_MISSING_DATA_ACTION_INPUT", "CALL_RULE_MISMATCH_TYPE", "CALL_RULE_INVALID_OPERATOR", "CALL_RULE_NO_DNC_LISTS_CONFIGURED", "CALL_RULE_UPDATED_PHONE_COLUMN", "CONTACT_LIST_FILTER_EVALUATION_FAILED", "CONTACT_LIST_FILTER_INTERNAL_ERROR", "CONTACT_COLUMNS_LIMIT_EXCEEDED", "CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED", "CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED", "CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "DATA_ACTION_EXECUTION_FAILED", "DATA_ACTION_AUTHENTICATION_FAILURE", "DATA_ACTION_NOT_FOUND", "DNC_AUTHENTICATION_FAILURE", "EXCEEDED_CONTACT_LIMIT", "INACTIVE_EDGES_FAILED_PLACE_CALLS", "INACTIVE_EDGES_TURNED_CAMPAIGN_OFF", "INVALID_PHONE_NUMBER", "IMPORT_FAILED_TO_READ_HEADERS", "IMPORT_COULD_NOT_PARSE_AN_ENTRY", "IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT", "IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS", "IMPORT_INVALID_CUSTOM_ID", "IMPORT_INVALID_DATA", "IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT", "IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT", "IMPORT_MISSING_CUSTOM_ID", "IMPORT_NO_COLUMNS_DEFINED", "IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST", "IMPORT_LIST_NO_LONGER_EXISTS", "IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID", "IMPORT_TOO_MANY_COLUMNS", "ORGANIZATION_HAS_NO_DOMAIN_SET", "RECYCLE_CAMPAIGN"]
190
190
  if code && !allowed_values.include?(code)
191
191
  fail ArgumentError, "invalid value for 'code', must be one of #{allowed_values}."
192
192
  end
@@ -70,6 +70,12 @@ module PureCloud
70
70
  # A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace.
71
71
  attr_accessor :external_system_url
72
72
 
73
+ # The schema defining custom fields for this contact
74
+ attr_accessor :schema
75
+
76
+ # Custom fields defined in the schema referenced by schemaId and schemaVersion.
77
+ attr_accessor :custom_fields
78
+
73
79
  # Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
74
80
  attr_accessor :external_data_sources
75
81
 
@@ -126,6 +132,10 @@ module PureCloud
126
132
 
127
133
  :'external_system_url' => :'externalSystemUrl',
128
134
 
135
+ :'schema' => :'schema',
136
+
137
+ :'custom_fields' => :'customFields',
138
+
129
139
  :'external_data_sources' => :'externalDataSources',
130
140
 
131
141
  :'self_uri' => :'selfUri'
@@ -183,6 +193,10 @@ module PureCloud
183
193
 
184
194
  :'external_system_url' => :'String',
185
195
 
196
+ :'schema' => :'DataSchema',
197
+
198
+ :'custom_fields' => :'Hash<String, Object>',
199
+
186
200
  :'external_data_sources' => :'Array<ExternalDataSource>',
187
201
 
188
202
  :'self_uri' => :'String'
@@ -406,6 +420,26 @@ module PureCloud
406
420
  end
407
421
 
408
422
 
423
+ if attributes.has_key?(:'schema')
424
+
425
+
426
+ self.schema = attributes[:'schema']
427
+
428
+
429
+ end
430
+
431
+
432
+ if attributes.has_key?(:'customFields')
433
+
434
+ if (value = attributes[:'customFields']).is_a?(Array)
435
+ self.custom_fields = value
436
+ end
437
+
438
+
439
+
440
+ end
441
+
442
+
409
443
  if attributes.has_key?(:'externalDataSources')
410
444
 
411
445
  if (value = attributes[:'externalDataSources']).is_a?(Array)
@@ -542,6 +576,14 @@ module PureCloud
542
576
 
543
577
 
544
578
 
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
545
587
 
546
588
 
547
589
 
@@ -668,6 +710,16 @@ module PureCloud
668
710
 
669
711
 
670
712
 
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
671
723
 
672
724
 
673
725
 
@@ -707,6 +759,8 @@ module PureCloud
707
759
  external_organization == o.external_organization &&
708
760
  survey_opt_out == o.survey_opt_out &&
709
761
  external_system_url == o.external_system_url &&
762
+ schema == o.schema &&
763
+ custom_fields == o.custom_fields &&
710
764
  external_data_sources == o.external_data_sources &&
711
765
  self_uri == o.self_uri
712
766
  end
@@ -720,7 +774,7 @@ module PureCloud
720
774
  # Calculates hash code according to all attributes.
721
775
  # @return [Fixnum] Hash code
722
776
  def hash
723
- [id, first_name, middle_name, last_name, salutation, title, work_phone, cell_phone, home_phone, other_phone, work_email, personal_email, other_email, address, twitter_id, line_id, whats_app_id, facebook_id, modify_date, create_date, external_organization, survey_opt_out, external_system_url, external_data_sources, self_uri].hash
777
+ [id, first_name, middle_name, last_name, salutation, title, work_phone, cell_phone, home_phone, other_phone, work_email, personal_email, other_email, address, twitter_id, line_id, whats_app_id, facebook_id, modify_date, create_date, external_organization, survey_opt_out, external_system_url, schema, custom_fields, external_data_sources, self_uri].hash
724
778
  end
725
779
 
726
780
  # build the object from hash