purecloudplatformclientv2 88.0.0 → 89.0.0

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -12,9 +12,9 @@ title: LanguageEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LexBotAliasEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LexBotEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LibraryEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LineBaseEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LineEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LineIntegrationEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LocationEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: LogicalInterfaceEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: ManagementUnitListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **next_uri** | **String** | | [optional] |
16
17
  | **page_count** | **Integer** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **self_uri** | **String** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: MessageConversationEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: MessagingIntegrationEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: MessagingStickerEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: NluDomainListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -16,6 +16,7 @@ title: NluDomainVersion
16
16
  | **date_trained** | **DateTime** | The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
17
  | **date_published** | **DateTime** | The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
18
18
  | **training_status** | **String** | The training status of the NLU domain version. | [optional] |
19
+ | **evaluation_status** | **String** | The evaluation status of the NLU domain version. | [optional] |
19
20
  | **intents** | [**Array<IntentDefinition>**](IntentDefinition.html) | The intents defined for this NLU domain version. | [optional] |
20
21
  | **entity_types** | [**Array<NamedEntityTypeDefinition>**](NamedEntityTypeDefinition.html) | The entity types defined for this NLU domain version. | [optional] |
21
22
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -12,9 +12,9 @@ title: NluDomainVersionListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: NluFeedbackListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,9 +12,9 @@ title: NoteListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
@@ -12,10 +12,13 @@ Method | Description
12
12
  [**get_oauth_authorization**](OAuthApi.html#get_oauth_authorization) | Get a client that is authorized by the resource owner
13
13
  [**get_oauth_authorizations**](OAuthApi.html#get_oauth_authorizations) | List clients that are authorized by the resource owner
14
14
  [**get_oauth_client**](OAuthApi.html#get_oauth_client) | Get OAuth Client
15
+ [**get_oauth_client_usage_query_result**](OAuthApi.html#get_oauth_client_usage_query_result) | Get the results of a usage query
16
+ [**get_oauth_client_usage_summary**](OAuthApi.html#get_oauth_client_usage_summary) | Get a summary of OAuth client API usage
15
17
  [**get_oauth_clients**](OAuthApi.html#get_oauth_clients) | The list of OAuth clients
16
18
  [**get_oauth_scope**](OAuthApi.html#get_oauth_scope) | An OAuth scope
17
19
  [**get_oauth_scopes**](OAuthApi.html#get_oauth_scopes) | The list of OAuth scopes
18
20
  [**post_oauth_client_secret**](OAuthApi.html#post_oauth_client_secret) | Regenerate Client Secret
21
+ [**post_oauth_client_usage_query**](OAuthApi.html#post_oauth_client_usage_query) | Query for OAuth client API usage
19
22
  [**post_oauth_clients**](OAuthApi.html#post_oauth_clients) | Create OAuth client
20
23
  [**put_oauth_client**](OAuthApi.html#put_oauth_client) | Update OAuth Client
21
24
  {: class="table table-striped"}
@@ -273,6 +276,143 @@ Name | Type | Description | Notes
273
276
 
274
277
 
275
278
 
279
+ <a name="get_oauth_client_usage_query_result"></a>
280
+
281
+ ## [**ApiUsageQueryResult**](ApiUsageQueryResult.html) get_oauth_client_usage_query_result(execution_id, client_id)
282
+
283
+
284
+
285
+ Get the results of a usage query
286
+
287
+
288
+
289
+ Wraps GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}
290
+
291
+ Requires ANY permissions:
292
+
293
+ * oauth:client:view
294
+
295
+
296
+ ### Example
297
+ ```{"language":"ruby"}
298
+ # load the gem
299
+ require 'purecloudplatformclientv2'
300
+ # setup authorization
301
+ @secret = ENV['PURECLOUD_SECRET']
302
+ @id = ENV['PURECLOUD_CLIENT_ID']
303
+ environment = "mypurecloud.com"
304
+
305
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
306
+
307
+ PureCloud.configure do |config|
308
+ config.access_token = @authToken
309
+ end
310
+
311
+ api_instance = PureCloud::OAuthApi.new
312
+
313
+ execution_id = "execution_id_example" # String | ID of the query execution
314
+
315
+ client_id = "client_id_example" # String | Client ID
316
+
317
+
318
+ begin
319
+ #Get the results of a usage query
320
+ result = api_instance.get_oauth_client_usage_query_result(execution_id, client_id)
321
+ p result
322
+ rescue PureCloud::ApiError => e
323
+ puts "Exception when calling OAuthApi->get_oauth_client_usage_query_result: #{e}"
324
+ end
325
+ ```
326
+
327
+ ### Parameters
328
+
329
+ Name | Type | Description | Notes
330
+ ------------- | ------------- | ------------- | -------------
331
+ **execution_id** | **String**| ID of the query execution | |
332
+ **client_id** | **String**| Client ID | |
333
+ {: class="table table-striped"}
334
+
335
+
336
+ ### Return type
337
+
338
+ [**ApiUsageQueryResult**](ApiUsageQueryResult.html)
339
+
340
+ ### HTTP request headers
341
+
342
+ - **Content-Type**: application/json
343
+ - **Accept**: application/json
344
+
345
+
346
+
347
+ <a name="get_oauth_client_usage_summary"></a>
348
+
349
+ ## [**UsageExecutionResult**](UsageExecutionResult.html) get_oauth_client_usage_summary(client_id, opts)
350
+
351
+
352
+
353
+ Get a summary of OAuth client API usage
354
+
355
+ After calling this method, you will then need to poll for the query results based on the returned execution Id
356
+
357
+ Wraps GET /api/v2/oauth/clients/{clientId}/usage/summary
358
+
359
+ Requires ANY permissions:
360
+
361
+ * oauth:client:view
362
+
363
+
364
+ ### Example
365
+ ```{"language":"ruby"}
366
+ # load the gem
367
+ require 'purecloudplatformclientv2'
368
+ # setup authorization
369
+ @secret = ENV['PURECLOUD_SECRET']
370
+ @id = ENV['PURECLOUD_CLIENT_ID']
371
+ environment = "mypurecloud.com"
372
+
373
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
374
+
375
+ PureCloud.configure do |config|
376
+ config.access_token = @authToken
377
+ end
378
+
379
+ api_instance = PureCloud::OAuthApi.new
380
+
381
+ client_id = "client_id_example" # String | Client ID
382
+
383
+ opts = {
384
+ days: "7" # String | Previous number of days to query
385
+ }
386
+
387
+ begin
388
+ #Get a summary of OAuth client API usage
389
+ result = api_instance.get_oauth_client_usage_summary(client_id, opts)
390
+ p result
391
+ rescue PureCloud::ApiError => e
392
+ puts "Exception when calling OAuthApi->get_oauth_client_usage_summary: #{e}"
393
+ end
394
+ ```
395
+
396
+ ### Parameters
397
+
398
+ Name | Type | Description | Notes
399
+ ------------- | ------------- | ------------- | -------------
400
+ **client_id** | **String**| Client ID | |
401
+ **days** | **String**| Previous number of days to query | [optional] [default to 7] |
402
+ {: class="table table-striped"}
403
+
404
+
405
+ ### Return type
406
+
407
+ [**UsageExecutionResult**](UsageExecutionResult.html)
408
+
409
+ ### HTTP request headers
410
+
411
+ - **Content-Type**: application/json
412
+ - **Accept**: application/json
413
+
414
+
415
+
276
416
  <a name="get_oauth_clients"></a>
277
417
 
278
418
  ## [**OAuthClientEntityListing**](OAuthClientEntityListing.html) get_oauth_clients
@@ -530,6 +670,74 @@ Name | Type | Description | Notes
530
670
 
531
671
 
532
672
 
673
+ <a name="post_oauth_client_usage_query"></a>
674
+
675
+ ## [**UsageExecutionResult**](UsageExecutionResult.html) post_oauth_client_usage_query(client_id, body)
676
+
677
+
678
+
679
+ Query for OAuth client API usage
680
+
681
+ After calling this method, you will then need to poll for the query results based on the returned execution Id
682
+
683
+ Wraps POST /api/v2/oauth/clients/{clientId}/usage/query
684
+
685
+ Requires ANY permissions:
686
+
687
+ * oauth:client:view
688
+
689
+
690
+ ### Example
691
+ ```{"language":"ruby"}
692
+ # load the gem
693
+ require 'purecloudplatformclientv2'
694
+ # setup authorization
695
+ @secret = ENV['PURECLOUD_SECRET']
696
+ @id = ENV['PURECLOUD_CLIENT_ID']
697
+ environment = "mypurecloud.com"
698
+
699
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
700
+
701
+ PureCloud.configure do |config|
702
+ config.access_token = @authToken
703
+ end
704
+
705
+ api_instance = PureCloud::OAuthApi.new
706
+
707
+ client_id = "client_id_example" # String | Client ID
708
+
709
+ body = PureCloud::ApiUsageQuery.new # ApiUsageQuery | Query
710
+
711
+
712
+ begin
713
+ #Query for OAuth client API usage
714
+ result = api_instance.post_oauth_client_usage_query(client_id, body)
715
+ p result
716
+ rescue PureCloud::ApiError => e
717
+ puts "Exception when calling OAuthApi->post_oauth_client_usage_query: #{e}"
718
+ end
719
+ ```
720
+
721
+ ### Parameters
722
+
723
+ Name | Type | Description | Notes
724
+ ------------- | ------------- | ------------- | -------------
725
+ **client_id** | **String**| Client ID | |
726
+ **body** | [**ApiUsageQuery**](ApiUsageQuery.html)| Query | |
727
+ {: class="table table-striped"}
728
+
729
+
730
+ ### Return type
731
+
732
+ [**UsageExecutionResult**](UsageExecutionResult.html)
733
+
734
+ ### HTTP request headers
735
+
736
+ - **Content-Type**: application/json
737
+ - **Accept**: application/json
738
+
739
+
740
+
533
741
  <a name="post_oauth_clients"></a>
534
742
 
535
743
  ## [**OAuthClient**](OAuthClient.html) post_oauth_clients(body)
@@ -12,9 +12,9 @@ title: OAuthClientEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **first_uri** | **String** | | [optional] |
15
+ | **previous_uri** | **String** | | [optional] |
15
16
  | **self_uri** | **String** | | [optional] |
16
17
  | **next_uri** | **String** | | [optional] |
17
- | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}