purecloudplatformclientv2 88.0.0 → 89.0.0

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 (428) 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/AnalyticsEvaluation.md +1 -1
  6. data/docs/ApiUsageQuery.md +16 -0
  7. data/docs/ApiUsageQueryResult.md +14 -0
  8. data/docs/ApiUsageRow.md +25 -0
  9. data/docs/ArchitectApi.md +132 -0
  10. data/docs/AttemptLimitsEntityListing.md +1 -1
  11. data/docs/AuditApi.md +60 -0
  12. data/docs/AuditQueryEntity.md +14 -0
  13. data/docs/AuditQueryExecutionStatusResponse.md +1 -0
  14. data/docs/AuditQueryRequest.md +1 -0
  15. data/docs/AuditQueryService.md +14 -0
  16. data/docs/AuditQueryServiceMapping.md +13 -0
  17. data/docs/AuditQuerySort.md +14 -0
  18. data/docs/AuthzDivisionEntityListing.md +1 -1
  19. data/docs/CalibrationEntityListing.md +1 -1
  20. data/docs/CallConversationEntityListing.md +1 -1
  21. data/docs/CallHistoryConversationEntityListing.md +1 -1
  22. data/docs/CallableTimeSetEntityListing.md +1 -1
  23. data/docs/CallbackConversationEntityListing.md +1 -1
  24. data/docs/CampaignDivisionViewListing.md +1 -1
  25. data/docs/CampaignEntityListing.md +1 -1
  26. data/docs/CampaignRuleEntityListing.md +1 -1
  27. data/docs/CampaignSequenceEntityListing.md +1 -1
  28. data/docs/CertificateAuthorityEntityListing.md +1 -1
  29. data/docs/ChatConversationEntityListing.md +1 -1
  30. data/docs/ClientAppEntityListing.md +1 -1
  31. data/docs/CoachingAnnotationList.md +1 -1
  32. data/docs/CoachingAppointmentResponseList.md +1 -1
  33. data/docs/CoachingNotificationList.md +1 -1
  34. data/docs/CobrowseConversationEntityListing.md +1 -1
  35. data/docs/CommandStatusEntityListing.md +1 -1
  36. data/docs/ConsumedResourcesEntityListing.md +1 -1
  37. data/docs/ConsumingResourcesEntityListing.md +1 -1
  38. data/docs/ContactListDivisionViewListing.md +1 -1
  39. data/docs/ContactListEntityListing.md +1 -1
  40. data/docs/ContactListFilterEntityListing.md +1 -1
  41. data/docs/ContactListing.md +1 -1
  42. data/docs/ConversationEntityListing.md +1 -1
  43. data/docs/CreateQueueRequest.md +1 -0
  44. data/docs/CredentialInfoListing.md +1 -1
  45. data/docs/CredentialTypeListing.md +1 -1
  46. data/docs/DIDEntityListing.md +1 -1
  47. data/docs/DIDPoolEntityListing.md +1 -1
  48. data/docs/DataTableRowEntityListing.md +1 -1
  49. data/docs/DataTablesDomainEntityListing.md +1 -1
  50. data/docs/DependencyObjectEntityListing.md +1 -1
  51. data/docs/DependencyTypeEntityListing.md +1 -1
  52. data/docs/DialerEventEntityListing.md +1 -1
  53. data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
  54. data/docs/DirectoryUserDevicesListing.md +1 -1
  55. data/docs/DivsPermittedEntityListing.md +1 -1
  56. data/docs/DncListDivisionViewListing.md +1 -1
  57. data/docs/DncListEntityListing.md +1 -1
  58. data/docs/DocumentAuditEntityListing.md +1 -1
  59. data/docs/DocumentEntityListing.md +1 -1
  60. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  61. data/docs/DomainEntityListing.md +1 -1
  62. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  63. data/docs/DomainEntityListingQueryResult.md +1 -1
  64. data/docs/DomainEntityListingSurveyForm.md +1 -1
  65. data/docs/DomainOrganizationRole.md +1 -1
  66. data/docs/DomainOrganizationRoleCreate.md +1 -1
  67. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  68. data/docs/EdgeEntityListing.md +1 -1
  69. data/docs/EdgeGroupEntityListing.md +1 -1
  70. data/docs/EdgeLineEntityListing.md +1 -1
  71. data/docs/EmailConversationEntityListing.md +1 -1
  72. data/docs/EmailMessageListing.md +1 -1
  73. data/docs/EmergencyGroupListing.md +1 -1
  74. data/docs/EncryptionKeyEntityListing.md +1 -1
  75. data/docs/EntityListing.md +5 -1
  76. data/docs/EvaluationEntityListing.md +1 -1
  77. data/docs/EvaluationFormEntityListing.md +1 -1
  78. data/docs/EvaluatorActivityEntityListing.md +1 -1
  79. data/docs/ExtensionEntityListing.md +1 -1
  80. data/docs/ExtensionPoolEntityListing.md +1 -1
  81. data/docs/ExternalContact.md +2 -0
  82. data/docs/ExternalOrganization.md +2 -0
  83. data/docs/ExternalOrganizationListing.md +1 -1
  84. data/docs/FacebookIntegrationEntityListing.md +1 -1
  85. data/docs/FaxDocumentEntityListing.md +1 -1
  86. data/docs/FlowDivisionViewEntityListing.md +1 -1
  87. data/docs/FlowEntityListing.md +1 -1
  88. data/docs/FlowExecutionLaunchRequest.md +16 -0
  89. data/docs/FlowExecutionLaunchResponse.md +16 -0
  90. data/docs/FlowOutcomeListing.md +1 -1
  91. data/docs/FlowRuntimeExecution.md +23 -0
  92. data/docs/FlowVersionEntityListing.md +1 -1
  93. data/docs/GDPRRequestEntityListing.md +1 -1
  94. data/docs/GDPRSubjectEntityListing.md +1 -1
  95. data/docs/GenericSAML.md +22 -0
  96. data/docs/GreetingListing.md +1 -1
  97. data/docs/GroupEntityListing.md +1 -1
  98. data/docs/GroupProfileEntityListing.md +1 -1
  99. data/docs/IVREntityListing.md +1 -1
  100. data/docs/IdentityProviderApi.md +187 -0
  101. data/docs/InboundDomainEntityListing.md +1 -1
  102. data/docs/InboundRouteEntityListing.md +1 -1
  103. data/docs/IntegrationEntityListing.md +1 -1
  104. data/docs/IntegrationEventEntityListing.md +1 -1
  105. data/docs/IntegrationTypeEntityListing.md +1 -1
  106. data/docs/InteractionStatsAlertContainer.md +1 -1
  107. data/docs/InteractionStatsRuleContainer.md +1 -1
  108. data/docs/IpAddressAuthentication.md +13 -0
  109. data/docs/KeywordSetEntityListing.md +1 -1
  110. data/docs/KnowledgeSearchResponse.md +1 -1
  111. data/docs/LanguageEntityListing.md +1 -1
  112. data/docs/LexBotAliasEntityListing.md +1 -1
  113. data/docs/LexBotEntityListing.md +1 -1
  114. data/docs/LibraryEntityListing.md +1 -1
  115. data/docs/LineBaseEntityListing.md +1 -1
  116. data/docs/LineEntityListing.md +1 -1
  117. data/docs/LineIntegrationEntityListing.md +1 -1
  118. data/docs/LocationEntityListing.md +1 -1
  119. data/docs/LogicalInterfaceEntityListing.md +1 -1
  120. data/docs/ManagementUnitListing.md +1 -1
  121. data/docs/MessageConversationEntityListing.md +1 -1
  122. data/docs/MessagingIntegrationEntityListing.md +1 -1
  123. data/docs/MessagingStickerEntityListing.md +1 -1
  124. data/docs/NluDomainListing.md +1 -1
  125. data/docs/NluDomainVersion.md +1 -0
  126. data/docs/NluDomainVersionListing.md +1 -1
  127. data/docs/NluFeedbackListing.md +1 -1
  128. data/docs/NoteListing.md +1 -1
  129. data/docs/OAuthApi.md +208 -0
  130. data/docs/OAuthClientEntityListing.md +1 -1
  131. data/docs/OAuthProviderEntityListing.md +1 -1
  132. data/docs/OrganizationApi.md +126 -0
  133. data/docs/OrganizationPresenceEntityListing.md +1 -1
  134. data/docs/OrganizationRoleEntityListing.md +1 -1
  135. data/docs/OrphanRecordingListing.md +1 -1
  136. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  137. data/docs/OutboundRouteEntityListing.md +1 -1
  138. data/docs/PermissionCollectionEntityListing.md +1 -1
  139. data/docs/PhoneBaseEntityListing.md +1 -1
  140. data/docs/PhoneEntityListing.md +1 -1
  141. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  142. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  143. data/docs/PolicyEntityListing.md +1 -1
  144. data/docs/Prompt.md +2 -2
  145. data/docs/PromptAssetEntityListing.md +1 -1
  146. data/docs/PromptEntityListing.md +1 -1
  147. data/docs/QualityAuditPage.md +1 -1
  148. data/docs/Queue.md +1 -0
  149. data/docs/QueueEntityListing.md +1 -1
  150. data/docs/QueueMemberEntityListing.md +1 -1
  151. data/docs/QueueRequest.md +1 -0
  152. data/docs/RecipientListing.md +1 -1
  153. data/docs/RecordingApi.md +12 -0
  154. data/docs/RecordingJobEntityListing.md +1 -1
  155. data/docs/RelationshipListing.md +1 -1
  156. data/docs/ReportMetaDataEntityListing.md +1 -1
  157. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  158. data/docs/ReportScheduleEntityListing.md +1 -1
  159. data/docs/ReportingExportJobListing.md +1 -1
  160. data/docs/ReportingExportMetadataJobListing.md +1 -1
  161. data/docs/ResponseEntityList.md +1 -1
  162. data/docs/ResponseEntityListing.md +1 -1
  163. data/docs/ResponseSetEntityListing.md +1 -1
  164. data/docs/RuleSetEntityListing.md +1 -1
  165. data/docs/SCIMApi.md +12 -24
  166. data/docs/ScheduleEntityListing.md +1 -1
  167. data/docs/ScheduleGroupEntityListing.md +1 -1
  168. data/docs/SchemaCategoryEntityListing.md +1 -1
  169. data/docs/SchemaReferenceEntityListing.md +1 -1
  170. data/docs/ScreenRecordingSessionListing.md +1 -1
  171. data/docs/ScriptEntityListing.md +1 -1
  172. data/docs/SecurityProfileEntityListing.md +1 -1
  173. data/docs/ShareEntityListing.md +1 -1
  174. data/docs/SiteEntityListing.md +1 -1
  175. data/docs/SkillEntityListing.md +1 -1
  176. data/docs/SmsAddressEntityListing.md +1 -1
  177. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  178. data/docs/StationEntityListing.md +1 -1
  179. data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
  180. data/docs/SurveyFormEntityListing.md +1 -1
  181. data/docs/SystemPromptAssetEntityListing.md +1 -1
  182. data/docs/SystemPromptEntityListing.md +1 -1
  183. data/docs/TagValueEntityListing.md +1 -1
  184. data/docs/TextMessageListing.md +1 -1
  185. data/docs/TimeZoneEntityListing.md +1 -1
  186. data/docs/TrunkBaseEntityListing.md +1 -1
  187. data/docs/TrunkEntityListing.md +1 -1
  188. data/docs/TrunkMetabaseEntityListing.md +1 -1
  189. data/docs/TrustEntityListing.md +1 -1
  190. data/docs/TrustUserEntityListing.md +1 -1
  191. data/docs/TrustorEntityListing.md +1 -1
  192. data/docs/TtsEngineEntityListing.md +1 -1
  193. data/docs/TtsVoiceEntityListing.md +1 -1
  194. data/docs/TwitterIntegrationEntityListing.md +1 -1
  195. data/docs/UploadUrlRequest.md +1 -0
  196. data/docs/UsageApi.md +144 -0
  197. data/docs/UsageExecutionResult.md +14 -0
  198. data/docs/UserActionCategoryEntityListing.md +1 -1
  199. data/docs/UserAppEntityListing.md +1 -1
  200. data/docs/UserEntityListing.md +1 -1
  201. data/docs/UserLanguageEntityListing.md +1 -1
  202. data/docs/UserProfileEntityListing.md +1 -1
  203. data/docs/UserQueue.md +1 -0
  204. data/docs/UserQueueEntityListing.md +1 -1
  205. data/docs/UserRecordingEntityListing.md +1 -1
  206. data/docs/UserSkillEntityListing.md +1 -1
  207. data/docs/VoicemailMessageEntityListing.md +1 -1
  208. data/docs/WebChatMemberInfoEntityList.md +1 -1
  209. data/docs/WhatsAppIntegrationEntityListing.md +1 -1
  210. data/docs/WorkspaceEntityListing.md +1 -1
  211. data/docs/WorkspaceMemberEntityListing.md +1 -1
  212. data/docs/WrapupCodeEntityListing.md +1 -1
  213. data/lib/purecloudplatformclientv2.rb +14 -0
  214. data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
  215. data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
  216. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
  217. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
  218. data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
  219. data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
  220. data/lib/purecloudplatformclientv2/api/scim_api.rb +8 -8
  221. data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
  222. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  223. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
  224. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
  225. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  226. data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
  227. data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
  228. data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
  229. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
  230. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
  231. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +32 -4
  232. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +32 -4
  233. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
  234. data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
  235. data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
  236. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +14 -14
  237. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
  238. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
  239. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
  240. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
  241. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
  242. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +14 -14
  243. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
  244. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
  245. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
  246. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
  247. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
  248. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
  249. data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +14 -14
  250. data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +14 -14
  251. data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +14 -14
  252. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
  253. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
  254. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
  255. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
  256. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +14 -14
  257. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
  258. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
  259. data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
  260. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  261. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
  262. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
  263. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
  264. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
  265. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
  266. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
  267. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
  268. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
  269. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
  270. data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +14 -14
  271. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
  272. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
  273. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
  274. data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +14 -14
  275. data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +14 -14
  276. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
  277. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
  278. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
  279. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
  280. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
  281. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
  282. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
  283. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
  284. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  285. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  286. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  287. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
  288. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
  289. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
  290. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
  291. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
  292. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
  293. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
  294. data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
  295. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
  296. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
  297. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
  298. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
  299. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
  300. data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
  301. data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
  302. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
  303. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +14 -14
  304. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
  305. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  306. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
  307. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
  308. data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
  309. data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
  310. data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +14 -14
  311. data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
  312. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
  313. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
  314. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
  315. data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
  316. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
  317. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
  318. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
  319. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
  320. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
  321. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
  322. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
  323. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
  324. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
  325. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
  326. data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
  327. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
  328. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
  329. data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
  330. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
  331. data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +14 -14
  332. data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +14 -14
  333. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
  334. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
  335. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
  336. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +14 -14
  337. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
  338. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
  339. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
  340. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
  341. data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +14 -14
  342. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +14 -14
  343. data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +14 -14
  344. data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +41 -1
  345. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +14 -14
  346. data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +14 -14
  347. data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
  348. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
  349. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
  350. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
  351. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
  352. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
  353. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
  354. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
  355. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
  356. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
  357. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
  358. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
  359. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
  360. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
  361. data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
  362. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
  363. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
  364. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
  365. data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
  366. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
  367. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
  368. data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
  369. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
  370. data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +14 -14
  371. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
  372. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
  373. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
  374. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
  375. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
  376. data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +14 -14
  377. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
  378. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
  379. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
  380. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
  381. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
  382. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
  383. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
  384. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
  385. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
  386. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
  387. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
  388. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
  389. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
  390. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
  391. data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +14 -14
  392. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
  393. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
  394. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +14 -14
  395. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
  396. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
  397. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
  398. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
  399. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
  400. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
  401. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
  402. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
  403. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
  404. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
  405. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
  406. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
  407. data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +14 -14
  408. data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +14 -14
  409. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +14 -14
  410. data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
  411. data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
  412. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
  413. data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +14 -14
  414. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
  415. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
  416. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
  417. data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
  418. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
  419. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
  420. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
  421. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
  422. data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +14 -14
  423. data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +14 -14
  424. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
  425. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
  426. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
  427. data/lib/purecloudplatformclientv2/version.rb +1 -1
  428. metadata +30 -2
@@ -414,7 +414,7 @@ module PureCloud
414
414
  #
415
415
  # @param [Hash] opts the optional parameters
416
416
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
417
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
417
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). (default to 25)
418
418
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
419
419
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
420
420
  # @option opts [String] :filter Filters results.
@@ -428,7 +428,7 @@ module PureCloud
428
428
  #
429
429
  # @param [Hash] opts the optional parameters
430
430
  # @option opts [Integer] :start_index The 1-based index of the first query result.
431
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
431
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
432
432
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
433
433
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
434
434
  # @option opts [String] :filter Filters results.
@@ -929,7 +929,7 @@ module PureCloud
929
929
  # To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
930
930
  # @param [Hash] opts the optional parameters
931
931
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
932
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
932
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). (default to 25)
933
933
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
934
934
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
935
935
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
@@ -943,7 +943,7 @@ module PureCloud
943
943
  # To return all active users, do not use a filter parameter. To return inactive users, set \&quot;filter\&quot; to \&quot;active eq false\&quot;. By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \&quot;attributes\&quot; to \&quot;id,active\&quot; or \&quot;excludeAttributes\&quot; to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
944
944
  # @param [Hash] opts the optional parameters
945
945
  # @option opts [Integer] :start_index The 1-based index of the first query result.
946
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
946
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
947
947
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
948
948
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
949
949
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
@@ -1122,7 +1122,7 @@ module PureCloud
1122
1122
  # @param filter Filters results.
1123
1123
  # @param [Hash] opts the optional parameters
1124
1124
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
1125
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
1125
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). (default to 25)
1126
1126
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1127
1127
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1128
1128
  # @return [ScimGroupListResponse]
@@ -1136,7 +1136,7 @@ module PureCloud
1136
1136
  # @param filter Filters results.
1137
1137
  # @param [Hash] opts the optional parameters
1138
1138
  # @option opts [Integer] :start_index The 1-based index of the first query result.
1139
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
1139
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
1140
1140
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;active&#39;, and &#39;meta attributes . Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1141
1141
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The&#39;id&#39;, &#39;active&#39;, and &#39;meta&#39; attributes will always be present in the output.
1142
1142
  # @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
@@ -1638,7 +1638,7 @@ module PureCloud
1638
1638
  # To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
1639
1639
  # @param [Hash] opts the optional parameters
1640
1640
  # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
1641
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
1641
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). (default to 25)
1642
1642
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1643
1643
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1644
1644
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
@@ -1652,7 +1652,7 @@ module PureCloud
1652
1652
  # To return all active users, do not use a filter parameter. To return inactive users, set \&quot;filter\&quot; to \&quot;active eq false\&quot;. By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \&quot;attributes\&quot; to \&quot;id,active\&quot; or \&quot;excludeAttributes\&quot; to \&quot;externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\&quot;.
1653
1653
  # @param [Hash] opts the optional parameters
1654
1654
  # @option opts [Integer] :start_index The 1-based index of the first query result.
1655
- # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
1655
+ # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
1656
1656
  # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
1657
1657
  # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes will always be present in output.
1658
1658
  # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
@@ -0,0 +1,157 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@genesys.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: UNLICENSED
11
+ https://help.mypurecloud.com/articles/terms-and-conditions/
12
+
13
+ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
14
+
15
+ =end
16
+
17
+ require "uri"
18
+
19
+ module PureCloud
20
+ class UsageApi
21
+ attr_accessor :api_client
22
+
23
+ def initialize(api_client = ApiClient.default)
24
+ @api_client = api_client
25
+ end
26
+
27
+ # Get the results of a usage query
28
+ #
29
+ # @param execution_id ID of the query execution
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [ApiUsageQueryResult]
32
+ def get_usage_query_execution_id_results(execution_id, opts = {})
33
+ data, _status_code, _headers = get_usage_query_execution_id_results_with_http_info(execution_id, opts)
34
+ return data
35
+ end
36
+
37
+ # Get the results of a usage query
38
+ #
39
+ # @param execution_id ID of the query execution
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(ApiUsageQueryResult, Fixnum, Hash)>] ApiUsageQueryResult data, response status code and response headers
42
+ def get_usage_query_execution_id_results_with_http_info(execution_id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: UsageApi.get_usage_query_execution_id_results ..."
45
+ end
46
+
47
+
48
+ # verify the required parameter 'execution_id' is set
49
+ fail ArgumentError, "Missing the required parameter 'execution_id' when calling UsageApi.get_usage_query_execution_id_results" if execution_id.nil?
50
+
51
+
52
+
53
+
54
+
55
+ # resource path
56
+ local_var_path = "/api/v2/usage/query/{executionId}/results".sub('{format}','json').sub('{' + 'executionId' + '}', execution_id.to_s)
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = nil
77
+
78
+ auth_names = ['PureCloud OAuth']
79
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
80
+ :header_params => header_params,
81
+ :query_params => query_params,
82
+ :form_params => form_params,
83
+ :body => post_body,
84
+ :auth_names => auth_names,
85
+ :return_type => 'ApiUsageQueryResult')
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: UsageApi#get_usage_query_execution_id_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
92
+ # Query organization API Usage -
93
+ # After calling this method, you will then need to poll for the query results based on the returned execution Id
94
+ # @param body Query
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [UsageExecutionResult]
97
+ def post_usage_query(body, opts = {})
98
+ data, _status_code, _headers = post_usage_query_with_http_info(body, opts)
99
+ return data
100
+ end
101
+
102
+ # Query organization API Usage -
103
+ # After calling this method, you will then need to poll for the query results based on the returned execution Id
104
+ # @param body Query
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [Array<(UsageExecutionResult, Fixnum, Hash)>] UsageExecutionResult data, response status code and response headers
107
+ def post_usage_query_with_http_info(body, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "Calling API: UsageApi.post_usage_query ..."
110
+ end
111
+
112
+
113
+ # verify the required parameter 'body' is set
114
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsageApi.post_usage_query" if body.nil?
115
+
116
+
117
+
118
+
119
+
120
+ # resource path
121
+ local_var_path = "/api/v2/usage/query".sub('{format}','json')
122
+
123
+ # query parameters
124
+ query_params = {}
125
+
126
+ # header parameters
127
+ header_params = {}
128
+
129
+ # HTTP header 'Accept' (if needed)
130
+ local_header_accept = ['application/json']
131
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
132
+
133
+ # HTTP header 'Content-Type'
134
+ local_header_content_type = ['application/json']
135
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
136
+
137
+ # form parameters
138
+ form_params = {}
139
+
140
+ # http body (model)
141
+ post_body = @api_client.object_to_http_body(body)
142
+
143
+ auth_names = ['PureCloud OAuth']
144
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
145
+ :header_params => header_params,
146
+ :query_params => query_params,
147
+ :form_params => form_params,
148
+ :body => post_body,
149
+ :auth_names => auth_names,
150
+ :return_type => 'UsageExecutionResult')
151
+ if @api_client.config.debugging
152
+ @api_client.config.logger.debug "API called: UsageApi#post_usage_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
+ end
154
+ return data, status_code, headers
155
+ end
156
+ end
157
+ end
@@ -76,7 +76,7 @@ module PureCloud
76
76
  http_method = http_method.to_sym.downcase
77
77
 
78
78
  header_params = @default_headers.merge(opts[:header_params] || {})
79
- header_params['purecloud-sdk'] = '88.0.0'
79
+ header_params['purecloud-sdk'] = '89.0.0'
80
80
  query_params = opts[:query_params] || {}
81
81
  form_params = opts[:form_params] || {}
82
82
 
@@ -28,12 +28,12 @@ module PureCloud
28
28
 
29
29
  attr_accessor :first_uri
30
30
 
31
+ attr_accessor :previous_uri
32
+
31
33
  attr_accessor :self_uri
32
34
 
33
35
  attr_accessor :next_uri
34
36
 
35
- attr_accessor :previous_uri
36
-
37
37
  attr_accessor :last_uri
38
38
 
39
39
  attr_accessor :page_count
@@ -52,12 +52,12 @@ module PureCloud
52
52
 
53
53
  :'first_uri' => :'firstUri',
54
54
 
55
+ :'previous_uri' => :'previousUri',
56
+
55
57
  :'self_uri' => :'selfUri',
56
58
 
57
59
  :'next_uri' => :'nextUri',
58
60
 
59
- :'previous_uri' => :'previousUri',
60
-
61
61
  :'last_uri' => :'lastUri',
62
62
 
63
63
  :'page_count' => :'pageCount'
@@ -79,12 +79,12 @@ module PureCloud
79
79
 
80
80
  :'first_uri' => :'String',
81
81
 
82
+ :'previous_uri' => :'String',
83
+
82
84
  :'self_uri' => :'String',
83
85
 
84
86
  :'next_uri' => :'String',
85
87
 
86
- :'previous_uri' => :'String',
87
-
88
88
  :'last_uri' => :'String',
89
89
 
90
90
  :'page_count' => :'Integer'
@@ -148,28 +148,28 @@ module PureCloud
148
148
  end
149
149
 
150
150
 
151
- if attributes.has_key?(:'selfUri')
151
+ if attributes.has_key?(:'previousUri')
152
152
 
153
153
 
154
- self.self_uri = attributes[:'selfUri']
154
+ self.previous_uri = attributes[:'previousUri']
155
155
 
156
156
 
157
157
  end
158
158
 
159
159
 
160
- if attributes.has_key?(:'nextUri')
160
+ if attributes.has_key?(:'selfUri')
161
161
 
162
162
 
163
- self.next_uri = attributes[:'nextUri']
163
+ self.self_uri = attributes[:'selfUri']
164
164
 
165
165
 
166
166
  end
167
167
 
168
168
 
169
- if attributes.has_key?(:'previousUri')
169
+ if attributes.has_key?(:'nextUri')
170
170
 
171
171
 
172
- self.previous_uri = attributes[:'previousUri']
172
+ self.next_uri = attributes[:'nextUri']
173
173
 
174
174
 
175
175
  end
@@ -311,9 +311,9 @@ module PureCloud
311
311
  page_number == o.page_number &&
312
312
  total == o.total &&
313
313
  first_uri == o.first_uri &&
314
+ previous_uri == o.previous_uri &&
314
315
  self_uri == o.self_uri &&
315
316
  next_uri == o.next_uri &&
316
- previous_uri == o.previous_uri &&
317
317
  last_uri == o.last_uri &&
318
318
  page_count == o.page_count
319
319
  end
@@ -327,7 +327,7 @@ module PureCloud
327
327
  # Calculates hash code according to all attributes.
328
328
  # @return [Fixnum] Hash code
329
329
  def hash
330
- [entities, page_size, page_number, total, first_uri, self_uri, next_uri, previous_uri, last_uri, page_count].hash
330
+ [entities, page_size, page_number, total, first_uri, previous_uri, self_uri, next_uri, last_uri, page_count].hash
331
331
  end
332
332
 
333
333
  # build the object from hash
@@ -28,12 +28,12 @@ module PureCloud
28
28
 
29
29
  attr_accessor :first_uri
30
30
 
31
+ attr_accessor :previous_uri
32
+
31
33
  attr_accessor :self_uri
32
34
 
33
35
  attr_accessor :next_uri
34
36
 
35
- attr_accessor :previous_uri
36
-
37
37
  attr_accessor :last_uri
38
38
 
39
39
  attr_accessor :page_count
@@ -52,12 +52,12 @@ module PureCloud
52
52
 
53
53
  :'first_uri' => :'firstUri',
54
54
 
55
+ :'previous_uri' => :'previousUri',
56
+
55
57
  :'self_uri' => :'selfUri',
56
58
 
57
59
  :'next_uri' => :'nextUri',
58
60
 
59
- :'previous_uri' => :'previousUri',
60
-
61
61
  :'last_uri' => :'lastUri',
62
62
 
63
63
  :'page_count' => :'pageCount'
@@ -79,12 +79,12 @@ module PureCloud
79
79
 
80
80
  :'first_uri' => :'String',
81
81
 
82
+ :'previous_uri' => :'String',
83
+
82
84
  :'self_uri' => :'String',
83
85
 
84
86
  :'next_uri' => :'String',
85
87
 
86
- :'previous_uri' => :'String',
87
-
88
88
  :'last_uri' => :'String',
89
89
 
90
90
  :'page_count' => :'Integer'
@@ -148,28 +148,28 @@ module PureCloud
148
148
  end
149
149
 
150
150
 
151
- if attributes.has_key?(:'selfUri')
151
+ if attributes.has_key?(:'previousUri')
152
152
 
153
153
 
154
- self.self_uri = attributes[:'selfUri']
154
+ self.previous_uri = attributes[:'previousUri']
155
155
 
156
156
 
157
157
  end
158
158
 
159
159
 
160
- if attributes.has_key?(:'nextUri')
160
+ if attributes.has_key?(:'selfUri')
161
161
 
162
162
 
163
- self.next_uri = attributes[:'nextUri']
163
+ self.self_uri = attributes[:'selfUri']
164
164
 
165
165
 
166
166
  end
167
167
 
168
168
 
169
- if attributes.has_key?(:'previousUri')
169
+ if attributes.has_key?(:'nextUri')
170
170
 
171
171
 
172
- self.previous_uri = attributes[:'previousUri']
172
+ self.next_uri = attributes[:'nextUri']
173
173
 
174
174
 
175
175
  end
@@ -311,9 +311,9 @@ module PureCloud
311
311
  page_number == o.page_number &&
312
312
  total == o.total &&
313
313
  first_uri == o.first_uri &&
314
+ previous_uri == o.previous_uri &&
314
315
  self_uri == o.self_uri &&
315
316
  next_uri == o.next_uri &&
316
- previous_uri == o.previous_uri &&
317
317
  last_uri == o.last_uri &&
318
318
  page_count == o.page_count
319
319
  end
@@ -327,7 +327,7 @@ module PureCloud
327
327
  # Calculates hash code according to all attributes.
328
328
  # @return [Fixnum] Hash code
329
329
  def hash
330
- [entities, page_size, page_number, total, first_uri, self_uri, next_uri, previous_uri, last_uri, page_count].hash
330
+ [entities, page_size, page_number, total, first_uri, previous_uri, self_uri, next_uri, last_uri, page_count].hash
331
331
  end
332
332
 
333
333
  # build the object from hash
@@ -51,10 +51,10 @@ module PureCloud
51
51
  # Whether this evaluation has been deleted
52
52
  attr_accessor :deleted
53
53
 
54
- attr_accessor :o_total_critical_score
55
-
56
54
  attr_accessor :o_total_score
57
55
 
56
+ attr_accessor :o_total_critical_score
57
+
58
58
  # Attribute mapping from ruby-style variable name to JSON key.
59
59
  def self.attribute_map
60
60
  {
@@ -81,9 +81,9 @@ module PureCloud
81
81
 
82
82
  :'deleted' => :'deleted',
83
83
 
84
- :'o_total_critical_score' => :'oTotalCriticalScore',
84
+ :'o_total_score' => :'oTotalScore',
85
85
 
86
- :'o_total_score' => :'oTotalScore'
86
+ :'o_total_critical_score' => :'oTotalCriticalScore'
87
87
 
88
88
  }
89
89
  end
@@ -114,9 +114,9 @@ module PureCloud
114
114
 
115
115
  :'deleted' => :'BOOLEAN',
116
116
 
117
- :'o_total_critical_score' => :'Integer',
117
+ :'o_total_score' => :'Integer',
118
118
 
119
- :'o_total_score' => :'Integer'
119
+ :'o_total_critical_score' => :'Integer'
120
120
 
121
121
  }
122
122
  end
@@ -229,19 +229,19 @@ module PureCloud
229
229
  end
230
230
 
231
231
 
232
- if attributes.has_key?(:'oTotalCriticalScore')
232
+ if attributes.has_key?(:'oTotalScore')
233
233
 
234
234
 
235
- self.o_total_critical_score = attributes[:'oTotalCriticalScore']
235
+ self.o_total_score = attributes[:'oTotalScore']
236
236
 
237
237
 
238
238
  end
239
239
 
240
240
 
241
- if attributes.has_key?(:'oTotalScore')
241
+ if attributes.has_key?(:'oTotalCriticalScore')
242
242
 
243
243
 
244
- self.o_total_score = attributes[:'oTotalScore']
244
+ self.o_total_critical_score = attributes[:'oTotalCriticalScore']
245
245
 
246
246
 
247
247
  end
@@ -398,8 +398,8 @@ module PureCloud
398
398
  calibration_id == o.calibration_id &&
399
399
  rescored == o.rescored &&
400
400
  deleted == o.deleted &&
401
- o_total_critical_score == o.o_total_critical_score &&
402
- o_total_score == o.o_total_score
401
+ o_total_score == o.o_total_score &&
402
+ o_total_critical_score == o.o_total_critical_score
403
403
  end
404
404
 
405
405
  # @see the `==` method
@@ -411,7 +411,7 @@ module PureCloud
411
411
  # Calculates hash code according to all attributes.
412
412
  # @return [Fixnum] Hash code
413
413
  def hash
414
- [evaluation_id, evaluator_id, user_id, event_time, queue_id, form_id, context_id, form_name, calibration_id, rescored, deleted, o_total_critical_score, o_total_score].hash
414
+ [evaluation_id, evaluator_id, user_id, event_time, queue_id, form_id, context_id, form_name, calibration_id, rescored, deleted, o_total_score, o_total_critical_score].hash
415
415
  end
416
416
 
417
417
  # build the object from hash