purecloudplatformclientv2 28.0.1 → 29.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (315) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +1 -1
  4. data/docs/AgentActivityEntityListing.md +1 -1
  5. data/docs/AnalyticsApi.md +114 -0
  6. data/docs/ArchitectApi.md +4 -4
  7. data/docs/AttemptLimitsEntityListing.md +1 -1
  8. data/docs/AttributeEntityListing.md +1 -1
  9. data/docs/AuthorizationApi.md +66 -0
  10. data/docs/AuthzTypedObject.md +14 -0
  11. data/docs/CalibrationEntityListing.md +1 -1
  12. data/docs/CallConversationEntityListing.md +1 -1
  13. data/docs/CallHistoryConversationEntityListing.md +1 -1
  14. data/docs/CallableTimeSetEntityListing.md +1 -1
  15. data/docs/CallbackConversationEntityListing.md +1 -1
  16. data/docs/CampaignEntityListing.md +1 -1
  17. data/docs/CampaignRuleEntityListing.md +1 -1
  18. data/docs/CampaignSequenceEntityListing.md +1 -1
  19. data/docs/CertificateAuthorityEntityListing.md +1 -1
  20. data/docs/CertificateDetails.md +1 -1
  21. data/docs/ChatConversationEntityListing.md +1 -1
  22. data/docs/CobrowseConversationEntityListing.md +1 -1
  23. data/docs/CommandStatusEntityListing.md +1 -1
  24. data/docs/ConsumedResourcesEntityListing.md +1 -1
  25. data/docs/ConsumingResourcesEntityListing.md +1 -1
  26. data/docs/ContactListEntityListing.md +1 -1
  27. data/docs/ContactListFilterEntityListing.md +1 -1
  28. data/docs/ContactListing.md +1 -1
  29. data/docs/ConversationEntityListing.md +1 -1
  30. data/docs/DIDEntityListing.md +1 -1
  31. data/docs/DIDPoolEntityListing.md +1 -1
  32. data/docs/DataColumn.md +14 -0
  33. data/docs/DataTableRowEntityListing.md +1 -1
  34. data/docs/DataTablesDomainEntityListing.md +1 -1
  35. data/docs/DependencyObjectEntityListing.md +1 -1
  36. data/docs/DependencyTypeEntityListing.md +1 -1
  37. data/docs/DialerEventEntityListing.md +1 -1
  38. data/docs/DirectoryUserDevicesListing.md +1 -1
  39. data/docs/DncListEntityListing.md +1 -1
  40. data/docs/DocumentAuditEntityListing.md +1 -1
  41. data/docs/DocumentEntityListing.md +1 -1
  42. data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
  43. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  44. data/docs/DomainEntityListing.md +1 -1
  45. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  46. data/docs/DomainEntityListingQueryResult.md +1 -1
  47. data/docs/DomainEntityListingSurveyForm.md +1 -1
  48. data/docs/EdgeEntityListing.md +1 -1
  49. data/docs/EdgeGroupEntityListing.md +1 -1
  50. data/docs/EdgeLineEntityListing.md +1 -1
  51. data/docs/EmailConversationEntityListing.md +1 -1
  52. data/docs/EmailMessageListing.md +1 -1
  53. data/docs/EncryptionKeyEntityListing.md +1 -1
  54. data/docs/EndpointEntityListing.md +1 -1
  55. data/docs/EvaluationEntityListing.md +1 -1
  56. data/docs/EvaluationFormEntityListing.md +1 -1
  57. data/docs/EvaluatorActivityEntityListing.md +1 -1
  58. data/docs/ExtensionEntityListing.md +1 -1
  59. data/docs/ExtensionPoolEntityListing.md +1 -1
  60. data/docs/ExternalOrganizationListing.md +1 -1
  61. data/docs/FaxDocumentEntityListing.md +1 -1
  62. data/docs/FlowEntityListing.md +1 -1
  63. data/docs/FlowVersionEntityListing.md +1 -1
  64. data/docs/FreeSeatingConfiguration.md +14 -0
  65. data/docs/GreetingListing.md +1 -1
  66. data/docs/Group.md +1 -0
  67. data/docs/GroupCreate.md +26 -0
  68. data/docs/GroupEntityListing.md +1 -1
  69. data/docs/GroupUpdate.md +1 -0
  70. data/docs/GroupsApi.md +2 -2
  71. data/docs/IVREntityListing.md +1 -1
  72. data/docs/InboundDomainEntityListing.md +1 -1
  73. data/docs/InboundRouteEntityListing.md +1 -1
  74. data/docs/InteractionStatsAlertContainer.md +1 -1
  75. data/docs/InteractionStatsRuleContainer.md +1 -1
  76. data/docs/KeywordSetEntityListing.md +1 -1
  77. data/docs/LanguageEntityListing.md +1 -1
  78. data/docs/LibraryEntityListing.md +1 -1
  79. data/docs/LineBaseEntityListing.md +1 -1
  80. data/docs/LineEntityListing.md +1 -1
  81. data/docs/LocationEntityListing.md +1 -1
  82. data/docs/LogicalInterfaceEntityListing.md +1 -1
  83. data/docs/ManagementUnitListing.md +1 -1
  84. data/docs/MessageConversationEntityListing.md +1 -1
  85. data/docs/NoteListing.md +1 -1
  86. data/docs/NotificationsApi.md +1 -1
  87. data/docs/OAuthClientEntityListing.md +1 -1
  88. data/docs/OAuthProviderEntityListing.md +1 -1
  89. data/docs/ObjectsApi.md +66 -0
  90. data/docs/OrganizationPresenceEntityListing.md +1 -1
  91. data/docs/OrganizationRoleEntityListing.md +1 -1
  92. data/docs/OrphanRecordingListing.md +1 -1
  93. data/docs/OutboundApi.md +4 -0
  94. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  95. data/docs/OutboundRouteEntityListing.md +1 -1
  96. data/docs/PermissionCollectionEntityListing.md +1 -1
  97. data/docs/PhoneBaseEntityListing.md +1 -1
  98. data/docs/PhoneEntityListing.md +1 -1
  99. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  100. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  101. data/docs/PolicyEntityListing.md +1 -1
  102. data/docs/PromptAssetEntityListing.md +1 -1
  103. data/docs/PromptEntityListing.md +1 -1
  104. data/docs/QualityAuditPage.md +1 -1
  105. data/docs/Question.md +1 -1
  106. data/docs/QueueEntityListing.md +1 -1
  107. data/docs/QueueMemberEntityListing.md +1 -1
  108. data/docs/RecipientListing.md +1 -1
  109. data/docs/RelationshipListing.md +1 -1
  110. data/docs/ReportMetaDataEntityListing.md +1 -1
  111. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  112. data/docs/ReportScheduleEntityListing.md +1 -1
  113. data/docs/ReportingExportJobListing.md +22 -0
  114. data/docs/ReportingExportJobRequest.md +21 -0
  115. data/docs/ReportingExportJobResponse.md +28 -0
  116. data/docs/ResponseEntityList.md +1 -1
  117. data/docs/ResponseEntityListing.md +1 -1
  118. data/docs/ResponseSetEntityListing.md +1 -1
  119. data/docs/RuleSetEntityListing.md +1 -1
  120. data/docs/ScheduleEntityListing.md +1 -1
  121. data/docs/ScheduleGroupEntityListing.md +1 -1
  122. data/docs/SchemaCategoryEntityListing.md +1 -1
  123. data/docs/SchemaReferenceEntityListing.md +1 -1
  124. data/docs/ScreenRecordingSessionListing.md +1 -1
  125. data/docs/ScriptEntityListing.md +1 -1
  126. data/docs/SecurityProfileEntityListing.md +1 -1
  127. data/docs/ShareEntityListing.md +1 -1
  128. data/docs/SiteEntityListing.md +1 -1
  129. data/docs/SkillEntityListing.md +1 -1
  130. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  131. data/docs/StationEntityListing.md +1 -1
  132. data/docs/StationSettings.md +13 -0
  133. data/docs/StationsApi.md +114 -0
  134. data/docs/SurveyFormEntityListing.md +1 -1
  135. data/docs/SystemPromptAssetEntityListing.md +1 -1
  136. data/docs/SystemPromptEntityListing.md +1 -1
  137. data/docs/TagValueEntityListing.md +1 -1
  138. data/docs/TextMessageListing.md +1 -1
  139. data/docs/TimeZone.md +4 -4
  140. data/docs/TimeZoneEntityListing.md +1 -1
  141. data/docs/TrunkBaseEntityListing.md +1 -1
  142. data/docs/TrunkEntityListing.md +1 -1
  143. data/docs/TrunkMetabaseEntityListing.md +1 -1
  144. data/docs/TrustEntityListing.md +1 -1
  145. data/docs/TrustGroup.md +1 -0
  146. data/docs/TrustUserEntityListing.md +1 -1
  147. data/docs/TrustorEntityListing.md +1 -1
  148. data/docs/UserEntityListing.md +1 -1
  149. data/docs/UserProfileEntityListing.md +1 -1
  150. data/docs/UserQueueEntityListing.md +1 -1
  151. data/docs/UserRecordingEntityListing.md +1 -1
  152. data/docs/UserSkillEntityListing.md +1 -1
  153. data/docs/ViewFilter.md +23 -0
  154. data/docs/VoicemailMessageEntityListing.md +1 -1
  155. data/docs/WorkspaceEntityListing.md +1 -1
  156. data/docs/WorkspaceMemberEntityListing.md +1 -1
  157. data/docs/WrapupCodeEntityListing.md +1 -1
  158. data/lib/purecloudplatformclientv2.rb +9 -0
  159. data/lib/purecloudplatformclientv2/api/analytics_api.rb +120 -0
  160. data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
  161. data/lib/purecloudplatformclientv2/api/authorization_api.rb +90 -0
  162. data/lib/purecloudplatformclientv2/api/notifications_api.rb +2 -2
  163. data/lib/purecloudplatformclientv2/api/objects_api.rb +90 -0
  164. data/lib/purecloudplatformclientv2/api/outbound_api.rb +18 -0
  165. data/lib/purecloudplatformclientv2/api/stations_api.rb +120 -0
  166. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  167. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
  168. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  169. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  170. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +12 -12
  171. data/lib/purecloudplatformclientv2/models/authz_typed_object.rb +252 -0
  172. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  173. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  174. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
  175. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  176. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  177. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  178. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  179. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  180. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  181. data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
  182. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  183. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  184. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  185. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  186. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  187. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  188. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  189. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  190. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  191. data/lib/purecloudplatformclientv2/models/data_column.rb +252 -0
  192. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
  193. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
  194. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  195. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  196. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  197. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  198. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  199. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
  200. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  201. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  202. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  203. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
  204. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  205. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  206. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  207. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  208. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
  209. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  210. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  211. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  212. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  213. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  214. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  215. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +12 -12
  216. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  217. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  218. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  219. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  220. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  221. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  222. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  223. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  224. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  225. data/lib/purecloudplatformclientv2/models/free_seating_configuration.rb +228 -0
  226. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  227. data/lib/purecloudplatformclientv2/models/group.rb +29 -1
  228. data/lib/purecloudplatformclientv2/models/group_create.rb +605 -0
  229. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  230. data/lib/purecloudplatformclientv2/models/group_update.rb +31 -3
  231. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  232. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  233. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  234. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  235. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  236. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  237. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  238. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  239. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  240. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  241. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  242. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  243. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
  244. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
  245. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  246. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  247. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  248. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  249. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  250. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  251. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  252. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  253. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  254. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  255. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  256. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  257. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  258. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  259. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  260. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  261. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  262. data/lib/purecloudplatformclientv2/models/question.rb +13 -13
  263. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  264. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  265. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
  266. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  267. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  268. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  269. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  270. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +428 -0
  271. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +470 -0
  272. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +694 -0
  273. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  274. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  275. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  276. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  277. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  278. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  279. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  280. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  281. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  282. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  283. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  284. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  285. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  286. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  287. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
  288. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  289. data/lib/purecloudplatformclientv2/models/station_settings.rb +203 -0
  290. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
  291. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  292. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  293. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  294. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
  295. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -26
  296. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  297. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  298. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  299. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  300. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  301. data/lib/purecloudplatformclientv2/models/trust_group.rb +29 -1
  302. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  303. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  304. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  305. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
  306. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  307. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  308. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  309. data/lib/purecloudplatformclientv2/models/view_filter.rb +484 -0
  310. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  311. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  312. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  313. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  314. data/lib/purecloudplatformclientv2/version.rb +1 -1
  315. metadata +20 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 168142ffad0211b1c7dc2fea87305c27655edc62
4
- data.tar.gz: a00105f46dccb2e8f9b8ab9df4e27e34d7171291
3
+ metadata.gz: 2b65f8f371d0d7e880e91b78747bb6488689cc13
4
+ data.tar.gz: 79d3800340ce01da87744de0ce1c4b072c1edd23
5
5
  SHA512:
6
- metadata.gz: 4de35e06659000a9ca35108486034fded2e7f30b13e743fcc423e8662c8078e44082e67d8d77c24af6698d3ff358e35bad24c54335445b909acf39275196f518
7
- data.tar.gz: 40c63bde16e053509213cae192388410cf756a8a7d2d61edb634fb485b564845c8716b51a04316393476a40b2ace7a1119ac48b8187b8022346890e726da57d5
6
+ metadata.gz: b630437b6f9a3d258e480a955cecde252180961ded41d845c4fcfd6526fa9238b1ef260aea6137f0f92cd428a0c1baaf0f9ef83d838cdcf6782ef9c8713c06c9
7
+ data.tar.gz: 4779afc0296d364c682d5a69d3e8df077e650f3291d2bd20dce9c6ac986c39bab7351451875b6bc851c426b27aae377e3f5c6e335a9febe58ec83b83210872c3
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: PureCloud Ruby Gem
3
3
  ---
4
- ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=28.0.1)
4
+ ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=29.0.0)
5
5
 
6
6
  Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
7
7
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
10
10
  ### from rubygems.org
11
11
 
12
12
  ~~~ ruby
13
- gem install 'purecloudplatformclientv2', '~> 28.0.1'
13
+ gem install 'purecloudplatformclientv2', '~> 29.0.0'
14
14
  ~~~
15
15
 
16
16
  ### Install from Git
@@ -14,8 +14,8 @@ title: ActionEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: AgentActivityEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -10,6 +10,7 @@ Method | Description
10
10
  ------------- | ------------- | -------------
11
11
  [**delete_analytics_reporting_schedule**](AnalyticsApi.html#delete_analytics_reporting_schedule) | Delete a scheduled report job.
12
12
  [**get_analytics_conversation_details**](AnalyticsApi.html#get_analytics_conversation_details) | Get a conversation by id
13
+ [**get_analytics_reporting_exports**](AnalyticsApi.html#get_analytics_reporting_exports) | Get all view export requests for a user
13
14
  [**get_analytics_reporting_metadata**](AnalyticsApi.html#get_analytics_reporting_metadata) | Get list of reporting metadata.
14
15
  [**get_analytics_reporting_report_id_metadata**](AnalyticsApi.html#get_analytics_reporting_report_id_metadata) | Get a reporting metadata.
15
16
  [**get_analytics_reporting_reportformats**](AnalyticsApi.html#get_analytics_reporting_reportformats) | Get a list of report formats
@@ -24,6 +25,7 @@ Method | Description
24
25
  [**post_analytics_conversations_details_query**](AnalyticsApi.html#post_analytics_conversations_details_query) | Query for conversation details
25
26
  [**post_analytics_evaluations_aggregates_query**](AnalyticsApi.html#post_analytics_evaluations_aggregates_query) | Query for evaluation aggregates
26
27
  [**post_analytics_queues_observations_query**](AnalyticsApi.html#post_analytics_queues_observations_query) | Query for queue observations
28
+ [**post_analytics_reporting_exports**](AnalyticsApi.html#post_analytics_reporting_exports) | Generate a view export request
27
29
  [**post_analytics_reporting_schedule_runreport**](AnalyticsApi.html#post_analytics_reporting_schedule_runreport) | Place a scheduled report immediately into the reporting queue
28
30
  [**post_analytics_reporting_schedules**](AnalyticsApi.html#post_analytics_reporting_schedules) | Create a scheduled report job
29
31
  [**post_analytics_users_aggregates_query**](AnalyticsApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
@@ -149,6 +151,59 @@ Name | Type | Description | Notes
149
151
 
150
152
 
151
153
 
154
+ <a name="get_analytics_reporting_exports"></a>
155
+
156
+ ## -[**ReportingExportJobListing**](ReportingExportJobListing.html) get_analytics_reporting_exports
157
+
158
+ Get all view export requests for a user
159
+
160
+
161
+
162
+ Wraps GET /api/v2/analytics/reporting/exports
163
+
164
+
165
+ ### Example
166
+ ~~~ruby
167
+ # load the gem
168
+ require 'purecloudplatformclientv2'
169
+ # setup authorization
170
+ @secret = ENV['PURECLOUD_SECRET']
171
+ @id = ENV['PURECLOUD_CLIENT_ID']
172
+ environment = "mypurecloud.com"
173
+
174
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
175
+
176
+ PureCloud.configure do |config|
177
+ config.access_token = @authToken
178
+ end
179
+
180
+ api_instance = PureCloud::AnalyticsApi.new
181
+
182
+ begin
183
+ #Get all view export requests for a user
184
+ result = api_instance.get_analytics_reporting_exports
185
+ p result
186
+ rescue PureCloud::ApiError => e
187
+ puts "Exception when calling AnalyticsApi->get_analytics_reporting_exports: #{e}"
188
+ end
189
+ ~~~
190
+
191
+ ### Parameters
192
+ This endpoint does not need any parameter.
193
+ {: class="table table-striped"}
194
+
195
+
196
+ ### Return type
197
+
198
+ [**ReportingExportJobListing**](ReportingExportJobListing.html)
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: application/json
203
+ - **Accept**: application/json
204
+
205
+
206
+
152
207
  <a name="get_analytics_reporting_metadata"></a>
153
208
 
154
209
  ## -[**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_analytics_reporting_metadata(opts)
@@ -987,6 +1042,65 @@ Name | Type | Description | Notes
987
1042
 
988
1043
 
989
1044
 
1045
+ <a name="post_analytics_reporting_exports"></a>
1046
+
1047
+ ## -[**ReportingExportJobResponse**](ReportingExportJobResponse.html) post_analytics_reporting_exports(body)
1048
+
1049
+ Generate a view export request
1050
+
1051
+
1052
+
1053
+ Wraps POST /api/v2/analytics/reporting/exports
1054
+
1055
+
1056
+ ### Example
1057
+ ~~~ruby
1058
+ # load the gem
1059
+ require 'purecloudplatformclientv2'
1060
+ # setup authorization
1061
+ @secret = ENV['PURECLOUD_SECRET']
1062
+ @id = ENV['PURECLOUD_CLIENT_ID']
1063
+ environment = "mypurecloud.com"
1064
+
1065
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1066
+
1067
+ PureCloud.configure do |config|
1068
+ config.access_token = @authToken
1069
+ end
1070
+
1071
+ api_instance = PureCloud::AnalyticsApi.new
1072
+
1073
+ body = PureCloud::ReportingExportJobRequest.new # ReportingExportJobRequest | ReportingExportJobRequest
1074
+
1075
+
1076
+ begin
1077
+ #Generate a view export request
1078
+ result = api_instance.post_analytics_reporting_exports(body)
1079
+ p result
1080
+ rescue PureCloud::ApiError => e
1081
+ puts "Exception when calling AnalyticsApi->post_analytics_reporting_exports: #{e}"
1082
+ end
1083
+ ~~~
1084
+
1085
+ ### Parameters
1086
+
1087
+ Name | Type | Description | Notes
1088
+ ------------- | ------------- | ------------- | -------------
1089
+ **body** | [**ReportingExportJobRequest**](ReportingExportJobRequest.html)| ReportingExportJobRequest | |
1090
+ {: class="table table-striped"}
1091
+
1092
+
1093
+ ### Return type
1094
+
1095
+ [**ReportingExportJobResponse**](ReportingExportJobResponse.html)
1096
+
1097
+ ### HTTP request headers
1098
+
1099
+ - **Content-Type**: application/json
1100
+ - **Accept**: application/json
1101
+
1102
+
1103
+
990
1104
  <a name="post_analytics_reporting_schedule_runreport"></a>
991
1105
 
992
1106
  ## -[**RunNowResponse**](RunNowResponse.html) post_analytics_reporting_schedule_runreport(schedule_id)
@@ -3038,8 +3038,8 @@ api_instance = PureCloud::ArchitectApi.new
3038
3038
  datatable_id = "datatable_id_example" # String | id of datatable
3039
3039
 
3040
3040
  opts = {
3041
- page_size: 25, # Integer | Page size
3042
3041
  page_number: 1, # Integer | Page number
3042
+ page_size: 25, # Integer | Page size
3043
3043
  showbrief: true # BOOLEAN | If true returns just the key value of the row
3044
3044
  }
3045
3045
 
@@ -3057,8 +3057,8 @@ end
3057
3057
  Name | Type | Description | Notes
3058
3058
  ------------- | ------------- | ------------- | -------------
3059
3059
  **datatable_id** | **String**| id of datatable | |
3060
- **page_size** | **Integer**| Page size | [optional] [default to 25] |
3061
3060
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
3061
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
3062
3062
  **showbrief** | **BOOLEAN**| If true returns just the key value of the row | [optional] [default to true] |
3063
3063
  {: class="table table-striped"}
3064
3064
 
@@ -3104,8 +3104,8 @@ api_instance = PureCloud::ArchitectApi.new
3104
3104
 
3105
3105
  opts = {
3106
3106
  expand: "expand_example", # String | Expand instructions for the result
3107
- page_size: 25, # Integer | Page size
3108
3107
  page_number: 1, # Integer | Page number
3108
+ page_size: 25, # Integer | Page size
3109
3109
  sort_by: "id", # String | Sort by
3110
3110
  sort_order: "ascending" # String | Sort order
3111
3111
  }
@@ -3124,8 +3124,8 @@ end
3124
3124
  Name | Type | Description | Notes
3125
3125
  ------------- | ------------- | ------------- | -------------
3126
3126
  **expand** | **String**| Expand instructions for the result | [optional] <br />**Values**: schema |
3127
- **page_size** | **Integer**| Page size | [optional] [default to 25] |
3128
3127
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
3128
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
3129
3129
  **sort_by** | **String**| Sort by | [optional] [default to id]<br />**Values**: id, name |
3130
3130
  **sort_order** | **String**| Sort order | [optional] [default to ascending]<br />**Values**: ascending, descending |
3131
3131
  {: class="table table-striped"}
@@ -14,8 +14,8 @@ title: AttemptLimitsEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: AttributeEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -18,6 +18,7 @@ Method | Description
18
18
  [**get_authorization_roles**](AuthorizationApi.html#get_authorization_roles) | Retrieve a list of all roles defined for the organization
19
19
  [**get_user_roles**](AuthorizationApi.html#get_user_roles) | Returns a listing of roles and permissions for a user.
20
20
  [**patch_authorization_role**](AuthorizationApi.html#patch_authorization_role) | Patch Organization Role for needsUpdate Field
21
+ [**post_authorization_division_object**](AuthorizationApi.html#post_authorization_division_object) | Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
21
22
  [**post_authorization_role_comparedefault_right_role_id**](AuthorizationApi.html#post_authorization_role_comparedefault_right_role_id) | Get an unsaved org role to default role comparison
22
23
  [**post_authorization_roles**](AuthorizationApi.html#post_authorization_roles) | Create an organization role.
23
24
  [**post_authorization_roles_default**](AuthorizationApi.html#post_authorization_roles_default) | Restores all default roles
@@ -634,6 +635,71 @@ Name | Type | Description | Notes
634
635
 
635
636
 
636
637
 
638
+ <a name="post_authorization_division_object"></a>
639
+
640
+ ## -[**Array&lt;AuthzTypedObject&gt;**](AuthzTypedObject.html) post_authorization_division_object(division_id, object_type, body)
641
+
642
+ Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
643
+
644
+
645
+
646
+ Wraps POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}
647
+
648
+
649
+ ### Example
650
+ ~~~ruby
651
+ # load the gem
652
+ require 'purecloudplatformclientv2'
653
+ # setup authorization
654
+ @secret = ENV['PURECLOUD_SECRET']
655
+ @id = ENV['PURECLOUD_CLIENT_ID']
656
+ environment = "mypurecloud.com"
657
+
658
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
659
+
660
+ PureCloud.configure do |config|
661
+ config.access_token = @authToken
662
+ end
663
+
664
+ api_instance = PureCloud::AuthorizationApi.new
665
+
666
+ division_id = "division_id_example" # String | Division ID
667
+
668
+ object_type = "object_type_example" # String | The type of the objects. Must be one of the valid object types
669
+
670
+ body = [PureCloud::Array<String>.new] # Array<String> | Object Id List
671
+
672
+
673
+ begin
674
+ #Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
675
+ result = api_instance.post_authorization_division_object(division_id, object_type, body)
676
+ p result
677
+ rescue PureCloud::ApiError => e
678
+ puts "Exception when calling AuthorizationApi->post_authorization_division_object: #{e}"
679
+ end
680
+ ~~~
681
+
682
+ ### Parameters
683
+
684
+ Name | Type | Description | Notes
685
+ ------------- | ------------- | ------------- | -------------
686
+ **division_id** | **String**| Division ID | |
687
+ **object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER |
688
+ **body** | **Array&lt;String&gt;**| Object Id List | |
689
+ {: class="table table-striped"}
690
+
691
+
692
+ ### Return type
693
+
694
+ [**Array&lt;AuthzTypedObject&gt;**](AuthzTypedObject.html)
695
+
696
+ ### HTTP request headers
697
+
698
+ - **Content-Type**: application/json
699
+ - **Accept**: application/json
700
+
701
+
702
+
637
703
  <a name="post_authorization_role_comparedefault_right_role_id"></a>
638
704
 
639
705
  ## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: AuthzTypedObject
3
+ ---
4
+ ## PureCloud::AuthzTypedObject
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The identifier associated with the object. | |
11
+ | **type** | **String** | The type of the object. | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -14,8 +14,8 @@ title: CalibrationEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CallConversationEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CallHistoryConversationEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CallableTimeSetEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CallbackConversationEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CampaignEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CampaignRuleEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CampaignSequenceEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -14,8 +14,8 @@ title: CertificateAuthorityEntityListing
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
16
  | **previous_uri** | **String** | | [optional] |
17
- | **next_uri** | **String** | | [optional] |
18
17
  | **last_uri** | **String** | | [optional] |
18
+ | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -12,8 +12,8 @@ title: CertificateDetails
12
12
  | **expiration_date** | **DateTime** | The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
13
  | **issue_date** | **DateTime** | The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
14
  | **expired** | **BOOLEAN** | True if the certificate is expired, false otherwise. | [optional] |
15
- | **signature_valid** | **BOOLEAN** | | [optional] |
16
15
  | **valid** | **BOOLEAN** | | [optional] |
16
+ | **signature_valid** | **BOOLEAN** | | [optional] |
17
17
  {: class="table table-striped"}
18
18
 
19
19