purecloudplatformclientv2 42.0.0 → 43.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (440) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ADFS.md +1 -1
  4. data/docs/ActionEntityListing.md +2 -2
  5. data/docs/AgentActivityEntityListing.md +2 -2
  6. data/docs/AnalyticsApi.md +66 -0
  7. data/docs/AnalyticsSurvey.md +1 -0
  8. data/docs/AttemptLimitsEntityListing.md +2 -2
  9. data/docs/AttributeEntityListing.md +2 -2
  10. data/docs/AuthorizationApi.md +1278 -185
  11. data/docs/AuthzDivision.md +18 -0
  12. data/docs/AuthzDivisionEntityListing.md +22 -0
  13. data/docs/AuthzGrant.md +16 -0
  14. data/docs/AuthzGrantPolicy.md +16 -0
  15. data/docs/AuthzGrantRole.md +18 -0
  16. data/docs/AuthzSubject.md +17 -0
  17. data/docs/CalibrationEntityListing.md +2 -2
  18. data/docs/CallConversationEntityListing.md +2 -2
  19. data/docs/CallHistoryConversationEntityListing.md +2 -2
  20. data/docs/CallableTimeSetEntityListing.md +2 -2
  21. data/docs/CallbackConversationEntityListing.md +2 -2
  22. data/docs/CampaignDivisionViewListing.md +2 -2
  23. data/docs/CampaignEntityListing.md +2 -2
  24. data/docs/CampaignRuleEntityListing.md +2 -2
  25. data/docs/CampaignSequenceEntityListing.md +2 -2
  26. data/docs/CertificateAuthorityEntityListing.md +2 -2
  27. data/docs/CertificateDetails.md +1 -1
  28. data/docs/ChatBadgeNotificationBadgeEntity.md +1 -3
  29. data/docs/ChatBadgeNotificationEntity.md +1 -3
  30. data/docs/ChatConversationEntityListing.md +2 -2
  31. data/docs/ClientAppEntityListing.md +2 -2
  32. data/docs/CobrowseConversationEntityListing.md +2 -2
  33. data/docs/CommandStatusEntityListing.md +2 -2
  34. data/docs/ConsumedResourcesEntityListing.md +2 -2
  35. data/docs/ConsumingResourcesEntityListing.md +2 -2
  36. data/docs/ContactListEntityListing.md +2 -2
  37. data/docs/ContactListFilterEntityListing.md +2 -2
  38. data/docs/ContactListing.md +2 -2
  39. data/docs/ConversationEntityListing.md +2 -2
  40. data/docs/ConversationQuery.md +1 -0
  41. data/docs/CreateCallbackCommand.md +1 -0
  42. data/docs/CreateCallbackOnConversationCommand.md +1 -0
  43. data/docs/CreateQueueRequest.md +1 -1
  44. data/docs/CredentialInfoListing.md +2 -2
  45. data/docs/CredentialTypeListing.md +2 -2
  46. data/docs/CustomerInteractionCenter.md +1 -1
  47. data/docs/DIDEntityListing.md +2 -2
  48. data/docs/DIDPoolEntityListing.md +2 -2
  49. data/docs/DataTableRowEntityListing.md +2 -2
  50. data/docs/DataTablesDomainEntityListing.md +2 -2
  51. data/docs/DependencyObjectEntityListing.md +2 -2
  52. data/docs/DependencyTypeEntityListing.md +2 -2
  53. data/docs/DialerEventEntityListing.md +2 -2
  54. data/docs/DirectoryUserDevicesListing.md +2 -2
  55. data/docs/DncListEntityListing.md +2 -2
  56. data/docs/Document.md +1 -1
  57. data/docs/DocumentAuditEntityListing.md +2 -2
  58. data/docs/DocumentEntityListing.md +2 -2
  59. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  60. data/docs/DomainEntityListing.md +2 -2
  61. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  62. data/docs/DomainEntityListingQueryResult.md +2 -2
  63. data/docs/DomainEntityListingSurveyForm.md +2 -2
  64. data/docs/DomainOrganizationRole.md +1 -1
  65. data/docs/DomainOrganizationRoleCreate.md +1 -1
  66. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  67. data/docs/EdgeEntityListing.md +2 -2
  68. data/docs/EdgeGroupEntityListing.md +2 -2
  69. data/docs/EdgeLineEntityListing.md +2 -2
  70. data/docs/EmailConversationEntityListing.md +2 -2
  71. data/docs/EmailMessageListing.md +2 -2
  72. data/docs/EmergencyGroupListing.md +2 -2
  73. data/docs/EncryptionKeyEntityListing.md +2 -2
  74. data/docs/EndpointEntityListing.md +2 -2
  75. data/docs/EvaluationEntityListing.md +2 -2
  76. data/docs/EvaluationFormEntityListing.md +2 -2
  77. data/docs/EvaluatorActivityEntityListing.md +2 -2
  78. data/docs/ExtensionEntityListing.md +2 -2
  79. data/docs/ExtensionPoolEntityListing.md +2 -2
  80. data/docs/ExternalOrganizationListing.md +2 -2
  81. data/docs/FacebookIntegration.md +24 -0
  82. data/docs/FacebookIntegrationEntityListing.md +22 -0
  83. data/docs/FacebookIntegrationRequest.md +20 -0
  84. data/docs/FaxDocument.md +1 -1
  85. data/docs/FaxDocumentEntityListing.md +2 -2
  86. data/docs/FlowDivisionViewEntityListing.md +2 -2
  87. data/docs/FlowEntityListing.md +2 -2
  88. data/docs/FlowVersionEntityListing.md +2 -2
  89. data/docs/FlowsApi.md +78 -0
  90. data/docs/GDPRRequestEntityListing.md +2 -2
  91. data/docs/GDPRSubjectEntityListing.md +2 -2
  92. data/docs/GKNDocumentationResult.md +16 -0
  93. data/docs/GKNDocumentationSearchCriteria.md +20 -0
  94. data/docs/GKNDocumentationSearchRequest.md +18 -0
  95. data/docs/GKNDocumentationSearchResponse.md +21 -0
  96. data/docs/GSuite.md +1 -1
  97. data/docs/GreetingListing.md +2 -2
  98. data/docs/GroupEntityListing.md +2 -2
  99. data/docs/GroupProfileEntityListing.md +2 -2
  100. data/docs/GroupsApi.md +1 -1
  101. data/docs/IVREntityListing.md +2 -2
  102. data/docs/IdentityNow.md +1 -1
  103. data/docs/InboundDomainEntityListing.md +2 -2
  104. data/docs/InboundRouteEntityListing.md +2 -2
  105. data/docs/IntegrationEntityListing.md +2 -2
  106. data/docs/IntegrationEventEntityListing.md +2 -2
  107. data/docs/IntegrationTypeEntityListing.md +2 -2
  108. data/docs/InteractionStatsAlertContainer.md +2 -2
  109. data/docs/InteractionStatsRuleContainer.md +2 -2
  110. data/docs/JsonNode.md +6 -6
  111. data/docs/KeywordSetEntityListing.md +2 -2
  112. data/docs/LanguageEntityListing.md +2 -2
  113. data/docs/LibraryEntityListing.md +2 -2
  114. data/docs/LineBaseEntityListing.md +2 -2
  115. data/docs/LineEntityListing.md +2 -2
  116. data/docs/LineIntegration.md +24 -0
  117. data/docs/LineIntegrationEntityListing.md +22 -0
  118. data/docs/LineIntegrationRequest.md +19 -0
  119. data/docs/LocationEntityListing.md +2 -2
  120. data/docs/LogicalInterfaceEntityListing.md +2 -2
  121. data/docs/ManagementUnitListing.md +2 -2
  122. data/docs/MessageConversationEntityListing.md +2 -2
  123. data/docs/MessagingApi.md +1015 -0
  124. data/docs/MessagingSticker.md +22 -0
  125. data/docs/MessagingStickerEntityListing.md +22 -0
  126. data/docs/NoteListing.md +2 -2
  127. data/docs/OAuthClientEntityListing.md +2 -2
  128. data/docs/OAuthProviderEntityListing.md +2 -2
  129. data/docs/ObjectsApi.md +554 -0
  130. data/docs/Okta.md +1 -1
  131. data/docs/OneLogin.md +1 -1
  132. data/docs/OrgUser.md +3 -1
  133. data/docs/OrganizationPresenceEntityListing.md +2 -2
  134. data/docs/OrganizationRoleEntityListing.md +2 -2
  135. data/docs/OrphanRecordingListing.md +2 -2
  136. data/docs/OutboundApi.md +2 -2
  137. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  138. data/docs/OutboundRouteEntityListing.md +2 -2
  139. data/docs/PermissionCollectionEntityListing.md +2 -2
  140. data/docs/PhoneBaseEntityListing.md +2 -2
  141. data/docs/PhoneEntityListing.md +2 -2
  142. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  143. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  144. data/docs/PingIdentity.md +1 -1
  145. data/docs/PolicyEntityListing.md +2 -2
  146. data/docs/PresenceApi.md +66 -0
  147. data/docs/PromptAsset.md +1 -0
  148. data/docs/PromptAssetCreate.md +1 -0
  149. data/docs/PromptAssetEntityListing.md +2 -2
  150. data/docs/PromptEntityListing.md +2 -2
  151. data/docs/QualityAuditPage.md +2 -2
  152. data/docs/QueueEntityListing.md +2 -2
  153. data/docs/QueueMemberEntityListing.md +2 -2
  154. data/docs/QueueRequest.md +1 -1
  155. data/docs/RecipientListing.md +2 -2
  156. data/docs/RelationshipListing.md +2 -2
  157. data/docs/ReportMetaDataEntityListing.md +2 -2
  158. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  159. data/docs/ReportScheduleEntityListing.md +2 -2
  160. data/docs/ReportingExportJobListing.md +2 -2
  161. data/docs/ResponseConfig.md +1 -0
  162. data/docs/ResponseEntityList.md +2 -2
  163. data/docs/ResponseEntityListing.md +2 -2
  164. data/docs/ResponseSetEntityListing.md +2 -2
  165. data/docs/RoutingApi.md +144 -4
  166. data/docs/RuleSetEntityListing.md +2 -2
  167. data/docs/Salesforce.md +1 -1
  168. data/docs/ScheduleEntityListing.md +2 -2
  169. data/docs/ScheduleGroupEntityListing.md +2 -2
  170. data/docs/SchemaCategoryEntityListing.md +2 -2
  171. data/docs/SchemaReferenceEntityListing.md +2 -2
  172. data/docs/ScreenRecordingSessionListing.md +2 -2
  173. data/docs/ScriptEntityListing.md +2 -2
  174. data/docs/SearchApi.md +132 -2
  175. data/docs/SecurityProfileEntityListing.md +2 -2
  176. data/docs/ShareEntityListing.md +2 -2
  177. data/docs/SiteEntityListing.md +2 -2
  178. data/docs/SkillEntityListing.md +2 -2
  179. data/docs/SmsPhoneNumberEntityListing.md +2 -2
  180. data/docs/StationEntityListing.md +2 -2
  181. data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
  182. data/docs/SubjectDivisions.md +14 -0
  183. data/docs/SuggestApi.md +2 -2
  184. data/docs/SurveyFormEntityListing.md +2 -2
  185. data/docs/SystemPromptAsset.md +1 -0
  186. data/docs/SystemPromptAssetEntityListing.md +2 -2
  187. data/docs/SystemPromptEntityListing.md +2 -2
  188. data/docs/TagValueEntityListing.md +2 -2
  189. data/docs/TextMessageListing.md +2 -2
  190. data/docs/TimeZone.md +2 -2
  191. data/docs/TimeZoneEntityListing.md +2 -2
  192. data/docs/TrunkBaseEntityListing.md +2 -2
  193. data/docs/TrunkEntityListing.md +2 -2
  194. data/docs/TrunkMetabaseEntityListing.md +2 -2
  195. data/docs/TrustEntityListing.md +2 -2
  196. data/docs/TrustUser.md +3 -1
  197. data/docs/TrustUserEntityListing.md +2 -2
  198. data/docs/TrustorEntityListing.md +2 -2
  199. data/docs/TwitterIntegration.md +28 -0
  200. data/docs/TwitterIntegrationEntityListing.md +22 -0
  201. data/docs/TwitterIntegrationRequest.md +21 -0
  202. data/docs/UpdateUser.md +1 -1
  203. data/docs/UpdateWeekScheduleRequest.md +1 -0
  204. data/docs/User.md +3 -1
  205. data/docs/UserActionCategoryEntityListing.md +2 -2
  206. data/docs/UserEntityListing.md +2 -2
  207. data/docs/UserLanguageEntityListing.md +2 -2
  208. data/docs/UserMe.md +3 -1
  209. data/docs/UserProfileEntityListing.md +2 -2
  210. data/docs/UserQueueEntityListing.md +2 -2
  211. data/docs/UserRecordingEntityListing.md +2 -2
  212. data/docs/UserSkillEntityListing.md +2 -2
  213. data/docs/UsersApi.md +560 -8
  214. data/docs/VoicemailMessageEntityListing.md +2 -2
  215. data/docs/WorkforceManagementApi.md +67 -0
  216. data/docs/WorkspaceEntityListing.md +2 -2
  217. data/docs/WorkspaceMemberEntityListing.md +2 -2
  218. data/docs/WrapupCodeEntityListing.md +2 -2
  219. data/docs/WritableDialerContact.md +17 -0
  220. data/lib/purecloudplatformclientv2.rb +26 -0
  221. data/lib/purecloudplatformclientv2/api/analytics_api.rb +65 -0
  222. data/lib/purecloudplatformclientv2/api/authorization_api.rb +1477 -250
  223. data/lib/purecloudplatformclientv2/api/flows_api.rb +92 -0
  224. data/lib/purecloudplatformclientv2/api/messaging_api.rb +1050 -0
  225. data/lib/purecloudplatformclientv2/api/objects_api.rb +640 -0
  226. data/lib/purecloudplatformclientv2/api/presence_api.rb +65 -0
  227. data/lib/purecloudplatformclientv2/api/routing_api.rb +157 -3
  228. data/lib/purecloudplatformclientv2/api/search_api.rb +131 -0
  229. data/lib/purecloudplatformclientv2/api/users_api.rb +607 -0
  230. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +64 -0
  231. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  232. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +23 -23
  233. data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
  234. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +23 -23
  235. data/lib/purecloudplatformclientv2/models/analytics_session.rb +2 -2
  236. data/lib/purecloudplatformclientv2/models/analytics_survey.rb +30 -4
  237. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +23 -23
  238. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +23 -23
  239. data/lib/purecloudplatformclientv2/models/authz_division.rb +338 -0
  240. data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +428 -0
  241. data/lib/purecloudplatformclientv2/models/authz_grant.rb +277 -0
  242. data/lib/purecloudplatformclientv2/models/authz_grant_policy.rb +278 -0
  243. data/lib/purecloudplatformclientv2/models/authz_grant_role.rb +330 -0
  244. data/lib/purecloudplatformclientv2/models/authz_subject.rb +305 -0
  245. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +23 -23
  246. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +23 -23
  247. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +23 -23
  248. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +23 -23
  249. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +23 -23
  250. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +23 -23
  251. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +23 -23
  252. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +23 -23
  253. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +23 -23
  254. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +23 -23
  255. data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
  256. data/lib/purecloudplatformclientv2/models/chat_badge_notification_badge_entity.rb +7 -71
  257. data/lib/purecloudplatformclientv2/models/chat_badge_notification_entity.rb +7 -71
  258. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +23 -23
  259. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +23 -23
  260. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +23 -23
  261. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +23 -23
  262. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +23 -23
  263. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +23 -23
  264. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +23 -23
  265. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +23 -23
  266. data/lib/purecloudplatformclientv2/models/contact_listing.rb +23 -23
  267. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +23 -23
  268. data/lib/purecloudplatformclientv2/models/conversation_query.rb +29 -1
  269. data/lib/purecloudplatformclientv2/models/create_callback_command.rb +27 -1
  270. data/lib/purecloudplatformclientv2/models/create_callback_on_conversation_command.rb +27 -1
  271. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +6 -0
  272. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +23 -23
  273. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +23 -23
  274. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
  275. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +23 -23
  276. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +23 -23
  277. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +23 -23
  278. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +23 -23
  279. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +23 -23
  280. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +23 -23
  281. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +23 -23
  282. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +23 -23
  283. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +23 -23
  284. data/lib/purecloudplatformclientv2/models/document.rb +12 -12
  285. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +23 -23
  286. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +23 -23
  287. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
  288. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +23 -23
  289. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +23 -23
  290. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +23 -23
  291. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +23 -23
  292. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  293. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  294. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  295. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +23 -23
  296. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +23 -23
  297. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +23 -23
  298. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +23 -23
  299. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +23 -23
  300. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +23 -23
  301. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +23 -23
  302. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +23 -23
  303. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +23 -23
  304. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +23 -23
  305. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +23 -23
  306. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +23 -23
  307. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +23 -23
  308. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +23 -23
  309. data/lib/purecloudplatformclientv2/models/facebook_integration.rb +508 -0
  310. data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +428 -0
  311. data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +394 -0
  312. data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
  313. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +23 -23
  314. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +23 -23
  315. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +23 -23
  316. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +23 -23
  317. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +2 -2
  318. data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
  319. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +23 -23
  320. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +23 -23
  321. data/lib/purecloudplatformclientv2/models/gkn_documentation_result.rb +285 -0
  322. data/lib/purecloudplatformclientv2/models/gkn_documentation_search_criteria.rb +423 -0
  323. data/lib/purecloudplatformclientv2/models/gkn_documentation_search_request.rb +349 -0
  324. data/lib/purecloudplatformclientv2/models/gkn_documentation_search_response.rb +444 -0
  325. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +23 -23
  326. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +23 -23
  327. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +23 -23
  328. data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
  329. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +23 -23
  330. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +23 -23
  331. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +23 -23
  332. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +23 -23
  333. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +23 -23
  334. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +23 -23
  335. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +23 -23
  336. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +23 -23
  337. data/lib/purecloudplatformclientv2/models/json_node.rb +89 -89
  338. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +23 -23
  339. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +23 -23
  340. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +23 -23
  341. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +23 -23
  342. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +23 -23
  343. data/lib/purecloudplatformclientv2/models/line_integration.rb +513 -0
  344. data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +428 -0
  345. data/lib/purecloudplatformclientv2/models/line_integration_request.rb +363 -0
  346. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +23 -23
  347. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +23 -23
  348. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +23 -23
  349. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +23 -23
  350. data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +477 -0
  351. data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +428 -0
  352. data/lib/purecloudplatformclientv2/models/note_listing.rb +23 -23
  353. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +23 -23
  354. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +23 -23
  355. data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
  356. data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
  357. data/lib/purecloudplatformclientv2/models/org_user.rb +58 -2
  358. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +23 -23
  359. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +23 -23
  360. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +23 -23
  361. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +23 -23
  362. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +23 -23
  363. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +23 -23
  364. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +23 -23
  365. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +23 -23
  366. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +23 -23
  367. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +23 -23
  368. data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
  369. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +23 -23
  370. data/lib/purecloudplatformclientv2/models/prompt_asset.rb +26 -1
  371. data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +26 -1
  372. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +23 -23
  373. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +23 -23
  374. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +23 -23
  375. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +23 -23
  376. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +23 -23
  377. data/lib/purecloudplatformclientv2/models/queue_request.rb +6 -0
  378. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +23 -23
  379. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +23 -23
  380. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +23 -23
  381. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +23 -23
  382. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +23 -23
  383. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +23 -23
  384. data/lib/purecloudplatformclientv2/models/response_config.rb +29 -1
  385. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +23 -23
  386. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +23 -23
  387. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +23 -23
  388. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +23 -23
  389. data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
  390. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +23 -23
  391. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +23 -23
  392. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +23 -23
  393. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +23 -23
  394. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +23 -23
  395. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +23 -23
  396. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +23 -23
  397. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +23 -23
  398. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +23 -23
  399. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +23 -23
  400. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +23 -23
  401. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +23 -23
  402. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +23 -23
  403. data/lib/purecloudplatformclientv2/models/subject_divisions.rb +242 -0
  404. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +23 -23
  405. data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +26 -1
  406. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +23 -23
  407. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +23 -23
  408. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +23 -23
  409. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +23 -23
  410. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
  411. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +23 -23
  412. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +23 -23
  413. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +23 -23
  414. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +23 -23
  415. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +23 -23
  416. data/lib/purecloudplatformclientv2/models/trust_user.rb +58 -2
  417. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +23 -23
  418. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +23 -23
  419. data/lib/purecloudplatformclientv2/models/twitter_integration.rb +636 -0
  420. data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +428 -0
  421. data/lib/purecloudplatformclientv2/models/twitter_integration_request.rb +454 -0
  422. data/lib/purecloudplatformclientv2/models/update_user.rb +1 -1
  423. data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +44 -4
  424. data/lib/purecloudplatformclientv2/models/user.rb +58 -2
  425. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +23 -23
  426. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +23 -23
  427. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +23 -23
  428. data/lib/purecloudplatformclientv2/models/user_me.rb +58 -2
  429. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +23 -23
  430. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +23 -23
  431. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +23 -23
  432. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +23 -23
  433. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +23 -23
  434. data/lib/purecloudplatformclientv2/models/web_chat_config.rb +15 -1
  435. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +23 -23
  436. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +23 -23
  437. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +23 -23
  438. data/lib/purecloudplatformclientv2/models/writable_dialer_contact.rb +320 -0
  439. data/lib/purecloudplatformclientv2/version.rb +1 -1
  440. metadata +54 -2
@@ -12,10 +12,10 @@ title: VoicemailMessageEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
15
  | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **last_uri** | **String** | | [optional] |
18
+ | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -36,6 +36,7 @@ Method | Description
36
36
  [**get_workforcemanagement_managementunit_workplan**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplan) | Get a work plan
37
37
  [**get_workforcemanagement_managementunit_workplans**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_workplans) | Get work plans
38
38
  [**get_workforcemanagement_managementunits**](WorkforceManagementApi.html#get_workforcemanagement_managementunits) | Get management units
39
+ [**get_workforcemanagement_managementunits_divisionviews**](WorkforceManagementApi.html#get_workforcemanagement_managementunits_divisionviews) | Get management units across divisions
39
40
  [**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user
40
41
  [**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
41
42
  [**patch_workforcemanagement_managementunit_activitycode**](WorkforceManagementApi.html#patch_workforcemanagement_managementunit_activitycode) | Update an activity code
@@ -2113,6 +2114,72 @@ Name | Type | Description | Notes
2113
2114
 
2114
2115
 
2115
2116
 
2117
+ <a name="get_workforcemanagement_managementunits_divisionviews"></a>
2118
+
2119
+ ## -[**ManagementUnitListing**](ManagementUnitListing.html) get_workforcemanagement_managementunits_divisionviews(opts)
2120
+
2121
+
2122
+
2123
+ Get management units across divisions
2124
+
2125
+
2126
+
2127
+ Wraps GET /api/v2/workforcemanagement/managementunits/divisionviews
2128
+
2129
+ Requires ANY permissions:
2130
+
2131
+ * wfm:managementUnit:search
2132
+
2133
+
2134
+ ### Example
2135
+ ~~~ruby
2136
+ # load the gem
2137
+ require 'purecloudplatformclientv2'
2138
+ # setup authorization
2139
+ @secret = ENV['PURECLOUD_SECRET']
2140
+ @id = ENV['PURECLOUD_CLIENT_ID']
2141
+ environment = "mypurecloud.com"
2142
+
2143
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2144
+
2145
+ PureCloud.configure do |config|
2146
+ config.access_token = @authToken
2147
+ end
2148
+
2149
+ api_instance = PureCloud::WorkforceManagementApi.new
2150
+
2151
+ opts = {
2152
+ division_id: ["division_id_example"] # Array<String> | The divisionIds to filter by. If omitted, will return all divisions
2153
+ }
2154
+
2155
+ begin
2156
+ #Get management units across divisions
2157
+ result = api_instance.get_workforcemanagement_managementunits_divisionviews(opts)
2158
+ p result
2159
+ rescue PureCloud::ApiError => e
2160
+ puts "Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits_divisionviews: #{e}"
2161
+ end
2162
+ ~~~
2163
+
2164
+ ### Parameters
2165
+
2166
+ Name | Type | Description | Notes
2167
+ ------------- | ------------- | ------------- | -------------
2168
+ **division_id** | [**Array&lt;String&gt;**](String.html)| The divisionIds to filter by. If omitted, will return all divisions | [optional] |
2169
+ {: class="table table-striped"}
2170
+
2171
+
2172
+ ### Return type
2173
+
2174
+ [**ManagementUnitListing**](ManagementUnitListing.html)
2175
+
2176
+ ### HTTP request headers
2177
+
2178
+ - **Content-Type**: application/json
2179
+ - **Accept**: application/json
2180
+
2181
+
2182
+
2116
2183
  <a name="get_workforcemanagement_timeoffrequest"></a>
2117
2184
 
2118
2185
  ## -[**TimeOffRequestResponse**](TimeOffRequestResponse.html) get_workforcemanagement_timeoffrequest(time_off_request_id)
@@ -12,10 +12,10 @@ title: WorkspaceEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
15
  | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **last_uri** | **String** | | [optional] |
18
+ | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -12,10 +12,10 @@ title: WorkspaceMemberEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
15
  | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **last_uri** | **String** | | [optional] |
18
+ | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -12,10 +12,10 @@ title: WrapupCodeEntityListing
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
- | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
15
  | **previous_uri** | **String** | | [optional] |
18
16
  | **next_uri** | **String** | | [optional] |
17
+ | **last_uri** | **String** | | [optional] |
18
+ | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: WritableDialerContact
3
+ ---
4
+ ## PureCloud::WritableDialerContact
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **contact_list_id** | **String** | The identifier of the contact list containing this contact. | |
12
+ | **data** | **Hash&lt;String, Object&gt;** | An ordered map of the contact&#39;s columns and corresponding values. | |
13
+ | **callable** | **BOOLEAN** | Indicates whether or not the contact can be called. | [optional] |
14
+ | **phone_number_status** | [**Hash&lt;String, PhoneNumberStatus&gt;**](PhoneNumberStatus.html) | A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not. | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -104,6 +104,12 @@ require 'purecloudplatformclientv2/models/audit_message'
104
104
  require 'purecloudplatformclientv2/models/audit_query_response'
105
105
  require 'purecloudplatformclientv2/models/audit_search_result'
106
106
  require 'purecloudplatformclientv2/models/audit_user'
107
+ require 'purecloudplatformclientv2/models/authz_division'
108
+ require 'purecloudplatformclientv2/models/authz_division_entity_listing'
109
+ require 'purecloudplatformclientv2/models/authz_grant'
110
+ require 'purecloudplatformclientv2/models/authz_grant_policy'
111
+ require 'purecloudplatformclientv2/models/authz_grant_role'
112
+ require 'purecloudplatformclientv2/models/authz_subject'
107
113
  require 'purecloudplatformclientv2/models/available_language_list'
108
114
  require 'purecloudplatformclientv2/models/available_topic'
109
115
  require 'purecloudplatformclientv2/models/available_topic_entity_listing'
@@ -567,6 +573,9 @@ require 'purecloudplatformclientv2/models/external_data_source'
567
573
  require 'purecloudplatformclientv2/models/external_organization'
568
574
  require 'purecloudplatformclientv2/models/external_organization_listing'
569
575
  require 'purecloudplatformclientv2/models/facebook_id'
576
+ require 'purecloudplatformclientv2/models/facebook_integration'
577
+ require 'purecloudplatformclientv2/models/facebook_integration_entity_listing'
578
+ require 'purecloudplatformclientv2/models/facebook_integration_request'
570
579
  require 'purecloudplatformclientv2/models/facebook_scoped_id'
571
580
  require 'purecloudplatformclientv2/models/facet'
572
581
  require 'purecloudplatformclientv2/models/facet_entry'
@@ -621,6 +630,10 @@ require 'purecloudplatformclientv2/models/gdpr_request'
621
630
  require 'purecloudplatformclientv2/models/gdpr_request_entity_listing'
622
631
  require 'purecloudplatformclientv2/models/gdpr_subject'
623
632
  require 'purecloudplatformclientv2/models/gdpr_subject_entity_listing'
633
+ require 'purecloudplatformclientv2/models/gkn_documentation_result'
634
+ require 'purecloudplatformclientv2/models/gkn_documentation_search_criteria'
635
+ require 'purecloudplatformclientv2/models/gkn_documentation_search_request'
636
+ require 'purecloudplatformclientv2/models/gkn_documentation_search_response'
624
637
  require 'purecloudplatformclientv2/models/g_suite'
625
638
  require 'purecloudplatformclientv2/models/generate_short_term_forecast_request'
626
639
  require 'purecloudplatformclientv2/models/generate_short_term_forecast_response'
@@ -742,6 +755,9 @@ require 'purecloudplatformclientv2/models/line_base'
742
755
  require 'purecloudplatformclientv2/models/line_base_entity_listing'
743
756
  require 'purecloudplatformclientv2/models/line_entity_listing'
744
757
  require 'purecloudplatformclientv2/models/line_id'
758
+ require 'purecloudplatformclientv2/models/line_integration'
759
+ require 'purecloudplatformclientv2/models/line_integration_entity_listing'
760
+ require 'purecloudplatformclientv2/models/line_integration_request'
745
761
  require 'purecloudplatformclientv2/models/line_status'
746
762
  require 'purecloudplatformclientv2/models/line_user_id'
747
763
  require 'purecloudplatformclientv2/models/list_wrapper_forecast_source_day_pointer'
@@ -796,6 +812,8 @@ require 'purecloudplatformclientv2/models/message_media_participant'
796
812
  require 'purecloudplatformclientv2/models/message_media_policy'
797
813
  require 'purecloudplatformclientv2/models/message_media_policy_conditions'
798
814
  require 'purecloudplatformclientv2/models/message_sticker'
815
+ require 'purecloudplatformclientv2/models/messaging_sticker'
816
+ require 'purecloudplatformclientv2/models/messaging_sticker_entity_listing'
799
817
  require 'purecloudplatformclientv2/models/meta_data'
800
818
  require 'purecloudplatformclientv2/models/metabase'
801
819
  require 'purecloudplatformclientv2/models/metered_evaluation_assignment'
@@ -1083,6 +1101,7 @@ require 'purecloudplatformclientv2/models/stats_notification_notification_metric
1083
1101
  require 'purecloudplatformclientv2/models/street_address'
1084
1102
  require 'purecloudplatformclientv2/models/subject_division_grants'
1085
1103
  require 'purecloudplatformclientv2/models/subject_division_grants_entity_listing'
1104
+ require 'purecloudplatformclientv2/models/subject_divisions'
1086
1105
  require 'purecloudplatformclientv2/models/subscriber_response'
1087
1106
  require 'purecloudplatformclientv2/models/suggest_search_criteria'
1088
1107
  require 'purecloudplatformclientv2/models/suggest_search_request'
@@ -1151,6 +1170,9 @@ require 'purecloudplatformclientv2/models/trustor'
1151
1170
  require 'purecloudplatformclientv2/models/trustor_audit_query_request'
1152
1171
  require 'purecloudplatformclientv2/models/trustor_entity_listing'
1153
1172
  require 'purecloudplatformclientv2/models/twitter_id'
1173
+ require 'purecloudplatformclientv2/models/twitter_integration'
1174
+ require 'purecloudplatformclientv2/models/twitter_integration_entity_listing'
1175
+ require 'purecloudplatformclientv2/models/twitter_integration_request'
1154
1176
  require 'purecloudplatformclientv2/models/unread_metric'
1155
1177
  require 'purecloudplatformclientv2/models/unread_status'
1156
1178
  require 'purecloudplatformclientv2/models/update_action_input'
@@ -1298,6 +1320,7 @@ require 'purecloudplatformclientv2/models/wrap_up_code_reference'
1298
1320
  require 'purecloudplatformclientv2/models/wrapup'
1299
1321
  require 'purecloudplatformclientv2/models/wrapup_code'
1300
1322
  require 'purecloudplatformclientv2/models/wrapup_code_entity_listing'
1323
+ require 'purecloudplatformclientv2/models/writable_dialer_contact'
1301
1324
  require 'purecloudplatformclientv2/models/writable_division'
1302
1325
  require 'purecloudplatformclientv2/models/writable_entity'
1303
1326
 
@@ -1312,6 +1335,7 @@ require 'purecloudplatformclientv2/api/content_management_api'
1312
1335
  require 'purecloudplatformclientv2/api/conversations_api'
1313
1336
  require 'purecloudplatformclientv2/api/external_contacts_api'
1314
1337
  require 'purecloudplatformclientv2/api/fax_api'
1338
+ require 'purecloudplatformclientv2/api/flows_api'
1315
1339
  require 'purecloudplatformclientv2/api/general_data_protection_regulation_api'
1316
1340
  require 'purecloudplatformclientv2/api/geolocation_api'
1317
1341
  require 'purecloudplatformclientv2/api/greetings_api'
@@ -1321,9 +1345,11 @@ require 'purecloudplatformclientv2/api/integrations_api'
1321
1345
  require 'purecloudplatformclientv2/api/languages_api'
1322
1346
  require 'purecloudplatformclientv2/api/license_api'
1323
1347
  require 'purecloudplatformclientv2/api/locations_api'
1348
+ require 'purecloudplatformclientv2/api/messaging_api'
1324
1349
  require 'purecloudplatformclientv2/api/mobile_devices_api'
1325
1350
  require 'purecloudplatformclientv2/api/notifications_api'
1326
1351
  require 'purecloudplatformclientv2/api/o_auth_api'
1352
+ require 'purecloudplatformclientv2/api/objects_api'
1327
1353
  require 'purecloudplatformclientv2/api/organization_api'
1328
1354
  require 'purecloudplatformclientv2/api/organization_authorization_api'
1329
1355
  require 'purecloudplatformclientv2/api/outbound_api'
@@ -1105,6 +1105,71 @@ module PureCloud
1105
1105
  return data, status_code, headers
1106
1106
  end
1107
1107
 
1108
+ # Query for flow aggregates
1109
+ #
1110
+ # @param body query
1111
+ # @param [Hash] opts the optional parameters
1112
+ # @return [AggregateQueryResponse]
1113
+ def post_analytics_flows_aggregates_query(body, opts = {})
1114
+ data, _status_code, _headers = post_analytics_flows_aggregates_query_with_http_info(body, opts)
1115
+ return data
1116
+ end
1117
+
1118
+ # Query for flow aggregates
1119
+ #
1120
+ # @param body query
1121
+ # @param [Hash] opts the optional parameters
1122
+ # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
1123
+ def post_analytics_flows_aggregates_query_with_http_info(body, opts = {})
1124
+ if @api_client.config.debugging
1125
+ @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_flows_aggregates_query ..."
1126
+ end
1127
+
1128
+
1129
+ # verify the required parameter 'body' is set
1130
+ fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_flows_aggregates_query" if body.nil?
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+ # resource path
1137
+ local_var_path = "/api/v2/analytics/flows/aggregates/query".sub('{format}','json')
1138
+
1139
+ # query parameters
1140
+ query_params = {}
1141
+
1142
+ # header parameters
1143
+ header_params = {}
1144
+
1145
+ # HTTP header 'Accept' (if needed)
1146
+ local_header_accept = ['application/json']
1147
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1148
+
1149
+ # HTTP header 'Content-Type'
1150
+ local_header_content_type = ['application/json']
1151
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1152
+
1153
+ # form parameters
1154
+ form_params = {}
1155
+
1156
+ # http body (model)
1157
+ post_body = @api_client.object_to_http_body(body)
1158
+
1159
+ auth_names = ['PureCloud Auth']
1160
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1161
+ :header_params => header_params,
1162
+ :query_params => query_params,
1163
+ :form_params => form_params,
1164
+ :body => post_body,
1165
+ :auth_names => auth_names,
1166
+ :return_type => 'AggregateQueryResponse')
1167
+ if @api_client.config.debugging
1168
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_flows_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1169
+ end
1170
+ return data, status_code, headers
1171
+ end
1172
+
1108
1173
  # Query for queue observations
1109
1174
  #
1110
1175
  # @param body query
@@ -24,36 +24,36 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
- # Delete an organization role.
27
+ # Delete a division.
28
28
  #
29
- # @param role_id Role ID
29
+ # @param division_id Division ID
30
30
  # @param [Hash] opts the optional parameters
31
31
  # @return [nil]
32
- def delete_authorization_role(role_id, opts = {})
33
- delete_authorization_role_with_http_info(role_id, opts)
32
+ def delete_authorization_division(division_id, opts = {})
33
+ delete_authorization_division_with_http_info(division_id, opts)
34
34
  return nil
35
35
  end
36
36
 
37
- # Delete an organization role.
37
+ # Delete a division.
38
38
  #
39
- # @param role_id Role ID
39
+ # @param division_id Division ID
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
42
- def delete_authorization_role_with_http_info(role_id, opts = {})
42
+ def delete_authorization_division_with_http_info(division_id, opts = {})
43
43
  if @api_client.config.debugging
44
- @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_authorization_role ..."
44
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_authorization_division ..."
45
45
  end
46
46
 
47
47
 
48
- # verify the required parameter 'role_id' is set
49
- fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.delete_authorization_role" if role_id.nil?
48
+ # verify the required parameter 'division_id' is set
49
+ fail ArgumentError, "Missing the required parameter 'division_id' when calling AuthorizationApi.delete_authorization_division" if division_id.nil?
50
50
 
51
51
 
52
52
 
53
53
 
54
54
 
55
55
  # resource path
56
- local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
56
+ local_var_path = "/api/v2/authorization/divisions/{divisionId}".sub('{format}','json').sub('{' + 'divisionId' + '}', division_id.to_s)
57
57
 
58
58
  # query parameters
59
59
  query_params = {}
@@ -83,41 +83,41 @@ module PureCloud
83
83
  :body => post_body,
84
84
  :auth_names => auth_names)
85
85
  if @api_client.config.debugging
86
- @api_client.config.logger.debug "API called: AuthorizationApi#delete_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ @api_client.config.logger.debug "API called: AuthorizationApi#delete_authorization_division\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
87
  end
88
88
  return data, status_code, headers
89
89
  end
90
90
 
91
- # Removes all the roles from the user.
91
+ # Delete an organization role.
92
92
  #
93
- # @param user_id User ID
93
+ # @param role_id Role ID
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @return [nil]
96
- def delete_user_roles(user_id, opts = {})
97
- delete_user_roles_with_http_info(user_id, opts)
96
+ def delete_authorization_role(role_id, opts = {})
97
+ delete_authorization_role_with_http_info(role_id, opts)
98
98
  return nil
99
99
  end
100
100
 
101
- # Removes all the roles from the user.
101
+ # Delete an organization role.
102
102
  #
103
- # @param user_id User ID
103
+ # @param role_id Role ID
104
104
  # @param [Hash] opts the optional parameters
105
105
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
106
- def delete_user_roles_with_http_info(user_id, opts = {})
106
+ def delete_authorization_role_with_http_info(role_id, opts = {})
107
107
  if @api_client.config.debugging
108
- @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_user_roles ..."
108
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_authorization_role ..."
109
109
  end
110
110
 
111
111
 
112
- # verify the required parameter 'user_id' is set
113
- fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.delete_user_roles" if user_id.nil?
112
+ # verify the required parameter 'role_id' is set
113
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.delete_authorization_role" if role_id.nil?
114
114
 
115
115
 
116
116
 
117
117
 
118
118
 
119
119
  # resource path
120
- local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
120
+ local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
121
121
 
122
122
  # query parameters
123
123
  query_params = {}
@@ -147,104 +147,61 @@ module PureCloud
147
147
  :body => post_body,
148
148
  :auth_names => auth_names)
149
149
  if @api_client.config.debugging
150
- @api_client.config.logger.debug "API called: AuthorizationApi#delete_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
150
+ @api_client.config.logger.debug "API called: AuthorizationApi#delete_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
151
151
  end
152
152
  return data, status_code, headers
153
153
  end
154
154
 
155
- # Get all permissions.
156
- # Retrieve a list of all permission defined in the system.
155
+ # Delete a grant of a role in a division
156
+ #
157
+ # @param subject_id Subject ID (user or group)
158
+ # @param division_id the id of the division of the grant
159
+ # @param role_id the id of the role of the grant
157
160
  # @param [Hash] opts the optional parameters
158
- # @option opts [Integer] :page_size Page size (default to 25)
159
- # @option opts [Integer] :page_number Page number (default to 1)
160
- # @return [PermissionCollectionEntityListing]
161
- def get_authorization_permissions(opts = {})
162
- data, _status_code, _headers = get_authorization_permissions_with_http_info(opts)
163
- return data
161
+ # @return [nil]
162
+ def delete_authorization_subject_division_role(subject_id, division_id, role_id, opts = {})
163
+ delete_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts)
164
+ return nil
164
165
  end
165
166
 
166
- # Get all permissions.
167
- # Retrieve a list of all permission defined in the system.
167
+ # Delete a grant of a role in a division
168
+ #
169
+ # @param subject_id Subject ID (user or group)
170
+ # @param division_id the id of the division of the grant
171
+ # @param role_id the id of the role of the grant
168
172
  # @param [Hash] opts the optional parameters
169
- # @option opts [Integer] :page_size Page size
170
- # @option opts [Integer] :page_number Page number
171
- # @return [Array<(PermissionCollectionEntityListing, Fixnum, Hash)>] PermissionCollectionEntityListing data, response status code and response headers
172
- def get_authorization_permissions_with_http_info(opts = {})
173
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
174
+ def delete_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts = {})
173
175
  if @api_client.config.debugging
174
- @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_permissions ..."
176
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_authorization_subject_division_role ..."
175
177
  end
176
178
 
177
179
 
180
+ # verify the required parameter 'subject_id' is set
181
+ fail ArgumentError, "Missing the required parameter 'subject_id' when calling AuthorizationApi.delete_authorization_subject_division_role" if subject_id.nil?
178
182
 
179
183
 
180
184
 
181
185
 
182
186
 
183
187
 
188
+ # verify the required parameter 'division_id' is set
189
+ fail ArgumentError, "Missing the required parameter 'division_id' when calling AuthorizationApi.delete_authorization_subject_division_role" if division_id.nil?
184
190
 
185
191
 
186
192
 
187
193
 
188
194
 
189
- # resource path
190
- local_var_path = "/api/v2/authorization/permissions".sub('{format}','json')
191
-
192
- # query parameters
193
- query_params = {}
194
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
195
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
196
-
197
- # header parameters
198
- header_params = {}
199
-
200
- # HTTP header 'Accept' (if needed)
201
- local_header_accept = ['application/json']
202
- local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
203
-
204
- # HTTP header 'Content-Type'
205
- local_header_content_type = ['application/json']
206
- header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
207
-
208
- # form parameters
209
- form_params = {}
210
-
211
- # http body (model)
212
- post_body = nil
213
195
 
214
- auth_names = ['PureCloud Auth']
215
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
216
- :header_params => header_params,
217
- :query_params => query_params,
218
- :form_params => form_params,
219
- :body => post_body,
220
- :auth_names => auth_names,
221
- :return_type => 'PermissionCollectionEntityListing')
222
- if @api_client.config.debugging
223
- @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
224
- end
225
- return data, status_code, headers
226
- end
227
-
228
- # Get the list of enabled products
229
- # Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
230
- # @param [Hash] opts the optional parameters
231
- # @return [OrganizationProductEntityListing]
232
- def get_authorization_products(opts = {})
233
- data, _status_code, _headers = get_authorization_products_with_http_info(opts)
234
- return data
235
- end
236
-
237
- # Get the list of enabled products
238
- # Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
239
- # @param [Hash] opts the optional parameters
240
- # @return [Array<(OrganizationProductEntityListing, Fixnum, Hash)>] OrganizationProductEntityListing data, response status code and response headers
241
- def get_authorization_products_with_http_info(opts = {})
242
- if @api_client.config.debugging
243
- @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_products ..."
244
- end
196
+ # verify the required parameter 'role_id' is set
197
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.delete_authorization_subject_division_role" if role_id.nil?
198
+
199
+
200
+
201
+
245
202
 
246
203
  # resource path
247
- local_var_path = "/api/v2/authorization/products".sub('{format}','json')
204
+ local_var_path = "/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}".sub('{format}','json').sub('{' + 'subjectId' + '}', subject_id.to_s).sub('{' + 'divisionId' + '}', division_id.to_s).sub('{' + 'roleId' + '}', role_id.to_s)
248
205
 
249
206
  # query parameters
250
207
  query_params = {}
@@ -267,49 +224,48 @@ module PureCloud
267
224
  post_body = nil
268
225
 
269
226
  auth_names = ['PureCloud Auth']
270
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
227
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
271
228
  :header_params => header_params,
272
229
  :query_params => query_params,
273
230
  :form_params => form_params,
274
231
  :body => post_body,
275
- :auth_names => auth_names,
276
- :return_type => 'OrganizationProductEntityListing')
232
+ :auth_names => auth_names)
277
233
  if @api_client.config.debugging
278
- @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
234
+ @api_client.config.logger.debug "API called: AuthorizationApi#delete_authorization_subject_division_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
279
235
  end
280
236
  return data, status_code, headers
281
237
  end
282
238
 
283
- # Get a single organization role.
284
- # Get the organization role specified by its ID.
285
- # @param role_id Role ID
239
+ # Removes all the roles from the user.
240
+ #
241
+ # @param user_id User ID
286
242
  # @param [Hash] opts the optional parameters
287
- # @return [DomainOrganizationRole]
288
- def get_authorization_role(role_id, opts = {})
289
- data, _status_code, _headers = get_authorization_role_with_http_info(role_id, opts)
290
- return data
243
+ # @return [nil]
244
+ def delete_user_roles(user_id, opts = {})
245
+ delete_user_roles_with_http_info(user_id, opts)
246
+ return nil
291
247
  end
292
248
 
293
- # Get a single organization role.
294
- # Get the organization role specified by its ID.
295
- # @param role_id Role ID
249
+ # Removes all the roles from the user.
250
+ #
251
+ # @param user_id User ID
296
252
  # @param [Hash] opts the optional parameters
297
- # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
298
- def get_authorization_role_with_http_info(role_id, opts = {})
253
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
254
+ def delete_user_roles_with_http_info(user_id, opts = {})
299
255
  if @api_client.config.debugging
300
- @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role ..."
256
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.delete_user_roles ..."
301
257
  end
302
258
 
303
259
 
304
- # verify the required parameter 'role_id' is set
305
- fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role" if role_id.nil?
260
+ # verify the required parameter 'user_id' is set
261
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.delete_user_roles" if user_id.nil?
306
262
 
307
263
 
308
264
 
309
265
 
310
266
 
311
267
  # resource path
312
- local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
268
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
313
269
 
314
270
  # query parameters
315
271
  query_params = {}
@@ -332,62 +288,60 @@ module PureCloud
332
288
  post_body = nil
333
289
 
334
290
  auth_names = ['PureCloud Auth']
335
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
291
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
336
292
  :header_params => header_params,
337
293
  :query_params => query_params,
338
294
  :form_params => form_params,
339
295
  :body => post_body,
340
- :auth_names => auth_names,
341
- :return_type => 'DomainOrganizationRole')
296
+ :auth_names => auth_names)
342
297
  if @api_client.config.debugging
343
- @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
298
+ @api_client.config.logger.debug "API called: AuthorizationApi#delete_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
344
299
  end
345
300
  return data, status_code, headers
346
301
  end
347
302
 
348
- # Get an org role to default role comparison comparison
349
- # Compares any organization role to a default role id and show differences
350
- # @param left_role_id Left Role ID
351
- # @param right_role_id Right Role id
303
+ # Returns an authorization division.
304
+ #
305
+ # @param division_id Division ID
352
306
  # @param [Hash] opts the optional parameters
353
- # @return [DomainOrgRoleDifference]
354
- def get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, opts = {})
355
- data, _status_code, _headers = get_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, opts)
307
+ # @option opts [BOOLEAN] :object_count Get count of objects in this division, grouped by type (default to false)
308
+ # @return [AuthzDivision]
309
+ def get_authorization_division(division_id, opts = {})
310
+ data, _status_code, _headers = get_authorization_division_with_http_info(division_id, opts)
356
311
  return data
357
312
  end
358
313
 
359
- # Get an org role to default role comparison comparison
360
- # Compares any organization role to a default role id and show differences
361
- # @param left_role_id Left Role ID
362
- # @param right_role_id Right Role id
314
+ # Returns an authorization division.
315
+ #
316
+ # @param division_id Division ID
363
317
  # @param [Hash] opts the optional parameters
364
- # @return [Array<(DomainOrgRoleDifference, Fixnum, Hash)>] DomainOrgRoleDifference data, response status code and response headers
365
- def get_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, opts = {})
318
+ # @option opts [BOOLEAN] :object_count Get count of objects in this division, grouped by type
319
+ # @return [Array<(AuthzDivision, Fixnum, Hash)>] AuthzDivision data, response status code and response headers
320
+ def get_authorization_division_with_http_info(division_id, opts = {})
366
321
  if @api_client.config.debugging
367
- @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role_comparedefault_right_role_id ..."
322
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_division ..."
368
323
  end
369
324
 
370
325
 
371
- # verify the required parameter 'left_role_id' is set
372
- fail ArgumentError, "Missing the required parameter 'left_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_id" if left_role_id.nil?
326
+ # verify the required parameter 'division_id' is set
327
+ fail ArgumentError, "Missing the required parameter 'division_id' when calling AuthorizationApi.get_authorization_division" if division_id.nil?
373
328
 
374
329
 
375
330
 
376
331
 
377
332
 
378
333
 
379
- # verify the required parameter 'right_role_id' is set
380
- fail ArgumentError, "Missing the required parameter 'right_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_id" if right_role_id.nil?
381
334
 
382
335
 
383
336
 
384
337
 
385
338
 
386
339
  # resource path
387
- local_var_path = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s)
340
+ local_var_path = "/api/v2/authorization/divisions/{divisionId}".sub('{format}','json').sub('{' + 'divisionId' + '}', division_id.to_s)
388
341
 
389
342
  # query parameters
390
343
  query_params = {}
344
+ query_params[:'objectCount'] = opts[:'object_count'] if opts[:'object_count']
391
345
 
392
346
  # header parameters
393
347
  header_params = {}
@@ -413,16 +367,15 @@ module PureCloud
413
367
  :form_params => form_params,
414
368
  :body => post_body,
415
369
  :auth_names => auth_names,
416
- :return_type => 'DomainOrgRoleDifference')
370
+ :return_type => 'AuthzDivision')
417
371
  if @api_client.config.debugging
418
- @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role_comparedefault_right_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
372
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_division\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
419
373
  end
420
374
  return data, status_code, headers
421
375
  end
422
376
 
423
- # Get the subjects' granted divisions in the specified role.
424
- # Includes the divisions for which the subject has a grant.
425
- # @param role_id Role ID
377
+ # Retrieve a list of all divisions defined for the organization
378
+ # Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3
426
379
  # @param [Hash] opts the optional parameters
427
380
  # @option opts [Integer] :page_size The total page size requested (default to 25)
428
381
  # @option opts [Integer] :page_number The page number requested (default to 1)
@@ -430,15 +383,17 @@ module PureCloud
430
383
  # @option opts [Array<String>] :expand variable name requested by expand list
431
384
  # @option opts [String] :next_page next page token
432
385
  # @option opts [String] :previous_page Previous page token
433
- # @return [SubjectDivisionGrantsEntityListing]
434
- def get_authorization_role_subjectgrants(role_id, opts = {})
435
- data, _status_code, _headers = get_authorization_role_subjectgrants_with_http_info(role_id, opts)
386
+ # @option opts [BOOLEAN] :object_count Include the count of objects contained in the division (default to false)
387
+ # @option opts [Array<String>] :id Optionally request specific divisions by their IDs
388
+ # @option opts [String] :name Search term to filter by division name
389
+ # @return [AuthzDivisionEntityListing]
390
+ def get_authorization_divisions(opts = {})
391
+ data, _status_code, _headers = get_authorization_divisions_with_http_info(opts)
436
392
  return data
437
393
  end
438
394
 
439
- # Get the subjects&#39; granted divisions in the specified role.
440
- # Includes the divisions for which the subject has a grant.
441
- # @param role_id Role ID
395
+ # Retrieve a list of all divisions defined for the organization
396
+ # Request specific divisions by id using a query param \&quot;id\&quot;, e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&amp;id=72e9fb25-c484-488d-9312-7acba82435b3
442
397
  # @param [Hash] opts the optional parameters
443
398
  # @option opts [Integer] :page_size The total page size requested
444
399
  # @option opts [Integer] :page_number The page number requested
@@ -446,15 +401,28 @@ module PureCloud
446
401
  # @option opts [Array<String>] :expand variable name requested by expand list
447
402
  # @option opts [String] :next_page next page token
448
403
  # @option opts [String] :previous_page Previous page token
449
- # @return [Array<(SubjectDivisionGrantsEntityListing, Fixnum, Hash)>] SubjectDivisionGrantsEntityListing data, response status code and response headers
450
- def get_authorization_role_subjectgrants_with_http_info(role_id, opts = {})
404
+ # @option opts [BOOLEAN] :object_count Include the count of objects contained in the division
405
+ # @option opts [Array<String>] :id Optionally request specific divisions by their IDs
406
+ # @option opts [String] :name Search term to filter by division name
407
+ # @return [Array<(AuthzDivisionEntityListing, Fixnum, Hash)>] AuthzDivisionEntityListing data, response status code and response headers
408
+ def get_authorization_divisions_with_http_info(opts = {})
451
409
  if @api_client.config.debugging
452
- @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role_subjectgrants ..."
410
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_divisions ..."
453
411
  end
454
412
 
455
413
 
456
- # verify the required parameter 'role_id' is set
457
- fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role_subjectgrants" if role_id.nil?
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
458
426
 
459
427
 
460
428
 
@@ -497,7 +465,7 @@ module PureCloud
497
465
 
498
466
 
499
467
  # resource path
500
- local_var_path = "/api/v2/authorization/roles/{roleId}/subjectgrants".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
468
+ local_var_path = "/api/v2/authorization/divisions".sub('{format}','json')
501
469
 
502
470
  # query parameters
503
471
  query_params = {}
@@ -507,6 +475,9 @@ module PureCloud
507
475
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
508
476
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
509
477
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
478
+ query_params[:'objectCount'] = opts[:'object_count'] if opts[:'object_count']
479
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
480
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
510
481
 
511
482
  # header parameters
512
483
  header_params = {}
@@ -532,53 +503,798 @@ module PureCloud
532
503
  :form_params => form_params,
533
504
  :body => post_body,
534
505
  :auth_names => auth_names,
535
- :return_type => 'SubjectDivisionGrantsEntityListing')
506
+ :return_type => 'AuthzDivisionEntityListing')
536
507
  if @api_client.config.debugging
537
- @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role_subjectgrants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
508
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_divisions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
538
509
  end
539
510
  return data, status_code, headers
540
511
  end
541
512
 
542
- # Retrieve a list of all roles defined for the organization
543
- #
513
+ # Retrieve the home division for the organization.
514
+ # Will not include object counts.
544
515
  # @param [Hash] opts the optional parameters
545
- # @option opts [Integer] :page_size The total page size requested (default to 25)
546
- # @option opts [Integer] :page_number The page number requested (default to 1)
547
- # @option opts [String] :sort_by variable name requested to sort by
548
- # @option opts [Array<String>] :expand variable name requested by expand list
549
- # @option opts [String] :next_page next page token
550
- # @option opts [String] :previous_page Previous page token
551
- # @option opts [String] :name
552
- # @option opts [Array<String>] :permission
553
- # @option opts [Array<String>] :default_role_id
554
- # @option opts [BOOLEAN] :user_count (default to true)
555
- # @option opts [Array<String>] :id id
556
- # @return [OrganizationRoleEntityListing]
557
- def get_authorization_roles(opts = {})
558
- data, _status_code, _headers = get_authorization_roles_with_http_info(opts)
516
+ # @return [AuthzDivision]
517
+ def get_authorization_divisions_home(opts = {})
518
+ data, _status_code, _headers = get_authorization_divisions_home_with_http_info(opts)
559
519
  return data
560
520
  end
561
521
 
562
- # Retrieve a list of all roles defined for the organization
563
- #
522
+ # Retrieve the home division for the organization.
523
+ # Will not include object counts.
564
524
  # @param [Hash] opts the optional parameters
565
- # @option opts [Integer] :page_size The total page size requested
566
- # @option opts [Integer] :page_number The page number requested
567
- # @option opts [String] :sort_by variable name requested to sort by
568
- # @option opts [Array<String>] :expand variable name requested by expand list
569
- # @option opts [String] :next_page next page token
570
- # @option opts [String] :previous_page Previous page token
571
- # @option opts [String] :name
572
- # @option opts [Array<String>] :permission
573
- # @option opts [Array<String>] :default_role_id
574
- # @option opts [BOOLEAN] :user_count
575
- # @option opts [Array<String>] :id id
576
- # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers
577
- def get_authorization_roles_with_http_info(opts = {})
525
+ # @return [Array<(AuthzDivision, Fixnum, Hash)>] AuthzDivision data, response status code and response headers
526
+ def get_authorization_divisions_home_with_http_info(opts = {})
578
527
  if @api_client.config.debugging
579
- @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_roles ..."
528
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_divisions_home ..."
580
529
  end
581
530
 
531
+ # resource path
532
+ local_var_path = "/api/v2/authorization/divisions/home".sub('{format}','json')
533
+
534
+ # query parameters
535
+ query_params = {}
536
+
537
+ # header parameters
538
+ header_params = {}
539
+
540
+ # HTTP header 'Accept' (if needed)
541
+ local_header_accept = ['application/json']
542
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
543
+
544
+ # HTTP header 'Content-Type'
545
+ local_header_content_type = ['application/json']
546
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
547
+
548
+ # form parameters
549
+ form_params = {}
550
+
551
+ # http body (model)
552
+ post_body = nil
553
+
554
+ auth_names = ['PureCloud Auth']
555
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
556
+ :header_params => header_params,
557
+ :query_params => query_params,
558
+ :form_params => form_params,
559
+ :body => post_body,
560
+ :auth_names => auth_names,
561
+ :return_type => 'AuthzDivision')
562
+ if @api_client.config.debugging
563
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_divisions_home\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
564
+ end
565
+ return data, status_code, headers
566
+ end
567
+
568
+ # Returns the maximum allowed number of divisions.
569
+ #
570
+ # @param [Hash] opts the optional parameters
571
+ # @return [Integer]
572
+ def get_authorization_divisions_limit(opts = {})
573
+ data, _status_code, _headers = get_authorization_divisions_limit_with_http_info(opts)
574
+ return data
575
+ end
576
+
577
+ # Returns the maximum allowed number of divisions.
578
+ #
579
+ # @param [Hash] opts the optional parameters
580
+ # @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers
581
+ def get_authorization_divisions_limit_with_http_info(opts = {})
582
+ if @api_client.config.debugging
583
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_divisions_limit ..."
584
+ end
585
+
586
+ # resource path
587
+ local_var_path = "/api/v2/authorization/divisions/limit".sub('{format}','json')
588
+
589
+ # query parameters
590
+ query_params = {}
591
+
592
+ # header parameters
593
+ header_params = {}
594
+
595
+ # HTTP header 'Accept' (if needed)
596
+ local_header_accept = ['application/json']
597
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
598
+
599
+ # HTTP header 'Content-Type'
600
+ local_header_content_type = ['application/json']
601
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
602
+
603
+ # form parameters
604
+ form_params = {}
605
+
606
+ # http body (model)
607
+ post_body = nil
608
+
609
+ auth_names = ['PureCloud Auth']
610
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
611
+ :header_params => header_params,
612
+ :query_params => query_params,
613
+ :form_params => form_params,
614
+ :body => post_body,
615
+ :auth_names => auth_names,
616
+ :return_type => 'Integer')
617
+ if @api_client.config.debugging
618
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_divisions_limit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
619
+ end
620
+ return data, status_code, headers
621
+ end
622
+
623
+ # Returns whether or not current user can perform the specified action(s).
624
+ #
625
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
626
+ # @param [Hash] opts the optional parameters
627
+ # @option opts [String] :name Search term to filter by division name
628
+ # @return [Array<AuthzDivision>]
629
+ def get_authorization_divisionspermitted_me(permission, opts = {})
630
+ data, _status_code, _headers = get_authorization_divisionspermitted_me_with_http_info(permission, opts)
631
+ return data
632
+ end
633
+
634
+ # Returns whether or not current user can perform the specified action(s).
635
+ #
636
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
637
+ # @param [Hash] opts the optional parameters
638
+ # @option opts [String] :name Search term to filter by division name
639
+ # @return [Array<(Array<AuthzDivision>, Fixnum, Hash)>] Array<AuthzDivision> data, response status code and response headers
640
+ def get_authorization_divisionspermitted_me_with_http_info(permission, opts = {})
641
+ if @api_client.config.debugging
642
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_divisionspermitted_me ..."
643
+ end
644
+
645
+
646
+ # verify the required parameter 'permission' is set
647
+ fail ArgumentError, "Missing the required parameter 'permission' when calling AuthorizationApi.get_authorization_divisionspermitted_me" if permission.nil?
648
+
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+ # resource path
660
+ local_var_path = "/api/v2/authorization/divisionspermitted/me".sub('{format}','json')
661
+
662
+ # query parameters
663
+ query_params = {}
664
+ query_params[:'permission'] = permission
665
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
666
+
667
+ # header parameters
668
+ header_params = {}
669
+
670
+ # HTTP header 'Accept' (if needed)
671
+ local_header_accept = ['application/json']
672
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
673
+
674
+ # HTTP header 'Content-Type'
675
+ local_header_content_type = ['application/json']
676
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
677
+
678
+ # form parameters
679
+ form_params = {}
680
+
681
+ # http body (model)
682
+ post_body = nil
683
+
684
+ auth_names = ['PureCloud Auth']
685
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
686
+ :header_params => header_params,
687
+ :query_params => query_params,
688
+ :form_params => form_params,
689
+ :body => post_body,
690
+ :auth_names => auth_names,
691
+ :return_type => 'Array<AuthzDivision>')
692
+ if @api_client.config.debugging
693
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_divisionspermitted_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
694
+ end
695
+ return data, status_code, headers
696
+ end
697
+
698
+ # Returns whether or not specified user can perform the specified action(s).
699
+ #
700
+ # @param subject_id Subject ID (user or group)
701
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
702
+ # @param [Hash] opts the optional parameters
703
+ # @option opts [String] :name Search term to filter by division name
704
+ # @return [Array<AuthzDivision>]
705
+ def get_authorization_divisionspermitted_subject_id(subject_id, permission, opts = {})
706
+ data, _status_code, _headers = get_authorization_divisionspermitted_subject_id_with_http_info(subject_id, permission, opts)
707
+ return data
708
+ end
709
+
710
+ # Returns whether or not specified user can perform the specified action(s).
711
+ #
712
+ # @param subject_id Subject ID (user or group)
713
+ # @param permission The permission string, including the object to access, e.g. routing:queue:view
714
+ # @param [Hash] opts the optional parameters
715
+ # @option opts [String] :name Search term to filter by division name
716
+ # @return [Array<(Array<AuthzDivision>, Fixnum, Hash)>] Array<AuthzDivision> data, response status code and response headers
717
+ def get_authorization_divisionspermitted_subject_id_with_http_info(subject_id, permission, opts = {})
718
+ if @api_client.config.debugging
719
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_divisionspermitted_subject_id ..."
720
+ end
721
+
722
+
723
+ # verify the required parameter 'subject_id' is set
724
+ fail ArgumentError, "Missing the required parameter 'subject_id' when calling AuthorizationApi.get_authorization_divisionspermitted_subject_id" if subject_id.nil?
725
+
726
+
727
+
728
+
729
+
730
+
731
+ # verify the required parameter 'permission' is set
732
+ fail ArgumentError, "Missing the required parameter 'permission' when calling AuthorizationApi.get_authorization_divisionspermitted_subject_id" if permission.nil?
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+ # resource path
745
+ local_var_path = "/api/v2/authorization/divisionspermitted/{subjectId}".sub('{format}','json').sub('{' + 'subjectId' + '}', subject_id.to_s)
746
+
747
+ # query parameters
748
+ query_params = {}
749
+ query_params[:'permission'] = permission
750
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
751
+
752
+ # header parameters
753
+ header_params = {}
754
+
755
+ # HTTP header 'Accept' (if needed)
756
+ local_header_accept = ['application/json']
757
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
758
+
759
+ # HTTP header 'Content-Type'
760
+ local_header_content_type = ['application/json']
761
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
762
+
763
+ # form parameters
764
+ form_params = {}
765
+
766
+ # http body (model)
767
+ post_body = nil
768
+
769
+ auth_names = ['PureCloud Auth']
770
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
771
+ :header_params => header_params,
772
+ :query_params => query_params,
773
+ :form_params => form_params,
774
+ :body => post_body,
775
+ :auth_names => auth_names,
776
+ :return_type => 'Array<AuthzDivision>')
777
+ if @api_client.config.debugging
778
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_divisionspermitted_subject_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
779
+ end
780
+ return data, status_code, headers
781
+ end
782
+
783
+ # Get all permissions.
784
+ # Retrieve a list of all permission defined in the system.
785
+ # @param [Hash] opts the optional parameters
786
+ # @option opts [Integer] :page_size Page size (default to 25)
787
+ # @option opts [Integer] :page_number Page number (default to 1)
788
+ # @return [PermissionCollectionEntityListing]
789
+ def get_authorization_permissions(opts = {})
790
+ data, _status_code, _headers = get_authorization_permissions_with_http_info(opts)
791
+ return data
792
+ end
793
+
794
+ # Get all permissions.
795
+ # Retrieve a list of all permission defined in the system.
796
+ # @param [Hash] opts the optional parameters
797
+ # @option opts [Integer] :page_size Page size
798
+ # @option opts [Integer] :page_number Page number
799
+ # @return [Array<(PermissionCollectionEntityListing, Fixnum, Hash)>] PermissionCollectionEntityListing data, response status code and response headers
800
+ def get_authorization_permissions_with_http_info(opts = {})
801
+ if @api_client.config.debugging
802
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_permissions ..."
803
+ end
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+ # resource path
818
+ local_var_path = "/api/v2/authorization/permissions".sub('{format}','json')
819
+
820
+ # query parameters
821
+ query_params = {}
822
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
823
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
824
+
825
+ # header parameters
826
+ header_params = {}
827
+
828
+ # HTTP header 'Accept' (if needed)
829
+ local_header_accept = ['application/json']
830
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
831
+
832
+ # HTTP header 'Content-Type'
833
+ local_header_content_type = ['application/json']
834
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
835
+
836
+ # form parameters
837
+ form_params = {}
838
+
839
+ # http body (model)
840
+ post_body = nil
841
+
842
+ auth_names = ['PureCloud Auth']
843
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
844
+ :header_params => header_params,
845
+ :query_params => query_params,
846
+ :form_params => form_params,
847
+ :body => post_body,
848
+ :auth_names => auth_names,
849
+ :return_type => 'PermissionCollectionEntityListing')
850
+ if @api_client.config.debugging
851
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
852
+ end
853
+ return data, status_code, headers
854
+ end
855
+
856
+ # Get the list of enabled products
857
+ # Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
858
+ # @param [Hash] opts the optional parameters
859
+ # @return [OrganizationProductEntityListing]
860
+ def get_authorization_products(opts = {})
861
+ data, _status_code, _headers = get_authorization_products_with_http_info(opts)
862
+ return data
863
+ end
864
+
865
+ # Get the list of enabled products
866
+ # Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
867
+ # @param [Hash] opts the optional parameters
868
+ # @return [Array<(OrganizationProductEntityListing, Fixnum, Hash)>] OrganizationProductEntityListing data, response status code and response headers
869
+ def get_authorization_products_with_http_info(opts = {})
870
+ if @api_client.config.debugging
871
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_products ..."
872
+ end
873
+
874
+ # resource path
875
+ local_var_path = "/api/v2/authorization/products".sub('{format}','json')
876
+
877
+ # query parameters
878
+ query_params = {}
879
+
880
+ # header parameters
881
+ header_params = {}
882
+
883
+ # HTTP header 'Accept' (if needed)
884
+ local_header_accept = ['application/json']
885
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
886
+
887
+ # HTTP header 'Content-Type'
888
+ local_header_content_type = ['application/json']
889
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
890
+
891
+ # form parameters
892
+ form_params = {}
893
+
894
+ # http body (model)
895
+ post_body = nil
896
+
897
+ auth_names = ['PureCloud Auth']
898
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
899
+ :header_params => header_params,
900
+ :query_params => query_params,
901
+ :form_params => form_params,
902
+ :body => post_body,
903
+ :auth_names => auth_names,
904
+ :return_type => 'OrganizationProductEntityListing')
905
+ if @api_client.config.debugging
906
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
907
+ end
908
+ return data, status_code, headers
909
+ end
910
+
911
+ # Get a single organization role.
912
+ # Get the organization role specified by its ID.
913
+ # @param role_id Role ID
914
+ # @param [Hash] opts the optional parameters
915
+ # @return [DomainOrganizationRole]
916
+ def get_authorization_role(role_id, opts = {})
917
+ data, _status_code, _headers = get_authorization_role_with_http_info(role_id, opts)
918
+ return data
919
+ end
920
+
921
+ # Get a single organization role.
922
+ # Get the organization role specified by its ID.
923
+ # @param role_id Role ID
924
+ # @param [Hash] opts the optional parameters
925
+ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
926
+ def get_authorization_role_with_http_info(role_id, opts = {})
927
+ if @api_client.config.debugging
928
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role ..."
929
+ end
930
+
931
+
932
+ # verify the required parameter 'role_id' is set
933
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role" if role_id.nil?
934
+
935
+
936
+
937
+
938
+
939
+ # resource path
940
+ local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
941
+
942
+ # query parameters
943
+ query_params = {}
944
+
945
+ # header parameters
946
+ header_params = {}
947
+
948
+ # HTTP header 'Accept' (if needed)
949
+ local_header_accept = ['application/json']
950
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
951
+
952
+ # HTTP header 'Content-Type'
953
+ local_header_content_type = ['application/json']
954
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
955
+
956
+ # form parameters
957
+ form_params = {}
958
+
959
+ # http body (model)
960
+ post_body = nil
961
+
962
+ auth_names = ['PureCloud Auth']
963
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
964
+ :header_params => header_params,
965
+ :query_params => query_params,
966
+ :form_params => form_params,
967
+ :body => post_body,
968
+ :auth_names => auth_names,
969
+ :return_type => 'DomainOrganizationRole')
970
+ if @api_client.config.debugging
971
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
972
+ end
973
+ return data, status_code, headers
974
+ end
975
+
976
+ # Get an org role to default role comparison comparison
977
+ # Compares any organization role to a default role id and show differences
978
+ # @param left_role_id Left Role ID
979
+ # @param right_role_id Right Role id
980
+ # @param [Hash] opts the optional parameters
981
+ # @return [DomainOrgRoleDifference]
982
+ def get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, opts = {})
983
+ data, _status_code, _headers = get_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, opts)
984
+ return data
985
+ end
986
+
987
+ # Get an org role to default role comparison comparison
988
+ # Compares any organization role to a default role id and show differences
989
+ # @param left_role_id Left Role ID
990
+ # @param right_role_id Right Role id
991
+ # @param [Hash] opts the optional parameters
992
+ # @return [Array<(DomainOrgRoleDifference, Fixnum, Hash)>] DomainOrgRoleDifference data, response status code and response headers
993
+ def get_authorization_role_comparedefault_right_role_id_with_http_info(left_role_id, right_role_id, opts = {})
994
+ if @api_client.config.debugging
995
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role_comparedefault_right_role_id ..."
996
+ end
997
+
998
+
999
+ # verify the required parameter 'left_role_id' is set
1000
+ fail ArgumentError, "Missing the required parameter 'left_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_id" if left_role_id.nil?
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+ # verify the required parameter 'right_role_id' is set
1008
+ fail ArgumentError, "Missing the required parameter 'right_role_id' when calling AuthorizationApi.get_authorization_role_comparedefault_right_role_id" if right_role_id.nil?
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+ # resource path
1015
+ local_var_path = "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s)
1016
+
1017
+ # query parameters
1018
+ query_params = {}
1019
+
1020
+ # header parameters
1021
+ header_params = {}
1022
+
1023
+ # HTTP header 'Accept' (if needed)
1024
+ local_header_accept = ['application/json']
1025
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1026
+
1027
+ # HTTP header 'Content-Type'
1028
+ local_header_content_type = ['application/json']
1029
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1030
+
1031
+ # form parameters
1032
+ form_params = {}
1033
+
1034
+ # http body (model)
1035
+ post_body = nil
1036
+
1037
+ auth_names = ['PureCloud Auth']
1038
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1039
+ :header_params => header_params,
1040
+ :query_params => query_params,
1041
+ :form_params => form_params,
1042
+ :body => post_body,
1043
+ :auth_names => auth_names,
1044
+ :return_type => 'DomainOrgRoleDifference')
1045
+ if @api_client.config.debugging
1046
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role_comparedefault_right_role_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1047
+ end
1048
+ return data, status_code, headers
1049
+ end
1050
+
1051
+ # Get the subjects' granted divisions in the specified role.
1052
+ # Includes the divisions for which the subject has a grant.
1053
+ # @param role_id Role ID
1054
+ # @param [Hash] opts the optional parameters
1055
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
1056
+ # @option opts [Integer] :page_number The page number requested (default to 1)
1057
+ # @option opts [String] :sort_by variable name requested to sort by
1058
+ # @option opts [Array<String>] :expand variable name requested by expand list
1059
+ # @option opts [String] :next_page next page token
1060
+ # @option opts [String] :previous_page Previous page token
1061
+ # @return [SubjectDivisionGrantsEntityListing]
1062
+ def get_authorization_role_subjectgrants(role_id, opts = {})
1063
+ data, _status_code, _headers = get_authorization_role_subjectgrants_with_http_info(role_id, opts)
1064
+ return data
1065
+ end
1066
+
1067
+ # Get the subjects&#39; granted divisions in the specified role.
1068
+ # Includes the divisions for which the subject has a grant.
1069
+ # @param role_id Role ID
1070
+ # @param [Hash] opts the optional parameters
1071
+ # @option opts [Integer] :page_size The total page size requested
1072
+ # @option opts [Integer] :page_number The page number requested
1073
+ # @option opts [String] :sort_by variable name requested to sort by
1074
+ # @option opts [Array<String>] :expand variable name requested by expand list
1075
+ # @option opts [String] :next_page next page token
1076
+ # @option opts [String] :previous_page Previous page token
1077
+ # @return [Array<(SubjectDivisionGrantsEntityListing, Fixnum, Hash)>] SubjectDivisionGrantsEntityListing data, response status code and response headers
1078
+ def get_authorization_role_subjectgrants_with_http_info(role_id, opts = {})
1079
+ if @api_client.config.debugging
1080
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role_subjectgrants ..."
1081
+ end
1082
+
1083
+
1084
+ # verify the required parameter 'role_id' is set
1085
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role_subjectgrants" if role_id.nil?
1086
+
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+
1111
+
1112
+
1113
+
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+ # resource path
1128
+ local_var_path = "/api/v2/authorization/roles/{roleId}/subjectgrants".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
1129
+
1130
+ # query parameters
1131
+ query_params = {}
1132
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1133
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1134
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1135
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1136
+ query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
1137
+ query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
1138
+
1139
+ # header parameters
1140
+ header_params = {}
1141
+
1142
+ # HTTP header 'Accept' (if needed)
1143
+ local_header_accept = ['application/json']
1144
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1145
+
1146
+ # HTTP header 'Content-Type'
1147
+ local_header_content_type = ['application/json']
1148
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1149
+
1150
+ # form parameters
1151
+ form_params = {}
1152
+
1153
+ # http body (model)
1154
+ post_body = nil
1155
+
1156
+ auth_names = ['PureCloud Auth']
1157
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1158
+ :header_params => header_params,
1159
+ :query_params => query_params,
1160
+ :form_params => form_params,
1161
+ :body => post_body,
1162
+ :auth_names => auth_names,
1163
+ :return_type => 'SubjectDivisionGrantsEntityListing')
1164
+ if @api_client.config.debugging
1165
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role_subjectgrants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1166
+ end
1167
+ return data, status_code, headers
1168
+ end
1169
+
1170
+ # Get a list of the users in a specified role.
1171
+ # Get an array of the UUIDs of the users in the specified role.
1172
+ # @param role_id Role ID
1173
+ # @param [Hash] opts the optional parameters
1174
+ # @option opts [Integer] :page_size Page size (default to 25)
1175
+ # @option opts [Integer] :page_number Page number (default to 1)
1176
+ # @return [UserEntityListing]
1177
+ def get_authorization_role_users(role_id, opts = {})
1178
+ data, _status_code, _headers = get_authorization_role_users_with_http_info(role_id, opts)
1179
+ return data
1180
+ end
1181
+
1182
+ # Get a list of the users in a specified role.
1183
+ # Get an array of the UUIDs of the users in the specified role.
1184
+ # @param role_id Role ID
1185
+ # @param [Hash] opts the optional parameters
1186
+ # @option opts [Integer] :page_size Page size
1187
+ # @option opts [Integer] :page_number Page number
1188
+ # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
1189
+ def get_authorization_role_users_with_http_info(role_id, opts = {})
1190
+ if @api_client.config.debugging
1191
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_role_users ..."
1192
+ end
1193
+
1194
+
1195
+ # verify the required parameter 'role_id' is set
1196
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.get_authorization_role_users" if role_id.nil?
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+ # resource path
1215
+ local_var_path = "/api/v2/authorization/roles/{roleId}/users".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
1216
+
1217
+ # query parameters
1218
+ query_params = {}
1219
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1220
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1221
+
1222
+ # header parameters
1223
+ header_params = {}
1224
+
1225
+ # HTTP header 'Accept' (if needed)
1226
+ local_header_accept = ['application/json']
1227
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1228
+
1229
+ # HTTP header 'Content-Type'
1230
+ local_header_content_type = ['application/json']
1231
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1232
+
1233
+ # form parameters
1234
+ form_params = {}
1235
+
1236
+ # http body (model)
1237
+ post_body = nil
1238
+
1239
+ auth_names = ['PureCloud Auth']
1240
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1241
+ :header_params => header_params,
1242
+ :query_params => query_params,
1243
+ :form_params => form_params,
1244
+ :body => post_body,
1245
+ :auth_names => auth_names,
1246
+ :return_type => 'UserEntityListing')
1247
+ if @api_client.config.debugging
1248
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_role_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1249
+ end
1250
+ return data, status_code, headers
1251
+ end
1252
+
1253
+ # Retrieve a list of all roles defined for the organization
1254
+ #
1255
+ # @param [Hash] opts the optional parameters
1256
+ # @option opts [Integer] :page_size The total page size requested (default to 25)
1257
+ # @option opts [Integer] :page_number The page number requested (default to 1)
1258
+ # @option opts [String] :sort_by variable name requested to sort by
1259
+ # @option opts [Array<String>] :expand variable name requested by expand list
1260
+ # @option opts [String] :next_page next page token
1261
+ # @option opts [String] :previous_page Previous page token
1262
+ # @option opts [String] :name
1263
+ # @option opts [Array<String>] :permission
1264
+ # @option opts [Array<String>] :default_role_id
1265
+ # @option opts [BOOLEAN] :user_count (default to true)
1266
+ # @option opts [Array<String>] :id id
1267
+ # @return [OrganizationRoleEntityListing]
1268
+ def get_authorization_roles(opts = {})
1269
+ data, _status_code, _headers = get_authorization_roles_with_http_info(opts)
1270
+ return data
1271
+ end
1272
+
1273
+ # Retrieve a list of all roles defined for the organization
1274
+ #
1275
+ # @param [Hash] opts the optional parameters
1276
+ # @option opts [Integer] :page_size The total page size requested
1277
+ # @option opts [Integer] :page_number The page number requested
1278
+ # @option opts [String] :sort_by variable name requested to sort by
1279
+ # @option opts [Array<String>] :expand variable name requested by expand list
1280
+ # @option opts [String] :next_page next page token
1281
+ # @option opts [String] :previous_page Previous page token
1282
+ # @option opts [String] :name
1283
+ # @option opts [Array<String>] :permission
1284
+ # @option opts [Array<String>] :default_role_id
1285
+ # @option opts [BOOLEAN] :user_count
1286
+ # @option opts [Array<String>] :id id
1287
+ # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers
1288
+ def get_authorization_roles_with_http_info(opts = {})
1289
+ if @api_client.config.debugging
1290
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_roles ..."
1291
+ end
1292
+
1293
+
1294
+
1295
+
1296
+
1297
+
582
1298
 
583
1299
 
584
1300
 
@@ -632,35 +1348,380 @@ module PureCloud
632
1348
 
633
1349
 
634
1350
 
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+
1359
+ # resource path
1360
+ local_var_path = "/api/v2/authorization/roles".sub('{format}','json')
1361
+
1362
+ # query parameters
1363
+ query_params = {}
1364
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1365
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1366
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1367
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1368
+ query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
1369
+ query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
1370
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
1371
+ query_params[:'permission'] = @api_client.build_collection_param(opts[:'permission'], :multi) if opts[:'permission']
1372
+ query_params[:'defaultRoleId'] = @api_client.build_collection_param(opts[:'default_role_id'], :multi) if opts[:'default_role_id']
1373
+ query_params[:'userCount'] = opts[:'user_count'] if opts[:'user_count']
1374
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
1375
+
1376
+ # header parameters
1377
+ header_params = {}
1378
+
1379
+ # HTTP header 'Accept' (if needed)
1380
+ local_header_accept = ['application/json']
1381
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1382
+
1383
+ # HTTP header 'Content-Type'
1384
+ local_header_content_type = ['application/json']
1385
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1386
+
1387
+ # form parameters
1388
+ form_params = {}
1389
+
1390
+ # http body (model)
1391
+ post_body = nil
1392
+
1393
+ auth_names = ['PureCloud Auth']
1394
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1395
+ :header_params => header_params,
1396
+ :query_params => query_params,
1397
+ :form_params => form_params,
1398
+ :body => post_body,
1399
+ :auth_names => auth_names,
1400
+ :return_type => 'OrganizationRoleEntityListing')
1401
+ if @api_client.config.debugging
1402
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1403
+ end
1404
+ return data, status_code, headers
1405
+ end
1406
+
1407
+ # Returns a listing of roles and permissions for a user.
1408
+ #
1409
+ # @param subject_id Subject ID (user or group)
1410
+ # @param [Hash] opts the optional parameters
1411
+ # @return [AuthzSubject]
1412
+ def get_authorization_subject(subject_id, opts = {})
1413
+ data, _status_code, _headers = get_authorization_subject_with_http_info(subject_id, opts)
1414
+ return data
1415
+ end
1416
+
1417
+ # Returns a listing of roles and permissions for a user.
1418
+ #
1419
+ # @param subject_id Subject ID (user or group)
1420
+ # @param [Hash] opts the optional parameters
1421
+ # @return [Array<(AuthzSubject, Fixnum, Hash)>] AuthzSubject data, response status code and response headers
1422
+ def get_authorization_subject_with_http_info(subject_id, opts = {})
1423
+ if @api_client.config.debugging
1424
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_subject ..."
1425
+ end
1426
+
1427
+
1428
+ # verify the required parameter 'subject_id' is set
1429
+ fail ArgumentError, "Missing the required parameter 'subject_id' when calling AuthorizationApi.get_authorization_subject" if subject_id.nil?
1430
+
1431
+
1432
+
1433
+
1434
+
1435
+ # resource path
1436
+ local_var_path = "/api/v2/authorization/subjects/{subjectId}".sub('{format}','json').sub('{' + 'subjectId' + '}', subject_id.to_s)
1437
+
1438
+ # query parameters
1439
+ query_params = {}
1440
+
1441
+ # header parameters
1442
+ header_params = {}
1443
+
1444
+ # HTTP header 'Accept' (if needed)
1445
+ local_header_accept = ['application/json']
1446
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1447
+
1448
+ # HTTP header 'Content-Type'
1449
+ local_header_content_type = ['application/json']
1450
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1451
+
1452
+ # form parameters
1453
+ form_params = {}
1454
+
1455
+ # http body (model)
1456
+ post_body = nil
1457
+
1458
+ auth_names = ['PureCloud Auth']
1459
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1460
+ :header_params => header_params,
1461
+ :query_params => query_params,
1462
+ :form_params => form_params,
1463
+ :body => post_body,
1464
+ :auth_names => auth_names,
1465
+ :return_type => 'AuthzSubject')
1466
+ if @api_client.config.debugging
1467
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_subject\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1468
+ end
1469
+ return data, status_code, headers
1470
+ end
1471
+
1472
+ # Returns a listing of roles and permissions for the currently authenticated user.
1473
+ #
1474
+ # @param [Hash] opts the optional parameters
1475
+ # @return [AuthzSubject]
1476
+ def get_authorization_subjects_me(opts = {})
1477
+ data, _status_code, _headers = get_authorization_subjects_me_with_http_info(opts)
1478
+ return data
1479
+ end
1480
+
1481
+ # Returns a listing of roles and permissions for the currently authenticated user.
1482
+ #
1483
+ # @param [Hash] opts the optional parameters
1484
+ # @return [Array<(AuthzSubject, Fixnum, Hash)>] AuthzSubject data, response status code and response headers
1485
+ def get_authorization_subjects_me_with_http_info(opts = {})
1486
+ if @api_client.config.debugging
1487
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_authorization_subjects_me ..."
1488
+ end
1489
+
1490
+ # resource path
1491
+ local_var_path = "/api/v2/authorization/subjects/me".sub('{format}','json')
1492
+
1493
+ # query parameters
1494
+ query_params = {}
1495
+
1496
+ # header parameters
1497
+ header_params = {}
1498
+
1499
+ # HTTP header 'Accept' (if needed)
1500
+ local_header_accept = ['application/json']
1501
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1502
+
1503
+ # HTTP header 'Content-Type'
1504
+ local_header_content_type = ['application/json']
1505
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1506
+
1507
+ # form parameters
1508
+ form_params = {}
1509
+
1510
+ # http body (model)
1511
+ post_body = nil
1512
+
1513
+ auth_names = ['PureCloud Auth']
1514
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1515
+ :header_params => header_params,
1516
+ :query_params => query_params,
1517
+ :form_params => form_params,
1518
+ :body => post_body,
1519
+ :auth_names => auth_names,
1520
+ :return_type => 'AuthzSubject')
1521
+ if @api_client.config.debugging
1522
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_subjects_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1523
+ end
1524
+ return data, status_code, headers
1525
+ end
1526
+
1527
+ # Returns a listing of roles and permissions for a user.
1528
+ #
1529
+ # @param user_id User ID
1530
+ # @param [Hash] opts the optional parameters
1531
+ # @return [UserAuthorization]
1532
+ def get_user_roles(user_id, opts = {})
1533
+ data, _status_code, _headers = get_user_roles_with_http_info(user_id, opts)
1534
+ return data
1535
+ end
1536
+
1537
+ # Returns a listing of roles and permissions for a user.
1538
+ #
1539
+ # @param user_id User ID
1540
+ # @param [Hash] opts the optional parameters
1541
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
1542
+ def get_user_roles_with_http_info(user_id, opts = {})
1543
+ if @api_client.config.debugging
1544
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.get_user_roles ..."
1545
+ end
1546
+
1547
+
1548
+ # verify the required parameter 'user_id' is set
1549
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.get_user_roles" if user_id.nil?
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+ # resource path
1556
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1557
+
1558
+ # query parameters
1559
+ query_params = {}
1560
+
1561
+ # header parameters
1562
+ header_params = {}
1563
+
1564
+ # HTTP header 'Accept' (if needed)
1565
+ local_header_accept = ['application/json']
1566
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1567
+
1568
+ # HTTP header 'Content-Type'
1569
+ local_header_content_type = ['application/json']
1570
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1571
+
1572
+ # form parameters
1573
+ form_params = {}
1574
+
1575
+ # http body (model)
1576
+ post_body = nil
1577
+
1578
+ auth_names = ['PureCloud Auth']
1579
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1580
+ :header_params => header_params,
1581
+ :query_params => query_params,
1582
+ :form_params => form_params,
1583
+ :body => post_body,
1584
+ :auth_names => auth_names,
1585
+ :return_type => 'UserAuthorization')
1586
+ if @api_client.config.debugging
1587
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1588
+ end
1589
+ return data, status_code, headers
1590
+ end
1591
+
1592
+ # Patch Organization Role for needsUpdate Field
1593
+ # Patch Organization Role for needsUpdate Field
1594
+ # @param role_id Role ID
1595
+ # @param body Organization role
1596
+ # @param [Hash] opts the optional parameters
1597
+ # @return [DomainOrganizationRole]
1598
+ def patch_authorization_role(role_id, body, opts = {})
1599
+ data, _status_code, _headers = patch_authorization_role_with_http_info(role_id, body, opts)
1600
+ return data
1601
+ end
1602
+
1603
+ # Patch Organization Role for needsUpdate Field
1604
+ # Patch Organization Role for needsUpdate Field
1605
+ # @param role_id Role ID
1606
+ # @param body Organization role
1607
+ # @param [Hash] opts the optional parameters
1608
+ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
1609
+ def patch_authorization_role_with_http_info(role_id, body, opts = {})
1610
+ if @api_client.config.debugging
1611
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.patch_authorization_role ..."
1612
+ end
1613
+
1614
+
1615
+ # verify the required parameter 'role_id' is set
1616
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.patch_authorization_role" if role_id.nil?
1617
+
1618
+
1619
+
1620
+
1621
+
1622
+
1623
+ # verify the required parameter 'body' is set
1624
+ fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.patch_authorization_role" if body.nil?
1625
+
1626
+
1627
+
1628
+
1629
+
1630
+ # resource path
1631
+ local_var_path = "/api/v2/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
1632
+
1633
+ # query parameters
1634
+ query_params = {}
1635
+
1636
+ # header parameters
1637
+ header_params = {}
1638
+
1639
+ # HTTP header 'Accept' (if needed)
1640
+ local_header_accept = ['application/json']
1641
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1642
+
1643
+ # HTTP header 'Content-Type'
1644
+ local_header_content_type = ['application/json']
1645
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1646
+
1647
+ # form parameters
1648
+ form_params = {}
1649
+
1650
+ # http body (model)
1651
+ post_body = @api_client.object_to_http_body(body)
1652
+
1653
+ auth_names = ['PureCloud Auth']
1654
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1655
+ :header_params => header_params,
1656
+ :query_params => query_params,
1657
+ :form_params => form_params,
1658
+ :body => post_body,
1659
+ :auth_names => auth_names,
1660
+ :return_type => 'DomainOrganizationRole')
1661
+ if @api_client.config.debugging
1662
+ @api_client.config.logger.debug "API called: AuthorizationApi#patch_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1663
+ end
1664
+ return data, status_code, headers
1665
+ end
1666
+
1667
+ # Assign a list of objects to a division
1668
+ # Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]
1669
+ # @param division_id Division ID
1670
+ # @param object_type The type of the objects. Must be one of the valid object types
1671
+ # @param body Object Id List
1672
+ # @param [Hash] opts the optional parameters
1673
+ # @return [nil]
1674
+ def post_authorization_division_object(division_id, object_type, body, opts = {})
1675
+ post_authorization_division_object_with_http_info(division_id, object_type, body, opts)
1676
+ return nil
1677
+ end
1678
+
1679
+ # Assign a list of objects to a division
1680
+ # Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\&quot;206ce31f-61ec-40ed-a8b1-be6f06303998\&quot;,\&quot;250a754e-f5e4-4f51-800f-a92f09d3bf8c\&quot;]
1681
+ # @param division_id Division ID
1682
+ # @param object_type The type of the objects. Must be one of the valid object types
1683
+ # @param body Object Id List
1684
+ # @param [Hash] opts the optional parameters
1685
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1686
+ def post_authorization_division_object_with_http_info(division_id, object_type, body, opts = {})
1687
+ if @api_client.config.debugging
1688
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_division_object ..."
1689
+ end
1690
+
1691
+
1692
+ # verify the required parameter 'division_id' is set
1693
+ fail ArgumentError, "Missing the required parameter 'division_id' when calling AuthorizationApi.post_authorization_division_object" if division_id.nil?
1694
+
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+ # verify the required parameter 'object_type' is set
1701
+ fail ArgumentError, "Missing the required parameter 'object_type' when calling AuthorizationApi.post_authorization_division_object" if object_type.nil?
1702
+
1703
+ # verify enum value
1704
+ unless ['QUEUE', 'CAMPAIGN', 'CONTACTLIST', 'DNCLIST', 'MANAGEMENTUNIT', 'FLOW', 'USER'].include?(object_type)
1705
+ fail ArgumentError, "invalid value for 'object_type', must be one of QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER"
1706
+ end
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+
1713
+ # verify the required parameter 'body' is set
1714
+ fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_division_object" if body.nil?
643
1715
 
644
1716
 
645
1717
 
646
1718
 
647
1719
 
648
1720
  # resource path
649
- local_var_path = "/api/v2/authorization/roles".sub('{format}','json')
1721
+ local_var_path = "/api/v2/authorization/divisions/{divisionId}/objects/{objectType}".sub('{format}','json').sub('{' + 'divisionId' + '}', division_id.to_s).sub('{' + 'objectType' + '}', object_type.to_s)
650
1722
 
651
1723
  # query parameters
652
1724
  query_params = {}
653
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
654
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
655
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
656
- query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
657
- query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
658
- query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
659
- query_params[:'name'] = opts[:'name'] if opts[:'name']
660
- query_params[:'permission'] = @api_client.build_collection_param(opts[:'permission'], :multi) if opts[:'permission']
661
- query_params[:'defaultRoleId'] = @api_client.build_collection_param(opts[:'default_role_id'], :multi) if opts[:'default_role_id']
662
- query_params[:'userCount'] = opts[:'user_count'] if opts[:'user_count']
663
- query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
664
1725
 
665
1726
  # header parameters
666
1727
  header_params = {}
@@ -677,52 +1738,51 @@ module PureCloud
677
1738
  form_params = {}
678
1739
 
679
1740
  # http body (model)
680
- post_body = nil
1741
+ post_body = @api_client.object_to_http_body(body)
681
1742
 
682
1743
  auth_names = ['PureCloud Auth']
683
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1744
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
684
1745
  :header_params => header_params,
685
1746
  :query_params => query_params,
686
1747
  :form_params => form_params,
687
1748
  :body => post_body,
688
- :auth_names => auth_names,
689
- :return_type => 'OrganizationRoleEntityListing')
1749
+ :auth_names => auth_names)
690
1750
  if @api_client.config.debugging
691
- @api_client.config.logger.debug "API called: AuthorizationApi#get_authorization_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1751
+ @api_client.config.logger.debug "API called: AuthorizationApi#post_authorization_division_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
692
1752
  end
693
1753
  return data, status_code, headers
694
1754
  end
695
1755
 
696
- # Returns a listing of roles and permissions for a user.
1756
+ # Create a division.
697
1757
  #
698
- # @param user_id User ID
1758
+ # @param body Division
699
1759
  # @param [Hash] opts the optional parameters
700
- # @return [UserAuthorization]
701
- def get_user_roles(user_id, opts = {})
702
- data, _status_code, _headers = get_user_roles_with_http_info(user_id, opts)
1760
+ # @return [AuthzDivision]
1761
+ def post_authorization_divisions(body, opts = {})
1762
+ data, _status_code, _headers = post_authorization_divisions_with_http_info(body, opts)
703
1763
  return data
704
1764
  end
705
1765
 
706
- # Returns a listing of roles and permissions for a user.
1766
+ # Create a division.
707
1767
  #
708
- # @param user_id User ID
1768
+ # @param body Division
709
1769
  # @param [Hash] opts the optional parameters
710
- # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
711
- def get_user_roles_with_http_info(user_id, opts = {})
1770
+ # @return [Array<(AuthzDivision, Fixnum, Hash)>] AuthzDivision data, response status code and response headers
1771
+ def post_authorization_divisions_with_http_info(body, opts = {})
712
1772
  if @api_client.config.debugging
713
- @api_client.config.logger.debug "Calling API: AuthorizationApi.get_user_roles ..."
1773
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_divisions ..."
714
1774
  end
715
1775
 
716
1776
 
717
- # verify the required parameter 'user_id' is set
718
- fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthorizationApi.get_user_roles" if user_id.nil?
1777
+ # verify the required parameter 'body' is set
1778
+ fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_divisions" if body.nil?
719
1779
 
720
1780
 
721
1781
 
722
1782
 
723
1783
 
724
1784
  # resource path
725
- local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1785
+ local_var_path = "/api/v2/authorization/divisions".sub('{format}','json')
726
1786
 
727
1787
  # query parameters
728
1788
  query_params = {}
@@ -742,47 +1802,47 @@ module PureCloud
742
1802
  form_params = {}
743
1803
 
744
1804
  # http body (model)
745
- post_body = nil
1805
+ post_body = @api_client.object_to_http_body(body)
746
1806
 
747
1807
  auth_names = ['PureCloud Auth']
748
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1808
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
749
1809
  :header_params => header_params,
750
1810
  :query_params => query_params,
751
1811
  :form_params => form_params,
752
1812
  :body => post_body,
753
1813
  :auth_names => auth_names,
754
- :return_type => 'UserAuthorization')
1814
+ :return_type => 'AuthzDivision')
755
1815
  if @api_client.config.debugging
756
- @api_client.config.logger.debug "API called: AuthorizationApi#get_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1816
+ @api_client.config.logger.debug "API called: AuthorizationApi#post_authorization_divisions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
757
1817
  end
758
1818
  return data, status_code, headers
759
1819
  end
760
1820
 
761
- # Patch Organization Role for needsUpdate Field
762
- # Patch Organization Role for needsUpdate Field
1821
+ # Bulk-grant subjects and divisions with an organization role.
1822
+ #
763
1823
  # @param role_id Role ID
764
- # @param body Organization role
1824
+ # @param body Subjects and Divisions
765
1825
  # @param [Hash] opts the optional parameters
766
- # @return [DomainOrganizationRole]
767
- def patch_authorization_role(role_id, body, opts = {})
768
- data, _status_code, _headers = patch_authorization_role_with_http_info(role_id, body, opts)
769
- return data
1826
+ # @return [nil]
1827
+ def post_authorization_role(role_id, body, opts = {})
1828
+ post_authorization_role_with_http_info(role_id, body, opts)
1829
+ return nil
770
1830
  end
771
1831
 
772
- # Patch Organization Role for needsUpdate Field
773
- # Patch Organization Role for needsUpdate Field
1832
+ # Bulk-grant subjects and divisions with an organization role.
1833
+ #
774
1834
  # @param role_id Role ID
775
- # @param body Organization role
1835
+ # @param body Subjects and Divisions
776
1836
  # @param [Hash] opts the optional parameters
777
- # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
778
- def patch_authorization_role_with_http_info(role_id, body, opts = {})
1837
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1838
+ def post_authorization_role_with_http_info(role_id, body, opts = {})
779
1839
  if @api_client.config.debugging
780
- @api_client.config.logger.debug "Calling API: AuthorizationApi.patch_authorization_role ..."
1840
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_role ..."
781
1841
  end
782
1842
 
783
1843
 
784
1844
  # verify the required parameter 'role_id' is set
785
- fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.patch_authorization_role" if role_id.nil?
1845
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.post_authorization_role" if role_id.nil?
786
1846
 
787
1847
 
788
1848
 
@@ -790,7 +1850,7 @@ module PureCloud
790
1850
 
791
1851
 
792
1852
  # verify the required parameter 'body' is set
793
- fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.patch_authorization_role" if body.nil?
1853
+ fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.post_authorization_role" if body.nil?
794
1854
 
795
1855
 
796
1856
 
@@ -820,15 +1880,14 @@ module PureCloud
820
1880
  post_body = @api_client.object_to_http_body(body)
821
1881
 
822
1882
  auth_names = ['PureCloud Auth']
823
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1883
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
824
1884
  :header_params => header_params,
825
1885
  :query_params => query_params,
826
1886
  :form_params => form_params,
827
1887
  :body => post_body,
828
- :auth_names => auth_names,
829
- :return_type => 'DomainOrganizationRole')
1888
+ :auth_names => auth_names)
830
1889
  if @api_client.config.debugging
831
- @api_client.config.logger.debug "API called: AuthorizationApi#patch_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1890
+ @api_client.config.logger.debug "API called: AuthorizationApi#post_authorization_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
832
1891
  end
833
1892
  return data, status_code, headers
834
1893
  end
@@ -1047,6 +2106,174 @@ module PureCloud
1047
2106
  return data, status_code, headers
1048
2107
  end
1049
2108
 
2109
+ # Make a grant of a role in a division
2110
+ #
2111
+ # @param subject_id Subject ID (user or group)
2112
+ # @param division_id the id of the division to which to make the grant
2113
+ # @param role_id the id of the role to grant
2114
+ # @param [Hash] opts the optional parameters
2115
+ # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER (default to PC_USER)
2116
+ # @return [nil]
2117
+ def post_authorization_subject_division_role(subject_id, division_id, role_id, opts = {})
2118
+ post_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts)
2119
+ return nil
2120
+ end
2121
+
2122
+ # Make a grant of a role in a division
2123
+ #
2124
+ # @param subject_id Subject ID (user or group)
2125
+ # @param division_id the id of the division to which to make the grant
2126
+ # @param role_id the id of the role to grant
2127
+ # @param [Hash] opts the optional parameters
2128
+ # @option opts [String] :subject_type what the type of the subject is, PC_GROUP or PC_USER
2129
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2130
+ def post_authorization_subject_division_role_with_http_info(subject_id, division_id, role_id, opts = {})
2131
+ if @api_client.config.debugging
2132
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.post_authorization_subject_division_role ..."
2133
+ end
2134
+
2135
+
2136
+ # verify the required parameter 'subject_id' is set
2137
+ fail ArgumentError, "Missing the required parameter 'subject_id' when calling AuthorizationApi.post_authorization_subject_division_role" if subject_id.nil?
2138
+
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+ # verify the required parameter 'division_id' is set
2145
+ fail ArgumentError, "Missing the required parameter 'division_id' when calling AuthorizationApi.post_authorization_subject_division_role" if division_id.nil?
2146
+
2147
+
2148
+
2149
+
2150
+
2151
+
2152
+ # verify the required parameter 'role_id' is set
2153
+ fail ArgumentError, "Missing the required parameter 'role_id' when calling AuthorizationApi.post_authorization_subject_division_role" if role_id.nil?
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+
2165
+ # resource path
2166
+ local_var_path = "/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}".sub('{format}','json').sub('{' + 'subjectId' + '}', subject_id.to_s).sub('{' + 'divisionId' + '}', division_id.to_s).sub('{' + 'roleId' + '}', role_id.to_s)
2167
+
2168
+ # query parameters
2169
+ query_params = {}
2170
+ query_params[:'subjectType'] = opts[:'subject_type'] if opts[:'subject_type']
2171
+
2172
+ # header parameters
2173
+ header_params = {}
2174
+
2175
+ # HTTP header 'Accept' (if needed)
2176
+ local_header_accept = ['application/json']
2177
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2178
+
2179
+ # HTTP header 'Content-Type'
2180
+ local_header_content_type = ['application/json']
2181
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2182
+
2183
+ # form parameters
2184
+ form_params = {}
2185
+
2186
+ # http body (model)
2187
+ post_body = nil
2188
+
2189
+ auth_names = ['PureCloud Auth']
2190
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2191
+ :header_params => header_params,
2192
+ :query_params => query_params,
2193
+ :form_params => form_params,
2194
+ :body => post_body,
2195
+ :auth_names => auth_names)
2196
+ if @api_client.config.debugging
2197
+ @api_client.config.logger.debug "API called: AuthorizationApi#post_authorization_subject_division_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2198
+ end
2199
+ return data, status_code, headers
2200
+ end
2201
+
2202
+ # Update a division.
2203
+ #
2204
+ # @param division_id Division ID
2205
+ # @param body Updated division data
2206
+ # @param [Hash] opts the optional parameters
2207
+ # @return [AuthzDivision]
2208
+ def put_authorization_division(division_id, body, opts = {})
2209
+ data, _status_code, _headers = put_authorization_division_with_http_info(division_id, body, opts)
2210
+ return data
2211
+ end
2212
+
2213
+ # Update a division.
2214
+ #
2215
+ # @param division_id Division ID
2216
+ # @param body Updated division data
2217
+ # @param [Hash] opts the optional parameters
2218
+ # @return [Array<(AuthzDivision, Fixnum, Hash)>] AuthzDivision data, response status code and response headers
2219
+ def put_authorization_division_with_http_info(division_id, body, opts = {})
2220
+ if @api_client.config.debugging
2221
+ @api_client.config.logger.debug "Calling API: AuthorizationApi.put_authorization_division ..."
2222
+ end
2223
+
2224
+
2225
+ # verify the required parameter 'division_id' is set
2226
+ fail ArgumentError, "Missing the required parameter 'division_id' when calling AuthorizationApi.put_authorization_division" if division_id.nil?
2227
+
2228
+
2229
+
2230
+
2231
+
2232
+
2233
+ # verify the required parameter 'body' is set
2234
+ fail ArgumentError, "Missing the required parameter 'body' when calling AuthorizationApi.put_authorization_division" if body.nil?
2235
+
2236
+
2237
+
2238
+
2239
+
2240
+ # resource path
2241
+ local_var_path = "/api/v2/authorization/divisions/{divisionId}".sub('{format}','json').sub('{' + 'divisionId' + '}', division_id.to_s)
2242
+
2243
+ # query parameters
2244
+ query_params = {}
2245
+
2246
+ # header parameters
2247
+ header_params = {}
2248
+
2249
+ # HTTP header 'Accept' (if needed)
2250
+ local_header_accept = ['application/json']
2251
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2252
+
2253
+ # HTTP header 'Content-Type'
2254
+ local_header_content_type = ['application/json']
2255
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2256
+
2257
+ # form parameters
2258
+ form_params = {}
2259
+
2260
+ # http body (model)
2261
+ post_body = @api_client.object_to_http_body(body)
2262
+
2263
+ auth_names = ['PureCloud Auth']
2264
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2265
+ :header_params => header_params,
2266
+ :query_params => query_params,
2267
+ :form_params => form_params,
2268
+ :body => post_body,
2269
+ :auth_names => auth_names,
2270
+ :return_type => 'AuthzDivision')
2271
+ if @api_client.config.debugging
2272
+ @api_client.config.logger.debug "API called: AuthorizationApi#put_authorization_division\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2273
+ end
2274
+ return data, status_code, headers
2275
+ end
2276
+
1050
2277
  # Update an organization role.
1051
2278
  # Update
1052
2279
  # @param role_id Role ID