purecloud 0.48.1 → 0.49.1

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 (287) 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 +1 -1
  5. data/doc_out/AttributeEntityListing.html.md +1 -1
  6. data/doc_out/AvailableTopicEntityListing.html.md +1 -1
  7. data/doc_out/CalibrationEntityListing.html.md +1 -1
  8. data/doc_out/Call.html.md +1 -0
  9. data/doc_out/CallConversationEntityListing.html.md +1 -1
  10. data/doc_out/CallMediaParticipant.html.md +1 -0
  11. data/doc_out/CallableTimeSetEntityListing.html.md +1 -1
  12. data/doc_out/CallbackConversationEntityListing.html.md +1 -1
  13. data/doc_out/Campaign.html.md +1 -0
  14. data/doc_out/CampaignEntityListing.html.md +1 -1
  15. data/doc_out/CampaignSequenceEntityListing.html.md +1 -1
  16. data/doc_out/CertificateAuthorityEntityListing.html.md +1 -1
  17. data/doc_out/ChannelEntityListing.html.md +1 -1
  18. data/doc_out/ChannelTopicEntityListing.html.md +1 -1
  19. data/doc_out/ChatConversationEntityListing.html.md +1 -1
  20. data/doc_out/CommandStatusEntityListing.html.md +1 -1
  21. data/doc_out/ContactListEntityListing.html.md +1 -1
  22. data/doc_out/ConversationEntityListing.html.md +1 -1
  23. data/doc_out/CreateQueueRequest.html.md +33 -0
  24. data/doc_out/DID.html.md +1 -1
  25. data/doc_out/DIDEntityListing.html.md +1 -1
  26. data/doc_out/DIDPool.html.md +3 -3
  27. data/doc_out/DIDPoolEntityListing.html.md +1 -1
  28. data/doc_out/DialerContactEntityListing.html.md +1 -1
  29. data/doc_out/DncListEntityListing.html.md +1 -1
  30. data/doc_out/Document.html.md +1 -1
  31. data/doc_out/DocumentAuditEntityListing.html.md +1 -1
  32. data/doc_out/DocumentEntityListing.html.md +1 -1
  33. data/doc_out/DocumentThumbnail.html.md +2 -0
  34. data/doc_out/DomainCertificateAuthority.html.md +1 -1
  35. data/doc_out/DomainEntityListing.html.md +1 -1
  36. data/doc_out/DomainEntityListingEvaluationForm.html.md +1 -1
  37. data/doc_out/DomainEntityListingQueryResult.html.md +1 -1
  38. data/doc_out/DomainLogicalInterface.html.md +1 -1
  39. data/doc_out/DomainPhysicalInterface.html.md +10 -1
  40. data/doc_out/DomainSchemaReference.html.md +10 -1
  41. data/doc_out/DownloadResponse.html.md +1 -0
  42. data/doc_out/Edge.html.md +1 -1
  43. data/doc_out/EdgeEntityListing.html.md +1 -1
  44. data/doc_out/EdgeGroup.html.md +1 -1
  45. data/doc_out/EdgeGroupEntityListing.html.md +1 -1
  46. data/doc_out/EdgeLine.html.md +10 -1
  47. data/doc_out/EdgeLineEntityListing.html.md +1 -1
  48. data/doc_out/EdgeLogsJob.html.md +10 -1
  49. data/doc_out/EdgeLogsJobFile.html.md +10 -1
  50. data/doc_out/EdgeLogsJobResponse.html.md +10 -1
  51. data/doc_out/EdgeLogsJobUploadRequest.html.md +1 -1
  52. data/doc_out/EmailConversationEntityListing.html.md +1 -1
  53. data/doc_out/EmailMessageListing.html.md +1 -1
  54. data/doc_out/EncryptionKeyEntityListing.html.md +1 -1
  55. data/doc_out/EndpointEntityListing.html.md +1 -1
  56. data/doc_out/EvaluationEntityListing.html.md +1 -1
  57. data/doc_out/EvaluationFormEntityListing.html.md +1 -1
  58. data/doc_out/EvaluatorActivityEntityListing.html.md +1 -1
  59. data/doc_out/Extension.html.md +1 -1
  60. data/doc_out/ExtensionEntityListing.html.md +1 -1
  61. data/doc_out/ExtensionPool.html.md +1 -1
  62. data/doc_out/ExtensionPoolEntityListing.html.md +1 -1
  63. data/doc_out/FaxDocument.html.md +1 -1
  64. data/doc_out/FaxDocumentEntityListing.html.md +1 -1
  65. data/doc_out/FaxStatus.html.md +20 -0
  66. data/doc_out/GroupEntityListing.html.md +1 -1
  67. data/doc_out/InboundDomainEntityListing.html.md +1 -1
  68. data/doc_out/InboundRouteEntityListing.html.md +1 -1
  69. data/doc_out/InteractionStatsAlertContainer.html.md +1 -1
  70. data/doc_out/InteractionStatsRuleContainer.html.md +1 -1
  71. data/doc_out/JsonNode.html.md +2 -2
  72. data/doc_out/Keyword.html.md +3 -0
  73. data/doc_out/KeywordSetEntityListing.html.md +1 -1
  74. data/doc_out/LanguageEntityListing.html.md +1 -1
  75. data/doc_out/LibraryEntityListing.html.md +1 -1
  76. data/doc_out/Line.html.md +1 -1
  77. data/doc_out/LineBase.html.md +10 -1
  78. data/doc_out/LineBaseEntityListing.html.md +1 -1
  79. data/doc_out/LineEntityListing.html.md +1 -1
  80. data/doc_out/Location.html.md +1 -0
  81. data/doc_out/LogicalInterfaceEntityListing.html.md +1 -1
  82. data/doc_out/Metabase.html.md +9 -1
  83. data/doc_out/NumberPlan.html.md +2 -2
  84. data/doc_out/OAuthClientEntityListing.html.md +1 -1
  85. data/doc_out/OAuthProviderEntityListing.html.md +1 -1
  86. data/doc_out/OrganizationPresenceEntityListing.html.md +1 -1
  87. data/doc_out/OrganizationRoleEntityListing.html.md +1 -1
  88. data/doc_out/OrphanRecordingListing.html.md +1 -1
  89. data/doc_out/OutboundRoute.html.md +2 -2
  90. data/doc_out/OutboundRouteEntityListing.html.md +1 -1
  91. data/doc_out/PermissionCollectionEntityListing.html.md +1 -1
  92. data/doc_out/Phone.html.md +2 -2
  93. data/doc_out/PhoneBase.html.md +12 -3
  94. data/doc_out/PhoneBaseEntityListing.html.md +1 -1
  95. data/doc_out/PhoneEntityListing.html.md +1 -1
  96. data/doc_out/PhoneMetaBaseEntityListing.html.md +1 -1
  97. data/doc_out/PhysicalInterfaceEntityListing.html.md +1 -1
  98. data/doc_out/PolicyEntityListing.html.md +1 -1
  99. data/doc_out/QualityApi.html.md +58 -0
  100. data/doc_out/QualityAuditPage.html.md +1 -1
  101. data/doc_out/Queue.html.md +7 -7
  102. data/doc_out/QueueEntityListing.html.md +1 -1
  103. data/doc_out/ReportMetaDataEntityListing.html.md +1 -1
  104. data/doc_out/ReportRunEntryEntityDomainListing.html.md +1 -1
  105. data/doc_out/ReportScheduleEntityListing.html.md +1 -1
  106. data/doc_out/ResponseEntityList.html.md +1 -1
  107. data/doc_out/ResponseEntityListing.html.md +1 -1
  108. data/doc_out/ResponseSetEntityListing.html.md +1 -1
  109. data/doc_out/RoutingApi.html.md +2 -2
  110. data/doc_out/RuleSetEntityListing.html.md +1 -1
  111. data/doc_out/SchemaCategory.html.md +10 -1
  112. data/doc_out/SchemaCategoryEntityListing.html.md +1 -1
  113. data/doc_out/SchemaReferenceEntityListing.html.md +1 -1
  114. data/doc_out/SecurityProfileEntityListing.html.md +1 -1
  115. data/doc_out/ShareEntityListing.html.md +1 -1
  116. data/doc_out/Site.html.md +1 -1
  117. data/doc_out/SiteEntityListing.html.md +1 -1
  118. data/doc_out/SkillEntityListing.html.md +1 -1
  119. data/doc_out/StationEntityListing.html.md +1 -1
  120. data/doc_out/TagValueEntityListing.html.md +1 -1
  121. data/doc_out/TelephonyProvidersEdgeApi.html.md +4 -0
  122. data/doc_out/TimeZoneEntityListing.html.md +1 -1
  123. data/doc_out/Trunk.html.md +1 -1
  124. data/doc_out/TrunkBase.html.md +1 -1
  125. data/doc_out/TrunkEntityListing.html.md +1 -1
  126. data/doc_out/TrunkMetabaseEntityListing.html.md +1 -1
  127. data/doc_out/User.html.md +1 -0
  128. data/doc_out/UserEntityListing.html.md +1 -1
  129. data/doc_out/UserMe.html.md +1 -0
  130. data/doc_out/UserQueue.html.md +7 -7
  131. data/doc_out/UserQueueEntityListing.html.md +1 -1
  132. data/doc_out/UserRecordingEntityListing.html.md +1 -1
  133. data/doc_out/UserSkillEntityListing.html.md +1 -1
  134. data/doc_out/UsersEntityListing.html.md +1 -1
  135. data/doc_out/ValidateAddressRequest.html.md +1 -1
  136. data/doc_out/WorkspaceEntityListing.html.md +1 -1
  137. data/doc_out/WorkspaceMemberEntityListing.html.md +1 -1
  138. data/doc_out/WrapupCodeEntityListing.html.md +1 -1
  139. data/doc_out/index.html.md +3 -3
  140. data/lib/purecloud.rb +2 -0
  141. data/lib/purecloud/api/quality_api.rb +57 -0
  142. data/lib/purecloud/api/telephony_providers_edge_api.rb +6 -0
  143. data/lib/purecloud/api_client.rb +1 -1
  144. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  145. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  146. data/lib/purecloud/models/available_topic_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  148. data/lib/purecloud/models/call.rb +15 -5
  149. data/lib/purecloud/models/call_conversation_entity_listing.rb +11 -11
  150. data/lib/purecloud/models/call_media_participant.rb +13 -2
  151. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  152. data/lib/purecloud/models/callback.rb +1 -1
  153. data/lib/purecloud/models/callback_conversation_entity_listing.rb +11 -11
  154. data/lib/purecloud/models/callback_media_participant.rb +1 -1
  155. data/lib/purecloud/models/campaign.rb +12 -1
  156. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  157. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  158. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  159. data/lib/purecloud/models/channel_entity_listing.rb +11 -11
  160. data/lib/purecloud/models/channel_topic_entity_listing.rb +11 -11
  161. data/lib/purecloud/models/chat_conversation_entity_listing.rb +11 -11
  162. data/lib/purecloud/models/chat_media_participant.rb +1 -1
  163. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  164. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  165. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  166. data/lib/purecloud/models/create_queue_request.rb +397 -0
  167. data/lib/purecloud/models/dialer_contact_entity_listing.rb +11 -11
  168. data/lib/purecloud/models/did.rb +1 -0
  169. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  170. data/lib/purecloud/models/did_pool.rb +1 -0
  171. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  172. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  173. data/lib/purecloud/models/document.rb +11 -11
  174. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  175. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  176. data/lib/purecloud/models/document_thumbnail.rb +24 -4
  177. data/lib/purecloud/models/domain_certificate_authority.rb +1 -0
  178. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  179. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  180. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  181. data/lib/purecloud/models/domain_logical_interface.rb +1 -0
  182. data/lib/purecloud/models/domain_physical_interface.rb +103 -1
  183. data/lib/purecloud/models/domain_schema_reference.rb +103 -1
  184. data/lib/purecloud/models/download_response.rb +16 -4
  185. data/lib/purecloud/models/edge.rb +1 -0
  186. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  187. data/lib/purecloud/models/edge_group.rb +1 -0
  188. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  189. data/lib/purecloud/models/edge_line.rb +103 -1
  190. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  191. data/lib/purecloud/models/edge_logs_job.rb +103 -1
  192. data/lib/purecloud/models/edge_logs_job_file.rb +103 -1
  193. data/lib/purecloud/models/edge_logs_job_response.rb +103 -1
  194. data/lib/purecloud/models/edge_logs_job_upload_request.rb +1 -0
  195. data/lib/purecloud/models/email.rb +1 -1
  196. data/lib/purecloud/models/email_conversation_entity_listing.rb +11 -11
  197. data/lib/purecloud/models/email_media_participant.rb +1 -1
  198. data/lib/purecloud/models/email_message_listing.rb +11 -11
  199. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  200. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  201. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  202. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  203. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  204. data/lib/purecloud/models/extension.rb +1 -0
  205. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  206. data/lib/purecloud/models/extension_pool.rb +1 -0
  207. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  208. data/lib/purecloud/models/fax_document.rb +11 -11
  209. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  210. data/lib/purecloud/models/fax_status.rb +235 -0
  211. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  212. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  213. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  214. data/lib/purecloud/models/interaction_stats_alert_container.rb +11 -11
  215. data/lib/purecloud/models/interaction_stats_rule_container.rb +11 -11
  216. data/lib/purecloud/models/json_node.rb +25 -25
  217. data/lib/purecloud/models/keyword.rb +34 -4
  218. data/lib/purecloud/models/keyword_set_entity_listing.rb +11 -11
  219. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  220. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  221. data/lib/purecloud/models/line.rb +1 -0
  222. data/lib/purecloud/models/line_base.rb +103 -1
  223. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  224. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  225. data/lib/purecloud/models/location.rb +13 -1
  226. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  227. data/lib/purecloud/models/metabase.rb +93 -1
  228. data/lib/purecloud/models/number_plan.rb +1 -10
  229. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  230. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  231. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  232. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  233. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  234. data/lib/purecloud/models/outbound_route.rb +2 -1
  235. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  236. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  237. data/lib/purecloud/models/phone.rb +2 -1
  238. data/lib/purecloud/models/phone_base.rb +105 -3
  239. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  241. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  242. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  243. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  244. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  245. data/lib/purecloud/models/queue.rb +7 -0
  246. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  247. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  248. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  249. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  250. data/lib/purecloud/models/response_entity_list.rb +11 -11
  251. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  252. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  253. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  254. data/lib/purecloud/models/schema_category.rb +103 -1
  255. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  256. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  257. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  258. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  259. data/lib/purecloud/models/site.rb +1 -0
  260. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  261. data/lib/purecloud/models/skill_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/social_expression.rb +1 -1
  263. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  264. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  265. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  266. data/lib/purecloud/models/trunk.rb +1 -0
  267. data/lib/purecloud/models/trunk_base.rb +1 -0
  268. data/lib/purecloud/models/trunk_entity_listing.rb +11 -11
  269. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  270. data/lib/purecloud/models/user.rb +14 -1
  271. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  272. data/lib/purecloud/models/user_me.rb +14 -1
  273. data/lib/purecloud/models/user_queue.rb +7 -0
  274. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  275. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  276. data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
  277. data/lib/purecloud/models/users_entity_listing.rb +11 -11
  278. data/lib/purecloud/models/validate_address_request.rb +1 -0
  279. data/lib/purecloud/models/video.rb +1 -1
  280. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  281. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  282. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  283. data/lib/purecloud/version.rb +1 -1
  284. data/newVersion.md +1 -1
  285. data/swagger.json +1 -1
  286. data/version.json +1 -1
  287. metadata +6 -2
@@ -14,8 +14,8 @@ title: LanguageEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: LibraryEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/doc_out/Line.html.md CHANGED
@@ -8,7 +8,7 @@ title: Line
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
11
+ | **name** | **String** | The name of the entity. | |
12
12
  | **description** | **String** | | [optional] |
13
13
  | **version** | **Integer** | | [optional] |
14
14
  | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -8,7 +8,16 @@ title: LineBase
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
11
+ | **name** | **String** | The name of the entity. | |
12
+ | **description** | **String** | | [optional] |
13
+ | **version** | **Integer** | | [optional] |
14
+ | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **modified_by** | **String** | | [optional] |
17
+ | **created_by** | **String** | | [optional] |
18
+ | **state** | **String** | | [optional] |
19
+ | **modified_by_app** | **String** | | [optional] |
20
+ | **created_by_app** | **String** | | [optional] |
12
21
  | **line_meta_base** | [**UriReference**](UriReference.html) | | [optional] |
13
22
  | **properties** | **Hash<String, Object>** | | [optional] |
14
23
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -14,8 +14,8 @@ title: LineBaseEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: LineEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,6 +14,7 @@ title: Location
14
14
  | **emergency_number** | [**LocationEmergencyNumber**](LocationEmergencyNumber.html) | | [optional] |
15
15
  | **state** | **String** | Current activity status of the location. | [optional] |
16
16
  | **version** | **Integer** | | [optional] |
17
+ | **path** | **Array<String>** | | [optional] |
17
18
  | **self_uri** | **String** | The URI for this object | [optional] |
18
19
  {: class="table table-striped"}
19
20
 
@@ -14,8 +14,8 @@ title: LogicalInterfaceEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -8,8 +8,16 @@ title: Metabase
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
11
+ | **name** | **String** | The name of the entity. | |
12
12
  | **description** | **String** | | [optional] |
13
+ | **version** | **Integer** | | [optional] |
14
+ | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **modified_by** | **String** | | [optional] |
17
+ | **created_by** | **String** | | [optional] |
18
+ | **state** | **String** | | [optional] |
19
+ | **modified_by_app** | **String** | | [optional] |
20
+ | **created_by_app** | **String** | | [optional] |
13
21
  | **self_uri** | **String** | The URI for this object | [optional] |
14
22
  {: class="table table-striped"}
15
23
 
@@ -8,7 +8,7 @@ title: NumberPlan
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
11
+ | **name** | **String** | The name of the entity. | |
12
12
  | **description** | **String** | | [optional] |
13
13
  | **version** | **Integer** | | [optional] |
14
14
  | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -24,7 +24,7 @@ title: NumberPlan
24
24
  | **numbers** | [**Array<Number>**](Number.html) | | [optional] |
25
25
  | **digit_length** | [**DigitLength**](DigitLength.html) | | [optional] |
26
26
  | **classification** | **String** | | [optional] |
27
- | **match_type** | **String** | The type of matching technique the number plan uses. | |
27
+ | **match_type** | **String** | | [optional] |
28
28
  | **self_uri** | **String** | The URI for this object | [optional] |
29
29
  {: class="table table-striped"}
30
30
 
@@ -14,8 +14,8 @@ title: OAuthClientEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: OAuthProviderEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: OrganizationPresenceEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: OrganizationRoleEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: OrphanRecordingListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -8,7 +8,7 @@ title: OutboundRoute
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
11
+ | **name** | **String** | The name of the entity. | |
12
12
  | **description** | **String** | | [optional] |
13
13
  | **version** | **Integer** | | [optional] |
14
14
  | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -18,7 +18,7 @@ title: OutboundRoute
18
18
  | **state** | **String** | | [optional] |
19
19
  | **modified_by_app** | **String** | | [optional] |
20
20
  | **created_by_app** | **String** | | [optional] |
21
- | **site** | [**Site**](Site.html) | Site | |
21
+ | **site** | [**Site**](Site.html) | The site associated to the outbound route. | |
22
22
  | **classification_types** | **Array<String>** | | [optional] |
23
23
  | **enabled** | **BOOLEAN** | | [optional] [default to false]|
24
24
  | **distribution** | **String** | | [optional] |
@@ -14,8 +14,8 @@ title: OutboundRouteEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: PermissionCollectionEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -8,7 +8,7 @@ title: Phone
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
11
+ | **name** | **String** | The name of the entity. | |
12
12
  | **description** | **String** | | [optional] |
13
13
  | **version** | **Integer** | | [optional] |
14
14
  | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -18,7 +18,7 @@ title: Phone
18
18
  | **state** | **String** | | [optional] |
19
19
  | **modified_by_app** | **String** | | [optional] |
20
20
  | **created_by_app** | **String** | | [optional] |
21
- | **site** | [**UriReference**](UriReference.html) | Site | |
21
+ | **site** | [**UriReference**](UriReference.html) | The site associated to the phone. | |
22
22
  | **phone_base_settings** | [**UriReference**](UriReference.html) | Phone Base Settings | |
23
23
  | **line_base_settings** | [**UriReference**](UriReference.html) | | [optional] |
24
24
  | **phone_meta_base** | [**UriReference**](UriReference.html) | | [optional] |
@@ -8,9 +8,18 @@ title: PhoneBase
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **name** | **String** | | [optional] |
12
- | **phone_meta_base** | [**UriReference**](UriReference.html) | Phone Meta Base | |
13
- | **lines** | [**Array<LineBase>**](LineBase.html) | Lines | |
11
+ | **name** | **String** | The name of the entity. | |
12
+ | **description** | **String** | | [optional] |
13
+ | **version** | **Integer** | | [optional] |
14
+ | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **modified_by** | **String** | | [optional] |
17
+ | **created_by** | **String** | | [optional] |
18
+ | **state** | **String** | | [optional] |
19
+ | **modified_by_app** | **String** | | [optional] |
20
+ | **created_by_app** | **String** | | [optional] |
21
+ | **phone_meta_base** | [**UriReference**](UriReference.html) | A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process. | |
22
+ | **lines** | [**Array<LineBase>**](LineBase.html) | The list of linebases associated with the phone base. | |
14
23
  | **properties** | **Hash<String, Object>** | | [optional] |
15
24
  | **capabilities** | [**PhoneCapabilities**](PhoneCapabilities.html) | | [optional] |
16
25
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -14,8 +14,8 @@ title: PhoneBaseEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: PhoneEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: PhoneMetaBaseEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: PhysicalInterfaceEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: PolicyEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -34,6 +34,7 @@ Method | HTTP request | Description
34
34
  |[**post_forms**](QualityApi.html#post_forms) | **POST** /api/v2/quality/forms | Create an evaluation form.|
35
35
  |[**post_keywordsets**](QualityApi.html#post_keywordsets) | **POST** /api/v2/quality/keywordsets | Create a Keyword Set|
36
36
  |[**post_publishedforms**](QualityApi.html#post_publishedforms) | **POST** /api/v2/quality/publishedforms | Publish an evaluation form.|
37
+ |[**post_spotability**](QualityApi.html#post_spotability) | **POST** /api/v2/quality/spotability | Retrieve the spotability statistic|
37
38
  |[**put_calibrations_calibration_id**](QualityApi.html#put_calibrations_calibration_id) | **PUT** /api/v2/quality/calibrations/{calibrationId} | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex|
38
39
  |[**put_conversations_conversation_id_evaluations_evaluation_id**](QualityApi.html#put_conversations_conversation_id_evaluations_evaluation_id) | **PUT** /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} | Update an evaluation|
39
40
  |[**put_forms_form_id**](QualityApi.html#put_forms_form_id) | **PUT** /api/v2/quality/forms/{formId} | Update an evaluation form.|
@@ -1682,6 +1683,63 @@ Name | Type | Description | Notes
1682
1683
 
1683
1684
 
1684
1685
 
1686
+ <a name="post_spotability"></a>
1687
+
1688
+ ## -[**KeywordSet**](KeywordSet.html) post_spotability(opts)
1689
+
1690
+ Retrieve the spotability statistic
1691
+
1692
+
1693
+
1694
+ ### Example
1695
+ ~~~ruby
1696
+ # load the gem
1697
+ require 'purecloud'
1698
+ # setup authorization
1699
+ @secret = ENV['PURECLOUD_SECRET']
1700
+ @id = ENV['PURECLOUD_CLIENT_ID']
1701
+ environment = "mypurecloud.com"
1702
+
1703
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1704
+
1705
+ PureCloud.configure do |config|
1706
+ config.access_token = @authToken
1707
+ end
1708
+
1709
+ api_instance = PureCloud::QualityApi.new
1710
+
1711
+ opts = {
1712
+ body: PureCloud::KeywordSet.new # KeywordSet | Keyword Set
1713
+ }
1714
+
1715
+ begin
1716
+ #Retrieve the spotability statistic
1717
+ result = api_instance.post_spotability(opts)
1718
+ p result
1719
+ rescue PureCloud::ApiError => e
1720
+ puts "Exception when calling QualityApi->post_spotability: #{e}"
1721
+ end
1722
+ ~~~
1723
+
1724
+ ### Parameters
1725
+
1726
+ Name | Type | Description | Notes
1727
+ ------------- | ------------- | ------------- | -------------
1728
+ **body** | [**KeywordSet**](KeywordSet.html)| Keyword Set | [optional]
1729
+ {: class="table table-striped"}
1730
+
1731
+
1732
+ ### Return type
1733
+
1734
+ [**KeywordSet**](KeywordSet.html)
1735
+
1736
+ ### HTTP request headers
1737
+
1738
+ - **Content-Type**: application/json
1739
+ - **Accept**: application/json
1740
+
1741
+
1742
+
1685
1743
  <a name="put_calibrations_calibration_id"></a>
1686
1744
 
1687
1745
  ## -[**Calibration**](Calibration.html) put_calibrations_calibration_id(calibration_id, body)
@@ -14,8 +14,8 @@ title: QualityAuditPage
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -18,13 +18,13 @@ title: Queue
18
18
  | **state** | **String** | | [optional] |
19
19
  | **modified_by_app** | **String** | | [optional] |
20
20
  | **created_by_app** | **String** | | [optional] |
21
- | **media_settings** | [**Hash&lt;String, MediaSetting&gt;**](MediaSetting.html) | | [optional] |
22
- | **bullseye** | [**Bullseye**](Bullseye.html) | | [optional] |
23
- | **acw_settings** | [**AcwSettings**](AcwSettings.html) | | [optional] |
24
- | **skill_evaluation_method** | **String** | | [optional] |
25
- | **queue_flow** | [**UriReference**](UriReference.html) | | [optional] |
26
- | **calling_party_name** | **String** | | [optional] |
27
- | **calling_party_number** | **String** | | [optional] |
21
+ | **media_settings** | [**Hash&lt;String, MediaSetting&gt;**](MediaSetting.html) | The media settings for the queue. | |
22
+ | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
23
+ | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
24
+ | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
25
+ | **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
26
+ | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
27
+ | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
28
28
  | **member_count** | **Integer** | | [optional] |
29
29
  | **self_uri** | **String** | The URI for this object | [optional] |
30
30
  {: class="table table-striped"}
@@ -14,8 +14,8 @@ title: QueueEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: ReportMetaDataEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **last_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21