purecloud 0.59.1 → 0.60.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (256) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  5. data/doc_out/AggregationQuery.html.md +1 -1
  6. data/doc_out/AlertingApi.html.md +1106 -92
  7. data/doc_out/Annotation.html.md +14 -4
  8. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  9. data/doc_out/AttributeEntityListing.html.md +2 -2
  10. data/doc_out/CalibrationEntityListing.html.md +2 -2
  11. data/doc_out/CallConversationEntityListing.html.md +2 -2
  12. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  13. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  14. data/doc_out/CampaignEntityListing.html.md +2 -2
  15. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  16. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  17. data/doc_out/ChannelEntityListing.html.md +2 -2
  18. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  19. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  20. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  21. data/doc_out/ContactListEntityListing.html.md +2 -2
  22. data/doc_out/ContactSort.html.md +1 -1
  23. data/doc_out/ConversationEntityListing.html.md +2 -2
  24. data/doc_out/DIDEntityListing.html.md +2 -2
  25. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  26. data/doc_out/DncListEntityListing.html.md +2 -2
  27. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  28. data/doc_out/DocumentEntityListing.html.md +2 -2
  29. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  30. data/doc_out/DomainEntityListing.html.md +2 -2
  31. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  32. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  33. data/doc_out/Edge.html.md +1 -1
  34. data/doc_out/EdgeEntityListing.html.md +2 -2
  35. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  36. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  37. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  38. data/doc_out/EmailMessageListing.html.md +2 -2
  39. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  40. data/doc_out/EndpointEntityListing.html.md +2 -2
  41. data/doc_out/EvaluationEntityListing.html.md +2 -2
  42. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  43. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  44. data/doc_out/ExtensionEntityListing.html.md +2 -2
  45. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  46. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  47. data/doc_out/GroupEntityListing.html.md +2 -2
  48. data/doc_out/HeartBeatAlert.html.md +1 -1
  49. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  50. data/doc_out/HeartBeatRule.html.md +1 -1
  51. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  52. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  53. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  54. data/doc_out/InteractionStatsAlert.html.md +1 -1
  55. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  56. data/doc_out/InteractionStatsRule.html.md +1 -1
  57. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  58. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  59. data/doc_out/LanguageEntityListing.html.md +2 -2
  60. data/doc_out/LibraryEntityListing.html.md +2 -2
  61. data/doc_out/LineBaseEntityListing.html.md +2 -2
  62. data/doc_out/LineEntityListing.html.md +2 -2
  63. data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
  64. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  65. data/doc_out/OAuthClient.html.md +2 -2
  66. data/doc_out/OAuthClientEntityListing.html.md +3 -3
  67. data/doc_out/OAuthClientListing.html.md +20 -0
  68. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  69. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  70. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  71. data/doc_out/OrphanRecording.html.md +1 -0
  72. data/doc_out/OrphanRecordingListing.html.md +2 -2
  73. data/doc_out/OrphanUpdateRequest.html.md +15 -0
  74. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  75. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  76. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  77. data/doc_out/PhoneEntityListing.html.md +2 -2
  78. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  79. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  80. data/doc_out/PolicyEntityListing.html.md +2 -2
  81. data/doc_out/QualityApi.html.md +5 -1
  82. data/doc_out/QualityAuditPage.html.md +2 -2
  83. data/doc_out/QueueEntityListing.html.md +2 -2
  84. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  85. data/doc_out/RecordingApi.html.md +132 -4
  86. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  87. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  88. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  89. data/doc_out/ResponseEntityList.html.md +2 -2
  90. data/doc_out/ResponseEntityListing.html.md +2 -2
  91. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  92. data/doc_out/RoutingStatusAlert.html.md +23 -0
  93. data/doc_out/RoutingStatusAlertContainer.html.md +22 -0
  94. data/doc_out/RoutingStatusRule.html.md +22 -0
  95. data/doc_out/RoutingStatusRuleContainer.html.md +22 -0
  96. data/doc_out/RuleSetEntityListing.html.md +2 -2
  97. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  98. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  99. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  100. data/doc_out/ScriptEntityListing.html.md +2 -2
  101. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  102. data/doc_out/ShareEntityListing.html.md +2 -2
  103. data/doc_out/SiteEntityListing.html.md +2 -2
  104. data/doc_out/SkillEntityListing.html.md +2 -2
  105. data/doc_out/StationEntityListing.html.md +2 -2
  106. data/doc_out/StreetAddress.html.md +2 -2
  107. data/doc_out/TagValueEntityListing.html.md +2 -2
  108. data/doc_out/TelephonyProvidersEdgeApi.html.md +21 -17
  109. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  110. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  111. data/doc_out/TrunkEntityListing.html.md +2 -2
  112. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  113. data/doc_out/UserEntityListing.html.md +2 -2
  114. data/doc_out/UserPresenceAlert.html.md +25 -0
  115. data/doc_out/UserPresenceAlertContainer.html.md +22 -0
  116. data/doc_out/UserPresenceRule.html.md +23 -0
  117. data/doc_out/{UsersEntityListing.html.md → UserPresenceRuleContainer.html.md} +5 -5
  118. data/doc_out/UserQueueEntityListing.html.md +2 -2
  119. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  120. data/doc_out/UserSkillEntityListing.html.md +2 -2
  121. data/doc_out/UsersApi.html.md +2 -2
  122. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  123. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  124. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  125. data/doc_out/index.html.md +3 -3
  126. data/lib/purecloud.rb +10 -1
  127. data/lib/purecloud/api/alerting_api.rb +1070 -49
  128. data/lib/purecloud/api/quality_api.rb +6 -0
  129. data/lib/purecloud/api/recording_api.rb +140 -2
  130. data/lib/purecloud/api/telephony_providers_edge_api.rb +13 -10
  131. data/lib/purecloud/api/users_api.rb +3 -3
  132. data/lib/purecloud/api_client.rb +1 -1
  133. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  134. data/lib/purecloud/models/aggregation_query.rb +1 -1
  135. data/lib/purecloud/models/annotation.rb +115 -1
  136. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  137. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  138. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  139. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  140. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  141. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  142. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  143. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  144. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  145. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  146. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  147. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  148. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  149. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  150. data/lib/purecloud/models/contact_sort.rb +1 -0
  151. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  152. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  153. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  154. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  155. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  156. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  157. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  158. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  159. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  160. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  161. data/lib/purecloud/models/edge.rb +2 -1
  162. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  163. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  164. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  165. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  166. data/lib/purecloud/models/email_message_listing.rb +17 -17
  167. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  168. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  169. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  170. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  171. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  172. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  173. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  174. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  175. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  176. data/lib/purecloud/models/group_search_criteria.rb +1 -1
  177. data/lib/purecloud/models/heart_beat_alert.rb +1 -1
  178. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  179. data/lib/purecloud/models/heart_beat_rule.rb +1 -1
  180. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  181. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  182. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  183. data/lib/purecloud/models/interaction_stats_alert.rb +1 -1
  184. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  185. data/lib/purecloud/models/interaction_stats_rule.rb +1 -1
  186. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  187. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  188. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  189. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  190. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  191. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  192. data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
  193. data/lib/purecloud/models/location_search_criteria.rb +1 -1
  194. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  195. data/lib/purecloud/models/o_auth_client_entity_listing.rb +18 -18
  196. data/lib/purecloud/models/o_auth_client_listing.rb +246 -0
  197. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  198. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  199. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  200. data/lib/purecloud/models/orphan_recording.rb +21 -1
  201. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  202. data/lib/purecloud/models/orphan_update_request.rb +188 -0
  203. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  204. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  205. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  206. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  207. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  208. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  209. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  210. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  211. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  212. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  213. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  214. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  215. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  216. data/lib/purecloud/models/response_entity_list.rb +17 -17
  217. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  218. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  219. data/lib/purecloud/models/routing_status_alert.rb +289 -0
  220. data/lib/purecloud/models/routing_status_alert_container.rb +257 -0
  221. data/lib/purecloud/models/routing_status_rule.rb +282 -0
  222. data/lib/purecloud/models/routing_status_rule_container.rb +257 -0
  223. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  224. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  225. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  226. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  227. data/lib/purecloud/models/script_entity_listing.rb +17 -17
  228. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  229. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  230. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  231. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  232. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  233. data/lib/purecloud/models/street_address.rb +2 -0
  234. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  235. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  236. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  237. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  238. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  239. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  240. data/lib/purecloud/models/user_presence_alert.rb +310 -0
  241. data/lib/purecloud/models/user_presence_alert_container.rb +257 -0
  242. data/lib/purecloud/models/user_presence_rule.rb +293 -0
  243. data/lib/purecloud/models/{users_entity_listing.rb → user_presence_rule_container.rb} +19 -19
  244. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  245. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  246. data/lib/purecloud/models/user_schedule_adherence.rb +3 -3
  247. data/lib/purecloud/models/user_search_criteria.rb +1 -1
  248. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  249. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  250. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  251. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  252. data/lib/purecloud/version.rb +1 -1
  253. data/newVersion.md +1 -1
  254. data/swagger.json +1 -1
  255. data/version.json +1 -1
  256. metadata +22 -4
@@ -11,11 +11,11 @@ title: ReportMetaDataEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ReportRunEntryEntityDomainListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ReportScheduleEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ResponseEntityList
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ResponseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ResponseSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: RoutingStatusAlert
3
+ ---
4
+ ## PureCloud::RoutingStatusAlert
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | Name of the rule | |
12
+ | **agent** | [**User**](User.html) | The agent whose routing status will be watched. | |
13
+ | **routing_status** | **String** | The routing status on which to alert. | |
14
+ | **routing_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the agent's routing status. | |
15
+ | **rule_id** | **String** | The id of the rule. | |
16
+ | **start_date** | **DateTime** | The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
17
+ | **end_date** | **DateTime** | The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
18
+ | **notification_users** | [**Array<User>**](User.html) | The ids of users who were notified of alarm state change. | |
19
+ | **alert_types** | **Array<String>** | A collection of notification methods. | |
20
+ | **self_uri** | **String** | The URI for this object | [optional] |
21
+ {: class="table table-striped"}
22
+
23
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: RoutingStatusAlertContainer
3
+ ---
4
+ ## PureCloud::RoutingStatusAlertContainer
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<RoutingStatusAlert>**](RoutingStatusAlert.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: RoutingStatusRule
3
+ ---
4
+ ## PureCloud::RoutingStatusRule
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | Name of the rule | |
12
+ | **agent** | [**User**](User.html) | The agent whose routing status will be watched. | |
13
+ | **routing_status** | **String** | The routing status on which to alert. | |
14
+ | **routing_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the agent's routing status. | |
15
+ | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
16
+ | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
17
+ | **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
18
+ | **alert_types** | **Array<String>** | A collection of notification methods. | |
19
+ | **self_uri** | **String** | The URI for this object | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: RoutingStatusRuleContainer
3
+ ---
4
+ ## PureCloud::RoutingStatusRuleContainer
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<RoutingStatusRule>**](RoutingStatusRule.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -11,11 +11,11 @@ title: RuleSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SchemaCategoryEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SchemaReferenceEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ScreenRecordingSessionListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ScriptEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SecurityProfileEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: ShareEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SiteEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: StationEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -8,8 +8,8 @@ title: StreetAddress
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **country** | **String** | 2 Letter Country code, like US or GB | |
11
- | **a1** | **String** | | [optional] |
12
- | **a3** | **String** | | [optional] |
11
+ | **a1** | **String** | State or Province | |
12
+ | **a3** | **String** | City or township | |
13
13
  | **rd** | **String** | | [optional] |
14
14
  | **hno** | **String** | | [optional] |
15
15
  | **loc** | **String** | | [optional] |
@@ -11,11 +11,11 @@ title: TagValueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **self_uri** | **String** | | [optional] |
15
14
  | **first_uri** | **String** | | [optional] |
15
+ | **self_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **previous_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -76,11 +76,11 @@ Method | HTTP request | Description
76
76
  |[**get_providers_edges_trunks**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks) | **GET** /api/v2/telephony/providers/edges/trunks | Get the list of available trunks.|
77
77
  |[**get_providers_edges_trunks_trunk_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id) | **GET** /api/v2/telephony/providers/edges/trunks/{trunkId} | Get a Trunk by ID|
78
78
  |[**get_providers_edges_trunkswithrecording**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkswithrecording) | **GET** /api/v2/telephony/providers/edges/trunkswithrecording | Get Counts of trunks that have recording disabled or enabled|
79
- |[**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | **GET** /api/v2/configuration/schemas/edges/vnext | Lists available schema categories|
80
- |[**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory} | List schemas of a specific category|
81
- |[**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType} | List schemas of a specific category|
82
- |[**get_schemas_edges_vnext_schemacategory_schematype_schema_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId} | Get a json schema|
83
- |[**get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId} | Get metadata for a schema|
79
+ |[**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | **GET** /api/v2/configuration/schemas/edges/vnext | Lists available schema categories (Deprecated)|
80
+ |[**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory} | List schemas of a specific category (Deprecated)|
81
+ |[**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType} | List schemas of a specific category (Deprecated)|
82
+ |[**get_schemas_edges_vnext_schemacategory_schematype_schema_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId} | Get a json schema (Deprecated)|
83
+ |[**get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId} | Get metadata for a schema (Deprecated)|
84
84
  |[**post_providers_edges**](TelephonyProvidersEdgeApi.html#post_providers_edges) | **POST** /api/v2/telephony/providers/edges | Create an edge.|
85
85
  |[**post_providers_edges_addressvalidation**](TelephonyProvidersEdgeApi.html#post_providers_edges_addressvalidation) | **POST** /api/v2/telephony/providers/edges/addressvalidation | Validates a street address|
86
86
  |[**post_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#post_providers_edges_certificateauthorities) | **POST** /api/v2/telephony/providers/edges/certificateauthorities | Create a certificate authority.|
@@ -1314,7 +1314,7 @@ Name | Type | Description | Notes
1314
1314
 
1315
1315
  <a name="get_providers_edges_edge_id"></a>
1316
1316
 
1317
- ## -[**Edge**](Edge.html) get_providers_edges_edge_id(edge_id)
1317
+ ## -[**Edge**](Edge.html) get_providers_edges_edge_id(edge_id, opts)
1318
1318
 
1319
1319
  Get edge.
1320
1320
 
@@ -1339,10 +1339,13 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new
1339
1339
 
1340
1340
  edge_id = "edge_id_example" # String | Edge ID
1341
1341
 
1342
+ opts = {
1343
+ expand: ["expand_example"] # Array<String> | Fields to expand in the response, comma-separated
1344
+ }
1342
1345
 
1343
1346
  begin
1344
1347
  #Get edge.
1345
- result = api_instance.get_providers_edges_edge_id(edge_id)
1348
+ result = api_instance.get_providers_edges_edge_id(edge_id, opts)
1346
1349
  p result
1347
1350
  rescue PureCloud::ApiError => e
1348
1351
  puts "Exception when calling TelephonyProvidersEdgeApi->get_providers_edges_edge_id: #{e}"
@@ -1354,6 +1357,7 @@ end
1354
1357
  Name | Type | Description | Notes
1355
1358
  ------------- | ------------- | ------------- | -------------
1356
1359
  **edge_id** | **String**| Edge ID |
1360
+ **expand** | [**Array&lt;String&gt;**](String.html)| Fields to expand in the response, comma-separated | [optional]
1357
1361
  {: class="table table-striped"}
1358
1362
 
1359
1363
 
@@ -4115,7 +4119,7 @@ Name | Type | Description | Notes
4115
4119
 
4116
4120
  ## -[**SchemaCategoryEntityListing**](SchemaCategoryEntityListing.html) get_schemas_edges_vnext(opts)
4117
4121
 
4118
- Lists available schema categories
4122
+ Lists available schema categories (Deprecated)
4119
4123
 
4120
4124
 
4121
4125
 
@@ -4142,7 +4146,7 @@ opts = {
4142
4146
  }
4143
4147
 
4144
4148
  begin
4145
- #Lists available schema categories
4149
+ #Lists available schema categories (Deprecated)
4146
4150
  result = api_instance.get_schemas_edges_vnext(opts)
4147
4151
  p result
4148
4152
  rescue PureCloud::ApiError => e
@@ -4174,7 +4178,7 @@ Name | Type | Description | Notes
4174
4178
 
4175
4179
  ## -[**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) get_schemas_edges_vnext_schemacategory(schema_category, opts)
4176
4180
 
4177
- List schemas of a specific category
4181
+ List schemas of a specific category (Deprecated)
4178
4182
 
4179
4183
 
4180
4184
 
@@ -4203,7 +4207,7 @@ opts = {
4203
4207
  }
4204
4208
 
4205
4209
  begin
4206
- #List schemas of a specific category
4210
+ #List schemas of a specific category (Deprecated)
4207
4211
  result = api_instance.get_schemas_edges_vnext_schemacategory(schema_category, opts)
4208
4212
  p result
4209
4213
  rescue PureCloud::ApiError => e
@@ -4236,7 +4240,7 @@ Name | Type | Description | Notes
4236
4240
 
4237
4241
  ## -[**SchemaReferenceEntityListing**](SchemaReferenceEntityListing.html) get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts)
4238
4242
 
4239
- List schemas of a specific category
4243
+ List schemas of a specific category (Deprecated)
4240
4244
 
4241
4245
 
4242
4246
 
@@ -4267,7 +4271,7 @@ opts = {
4267
4271
  }
4268
4272
 
4269
4273
  begin
4270
- #List schemas of a specific category
4274
+ #List schemas of a specific category (Deprecated)
4271
4275
  result = api_instance.get_schemas_edges_vnext_schemacategory_schematype(schema_category, schema_type, opts)
4272
4276
  p result
4273
4277
  rescue PureCloud::ApiError => e
@@ -4301,7 +4305,7 @@ Name | Type | Description | Notes
4301
4305
 
4302
4306
  ## -[**Organization**](Organization.html) get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id)
4303
4307
 
4304
- Get a json schema
4308
+ Get a json schema (Deprecated)
4305
4309
 
4306
4310
 
4307
4311
 
@@ -4330,7 +4334,7 @@ schema_id = "schema_id_example" # String | Schema ID
4330
4334
 
4331
4335
 
4332
4336
  begin
4333
- #Get a json schema
4337
+ #Get a json schema (Deprecated)
4334
4338
  result = api_instance.get_schemas_edges_vnext_schemacategory_schematype_schema_id(schema_category, schema_type, schema_id)
4335
4339
  p result
4336
4340
  rescue PureCloud::ApiError => e
@@ -4363,7 +4367,7 @@ Name | Type | Description | Notes
4363
4367
 
4364
4368
  ## -[**Organization**](Organization.html) get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts)
4365
4369
 
4366
- Get metadata for a schema
4370
+ Get metadata for a schema (Deprecated)
4367
4371
 
4368
4372
 
4369
4373
 
@@ -4399,7 +4403,7 @@ opts = {
4399
4403
  }
4400
4404
 
4401
4405
  begin
4402
- #Get metadata for a schema
4406
+ #Get metadata for a schema (Deprecated)
4403
4407
  result = api_instance.get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id(schema_category, schema_type, schema_id, extension_type, metadata_id, opts)
4404
4408
  p result
4405
4409
  rescue PureCloud::ApiError => e