purecloud 0.54.1 → 0.55.1

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -8,7 +8,7 @@ title: Workspace
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 current name of the workspace. | |
12
12
  | **type** | **String** | | [optional] |
13
13
  | **is_current_user_workspace** | **BOOLEAN** | | [optional] [default to false]|
14
14
  | **user** | [**UriReference**](UriReference.html) | | [optional] |
@@ -11,11 +11,11 @@ title: WorkspaceEntityListing
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
 
@@ -10,7 +10,7 @@ title: WorkspaceMember
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **workspace** | [**UriReference**](UriReference.html) | | [optional] |
13
- | **member_type** | **String** | | [optional] |
13
+ | **member_type** | **String** | The workspace member type. | |
14
14
  | **member** | [**UriReference**](UriReference.html) | | [optional] |
15
15
  | **user** | [**User**](User.html) | | [optional] |
16
16
  | **group** | [**Group**](Group.html) | | [optional] |
@@ -11,11 +11,11 @@ title: WorkspaceMemberEntityListing
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
 
@@ -11,11 +11,11 @@ title: WrapupCodeEntityListing
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
 
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
9
9
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
10
10
 
11
11
  - API version: v2
12
- - Package version: 0.54.1
13
- - Build date: 2016-10-18T18:59:42.589Z
12
+ - Package version: 0.55.1
13
+ - Build date: 2016-10-24T20:40:37.041Z
14
14
 
15
15
  For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
16
16
 
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
18
18
 
19
19
  ### from rubygems.org
20
20
 
21
- gem 'purecloud', '~> 0.54.1'
21
+ gem 'purecloud', '~> 0.55.1'
22
22
 
23
23
  ### Install from Git
24
24
 
@@ -260,6 +260,7 @@ require 'purecloud/models/domain_org_role_difference'
260
260
  require 'purecloud/models/domain_organization_product'
261
261
  require 'purecloud/models/domain_organization_role'
262
262
  require 'purecloud/models/domain_organization_role_create'
263
+ require 'purecloud/models/domain_organization_role_update'
263
264
  require 'purecloud/models/domain_permission'
264
265
  require 'purecloud/models/domain_permission_collection'
265
266
  require 'purecloud/models/domain_permission_policy'
@@ -342,6 +343,20 @@ require 'purecloud/models/fax_send_request'
342
343
  require 'purecloud/models/fax_send_response'
343
344
  require 'purecloud/models/fax_status'
344
345
  require 'purecloud/models/fax_summary'
346
+ require 'purecloud/models/field_config'
347
+ require 'purecloud/models/field_list'
348
+ require 'purecloud/models/forecast'
349
+ require 'purecloud/models/forecast_creation'
350
+ require 'purecloud/models/forecast_creation_completion'
351
+ require 'purecloud/models/forecast_dimensions'
352
+ require 'purecloud/models/forecast_entry'
353
+ require 'purecloud/models/forecast_filter_attributes'
354
+ require 'purecloud/models/forecast_metadata'
355
+ require 'purecloud/models/forecast_metadata_entity_listing'
356
+ require 'purecloud/models/forecast_modification'
357
+ require 'purecloud/models/forecast_modification_creation'
358
+ require 'purecloud/models/forecast_search_criteria'
359
+ require 'purecloud/models/forecast_search_request'
345
360
  require 'purecloud/models/geolocation'
346
361
  require 'purecloud/models/geolocation_settings'
347
362
  require 'purecloud/models/greeting'
@@ -539,6 +554,7 @@ require 'purecloud/models/screenshare'
539
554
  require 'purecloud/models/search_aggregation'
540
555
  require 'purecloud/models/search_criteria'
541
556
  require 'purecloud/models/search_request'
557
+ require 'purecloud/models/section'
542
558
  require 'purecloud/models/security_profile'
543
559
  require 'purecloud/models/security_profile_entity_listing'
544
560
  require 'purecloud/models/segment'
@@ -584,6 +600,7 @@ require 'purecloud/models/transfer_request'
584
600
  require 'purecloud/models/trunk'
585
601
  require 'purecloud/models/trunk_base'
586
602
  require 'purecloud/models/trunk_base_assignment'
603
+ require 'purecloud/models/trunk_base_entity_listing'
587
604
  require 'purecloud/models/trunk_entity_listing'
588
605
  require 'purecloud/models/trunk_metabase_entity_listing'
589
606
  require 'purecloud/models/trunk_recording_enabled_count'
@@ -593,6 +610,7 @@ require 'purecloud/models/uri_reference'
593
610
  require 'purecloud/models/usage'
594
611
  require 'purecloud/models/usage_item'
595
612
  require 'purecloud/models/user'
613
+ require 'purecloud/models/user_agent_info'
596
614
  require 'purecloud/models/user_authorization'
597
615
  require 'purecloud/models/user_conversation_summary'
598
616
  require 'purecloud/models/user_conversation_summary_notification'
@@ -3591,6 +3591,80 @@ module PureCloud
3591
3591
  return data, status_code, headers
3592
3592
  end
3593
3593
 
3594
+ # Update conversation participant's communication by disconnecting it.
3595
+ #
3596
+ # @param email_id emailId
3597
+ # @param participant_id participantId
3598
+ # @param communication_id communicationId
3599
+ # @param body Participant
3600
+ # @param [Hash] opts the optional parameters
3601
+ # @return [nil]
3602
+ def patch_emails_email_id_participants_participant_id_communications_communication_id(email_id, participant_id, communication_id, body, opts = {})
3603
+ patch_emails_email_id_participants_participant_id_communications_communication_id_with_http_info(email_id, participant_id, communication_id, body, opts)
3604
+ return nil
3605
+ end
3606
+
3607
+ # Update conversation participant's communication by disconnecting it.
3608
+ #
3609
+ # @param email_id emailId
3610
+ # @param participant_id participantId
3611
+ # @param communication_id communicationId
3612
+ # @param body Participant
3613
+ # @param [Hash] opts the optional parameters
3614
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3615
+ def patch_emails_email_id_participants_participant_id_communications_communication_id_with_http_info(email_id, participant_id, communication_id, body, opts = {})
3616
+ if @api_client.config.debugging
3617
+ @api_client.config.logger.debug "Calling API: ConversationsApi#patch_emails_email_id_participants_participant_id_communications_communication_id ..."
3618
+ end
3619
+
3620
+ # verify the required parameter 'email_id' is set
3621
+ fail "Missing the required parameter 'email_id' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if email_id.nil?
3622
+
3623
+ # verify the required parameter 'participant_id' is set
3624
+ fail "Missing the required parameter 'participant_id' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if participant_id.nil?
3625
+
3626
+ # verify the required parameter 'communication_id' is set
3627
+ fail "Missing the required parameter 'communication_id' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if communication_id.nil?
3628
+
3629
+ # verify the required parameter 'body' is set
3630
+ fail "Missing the required parameter 'body' when calling patch_emails_email_id_participants_participant_id_communications_communication_id" if body.nil?
3631
+
3632
+ # resource path
3633
+ local_var_path = "/api/v2/conversations/emails/{emailId}/participants/{participantId}/communications/{communicationId}".sub('{format}','json').sub('{' + 'emailId' + '}', email_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s).sub('{' + 'communicationId' + '}', communication_id.to_s)
3634
+
3635
+ # query parameters
3636
+ query_params = {}
3637
+
3638
+ # header parameters
3639
+ header_params = {}
3640
+
3641
+ # HTTP header 'Accept' (if needed)
3642
+ _header_accept = ['application/json']
3643
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
3644
+
3645
+ # HTTP header 'Content-Type'
3646
+ _header_content_type = ['application/json']
3647
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
3648
+
3649
+ # form parameters
3650
+ form_params = {}
3651
+
3652
+ # http body (model)
3653
+ post_body = @api_client.object_to_http_body(body)
3654
+
3655
+ auth_names = ['PureCloud Auth']
3656
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
3657
+ :header_params => header_params,
3658
+ :query_params => query_params,
3659
+ :form_params => form_params,
3660
+ :body => post_body,
3661
+ :auth_names => auth_names)
3662
+ if @api_client.config.debugging
3663
+ @api_client.config.logger.debug "API called: ConversationsApi#patch_emails_email_id_participants_participant_id_communications_communication_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3664
+ end
3665
+ return data, status_code, headers
3666
+ end
3667
+
3594
3668
  # Create a Callback
3595
3669
  #
3596
3670
  # @param body Callback
@@ -149,6 +149,70 @@ module PureCloud
149
149
  return data, status_code, headers
150
150
  end
151
151
 
152
+ # Fetch field config for an entity type
153
+ #
154
+ # @param type Field type
155
+ # @param [Hash] opts the optional parameters
156
+ # @return [FieldConfig]
157
+ def get_fieldconfig(type, opts = {})
158
+ data, status_code, headers = get_fieldconfig_with_http_info(type, opts)
159
+ return data
160
+ end
161
+
162
+ # Fetch field config for an entity type
163
+ #
164
+ # @param type Field type
165
+ # @param [Hash] opts the optional parameters
166
+ # @return [Array<(FieldConfig, Fixnum, Hash)>] FieldConfig data, response status code and response headers
167
+ def get_fieldconfig_with_http_info(type, opts = {})
168
+ if @api_client.config.debugging
169
+ @api_client.config.logger.debug "Calling API: GroupsApi#get_fieldconfig ..."
170
+ end
171
+
172
+ # verify the required parameter 'type' is set
173
+ fail "Missing the required parameter 'type' when calling get_fieldconfig" if type.nil?
174
+ unless ['person', 'group', 'org'].include?(type)
175
+ fail "invalid value for 'type', must be one of person, group, org"
176
+ end
177
+
178
+ # resource path
179
+ local_var_path = "/api/v2/fieldconfig".sub('{format}','json')
180
+
181
+ # query parameters
182
+ query_params = {}
183
+ query_params[:'type'] = type
184
+
185
+ # header parameters
186
+ header_params = {}
187
+
188
+ # HTTP header 'Accept' (if needed)
189
+ _header_accept = ['application/json']
190
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
191
+
192
+ # HTTP header 'Content-Type'
193
+ _header_content_type = ['application/json']
194
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
195
+
196
+ # form parameters
197
+ form_params = {}
198
+
199
+ # http body (model)
200
+ post_body = nil
201
+
202
+ auth_names = ['PureCloud Auth']
203
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
204
+ :header_params => header_params,
205
+ :query_params => query_params,
206
+ :form_params => form_params,
207
+ :body => post_body,
208
+ :auth_names => auth_names,
209
+ :return_type => 'FieldConfig')
210
+ if @api_client.config.debugging
211
+ @api_client.config.logger.debug "API called: GroupsApi#get_fieldconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
+ end
213
+ return data, status_code, headers
214
+ end
215
+
152
216
  # Get group
153
217
  #
154
218
  # @param group_id Group ID
@@ -24,6 +24,70 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
+ # Fetch field config for an entity type
28
+ #
29
+ # @param type Field type
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [FieldConfig]
32
+ def get_fieldconfig(type, opts = {})
33
+ data, status_code, headers = get_fieldconfig_with_http_info(type, opts)
34
+ return data
35
+ end
36
+
37
+ # Fetch field config for an entity type
38
+ #
39
+ # @param type Field type
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(FieldConfig, Fixnum, Hash)>] FieldConfig data, response status code and response headers
42
+ def get_fieldconfig_with_http_info(type, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: OrganizationApi#get_fieldconfig ..."
45
+ end
46
+
47
+ # verify the required parameter 'type' is set
48
+ fail "Missing the required parameter 'type' when calling get_fieldconfig" if type.nil?
49
+ unless ['person', 'group', 'org'].include?(type)
50
+ fail "invalid value for 'type', must be one of person, group, org"
51
+ end
52
+
53
+ # resource path
54
+ local_var_path = "/api/v2/fieldconfig".sub('{format}','json')
55
+
56
+ # query parameters
57
+ query_params = {}
58
+ query_params[:'type'] = type
59
+
60
+ # header parameters
61
+ header_params = {}
62
+
63
+ # HTTP header 'Accept' (if needed)
64
+ _header_accept = ['application/json']
65
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
66
+
67
+ # HTTP header 'Content-Type'
68
+ _header_content_type = ['application/json']
69
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
70
+
71
+ # form parameters
72
+ form_params = {}
73
+
74
+ # http body (model)
75
+ post_body = nil
76
+
77
+ auth_names = ['PureCloud Auth']
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => 'FieldConfig')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: OrganizationApi#get_fieldconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+
27
91
  # Get organization.
28
92
  #
29
93
  # @param [Hash] opts the optional parameters
@@ -3871,7 +3871,7 @@ module PureCloud
3871
3871
  # @option opts [String] :sort_by Value by which to sort (default to name)
3872
3872
  # @option opts [String] :sort_order Sort order (default to ASC)
3873
3873
  # @option opts [BOOLEAN] :recording_enabled Filter trunks by recording enabled
3874
- # @return [TrunkBase]
3874
+ # @return [TrunkBaseEntityListing]
3875
3875
  def get_providers_edges_trunkbasesettings(opts = {})
3876
3876
  data, status_code, headers = get_providers_edges_trunkbasesettings_with_http_info(opts)
3877
3877
  return data
@@ -3885,7 +3885,7 @@ module PureCloud
3885
3885
  # @option opts [String] :sort_by Value by which to sort
3886
3886
  # @option opts [String] :sort_order Sort order
3887
3887
  # @option opts [BOOLEAN] :recording_enabled Filter trunks by recording enabled
3888
- # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
3888
+ # @return [Array<(TrunkBaseEntityListing, Fixnum, Hash)>] TrunkBaseEntityListing data, response status code and response headers
3889
3889
  def get_providers_edges_trunkbasesettings_with_http_info(opts = {})
3890
3890
  if @api_client.config.debugging
3891
3891
  @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings ..."
@@ -3926,7 +3926,7 @@ module PureCloud
3926
3926
  :form_params => form_params,
3927
3927
  :body => post_body,
3928
3928
  :auth_names => auth_names,
3929
- :return_type => 'TrunkBase')
3929
+ :return_type => 'TrunkBaseEntityListing')
3930
3930
  if @api_client.config.debugging
3931
3931
  @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_providers_edges_trunkbasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3932
3932
  end
@@ -326,6 +326,70 @@ module PureCloud
326
326
  return data, status_code, headers
327
327
  end
328
328
 
329
+ # Fetch field config for an entity type
330
+ #
331
+ # @param type Field type
332
+ # @param [Hash] opts the optional parameters
333
+ # @return [FieldConfig]
334
+ def get_fieldconfig(type, opts = {})
335
+ data, status_code, headers = get_fieldconfig_with_http_info(type, opts)
336
+ return data
337
+ end
338
+
339
+ # Fetch field config for an entity type
340
+ #
341
+ # @param type Field type
342
+ # @param [Hash] opts the optional parameters
343
+ # @return [Array<(FieldConfig, Fixnum, Hash)>] FieldConfig data, response status code and response headers
344
+ def get_fieldconfig_with_http_info(type, opts = {})
345
+ if @api_client.config.debugging
346
+ @api_client.config.logger.debug "Calling API: UsersApi#get_fieldconfig ..."
347
+ end
348
+
349
+ # verify the required parameter 'type' is set
350
+ fail "Missing the required parameter 'type' when calling get_fieldconfig" if type.nil?
351
+ unless ['person', 'group', 'org'].include?(type)
352
+ fail "invalid value for 'type', must be one of person, group, org"
353
+ end
354
+
355
+ # resource path
356
+ local_var_path = "/api/v2/fieldconfig".sub('{format}','json')
357
+
358
+ # query parameters
359
+ query_params = {}
360
+ query_params[:'type'] = type
361
+
362
+ # header parameters
363
+ header_params = {}
364
+
365
+ # HTTP header 'Accept' (if needed)
366
+ _header_accept = ['application/json']
367
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
368
+
369
+ # HTTP header 'Content-Type'
370
+ _header_content_type = ['application/json']
371
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
372
+
373
+ # form parameters
374
+ form_params = {}
375
+
376
+ # http body (model)
377
+ post_body = nil
378
+
379
+ auth_names = ['PureCloud Auth']
380
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
381
+ :header_params => header_params,
382
+ :query_params => query_params,
383
+ :form_params => form_params,
384
+ :body => post_body,
385
+ :auth_names => auth_names,
386
+ :return_type => 'FieldConfig')
387
+ if @api_client.config.debugging
388
+ @api_client.config.logger.debug "API called: UsersApi#get_fieldconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
389
+ end
390
+ return data, status_code, headers
391
+ end
392
+
329
393
  # Get current user details.
330
394
  # This request is not valid when using the Client Credentials OAuth grant.
331
395
  # @param [Hash] opts the optional parameters