purecloud 0.54.1 → 0.55.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 (286) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/ADFS.html.md +1 -1
  5. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  6. data/doc_out/AggregationQuery.html.md +1 -0
  7. data/doc_out/AnalyticsParticipant.html.md +2 -0
  8. data/doc_out/AnalyticsQueryClause.html.md +2 -2
  9. data/doc_out/AnalyticsQueryFilter.html.md +1 -1
  10. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  11. data/doc_out/AttributeEntityListing.html.md +2 -2
  12. data/doc_out/AuthorizationApi.html.md +2 -2
  13. data/doc_out/CalibrationEntityListing.html.md +2 -2
  14. data/doc_out/CallConversationEntityListing.html.md +2 -2
  15. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  16. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  17. data/doc_out/CampaignEntityListing.html.md +2 -2
  18. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  19. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  20. data/doc_out/ChannelEntityListing.html.md +2 -2
  21. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  22. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  23. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  24. data/doc_out/ContactListEntityListing.html.md +2 -2
  25. data/doc_out/ConversationEntityListing.html.md +2 -2
  26. data/doc_out/ConversationsApi.html.md +65 -0
  27. data/doc_out/CustomerInteractionCenter.html.md +1 -1
  28. data/doc_out/DIDEntityListing.html.md +2 -2
  29. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  30. data/doc_out/DncListEntityListing.html.md +2 -2
  31. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  32. data/doc_out/DocumentEntityListing.html.md +2 -2
  33. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  34. data/doc_out/DomainEntityListing.html.md +2 -2
  35. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  36. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  37. data/doc_out/DomainOrganizationRole.html.md +2 -2
  38. data/doc_out/DomainOrganizationRoleCreate.html.md +2 -2
  39. data/doc_out/DomainOrganizationRoleUpdate.html.md +23 -0
  40. data/doc_out/EdgeEntityListing.html.md +2 -2
  41. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  42. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  43. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  44. data/doc_out/EmailMessageListing.html.md +2 -2
  45. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  46. data/doc_out/EndpointEntityListing.html.md +2 -2
  47. data/doc_out/EvaluationEntityListing.html.md +2 -2
  48. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  49. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  50. data/doc_out/ExtensionEntityListing.html.md +2 -2
  51. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  52. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  53. data/doc_out/FieldConfig.html.md +20 -0
  54. data/doc_out/FieldList.html.md +21 -0
  55. data/doc_out/Forecast.html.md +16 -0
  56. data/doc_out/ForecastCreation.html.md +17 -0
  57. data/doc_out/ForecastCreationCompletion.html.md +14 -0
  58. data/doc_out/ForecastDimensions.html.md +15 -0
  59. data/doc_out/ForecastEntry.html.md +15 -0
  60. data/doc_out/ForecastFilterAttributes.html.md +15 -0
  61. data/doc_out/ForecastMetadata.html.md +22 -0
  62. data/doc_out/ForecastMetadataEntityListing.html.md +22 -0
  63. data/doc_out/ForecastModification.html.md +27 -0
  64. data/doc_out/ForecastModificationCreation.html.md +25 -0
  65. data/doc_out/ForecastSearchCriteria.html.md +20 -0
  66. data/doc_out/ForecastSearchRequest.html.md +20 -0
  67. data/doc_out/GroupEntityListing.html.md +2 -2
  68. data/doc_out/GroupsApi.html.md +57 -0
  69. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  70. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  71. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  72. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  73. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  74. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  75. data/doc_out/JsonNode.html.md +4 -4
  76. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  77. data/doc_out/LanguageEntityListing.html.md +2 -2
  78. data/doc_out/LibraryEntityListing.html.md +2 -2
  79. data/doc_out/LineBaseEntityListing.html.md +2 -2
  80. data/doc_out/LineEntityListing.html.md +2 -2
  81. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  82. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  83. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  84. data/doc_out/ObservationQuery.html.md +1 -1
  85. data/doc_out/Okta.html.md +1 -1
  86. data/doc_out/OneLogin.html.md +1 -1
  87. data/doc_out/OrganizationApi.html.md +57 -0
  88. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  89. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  90. data/doc_out/OrphanRecordingListing.html.md +2 -2
  91. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  92. data/doc_out/PagingSpec.html.md +2 -2
  93. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  94. data/doc_out/Phone.html.md +1 -0
  95. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  96. data/doc_out/PhoneEntityListing.html.md +2 -2
  97. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  98. data/doc_out/PhoneStatus.html.md +1 -0
  99. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  100. data/doc_out/PolicyEntityListing.html.md +2 -2
  101. data/doc_out/PropertyIndexRequest.html.md +2 -2
  102. data/doc_out/QualityAuditPage.html.md +2 -2
  103. data/doc_out/QueueEntityListing.html.md +2 -2
  104. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  105. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  106. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  107. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  108. data/doc_out/ResponseEntityList.html.md +2 -2
  109. data/doc_out/ResponseEntityListing.html.md +2 -2
  110. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  111. data/doc_out/RuleSetEntityListing.html.md +2 -2
  112. data/doc_out/Salesforce.html.md +1 -1
  113. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  114. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  115. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  116. data/doc_out/Section.html.md +16 -0
  117. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  118. data/doc_out/ShareEntityListing.html.md +2 -2
  119. data/doc_out/SiteEntityListing.html.md +2 -2
  120. data/doc_out/SkillEntityListing.html.md +2 -2
  121. data/doc_out/SocialExpression.html.md +1 -1
  122. data/doc_out/StationEntityListing.html.md +2 -2
  123. data/doc_out/TagValueEntityListing.html.md +2 -2
  124. data/doc_out/TelephonyProvidersEdgeApi.html.md +2 -2
  125. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  126. data/doc_out/TrunkBaseEntityListing.html.md +22 -0
  127. data/doc_out/TrunkEntityListing.html.md +2 -2
  128. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  129. data/doc_out/UserAgentInfo.html.md +15 -0
  130. data/doc_out/UserEntityListing.html.md +2 -2
  131. data/doc_out/UserQueueEntityListing.html.md +2 -2
  132. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  133. data/doc_out/UserSkillEntityListing.html.md +2 -2
  134. data/doc_out/UsersApi.html.md +57 -0
  135. data/doc_out/UsersEntityListing.html.md +2 -2
  136. data/doc_out/WorkforceManagementApi.html.md +463 -0
  137. data/doc_out/Workspace.html.md +1 -1
  138. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  139. data/doc_out/WorkspaceMember.html.md +1 -1
  140. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  141. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  142. data/doc_out/index.html.md +3 -3
  143. data/lib/purecloud.rb +18 -0
  144. data/lib/purecloud/api/conversations_api.rb +74 -0
  145. data/lib/purecloud/api/groups_api.rb +64 -0
  146. data/lib/purecloud/api/organization_api.rb +64 -0
  147. data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -3
  148. data/lib/purecloud/api/users_api.rb +64 -0
  149. data/lib/purecloud/api/workforce_management_api.rb +493 -0
  150. data/lib/purecloud/api_client.rb +1 -1
  151. data/lib/purecloud/models/adfs.rb +11 -11
  152. data/lib/purecloud/models/agent_activity_entity_listing.rb +21 -21
  153. data/lib/purecloud/models/aggregation_query.rb +12 -1
  154. data/lib/purecloud/models/analytics_participant.rb +21 -1
  155. data/lib/purecloud/models/analytics_query_clause.rb +1 -0
  156. data/lib/purecloud/models/analytics_query_filter.rb +1 -0
  157. data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
  158. data/lib/purecloud/models/analytics_session.rb +1 -1
  159. data/lib/purecloud/models/attempt_limits_entity_listing.rb +21 -21
  160. data/lib/purecloud/models/attribute_entity_listing.rb +21 -21
  161. data/lib/purecloud/models/calibration_entity_listing.rb +21 -21
  162. data/lib/purecloud/models/call_conversation_entity_listing.rb +21 -21
  163. data/lib/purecloud/models/callable_time_set_entity_listing.rb +21 -21
  164. data/lib/purecloud/models/callback_conversation_entity_listing.rb +21 -21
  165. data/lib/purecloud/models/campaign_entity_listing.rb +21 -21
  166. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +21 -21
  167. data/lib/purecloud/models/certificate_authority_entity_listing.rb +21 -21
  168. data/lib/purecloud/models/channel_entity_listing.rb +21 -21
  169. data/lib/purecloud/models/chat_conversation_entity_listing.rb +21 -21
  170. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +21 -21
  171. data/lib/purecloud/models/command_status_entity_listing.rb +21 -21
  172. data/lib/purecloud/models/contact_list_entity_listing.rb +21 -21
  173. data/lib/purecloud/models/conversation_entity_listing.rb +21 -21
  174. data/lib/purecloud/models/customer_interaction_center.rb +11 -11
  175. data/lib/purecloud/models/did_entity_listing.rb +21 -21
  176. data/lib/purecloud/models/did_pool_entity_listing.rb +21 -21
  177. data/lib/purecloud/models/dnc_list_entity_listing.rb +21 -21
  178. data/lib/purecloud/models/document_audit_entity_listing.rb +21 -21
  179. data/lib/purecloud/models/document_entity_listing.rb +21 -21
  180. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +21 -21
  181. data/lib/purecloud/models/domain_entity_listing.rb +21 -21
  182. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +21 -21
  183. data/lib/purecloud/models/domain_entity_listing_query_result.rb +21 -21
  184. data/lib/purecloud/models/domain_organization_role.rb +14 -13
  185. data/lib/purecloud/models/domain_organization_role_create.rb +14 -13
  186. data/lib/purecloud/models/domain_organization_role_update.rb +279 -0
  187. data/lib/purecloud/models/edge_entity_listing.rb +21 -21
  188. data/lib/purecloud/models/edge_group_entity_listing.rb +21 -21
  189. data/lib/purecloud/models/edge_line_entity_listing.rb +21 -21
  190. data/lib/purecloud/models/email_conversation_entity_listing.rb +21 -21
  191. data/lib/purecloud/models/email_message_listing.rb +21 -21
  192. data/lib/purecloud/models/encryption_key_entity_listing.rb +21 -21
  193. data/lib/purecloud/models/endpoint_entity_listing.rb +21 -21
  194. data/lib/purecloud/models/evaluation_entity_listing.rb +21 -21
  195. data/lib/purecloud/models/evaluation_form_entity_listing.rb +21 -21
  196. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +21 -21
  197. data/lib/purecloud/models/extension_entity_listing.rb +21 -21
  198. data/lib/purecloud/models/extension_pool_entity_listing.rb +21 -21
  199. data/lib/purecloud/models/fax_document_entity_listing.rb +21 -21
  200. data/lib/purecloud/models/field_config.rb +248 -0
  201. data/lib/purecloud/models/field_list.rb +255 -0
  202. data/lib/purecloud/models/forecast.rb +201 -0
  203. data/lib/purecloud/models/forecast_creation.rb +221 -0
  204. data/lib/purecloud/models/forecast_creation_completion.rb +186 -0
  205. data/lib/purecloud/models/forecast_dimensions.rb +197 -0
  206. data/lib/purecloud/models/forecast_entry.rb +199 -0
  207. data/lib/purecloud/models/forecast_filter_attributes.rb +191 -0
  208. data/lib/purecloud/models/forecast_metadata.rb +284 -0
  209. data/lib/purecloud/models/forecast_metadata_entity_listing.rb +257 -0
  210. data/lib/purecloud/models/forecast_modification.rb +339 -0
  211. data/lib/purecloud/models/forecast_modification_creation.rb +317 -0
  212. data/lib/purecloud/models/forecast_search_criteria.rb +267 -0
  213. data/lib/purecloud/models/forecast_search_request.rb +259 -0
  214. data/lib/purecloud/models/group_entity_listing.rb +21 -21
  215. data/lib/purecloud/models/heart_beat_alert_container.rb +21 -21
  216. data/lib/purecloud/models/heart_beat_rule_container.rb +21 -21
  217. data/lib/purecloud/models/inbound_domain_entity_listing.rb +21 -21
  218. data/lib/purecloud/models/inbound_route_entity_listing.rb +21 -21
  219. data/lib/purecloud/models/interaction_stats_alert_container.rb +21 -21
  220. data/lib/purecloud/models/interaction_stats_rule_container.rb +21 -21
  221. data/lib/purecloud/models/json_node.rb +44 -44
  222. data/lib/purecloud/models/keyword_set_entity_listing.rb +21 -21
  223. data/lib/purecloud/models/language_entity_listing.rb +21 -21
  224. data/lib/purecloud/models/library_entity_listing.rb +21 -21
  225. data/lib/purecloud/models/line_base_entity_listing.rb +21 -21
  226. data/lib/purecloud/models/line_entity_listing.rb +21 -21
  227. data/lib/purecloud/models/logical_interface_entity_listing.rb +21 -21
  228. data/lib/purecloud/models/o_auth_client_entity_listing.rb +21 -21
  229. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +21 -21
  230. data/lib/purecloud/models/okta.rb +11 -11
  231. data/lib/purecloud/models/one_login.rb +11 -11
  232. data/lib/purecloud/models/organization_presence_entity_listing.rb +21 -21
  233. data/lib/purecloud/models/organization_role_entity_listing.rb +21 -21
  234. data/lib/purecloud/models/orphan_recording_listing.rb +21 -21
  235. data/lib/purecloud/models/outbound_route_entity_listing.rb +21 -21
  236. data/lib/purecloud/models/permission_collection_entity_listing.rb +21 -21
  237. data/lib/purecloud/models/phone.rb +12 -1
  238. data/lib/purecloud/models/phone_base_entity_listing.rb +21 -21
  239. data/lib/purecloud/models/phone_entity_listing.rb +21 -21
  240. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +21 -21
  241. data/lib/purecloud/models/phone_status.rb +12 -1
  242. data/lib/purecloud/models/physical_interface_entity_listing.rb +21 -21
  243. data/lib/purecloud/models/policy_entity_listing.rb +21 -21
  244. data/lib/purecloud/models/property_index_request.rb +9 -9
  245. data/lib/purecloud/models/quality_audit_page.rb +21 -21
  246. data/lib/purecloud/models/queue_entity_listing.rb +21 -21
  247. data/lib/purecloud/models/queue_member_entity_listing.rb +21 -21
  248. data/lib/purecloud/models/report_meta_data_entity_listing.rb +21 -21
  249. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +21 -21
  250. data/lib/purecloud/models/report_schedule_entity_listing.rb +21 -21
  251. data/lib/purecloud/models/response_entity_list.rb +21 -21
  252. data/lib/purecloud/models/response_entity_listing.rb +21 -21
  253. data/lib/purecloud/models/response_set_entity_listing.rb +21 -21
  254. data/lib/purecloud/models/rule_set_entity_listing.rb +21 -21
  255. data/lib/purecloud/models/salesforce.rb +11 -11
  256. data/lib/purecloud/models/schema_category_entity_listing.rb +21 -21
  257. data/lib/purecloud/models/schema_reference_entity_listing.rb +21 -21
  258. data/lib/purecloud/models/screen_recording_session_listing.rb +21 -21
  259. data/lib/purecloud/models/section.rb +197 -0
  260. data/lib/purecloud/models/security_profile_entity_listing.rb +21 -21
  261. data/lib/purecloud/models/share_entity_listing.rb +21 -21
  262. data/lib/purecloud/models/site_entity_listing.rb +21 -21
  263. data/lib/purecloud/models/skill_entity_listing.rb +21 -21
  264. data/lib/purecloud/models/social_expression.rb +1 -1
  265. data/lib/purecloud/models/station_entity_listing.rb +21 -21
  266. data/lib/purecloud/models/tag_value_entity_listing.rb +21 -21
  267. data/lib/purecloud/models/time_zone_entity_listing.rb +21 -21
  268. data/lib/purecloud/models/trunk_base_entity_listing.rb +257 -0
  269. data/lib/purecloud/models/trunk_entity_listing.rb +21 -21
  270. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +21 -21
  271. data/lib/purecloud/models/user_agent_info.rb +188 -0
  272. data/lib/purecloud/models/user_entity_listing.rb +21 -21
  273. data/lib/purecloud/models/user_queue_entity_listing.rb +21 -21
  274. data/lib/purecloud/models/user_recording_entity_listing.rb +21 -21
  275. data/lib/purecloud/models/user_skill_entity_listing.rb +21 -21
  276. data/lib/purecloud/models/users_entity_listing.rb +21 -21
  277. data/lib/purecloud/models/workspace.rb +1 -0
  278. data/lib/purecloud/models/workspace_entity_listing.rb +21 -21
  279. data/lib/purecloud/models/workspace_member.rb +1 -0
  280. data/lib/purecloud/models/workspace_member_entity_listing.rb +21 -21
  281. data/lib/purecloud/models/wrapup_code_entity_listing.rb +21 -21
  282. data/lib/purecloud/version.rb +1 -1
  283. data/newVersion.md +1 -1
  284. data/swagger.json +1 -1
  285. data/version.json +1 -1
  286. metadata +38 -2
data/doc_out/ResponseEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: ResponseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/ResponseSetEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: ResponseSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/RuleSetEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: RuleSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/Salesforce.html.md CHANGED
@@ -10,8 +10,8 @@ title: Salesforce
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **certificate** | **String** | | [optional] |
13
- | **sso_target_uri** | **String** | | [optional] |
14
13
  | **issuer_uri** | **String** | | [optional] |
14
+ | **sso_target_uri** | **String** | | [optional] |
15
15
  | **disabled** | **BOOLEAN** | | [optional] [default to false]|
16
16
  | **self_uri** | **String** | The URI for this object | [optional] |
17
17
  {: class="table table-striped"}
data/doc_out/SchemaCategoryEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SchemaCategoryEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/SchemaReferenceEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SchemaReferenceEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/ScreenRecordingSessionListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: ScreenRecordingSessionListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/Section.html.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: Section
3
+ ---
4
+ ## PureCloud::Section
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **field_list** | [**Array<FieldList>**](FieldList.html) | | [optional] |
11
+ | **instruction_text** | **String** | | [optional] |
12
+ | **key** | **String** | | [optional] |
13
+ | **state** | **String** | | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
data/doc_out/SecurityProfileEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SecurityProfileEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/ShareEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: ShareEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/SiteEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SiteEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/SkillEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: SkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/SocialExpression.html.md CHANGED
@@ -20,7 +20,7 @@ title: SocialExpression
20
20
  | **start_hold_time** | **DateTime** | The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
21
21
  | **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
22
22
  | **disconnected_time** | **DateTime** | The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
- | **provider** | **String** | The source provider for the video. | [optional] |
23
+ | **provider** | **String** | The source provider for the social expression. | [optional] |
24
24
  {: class="table table-striped"}
25
25
 
26
26
 
data/doc_out/StationEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: StationEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/TagValueEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TagValueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/TelephonyProvidersEdgeApi.html.md CHANGED
@@ -3691,7 +3691,7 @@ Name | Type | Description | Notes
3691
3691
 
3692
3692
  <a name="get_providers_edges_trunkbasesettings"></a>
3693
3693
 
3694
- ## -[**TrunkBase**](TrunkBase.html) get_providers_edges_trunkbasesettings(opts)
3694
+ ## -[**TrunkBaseEntityListing**](TrunkBaseEntityListing.html) get_providers_edges_trunkbasesettings(opts)
3695
3695
 
3696
3696
  Get Trunk Base Settings listing
3697
3697
 
@@ -3745,7 +3745,7 @@ Name | Type | Description | Notes
3745
3745
 
3746
3746
  ### Return type
3747
3747
 
3748
- [**TrunkBase**](TrunkBase.html)
3748
+ [**TrunkBaseEntityListing**](TrunkBaseEntityListing.html)
3749
3749
 
3750
3750
  ### HTTP request headers
3751
3751
 
data/doc_out/TimeZoneEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TimeZoneEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/TrunkBaseEntityListing.html.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: TrunkBaseEntityListing
3
+ ---
4
+ ## PureCloud::TrunkBaseEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array&lt;TrunkBase&gt;**](TrunkBase.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_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
+
data/doc_out/TrunkEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/TrunkMetabaseEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: TrunkMetabaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/UserAgentInfo.html.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: UserAgentInfo
3
+ ---
4
+ ## PureCloud::UserAgentInfo
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **firmware_version** | **String** | The firmware version of the phone. | [optional] |
11
+ | **manufacturer** | **String** | The manufacturer of the phone. | [optional] |
12
+ | **model** | **String** | The model of the phone. | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
data/doc_out/UserEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/UserQueueEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserQueueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/UserRecordingEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserRecordingEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/UserSkillEntityListing.html.md CHANGED
@@ -11,11 +11,11 @@ title: UserSkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
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/UsersApi.html.md CHANGED
@@ -13,6 +13,7 @@ Method | HTTP request | Description
13
13
  |[**delete_user_id_routingskills_skill_id**](UsersApi.html#delete_user_id_routingskills_skill_id) | **DELETE** /api/v2/users/{userId}/routingskills/{skillId} | Remove routing skill from user|
14
14
  |[**delete_user_id_station_associatedstation**](UsersApi.html#delete_user_id_station_associatedstation) | **DELETE** /api/v2/users/{userId}/station/associatedstation | Clear associated station|
15
15
  |[**delete_user_id_station_defaultstation**](UsersApi.html#delete_user_id_station_defaultstation) | **DELETE** /api/v2/users/{userId}/station/defaultstation | Clear default station|
16
+ |[**get_fieldconfig**](UsersApi.html#get_fieldconfig) | **GET** /api/v2/fieldconfig | Fetch field config for an entity type|
16
17
  |[**get_me**](UsersApi.html#get_me) | **GET** /api/v2/users/me | Get current user details.|
17
18
  |[**get_search**](UsersApi.html#get_search) | **GET** /api/v2/users/search | Search users using the q64 value returned from a previous search|
18
19
  |[**get_user_id**](UsersApi.html#get_user_id) | **GET** /api/v2/users/{userId} | Get user.|
@@ -330,6 +331,62 @@ nil (empty response body)
330
331
 
331
332
 
332
333
 
334
+ <a name="get_fieldconfig"></a>
335
+
336
+ ## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
337
+
338
+ Fetch field config for an entity type
339
+
340
+
341
+
342
+ ### Example
343
+ ~~~ruby
344
+ # load the gem
345
+ require 'purecloud'
346
+ # setup authorization
347
+ @secret = ENV['PURECLOUD_SECRET']
348
+ @id = ENV['PURECLOUD_CLIENT_ID']
349
+ environment = "mypurecloud.com"
350
+
351
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
352
+
353
+ PureCloud.configure do |config|
354
+ config.access_token = @authToken
355
+ end
356
+
357
+ api_instance = PureCloud::UsersApi.new
358
+
359
+ type = "type_example" # String | Field type
360
+
361
+
362
+ begin
363
+ #Fetch field config for an entity type
364
+ result = api_instance.get_fieldconfig(type)
365
+ p result
366
+ rescue PureCloud::ApiError => e
367
+ puts "Exception when calling UsersApi->get_fieldconfig: #{e}"
368
+ end
369
+ ~~~
370
+
371
+ ### Parameters
372
+
373
+ Name | Type | Description | Notes
374
+ ------------- | ------------- | ------------- | -------------
375
+ **type** | **String**| Field type |
376
+ {: class="table table-striped"}
377
+
378
+
379
+ ### Return type
380
+
381
+ [**FieldConfig**](FieldConfig.html)
382
+
383
+ ### HTTP request headers
384
+
385
+ - **Content-Type**: application/json
386
+ - **Accept**: application/json
387
+
388
+
389
+
333
390
  <a name="get_me"></a>
334
391
 
335
392
  ## -[**UserMe**](UserMe.html) get_me(opts)