purecloudplatformclientv2 13.1.0 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (325) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AgentActivityEntityListing.md +2 -2
  4. data/docs/ArchitectApi.md +966 -33
  5. data/docs/AttemptLimitsEntityListing.md +2 -2
  6. data/docs/AttributeEntityListing.md +2 -2
  7. data/docs/AuditQueryResponse.md +12 -0
  8. data/docs/AuthorizationApi.md +2 -0
  9. data/docs/CalibrationEntityListing.md +2 -2
  10. data/docs/Call.md +1 -0
  11. data/docs/CallBasic.md +1 -0
  12. data/docs/CallConversationEntityListing.md +2 -2
  13. data/docs/CallableTimeSetEntityListing.md +2 -2
  14. data/docs/CallbackConversationEntityListing.md +2 -2
  15. data/docs/CampaignEntityListing.md +2 -2
  16. data/docs/CampaignRuleEntityListing.md +2 -2
  17. data/docs/CampaignSequenceEntityListing.md +2 -2
  18. data/docs/CertificateAuthorityEntityListing.md +2 -2
  19. data/docs/ChatConversationEntityListing.md +2 -2
  20. data/docs/CobrowseConversationEntityListing.md +2 -2
  21. data/docs/CommandStatusEntityListing.md +2 -2
  22. data/docs/ConsumedResourcesEntityListing.md +2 -2
  23. data/docs/ConsumingResourcesEntityListing.md +2 -2
  24. data/docs/ContactListEntityListing.md +2 -2
  25. data/docs/ContactListFilterEntityListing.md +2 -2
  26. data/docs/ContactListing.md +2 -2
  27. data/docs/ConversationChat.md +1 -0
  28. data/docs/ConversationEntityListing.md +2 -2
  29. data/docs/ConversationsApi.md +71 -2
  30. data/docs/CreateCallbackOnConversationCommand.md +20 -0
  31. data/docs/DIDEntityListing.md +2 -2
  32. data/docs/DIDPoolEntityListing.md +2 -2
  33. data/docs/DependencyObjectEntityListing.md +2 -2
  34. data/docs/DependencyTypeEntityListing.md +2 -2
  35. data/docs/DialerEventEntityListing.md +2 -2
  36. data/docs/DncListEntityListing.md +2 -2
  37. data/docs/DocumentAuditEntityListing.md +2 -2
  38. data/docs/DocumentEntityListing.md +2 -2
  39. data/docs/DocumentationSearchRequest.md +1 -0
  40. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
  41. data/docs/DomainEntityListing.md +2 -2
  42. data/docs/DomainEntityListingEvaluationForm.md +2 -2
  43. data/docs/DomainEntityListingQueryResult.md +2 -2
  44. data/docs/EdgeEntityListing.md +2 -2
  45. data/docs/EdgeGroupEntityListing.md +2 -2
  46. data/docs/EdgeLineEntityListing.md +2 -2
  47. data/docs/Email.md +2 -0
  48. data/docs/EmailConversationEntityListing.md +2 -2
  49. data/docs/EmailMessageListing.md +2 -2
  50. data/docs/EncryptionKeyEntityListing.md +2 -2
  51. data/docs/EndpointEntityListing.md +2 -2
  52. data/docs/EvaluationEntityListing.md +2 -2
  53. data/docs/EvaluationFormEntityListing.md +2 -2
  54. data/docs/EvaluatorActivityEntityListing.md +2 -2
  55. data/docs/ExtensionEntityListing.md +2 -2
  56. data/docs/ExtensionPoolEntityListing.md +2 -2
  57. data/docs/ExternalContactsApi.md +2 -2
  58. data/docs/ExternalOrganizationListing.md +2 -2
  59. data/docs/Facet.md +14 -0
  60. data/docs/FaxDocumentEntityListing.md +2 -2
  61. data/docs/Filter.md +16 -0
  62. data/docs/FlowEntityListing.md +2 -2
  63. data/docs/FlowVersionEntityListing.md +2 -2
  64. data/docs/GreetingListing.md +2 -2
  65. data/docs/GroupEntityListing.md +2 -2
  66. data/docs/GroupSearchRequest.md +1 -0
  67. data/docs/HistoryListing.md +10 -5
  68. data/docs/IVR.md +28 -0
  69. data/docs/IVREntityListing.md +22 -0
  70. data/docs/InboundDomainEntityListing.md +2 -2
  71. data/docs/InboundRouteEntityListing.md +2 -2
  72. data/docs/InteractionStatsAlertContainer.md +2 -2
  73. data/docs/InteractionStatsRuleContainer.md +2 -2
  74. data/docs/KeywordSetEntityListing.md +2 -2
  75. data/docs/LanguageEntityListing.md +2 -2
  76. data/docs/LibraryEntityListing.md +2 -2
  77. data/docs/LineBaseEntityListing.md +2 -2
  78. data/docs/LineEntityListing.md +2 -2
  79. data/docs/LocationEntityListing.md +2 -2
  80. data/docs/LocationSearchRequest.md +1 -0
  81. data/docs/LogicalInterfaceEntityListing.md +2 -2
  82. data/docs/NoteListing.md +2 -2
  83. data/docs/OAuthClientEntityListing.md +2 -2
  84. data/docs/OAuthProviderEntityListing.md +2 -2
  85. data/docs/OrganizationAuthorizationApi.md +1458 -0
  86. data/docs/OrganizationPresenceEntityListing.md +2 -2
  87. data/docs/OrganizationRoleEntityListing.md +2 -2
  88. data/docs/OrphanRecordingListing.md +2 -2
  89. data/docs/OutboundRouteBaseEntityListing.md +2 -2
  90. data/docs/OutboundRouteEntityListing.md +2 -2
  91. data/docs/Participant.md +1 -0
  92. data/docs/ParticipantBasic.md +1 -0
  93. data/docs/PermissionCollectionEntityListing.md +2 -2
  94. data/docs/PhoneBaseEntityListing.md +2 -2
  95. data/docs/PhoneEntityListing.md +2 -2
  96. data/docs/PhoneMetaBaseEntityListing.md +2 -2
  97. data/docs/PhysicalInterfaceEntityListing.md +2 -2
  98. data/docs/PolicyEntityListing.md +2 -2
  99. data/docs/PromptAssetEntityListing.md +2 -2
  100. data/docs/PromptEntityListing.md +2 -2
  101. data/docs/QualityAuditPage.md +2 -2
  102. data/docs/QueueEntityListing.md +2 -2
  103. data/docs/QueueMemberEntityListing.md +2 -2
  104. data/docs/RelationshipListing.md +2 -2
  105. data/docs/ReportMetaDataEntityListing.md +2 -2
  106. data/docs/ReportRunEntryEntityDomainListing.md +2 -2
  107. data/docs/ReportScheduleEntityListing.md +2 -2
  108. data/docs/ResponseEntityList.md +2 -2
  109. data/docs/ResponseEntityListing.md +2 -2
  110. data/docs/ResponseSetEntityListing.md +2 -2
  111. data/docs/RoutingApi.md +1 -1
  112. data/docs/RuleSetEntityListing.md +2 -2
  113. data/docs/Schedule.md +27 -0
  114. data/docs/ScheduleEntityListing.md +22 -0
  115. data/docs/ScheduleGroup.md +27 -0
  116. data/docs/ScheduleGroupEntityListing.md +22 -0
  117. data/docs/SchemaCategoryEntityListing.md +2 -2
  118. data/docs/SchemaReferenceEntityListing.md +2 -2
  119. data/docs/ScreenRecordingSession.md +1 -1
  120. data/docs/ScreenRecordingSessionListing.md +2 -2
  121. data/docs/ScriptEntityListing.md +2 -2
  122. data/docs/SearchRequest.md +1 -0
  123. data/docs/SearchSort.md +14 -0
  124. data/docs/SecurityProfileEntityListing.md +2 -2
  125. data/docs/SetUuiDataRequest.md +13 -0
  126. data/docs/ShareEntityListing.md +2 -2
  127. data/docs/SiteEntityListing.md +2 -2
  128. data/docs/SkillEntityListing.md +2 -2
  129. data/docs/SocialExpression.md +1 -0
  130. data/docs/StationEntityListing.md +2 -2
  131. data/docs/SystemPromptAssetEntityListing.md +2 -2
  132. data/docs/SystemPromptEntityListing.md +2 -2
  133. data/docs/TagValueEntityListing.md +2 -2
  134. data/docs/TimeZoneEntityListing.md +2 -2
  135. data/docs/TrunkBaseEntityListing.md +2 -2
  136. data/docs/TrunkEntityListing.md +2 -2
  137. data/docs/TrunkMetabaseEntityListing.md +2 -2
  138. data/docs/TrustCreate.md +15 -0
  139. data/docs/TrustEntityListing.md +22 -0
  140. data/docs/TrustRequest.md +18 -0
  141. data/docs/TrustRequestCreate.md +13 -0
  142. data/docs/TrustUser.md +36 -0
  143. data/docs/TrustUserCreate.md +14 -0
  144. data/docs/TrustUserDetails.md +14 -0
  145. data/docs/TrustUserEntityListing.md +22 -0
  146. data/docs/Trustee.md +18 -0
  147. data/docs/TrusteeAuditQueryRequest.md +19 -0
  148. data/docs/TrustorAuditQueryRequest.md +19 -0
  149. data/docs/TrustorEntityListing.md +22 -0
  150. data/docs/UserEntityListing.md +2 -2
  151. data/docs/UserMe.md +1 -0
  152. data/docs/UserQueueEntityListing.md +2 -2
  153. data/docs/UserRecordingEntityListing.md +2 -2
  154. data/docs/UserSearchRequest.md +1 -0
  155. data/docs/UserSkillEntityListing.md +2 -2
  156. data/docs/UsersApi.md +1 -1
  157. data/docs/VoicemailMessageEntityListing.md +2 -2
  158. data/docs/VoicemailSearchRequest.md +1 -0
  159. data/docs/WorkspaceEntityListing.md +2 -2
  160. data/docs/WorkspaceMemberEntityListing.md +2 -2
  161. data/docs/WrapupCodeEntityListing.md +2 -2
  162. data/lib/purecloudplatformclientv2.rb +25 -1
  163. data/lib/purecloudplatformclientv2/api/architect_api.rb +1216 -148
  164. data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
  165. data/lib/purecloudplatformclientv2/api/conversations_api.rb +97 -2
  166. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +2 -2
  167. data/lib/purecloudplatformclientv2/api/organization_authorization_api.rb +1751 -0
  168. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  169. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +25 -25
  170. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +25 -25
  171. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +25 -25
  172. data/lib/purecloudplatformclientv2/models/audit_query_response.rb +176 -0
  173. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +25 -25
  174. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  175. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  176. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +25 -25
  177. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +25 -25
  178. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +25 -25
  179. data/lib/purecloudplatformclientv2/models/campaign.rb +15 -1
  180. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +25 -25
  181. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +25 -25
  182. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +25 -25
  183. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +25 -25
  184. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +25 -25
  185. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +25 -25
  186. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +25 -25
  187. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +25 -25
  188. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +25 -25
  189. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +25 -25
  190. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +25 -25
  191. data/lib/purecloudplatformclientv2/models/contact_listing.rb +25 -25
  192. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +27 -1
  193. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +25 -25
  194. data/lib/purecloudplatformclientv2/models/create_callback_on_conversation_command.rb +393 -0
  195. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +25 -25
  196. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +25 -25
  197. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +25 -25
  198. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +25 -25
  199. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +25 -25
  200. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +25 -25
  201. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +25 -25
  202. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +25 -25
  203. data/lib/purecloudplatformclientv2/models/documentation_search_request.rb +29 -1
  204. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +25 -25
  205. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +25 -25
  206. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +25 -25
  207. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +25 -25
  208. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +25 -25
  209. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +25 -25
  210. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +25 -25
  211. data/lib/purecloudplatformclientv2/models/email.rb +56 -4
  212. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +25 -25
  213. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +25 -25
  214. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +25 -25
  215. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +25 -25
  216. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +25 -25
  217. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +25 -25
  218. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +25 -25
  219. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +25 -25
  220. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +25 -25
  221. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +25 -25
  222. data/lib/purecloudplatformclientv2/models/facet.rb +238 -0
  223. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +25 -25
  224. data/lib/purecloudplatformclientv2/models/filter.rb +302 -0
  225. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +25 -25
  226. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +25 -25
  227. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +25 -25
  228. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +25 -25
  229. data/lib/purecloudplatformclientv2/models/group_search_request.rb +29 -1
  230. data/lib/purecloudplatformclientv2/models/history_listing.rb +197 -38
  231. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +25 -25
  232. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +25 -25
  233. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +25 -25
  234. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +25 -25
  235. data/lib/purecloudplatformclientv2/models/ivr.rb +607 -0
  236. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +428 -0
  237. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +25 -25
  238. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +25 -25
  239. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +25 -25
  240. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +25 -25
  241. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +25 -25
  242. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +25 -25
  243. data/lib/purecloudplatformclientv2/models/location_search_request.rb +29 -1
  244. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +25 -25
  245. data/lib/purecloudplatformclientv2/models/note_listing.rb +25 -25
  246. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +25 -25
  247. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +25 -25
  248. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +25 -25
  249. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +25 -25
  250. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +25 -25
  251. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +25 -25
  252. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +25 -25
  253. data/lib/purecloudplatformclientv2/models/participant.rb +44 -4
  254. data/lib/purecloudplatformclientv2/models/participant_basic.rb +44 -4
  255. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +25 -25
  256. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +25 -25
  257. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +25 -25
  258. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +25 -25
  259. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +25 -25
  260. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +25 -25
  261. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +25 -25
  262. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +25 -25
  263. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +25 -25
  264. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +25 -25
  265. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +25 -25
  266. data/lib/purecloudplatformclientv2/models/reaction.rb +2 -2
  267. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +25 -25
  268. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +25 -25
  269. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +25 -25
  270. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +25 -25
  271. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +25 -25
  272. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +25 -25
  273. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +25 -25
  274. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +25 -25
  275. data/lib/purecloudplatformclientv2/models/schedule.rb +578 -0
  276. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +428 -0
  277. data/lib/purecloudplatformclientv2/models/schedule_group.rb +577 -0
  278. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +428 -0
  279. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +25 -25
  280. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +25 -25
  281. data/lib/purecloudplatformclientv2/models/screen_recording_session.rb +8 -8
  282. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +25 -25
  283. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +25 -25
  284. data/lib/purecloudplatformclientv2/models/search_request.rb +29 -1
  285. data/lib/purecloudplatformclientv2/models/search_sort.rb +242 -0
  286. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +25 -25
  287. data/lib/purecloudplatformclientv2/models/set_uui_data_request.rb +202 -0
  288. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +25 -25
  289. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +25 -25
  290. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +25 -25
  291. data/lib/purecloudplatformclientv2/models/social_expression.rb +27 -1
  292. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +25 -25
  293. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +25 -25
  294. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +25 -25
  295. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +25 -25
  296. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +25 -25
  297. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +25 -25
  298. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +25 -25
  299. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +25 -25
  300. data/lib/purecloudplatformclientv2/models/trust_create.rb +271 -0
  301. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +428 -0
  302. data/lib/purecloudplatformclientv2/models/trust_request.rb +344 -0
  303. data/lib/purecloudplatformclientv2/models/trust_request_create.rb +209 -0
  304. data/lib/purecloudplatformclientv2/models/trust_user.rb +822 -0
  305. data/lib/purecloudplatformclientv2/models/trust_user_create.rb +240 -0
  306. data/lib/purecloudplatformclientv2/models/trust_user_details.rb +228 -0
  307. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +428 -0
  308. data/lib/purecloudplatformclientv2/models/{history_entry.rb → trustee.rb} +66 -46
  309. data/lib/purecloudplatformclientv2/models/trustee_audit_query_request.rb +376 -0
  310. data/lib/purecloudplatformclientv2/models/trustor_audit_query_request.rb +374 -0
  311. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +428 -0
  312. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +25 -25
  313. data/lib/purecloudplatformclientv2/models/user_me.rb +29 -1
  314. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +25 -25
  315. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +25 -25
  316. data/lib/purecloudplatformclientv2/models/user_search_request.rb +29 -1
  317. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +25 -25
  318. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +25 -25
  319. data/lib/purecloudplatformclientv2/models/voicemail_search_request.rb +29 -1
  320. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +25 -25
  321. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +25 -25
  322. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +25 -25
  323. data/lib/purecloudplatformclientv2/version.rb +1 -1
  324. metadata +52 -4
  325. data/docs/HistoryEntry.md +0 -17
data/docs/FaxDocumentEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: FaxDocumentEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/Filter.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: Filter
3
+ ---
4
+ ## PureCloud::Filter
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | The name of the field by which to filter. | |
11
+ | **type** | **String** | The type of the filter, DATE or STRING. | |
12
+ | **operator** | **String** | The operation that the filter performs. | |
13
+ | **values** | **Array<String>** | The values to make the filter comparison against. | |
14
+ {: class="table table-striped"}
15
+
16
+
data/docs/FlowEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: FlowEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/FlowVersionEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: FlowVersionEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/GreetingListing.md CHANGED
@@ -11,11 +11,11 @@ title: GreetingListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/GroupEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: GroupEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/GroupSearchRequest.md CHANGED
@@ -11,6 +11,7 @@ title: GroupSearchRequest
11
11
  | **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
12
12
  | **page_size** | **Integer** | The number of results per page | [optional] |
13
13
  | **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
14
+ | **sort** | [**Array<SearchSort>**](SearchSort.html) | Multi-value sort order, list of multiple sort values | [optional] |
14
15
  | **query** | [**Array<GroupSearchCriteria>**](GroupSearchCriteria.html) | | [optional] |
15
16
  {: class="table table-striped"}
16
17
 
data/docs/HistoryListing.md CHANGED
@@ -7,15 +7,20 @@ title: HistoryListing
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **entities** | [**Array<HistoryEntry>**](HistoryEntry.html) | | [optional] |
11
- | **page_size** | **Integer** | | [optional] |
12
- | **page_number** | **Integer** | | [optional] |
13
- | **total** | **Integer** | | [optional] |
14
10
  | **id** | **String** | | [optional] |
11
+ | **complete** | **BOOLEAN** | | [optional] |
12
+ | **user** | [**User**](User.html) | | [optional] |
13
+ | **error_message** | **String** | | [optional] |
14
+ | **error_code** | **String** | | [optional] |
15
+ | **error_details** | [**Array<Detail>**](Detail.html) | | [optional] |
16
+ | **error_message_params** | **Hash<String, String>** | | [optional] |
17
+ | **action_name** | **String** | Action name | [optional] |
18
+ | **action_status** | **String** | Action status | [optional] |
15
19
  | **name** | **String** | | [optional] |
16
20
  | **description** | **String** | | [optional] |
17
21
  | **system** | **BOOLEAN** | | [optional] |
18
- | **page_count** | **Integer** | | [optional] |
22
+ | **started** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
+ | **completed** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
19
24
  {: class="table table-striped"}
20
25
 
21
26
 
data/docs/IVR.md ADDED
@@ -0,0 +1,28 @@
1
+ ---
2
+ title: IVR
3
+ ---
4
+ ## PureCloud::IVR
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | The name of the entity. | |
12
+ | **description** | **String** | | [optional] |
13
+ | **version** | **Integer** | | [optional] |
14
+ | **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **modified_by** | **String** | | [optional] |
17
+ | **created_by** | **String** | | [optional] |
18
+ | **state** | **String** | | [optional] |
19
+ | **modified_by_app** | **String** | | [optional] |
20
+ | **created_by_app** | **String** | | [optional] |
21
+ | **dnis** | **Array<String>** | The phone number(s) to contact the IVR by. Each phone number must be unique and not in use by another resource. For example, a user and an iVR cannot have the same phone number. | [optional] |
22
+ | **open_hours_flow** | [**UriReference**](UriReference.html) | The Architect flow to execute during the hours an organization is open. | [optional] |
23
+ | **closed_hours_flow** | [**UriReference**](UriReference.html) | The Architect flow to execute during the hours an organization is closed. | [optional] |
24
+ | **schedule_group** | [**UriReference**](UriReference.html) | The schedule group defining the open and closed hours for an organization. If this is provided, an open flow and a closed flow must be specified as well. | [optional] |
25
+ | **self_uri** | **String** | The URI for this object | [optional] |
26
+ {: class="table table-striped"}
27
+
28
+
data/docs/IVREntityListing.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: IVREntityListing
3
+ ---
4
+ ## PureCloud::IVREntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<IVR>**](IVR.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
data/docs/InboundDomainEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: InboundDomainEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/InboundRouteEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: InboundRouteEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/InteractionStatsAlertContainer.md CHANGED
@@ -11,11 +11,11 @@ title: InteractionStatsAlertContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/InteractionStatsRuleContainer.md CHANGED
@@ -11,11 +11,11 @@ title: InteractionStatsRuleContainer
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/KeywordSetEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: KeywordSetEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/LanguageEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: LanguageEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/LibraryEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: LibraryEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/LineBaseEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: LineBaseEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/LineEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: LineEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/LocationEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: LocationEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/LocationSearchRequest.md CHANGED
@@ -11,6 +11,7 @@ title: LocationSearchRequest
11
11
  | **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
12
12
  | **page_size** | **Integer** | The number of results per page | [optional] |
13
13
  | **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
14
+ | **sort** | [**Array<SearchSort>**](SearchSort.html) | Multi-value sort order, list of multiple sort values | [optional] |
14
15
  | **query** | [**Array<LocationSearchCriteria>**](LocationSearchCriteria.html) | | [optional] |
15
16
  {: class="table table-striped"}
16
17
 
data/docs/LogicalInterfaceEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: LogicalInterfaceEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/NoteListing.md CHANGED
@@ -11,11 +11,11 @@ title: NoteListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/OAuthClientEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: OAuthClientEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/OAuthProviderEntityListing.md CHANGED
@@ -11,11 +11,11 @@ title: OAuthProviderEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
14
16
  | **previous_uri** | **String** | | [optional] |
15
17
  | **next_uri** | **String** | | [optional] |
16
18
  | **last_uri** | **String** | | [optional] |
17
- | **self_uri** | **String** | | [optional] |
18
- | **first_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
data/docs/OrganizationAuthorizationApi.md ADDED
@@ -0,0 +1,1458 @@
1
+ ---
2
+ title: OrganizationAuthorizationApi
3
+ ---
4
+
5
+ ## PureCloud::OrganizationAuthorizationApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**delete_orgauthorization_trustee**](OrganizationAuthorizationApi.html#delete_orgauthorization_trustee) | Delete Org Trust
12
+ [**delete_orgauthorization_trustee_user**](OrganizationAuthorizationApi.html#delete_orgauthorization_trustee_user) | Delete Trustee User
13
+ [**delete_orgauthorization_trustee_user_roles**](OrganizationAuthorizationApi.html#delete_orgauthorization_trustee_user_roles) | Delete Trustee User Roles
14
+ [**delete_orgauthorization_trustor**](OrganizationAuthorizationApi.html#delete_orgauthorization_trustor) | Delete Org Trust
15
+ [**delete_orgauthorization_trustor_user**](OrganizationAuthorizationApi.html#delete_orgauthorization_trustor_user) | Delete Trustee User
16
+ [**get_orgauthorization_pairing**](OrganizationAuthorizationApi.html#get_orgauthorization_pairing) | Get Pairing Info
17
+ [**get_orgauthorization_trustee**](OrganizationAuthorizationApi.html#get_orgauthorization_trustee) | Get Org Trust
18
+ [**get_orgauthorization_trustee_user**](OrganizationAuthorizationApi.html#get_orgauthorization_trustee_user) | Get Trustee User
19
+ [**get_orgauthorization_trustee_user_roles**](OrganizationAuthorizationApi.html#get_orgauthorization_trustee_user_roles) | Get Trustee User Roles
20
+ [**get_orgauthorization_trustee_users**](OrganizationAuthorizationApi.html#get_orgauthorization_trustee_users) | The list of trustee users for this organization (i.e. users granted access to this organization).
21
+ [**get_orgauthorization_trustees**](OrganizationAuthorizationApi.html#get_orgauthorization_trustees) | The list of trustees for this organization (i.e. organizations granted access to this organization).
22
+ [**get_orgauthorization_trustor**](OrganizationAuthorizationApi.html#get_orgauthorization_trustor) | Get Org Trust
23
+ [**get_orgauthorization_trustor_user**](OrganizationAuthorizationApi.html#get_orgauthorization_trustor_user) | Get Trustee User
24
+ [**get_orgauthorization_trustor_users**](OrganizationAuthorizationApi.html#get_orgauthorization_trustor_users) | The list of users in the trustor organization (i.e. users granted access).
25
+ [**get_orgauthorization_trustors**](OrganizationAuthorizationApi.html#get_orgauthorization_trustors) | The list of organizations that have authorized/trusted your organization.
26
+ [**post_orgauthorization_pairings**](OrganizationAuthorizationApi.html#post_orgauthorization_pairings) | A pairing id is created by the trustee and given to the trustor to create a trust.
27
+ [**post_orgauthorization_trustee_users**](OrganizationAuthorizationApi.html#post_orgauthorization_trustee_users) | Add a user to the trust.
28
+ [**post_orgauthorization_trustees**](OrganizationAuthorizationApi.html#post_orgauthorization_trustees) | Create a new organization authorization trust. This is required to grant other organizations access to your organization.
29
+ [**post_orgauthorization_trustees_audits**](OrganizationAuthorizationApi.html#post_orgauthorization_trustees_audits) | Get Org Trustee Audits
30
+ [**post_orgauthorization_trustor_audits**](OrganizationAuthorizationApi.html#post_orgauthorization_trustor_audits) | Get Org Trustor Audits
31
+ [**put_orgauthorization_trustee**](OrganizationAuthorizationApi.html#put_orgauthorization_trustee) | Update Org Trust
32
+ [**put_orgauthorization_trustee_user_roles**](OrganizationAuthorizationApi.html#put_orgauthorization_trustee_user_roles) | Update Trustee User Roles
33
+ [**put_orgauthorization_trustor_user**](OrganizationAuthorizationApi.html#put_orgauthorization_trustor_user) | Add a Trustee user to the trust.
34
+ {: class="table table-striped"}
35
+
36
+ <a name="delete_orgauthorization_trustee"></a>
37
+
38
+ ## - delete_orgauthorization_trustee(trustee_org_id)
39
+
40
+ Delete Org Trust
41
+
42
+
43
+
44
+ Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}
45
+
46
+
47
+ ### Example
48
+ ~~~ruby
49
+ # load the gem
50
+ require 'purecloudplatformclientv2'
51
+ # setup authorization
52
+ @secret = ENV['PURECLOUD_SECRET']
53
+ @id = ENV['PURECLOUD_CLIENT_ID']
54
+ environment = "mypurecloud.com"
55
+
56
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
57
+
58
+ PureCloud.configure do |config|
59
+ config.access_token = @authToken
60
+ end
61
+
62
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
63
+
64
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
65
+
66
+
67
+ begin
68
+ #Delete Org Trust
69
+ api_instance.delete_orgauthorization_trustee(trustee_org_id)
70
+ rescue PureCloud::ApiError => e
71
+ puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee: #{e}"
72
+ end
73
+ ~~~
74
+
75
+ ### Parameters
76
+
77
+ Name | Type | Description | Notes
78
+ ------------- | ------------- | ------------- | -------------
79
+ **trustee_org_id** | **String**| Trustee Organization Id | |
80
+ {: class="table table-striped"}
81
+
82
+
83
+ ### Return type
84
+
85
+ nil (empty response body)
86
+
87
+ ### HTTP request headers
88
+
89
+ - **Content-Type**: application/json
90
+ - **Accept**: application/json
91
+
92
+
93
+
94
+ <a name="delete_orgauthorization_trustee_user"></a>
95
+
96
+ ## - delete_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
97
+
98
+ Delete Trustee User
99
+
100
+
101
+
102
+ Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}
103
+
104
+
105
+ ### Example
106
+ ~~~ruby
107
+ # load the gem
108
+ require 'purecloudplatformclientv2'
109
+ # setup authorization
110
+ @secret = ENV['PURECLOUD_SECRET']
111
+ @id = ENV['PURECLOUD_CLIENT_ID']
112
+ environment = "mypurecloud.com"
113
+
114
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
115
+
116
+ PureCloud.configure do |config|
117
+ config.access_token = @authToken
118
+ end
119
+
120
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
121
+
122
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
123
+
124
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
125
+
126
+
127
+ begin
128
+ #Delete Trustee User
129
+ api_instance.delete_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
130
+ rescue PureCloud::ApiError => e
131
+ puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_user: #{e}"
132
+ end
133
+ ~~~
134
+
135
+ ### Parameters
136
+
137
+ Name | Type | Description | Notes
138
+ ------------- | ------------- | ------------- | -------------
139
+ **trustee_org_id** | **String**| Trustee Organization Id | |
140
+ **trustee_user_id** | **String**| Trustee User Id | |
141
+ {: class="table table-striped"}
142
+
143
+
144
+ ### Return type
145
+
146
+ nil (empty response body)
147
+
148
+ ### HTTP request headers
149
+
150
+ - **Content-Type**: application/json
151
+ - **Accept**: application/json
152
+
153
+
154
+
155
+ <a name="delete_orgauthorization_trustee_user_roles"></a>
156
+
157
+ ## - delete_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
158
+
159
+ Delete Trustee User Roles
160
+
161
+
162
+
163
+ Wraps DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles
164
+
165
+
166
+ ### Example
167
+ ~~~ruby
168
+ # load the gem
169
+ require 'purecloudplatformclientv2'
170
+ # setup authorization
171
+ @secret = ENV['PURECLOUD_SECRET']
172
+ @id = ENV['PURECLOUD_CLIENT_ID']
173
+ environment = "mypurecloud.com"
174
+
175
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
176
+
177
+ PureCloud.configure do |config|
178
+ config.access_token = @authToken
179
+ end
180
+
181
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
182
+
183
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
184
+
185
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
186
+
187
+
188
+ begin
189
+ #Delete Trustee User Roles
190
+ api_instance.delete_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
191
+ rescue PureCloud::ApiError => e
192
+ puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_user_roles: #{e}"
193
+ end
194
+ ~~~
195
+
196
+ ### Parameters
197
+
198
+ Name | Type | Description | Notes
199
+ ------------- | ------------- | ------------- | -------------
200
+ **trustee_org_id** | **String**| Trustee Organization Id | |
201
+ **trustee_user_id** | **String**| Trustee User Id | |
202
+ {: class="table table-striped"}
203
+
204
+
205
+ ### Return type
206
+
207
+ nil (empty response body)
208
+
209
+ ### HTTP request headers
210
+
211
+ - **Content-Type**: application/json
212
+ - **Accept**: application/json
213
+
214
+
215
+
216
+ <a name="delete_orgauthorization_trustor"></a>
217
+
218
+ ## - delete_orgauthorization_trustor(trustor_org_id)
219
+
220
+ Delete Org Trust
221
+
222
+
223
+
224
+ Wraps DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}
225
+
226
+
227
+ ### Example
228
+ ~~~ruby
229
+ # load the gem
230
+ require 'purecloudplatformclientv2'
231
+ # setup authorization
232
+ @secret = ENV['PURECLOUD_SECRET']
233
+ @id = ENV['PURECLOUD_CLIENT_ID']
234
+ environment = "mypurecloud.com"
235
+
236
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
237
+
238
+ PureCloud.configure do |config|
239
+ config.access_token = @authToken
240
+ end
241
+
242
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
243
+
244
+ trustor_org_id = "trustor_org_id_example" # String | Trustor Organization Id
245
+
246
+
247
+ begin
248
+ #Delete Org Trust
249
+ api_instance.delete_orgauthorization_trustor(trustor_org_id)
250
+ rescue PureCloud::ApiError => e
251
+ puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor: #{e}"
252
+ end
253
+ ~~~
254
+
255
+ ### Parameters
256
+
257
+ Name | Type | Description | Notes
258
+ ------------- | ------------- | ------------- | -------------
259
+ **trustor_org_id** | **String**| Trustor Organization Id | |
260
+ {: class="table table-striped"}
261
+
262
+
263
+ ### Return type
264
+
265
+ nil (empty response body)
266
+
267
+ ### HTTP request headers
268
+
269
+ - **Content-Type**: application/json
270
+ - **Accept**: application/json
271
+
272
+
273
+
274
+ <a name="delete_orgauthorization_trustor_user"></a>
275
+
276
+ ## - delete_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
277
+
278
+ Delete Trustee User
279
+
280
+
281
+
282
+ Wraps DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}
283
+
284
+
285
+ ### Example
286
+ ~~~ruby
287
+ # load the gem
288
+ require 'purecloudplatformclientv2'
289
+ # setup authorization
290
+ @secret = ENV['PURECLOUD_SECRET']
291
+ @id = ENV['PURECLOUD_CLIENT_ID']
292
+ environment = "mypurecloud.com"
293
+
294
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
295
+
296
+ PureCloud.configure do |config|
297
+ config.access_token = @authToken
298
+ end
299
+
300
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
301
+
302
+ trustor_org_id = "trustor_org_id_example" # String | Trustor Organization Id
303
+
304
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
305
+
306
+
307
+ begin
308
+ #Delete Trustee User
309
+ api_instance.delete_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
310
+ rescue PureCloud::ApiError => e
311
+ puts "Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor_user: #{e}"
312
+ end
313
+ ~~~
314
+
315
+ ### Parameters
316
+
317
+ Name | Type | Description | Notes
318
+ ------------- | ------------- | ------------- | -------------
319
+ **trustor_org_id** | **String**| Trustor Organization Id | |
320
+ **trustee_user_id** | **String**| Trustee User Id | |
321
+ {: class="table table-striped"}
322
+
323
+
324
+ ### Return type
325
+
326
+ nil (empty response body)
327
+
328
+ ### HTTP request headers
329
+
330
+ - **Content-Type**: application/json
331
+ - **Accept**: application/json
332
+
333
+
334
+
335
+ <a name="get_orgauthorization_pairing"></a>
336
+
337
+ ## -[**TrustRequest**](TrustRequest.html) get_orgauthorization_pairing(pairing_id)
338
+
339
+ Get Pairing Info
340
+
341
+
342
+
343
+ Wraps GET /api/v2/orgauthorization/pairings/{pairingId}
344
+
345
+
346
+ ### Example
347
+ ~~~ruby
348
+ # load the gem
349
+ require 'purecloudplatformclientv2'
350
+ # setup authorization
351
+ @secret = ENV['PURECLOUD_SECRET']
352
+ @id = ENV['PURECLOUD_CLIENT_ID']
353
+ environment = "mypurecloud.com"
354
+
355
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
356
+
357
+ PureCloud.configure do |config|
358
+ config.access_token = @authToken
359
+ end
360
+
361
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
362
+
363
+ pairing_id = "pairing_id_example" # String | Pairing Id
364
+
365
+
366
+ begin
367
+ #Get Pairing Info
368
+ result = api_instance.get_orgauthorization_pairing(pairing_id)
369
+ p result
370
+ rescue PureCloud::ApiError => e
371
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_pairing: #{e}"
372
+ end
373
+ ~~~
374
+
375
+ ### Parameters
376
+
377
+ Name | Type | Description | Notes
378
+ ------------- | ------------- | ------------- | -------------
379
+ **pairing_id** | **String**| Pairing Id | |
380
+ {: class="table table-striped"}
381
+
382
+
383
+ ### Return type
384
+
385
+ [**TrustRequest**](TrustRequest.html)
386
+
387
+ ### HTTP request headers
388
+
389
+ - **Content-Type**: application/json
390
+ - **Accept**: application/json
391
+
392
+
393
+
394
+ <a name="get_orgauthorization_trustee"></a>
395
+
396
+ ## -[**Trustee**](Trustee.html) get_orgauthorization_trustee(trustee_org_id)
397
+
398
+ Get Org Trust
399
+
400
+
401
+
402
+ Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}
403
+
404
+
405
+ ### Example
406
+ ~~~ruby
407
+ # load the gem
408
+ require 'purecloudplatformclientv2'
409
+ # setup authorization
410
+ @secret = ENV['PURECLOUD_SECRET']
411
+ @id = ENV['PURECLOUD_CLIENT_ID']
412
+ environment = "mypurecloud.com"
413
+
414
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
415
+
416
+ PureCloud.configure do |config|
417
+ config.access_token = @authToken
418
+ end
419
+
420
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
421
+
422
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
423
+
424
+
425
+ begin
426
+ #Get Org Trust
427
+ result = api_instance.get_orgauthorization_trustee(trustee_org_id)
428
+ p result
429
+ rescue PureCloud::ApiError => e
430
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee: #{e}"
431
+ end
432
+ ~~~
433
+
434
+ ### Parameters
435
+
436
+ Name | Type | Description | Notes
437
+ ------------- | ------------- | ------------- | -------------
438
+ **trustee_org_id** | **String**| Trustee Organization Id | |
439
+ {: class="table table-striped"}
440
+
441
+
442
+ ### Return type
443
+
444
+ [**Trustee**](Trustee.html)
445
+
446
+ ### HTTP request headers
447
+
448
+ - **Content-Type**: application/json
449
+ - **Accept**: application/json
450
+
451
+
452
+
453
+ <a name="get_orgauthorization_trustee_user"></a>
454
+
455
+ ## -[**TrustUser**](TrustUser.html) get_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
456
+
457
+ Get Trustee User
458
+
459
+
460
+
461
+ Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}
462
+
463
+
464
+ ### Example
465
+ ~~~ruby
466
+ # load the gem
467
+ require 'purecloudplatformclientv2'
468
+ # setup authorization
469
+ @secret = ENV['PURECLOUD_SECRET']
470
+ @id = ENV['PURECLOUD_CLIENT_ID']
471
+ environment = "mypurecloud.com"
472
+
473
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
474
+
475
+ PureCloud.configure do |config|
476
+ config.access_token = @authToken
477
+ end
478
+
479
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
480
+
481
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
482
+
483
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
484
+
485
+
486
+ begin
487
+ #Get Trustee User
488
+ result = api_instance.get_orgauthorization_trustee_user(trustee_org_id, trustee_user_id)
489
+ p result
490
+ rescue PureCloud::ApiError => e
491
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_user: #{e}"
492
+ end
493
+ ~~~
494
+
495
+ ### Parameters
496
+
497
+ Name | Type | Description | Notes
498
+ ------------- | ------------- | ------------- | -------------
499
+ **trustee_org_id** | **String**| Trustee Organization Id | |
500
+ **trustee_user_id** | **String**| Trustee User Id | |
501
+ {: class="table table-striped"}
502
+
503
+
504
+ ### Return type
505
+
506
+ [**TrustUser**](TrustUser.html)
507
+
508
+ ### HTTP request headers
509
+
510
+ - **Content-Type**: application/json
511
+ - **Accept**: application/json
512
+
513
+
514
+
515
+ <a name="get_orgauthorization_trustee_user_roles"></a>
516
+
517
+ ## -[**UserAuthorization**](UserAuthorization.html) get_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
518
+
519
+ Get Trustee User Roles
520
+
521
+
522
+
523
+ Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles
524
+
525
+
526
+ ### Example
527
+ ~~~ruby
528
+ # load the gem
529
+ require 'purecloudplatformclientv2'
530
+ # setup authorization
531
+ @secret = ENV['PURECLOUD_SECRET']
532
+ @id = ENV['PURECLOUD_CLIENT_ID']
533
+ environment = "mypurecloud.com"
534
+
535
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
536
+
537
+ PureCloud.configure do |config|
538
+ config.access_token = @authToken
539
+ end
540
+
541
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
542
+
543
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
544
+
545
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
546
+
547
+
548
+ begin
549
+ #Get Trustee User Roles
550
+ result = api_instance.get_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id)
551
+ p result
552
+ rescue PureCloud::ApiError => e
553
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_user_roles: #{e}"
554
+ end
555
+ ~~~
556
+
557
+ ### Parameters
558
+
559
+ Name | Type | Description | Notes
560
+ ------------- | ------------- | ------------- | -------------
561
+ **trustee_org_id** | **String**| Trustee Organization Id | |
562
+ **trustee_user_id** | **String**| Trustee User Id | |
563
+ {: class="table table-striped"}
564
+
565
+
566
+ ### Return type
567
+
568
+ [**UserAuthorization**](UserAuthorization.html)
569
+
570
+ ### HTTP request headers
571
+
572
+ - **Content-Type**: application/json
573
+ - **Accept**: application/json
574
+
575
+
576
+
577
+ <a name="get_orgauthorization_trustee_users"></a>
578
+
579
+ ## -[**TrustUserEntityListing**](TrustUserEntityListing.html) get_orgauthorization_trustee_users(trustee_org_id, opts)
580
+
581
+ The list of trustee users for this organization (i.e. users granted access to this organization).
582
+
583
+
584
+
585
+ Wraps GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users
586
+
587
+
588
+ ### Example
589
+ ~~~ruby
590
+ # load the gem
591
+ require 'purecloudplatformclientv2'
592
+ # setup authorization
593
+ @secret = ENV['PURECLOUD_SECRET']
594
+ @id = ENV['PURECLOUD_CLIENT_ID']
595
+ environment = "mypurecloud.com"
596
+
597
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
598
+
599
+ PureCloud.configure do |config|
600
+ config.access_token = @authToken
601
+ end
602
+
603
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
604
+
605
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
606
+
607
+ opts = {
608
+ page_size: 25, # Integer | Page size
609
+ page_number: 1 # Integer | Page number
610
+ }
611
+
612
+ begin
613
+ #The list of trustee users for this organization (i.e. users granted access to this organization).
614
+ result = api_instance.get_orgauthorization_trustee_users(trustee_org_id, opts)
615
+ p result
616
+ rescue PureCloud::ApiError => e
617
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_users: #{e}"
618
+ end
619
+ ~~~
620
+
621
+ ### Parameters
622
+
623
+ Name | Type | Description | Notes
624
+ ------------- | ------------- | ------------- | -------------
625
+ **trustee_org_id** | **String**| Trustee Organization Id | |
626
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
627
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
628
+ {: class="table table-striped"}
629
+
630
+
631
+ ### Return type
632
+
633
+ [**TrustUserEntityListing**](TrustUserEntityListing.html)
634
+
635
+ ### HTTP request headers
636
+
637
+ - **Content-Type**: application/json
638
+ - **Accept**: application/json
639
+
640
+
641
+
642
+ <a name="get_orgauthorization_trustees"></a>
643
+
644
+ ## -[**TrustEntityListing**](TrustEntityListing.html) get_orgauthorization_trustees(opts)
645
+
646
+ The list of trustees for this organization (i.e. organizations granted access to this organization).
647
+
648
+
649
+
650
+ Wraps GET /api/v2/orgauthorization/trustees
651
+
652
+
653
+ ### Example
654
+ ~~~ruby
655
+ # load the gem
656
+ require 'purecloudplatformclientv2'
657
+ # setup authorization
658
+ @secret = ENV['PURECLOUD_SECRET']
659
+ @id = ENV['PURECLOUD_CLIENT_ID']
660
+ environment = "mypurecloud.com"
661
+
662
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
663
+
664
+ PureCloud.configure do |config|
665
+ config.access_token = @authToken
666
+ end
667
+
668
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
669
+
670
+ opts = {
671
+ page_size: 25, # Integer | Page size
672
+ page_number: 1 # Integer | Page number
673
+ }
674
+
675
+ begin
676
+ #The list of trustees for this organization (i.e. organizations granted access to this organization).
677
+ result = api_instance.get_orgauthorization_trustees(opts)
678
+ p result
679
+ rescue PureCloud::ApiError => e
680
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustees: #{e}"
681
+ end
682
+ ~~~
683
+
684
+ ### Parameters
685
+
686
+ Name | Type | Description | Notes
687
+ ------------- | ------------- | ------------- | -------------
688
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
689
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
690
+ {: class="table table-striped"}
691
+
692
+
693
+ ### Return type
694
+
695
+ [**TrustEntityListing**](TrustEntityListing.html)
696
+
697
+ ### HTTP request headers
698
+
699
+ - **Content-Type**: application/json
700
+ - **Accept**: application/json
701
+
702
+
703
+
704
+ <a name="get_orgauthorization_trustor"></a>
705
+
706
+ ## -[**Trustor**](Trustor.html) get_orgauthorization_trustor(trustor_org_id)
707
+
708
+ Get Org Trust
709
+
710
+
711
+
712
+ Wraps GET /api/v2/orgauthorization/trustors/{trustorOrgId}
713
+
714
+
715
+ ### Example
716
+ ~~~ruby
717
+ # load the gem
718
+ require 'purecloudplatformclientv2'
719
+ # setup authorization
720
+ @secret = ENV['PURECLOUD_SECRET']
721
+ @id = ENV['PURECLOUD_CLIENT_ID']
722
+ environment = "mypurecloud.com"
723
+
724
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
725
+
726
+ PureCloud.configure do |config|
727
+ config.access_token = @authToken
728
+ end
729
+
730
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
731
+
732
+ trustor_org_id = "trustor_org_id_example" # String | Trustor Organization Id
733
+
734
+
735
+ begin
736
+ #Get Org Trust
737
+ result = api_instance.get_orgauthorization_trustor(trustor_org_id)
738
+ p result
739
+ rescue PureCloud::ApiError => e
740
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor: #{e}"
741
+ end
742
+ ~~~
743
+
744
+ ### Parameters
745
+
746
+ Name | Type | Description | Notes
747
+ ------------- | ------------- | ------------- | -------------
748
+ **trustor_org_id** | **String**| Trustor Organization Id | |
749
+ {: class="table table-striped"}
750
+
751
+
752
+ ### Return type
753
+
754
+ [**Trustor**](Trustor.html)
755
+
756
+ ### HTTP request headers
757
+
758
+ - **Content-Type**: application/json
759
+ - **Accept**: application/json
760
+
761
+
762
+
763
+ <a name="get_orgauthorization_trustor_user"></a>
764
+
765
+ ## -[**TrustUser**](TrustUser.html) get_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
766
+
767
+ Get Trustee User
768
+
769
+
770
+
771
+ Wraps GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}
772
+
773
+
774
+ ### Example
775
+ ~~~ruby
776
+ # load the gem
777
+ require 'purecloudplatformclientv2'
778
+ # setup authorization
779
+ @secret = ENV['PURECLOUD_SECRET']
780
+ @id = ENV['PURECLOUD_CLIENT_ID']
781
+ environment = "mypurecloud.com"
782
+
783
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
784
+
785
+ PureCloud.configure do |config|
786
+ config.access_token = @authToken
787
+ end
788
+
789
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
790
+
791
+ trustor_org_id = "trustor_org_id_example" # String | Trustor Organization Id
792
+
793
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
794
+
795
+
796
+ begin
797
+ #Get Trustee User
798
+ result = api_instance.get_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
799
+ p result
800
+ rescue PureCloud::ApiError => e
801
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_user: #{e}"
802
+ end
803
+ ~~~
804
+
805
+ ### Parameters
806
+
807
+ Name | Type | Description | Notes
808
+ ------------- | ------------- | ------------- | -------------
809
+ **trustor_org_id** | **String**| Trustor Organization Id | |
810
+ **trustee_user_id** | **String**| Trustee User Id | |
811
+ {: class="table table-striped"}
812
+
813
+
814
+ ### Return type
815
+
816
+ [**TrustUser**](TrustUser.html)
817
+
818
+ ### HTTP request headers
819
+
820
+ - **Content-Type**: application/json
821
+ - **Accept**: application/json
822
+
823
+
824
+
825
+ <a name="get_orgauthorization_trustor_users"></a>
826
+
827
+ ## -[**TrustUserEntityListing**](TrustUserEntityListing.html) get_orgauthorization_trustor_users(trustor_org_id, opts)
828
+
829
+ The list of users in the trustor organization (i.e. users granted access).
830
+
831
+
832
+
833
+ Wraps GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users
834
+
835
+
836
+ ### Example
837
+ ~~~ruby
838
+ # load the gem
839
+ require 'purecloudplatformclientv2'
840
+ # setup authorization
841
+ @secret = ENV['PURECLOUD_SECRET']
842
+ @id = ENV['PURECLOUD_CLIENT_ID']
843
+ environment = "mypurecloud.com"
844
+
845
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
846
+
847
+ PureCloud.configure do |config|
848
+ config.access_token = @authToken
849
+ end
850
+
851
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
852
+
853
+ trustor_org_id = "trustor_org_id_example" # String | Trustee Organization Id
854
+
855
+ opts = {
856
+ page_size: 25, # Integer | Page size
857
+ page_number: 1 # Integer | Page number
858
+ }
859
+
860
+ begin
861
+ #The list of users in the trustor organization (i.e. users granted access).
862
+ result = api_instance.get_orgauthorization_trustor_users(trustor_org_id, opts)
863
+ p result
864
+ rescue PureCloud::ApiError => e
865
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_users: #{e}"
866
+ end
867
+ ~~~
868
+
869
+ ### Parameters
870
+
871
+ Name | Type | Description | Notes
872
+ ------------- | ------------- | ------------- | -------------
873
+ **trustor_org_id** | **String**| Trustee Organization Id | |
874
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
875
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
876
+ {: class="table table-striped"}
877
+
878
+
879
+ ### Return type
880
+
881
+ [**TrustUserEntityListing**](TrustUserEntityListing.html)
882
+
883
+ ### HTTP request headers
884
+
885
+ - **Content-Type**: application/json
886
+ - **Accept**: application/json
887
+
888
+
889
+
890
+ <a name="get_orgauthorization_trustors"></a>
891
+
892
+ ## -[**TrustorEntityListing**](TrustorEntityListing.html) get_orgauthorization_trustors(opts)
893
+
894
+ The list of organizations that have authorized/trusted your organization.
895
+
896
+
897
+
898
+ Wraps GET /api/v2/orgauthorization/trustors
899
+
900
+
901
+ ### Example
902
+ ~~~ruby
903
+ # load the gem
904
+ require 'purecloudplatformclientv2'
905
+ # setup authorization
906
+ @secret = ENV['PURECLOUD_SECRET']
907
+ @id = ENV['PURECLOUD_CLIENT_ID']
908
+ environment = "mypurecloud.com"
909
+
910
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
911
+
912
+ PureCloud.configure do |config|
913
+ config.access_token = @authToken
914
+ end
915
+
916
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
917
+
918
+ opts = {
919
+ page_size: 25, # Integer | Page size
920
+ page_number: 1 # Integer | Page number
921
+ }
922
+
923
+ begin
924
+ #The list of organizations that have authorized/trusted your organization.
925
+ result = api_instance.get_orgauthorization_trustors(opts)
926
+ p result
927
+ rescue PureCloud::ApiError => e
928
+ puts "Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustors: #{e}"
929
+ end
930
+ ~~~
931
+
932
+ ### Parameters
933
+
934
+ Name | Type | Description | Notes
935
+ ------------- | ------------- | ------------- | -------------
936
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
937
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
938
+ {: class="table table-striped"}
939
+
940
+
941
+ ### Return type
942
+
943
+ [**TrustorEntityListing**](TrustorEntityListing.html)
944
+
945
+ ### HTTP request headers
946
+
947
+ - **Content-Type**: application/json
948
+ - **Accept**: application/json
949
+
950
+
951
+
952
+ <a name="post_orgauthorization_pairings"></a>
953
+
954
+ ## -[**TrustRequest**](TrustRequest.html) post_orgauthorization_pairings(body)
955
+
956
+ A pairing id is created by the trustee and given to the trustor to create a trust.
957
+
958
+
959
+
960
+ Wraps POST /api/v2/orgauthorization/pairings
961
+
962
+
963
+ ### Example
964
+ ~~~ruby
965
+ # load the gem
966
+ require 'purecloudplatformclientv2'
967
+ # setup authorization
968
+ @secret = ENV['PURECLOUD_SECRET']
969
+ @id = ENV['PURECLOUD_CLIENT_ID']
970
+ environment = "mypurecloud.com"
971
+
972
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
973
+
974
+ PureCloud.configure do |config|
975
+ config.access_token = @authToken
976
+ end
977
+
978
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
979
+
980
+ body = PureCloud::TrustRequestCreate.new # TrustRequestCreate | Pairing Info
981
+
982
+
983
+ begin
984
+ #A pairing id is created by the trustee and given to the trustor to create a trust.
985
+ result = api_instance.post_orgauthorization_pairings(body)
986
+ p result
987
+ rescue PureCloud::ApiError => e
988
+ puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_pairings: #{e}"
989
+ end
990
+ ~~~
991
+
992
+ ### Parameters
993
+
994
+ Name | Type | Description | Notes
995
+ ------------- | ------------- | ------------- | -------------
996
+ **body** | [**TrustRequestCreate**](TrustRequestCreate.html)| Pairing Info | |
997
+ {: class="table table-striped"}
998
+
999
+
1000
+ ### Return type
1001
+
1002
+ [**TrustRequest**](TrustRequest.html)
1003
+
1004
+ ### HTTP request headers
1005
+
1006
+ - **Content-Type**: application/json
1007
+ - **Accept**: application/json
1008
+
1009
+
1010
+
1011
+ <a name="post_orgauthorization_trustee_users"></a>
1012
+
1013
+ ## -[**TrustUser**](TrustUser.html) post_orgauthorization_trustee_users(trustee_org_id, body)
1014
+
1015
+ Add a user to the trust.
1016
+
1017
+
1018
+
1019
+ Wraps POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users
1020
+
1021
+
1022
+ ### Example
1023
+ ~~~ruby
1024
+ # load the gem
1025
+ require 'purecloudplatformclientv2'
1026
+ # setup authorization
1027
+ @secret = ENV['PURECLOUD_SECRET']
1028
+ @id = ENV['PURECLOUD_CLIENT_ID']
1029
+ environment = "mypurecloud.com"
1030
+
1031
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1032
+
1033
+ PureCloud.configure do |config|
1034
+ config.access_token = @authToken
1035
+ end
1036
+
1037
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
1038
+
1039
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
1040
+
1041
+ body = PureCloud::TrustUserCreate.new # TrustUserCreate | Trust
1042
+
1043
+
1044
+ begin
1045
+ #Add a user to the trust.
1046
+ result = api_instance.post_orgauthorization_trustee_users(trustee_org_id, body)
1047
+ p result
1048
+ rescue PureCloud::ApiError => e
1049
+ puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustee_users: #{e}"
1050
+ end
1051
+ ~~~
1052
+
1053
+ ### Parameters
1054
+
1055
+ Name | Type | Description | Notes
1056
+ ------------- | ------------- | ------------- | -------------
1057
+ **trustee_org_id** | **String**| Trustee Organization Id | |
1058
+ **body** | [**TrustUserCreate**](TrustUserCreate.html)| Trust | |
1059
+ {: class="table table-striped"}
1060
+
1061
+
1062
+ ### Return type
1063
+
1064
+ [**TrustUser**](TrustUser.html)
1065
+
1066
+ ### HTTP request headers
1067
+
1068
+ - **Content-Type**: application/json
1069
+ - **Accept**: application/json
1070
+
1071
+
1072
+
1073
+ <a name="post_orgauthorization_trustees"></a>
1074
+
1075
+ ## -[**Trustee**](Trustee.html) post_orgauthorization_trustees(body)
1076
+
1077
+ Create a new organization authorization trust. This is required to grant other organizations access to your organization.
1078
+
1079
+
1080
+
1081
+ Wraps POST /api/v2/orgauthorization/trustees
1082
+
1083
+
1084
+ ### Example
1085
+ ~~~ruby
1086
+ # load the gem
1087
+ require 'purecloudplatformclientv2'
1088
+ # setup authorization
1089
+ @secret = ENV['PURECLOUD_SECRET']
1090
+ @id = ENV['PURECLOUD_CLIENT_ID']
1091
+ environment = "mypurecloud.com"
1092
+
1093
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1094
+
1095
+ PureCloud.configure do |config|
1096
+ config.access_token = @authToken
1097
+ end
1098
+
1099
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
1100
+
1101
+ body = PureCloud::TrustCreate.new # TrustCreate | Trust
1102
+
1103
+
1104
+ begin
1105
+ #Create a new organization authorization trust. This is required to grant other organizations access to your organization.
1106
+ result = api_instance.post_orgauthorization_trustees(body)
1107
+ p result
1108
+ rescue PureCloud::ApiError => e
1109
+ puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustees: #{e}"
1110
+ end
1111
+ ~~~
1112
+
1113
+ ### Parameters
1114
+
1115
+ Name | Type | Description | Notes
1116
+ ------------- | ------------- | ------------- | -------------
1117
+ **body** | [**TrustCreate**](TrustCreate.html)| Trust | |
1118
+ {: class="table table-striped"}
1119
+
1120
+
1121
+ ### Return type
1122
+
1123
+ [**Trustee**](Trustee.html)
1124
+
1125
+ ### HTTP request headers
1126
+
1127
+ - **Content-Type**: application/json
1128
+ - **Accept**: application/json
1129
+
1130
+
1131
+
1132
+ <a name="post_orgauthorization_trustees_audits"></a>
1133
+
1134
+ ## -[**AuditQueryResponse**](AuditQueryResponse.html) post_orgauthorization_trustees_audits(body, opts)
1135
+
1136
+ Get Org Trustee Audits
1137
+
1138
+
1139
+
1140
+ Wraps POST /api/v2/orgauthorization/trustees/audits
1141
+
1142
+
1143
+ ### Example
1144
+ ~~~ruby
1145
+ # load the gem
1146
+ require 'purecloudplatformclientv2'
1147
+ # setup authorization
1148
+ @secret = ENV['PURECLOUD_SECRET']
1149
+ @id = ENV['PURECLOUD_CLIENT_ID']
1150
+ environment = "mypurecloud.com"
1151
+
1152
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1153
+
1154
+ PureCloud.configure do |config|
1155
+ config.access_token = @authToken
1156
+ end
1157
+
1158
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
1159
+
1160
+ body = PureCloud::TrusteeAuditQueryRequest.new # TrusteeAuditQueryRequest | Values to scope the request.
1161
+
1162
+ opts = {
1163
+ page_size: 25, # Integer | Page size
1164
+ page_number: 1, # Integer | Page number
1165
+ sort_by: "timestamp", # String | Sort by
1166
+ sort_order: "descending" # String | Sort order
1167
+ }
1168
+
1169
+ begin
1170
+ #Get Org Trustee Audits
1171
+ result = api_instance.post_orgauthorization_trustees_audits(body, opts)
1172
+ p result
1173
+ rescue PureCloud::ApiError => e
1174
+ puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustees_audits: #{e}"
1175
+ end
1176
+ ~~~
1177
+
1178
+ ### Parameters
1179
+
1180
+ Name | Type | Description | Notes
1181
+ ------------- | ------------- | ------------- | -------------
1182
+ **body** | [**TrusteeAuditQueryRequest**](TrusteeAuditQueryRequest.html)| Values to scope the request. | |
1183
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1184
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1185
+ **sort_by** | **String**| Sort by | [optional] [default to timestamp] |
1186
+ **sort_order** | **String**| Sort order | [optional] [default to descending] |
1187
+ {: class="table table-striped"}
1188
+
1189
+
1190
+ ### Return type
1191
+
1192
+ [**AuditQueryResponse**](AuditQueryResponse.html)
1193
+
1194
+ ### HTTP request headers
1195
+
1196
+ - **Content-Type**: application/json
1197
+ - **Accept**: application/json
1198
+
1199
+
1200
+
1201
+ <a name="post_orgauthorization_trustor_audits"></a>
1202
+
1203
+ ## -[**AuditQueryResponse**](AuditQueryResponse.html) post_orgauthorization_trustor_audits(body, opts)
1204
+
1205
+ Get Org Trustor Audits
1206
+
1207
+
1208
+
1209
+ Wraps POST /api/v2/orgauthorization/trustor/audits
1210
+
1211
+
1212
+ ### Example
1213
+ ~~~ruby
1214
+ # load the gem
1215
+ require 'purecloudplatformclientv2'
1216
+ # setup authorization
1217
+ @secret = ENV['PURECLOUD_SECRET']
1218
+ @id = ENV['PURECLOUD_CLIENT_ID']
1219
+ environment = "mypurecloud.com"
1220
+
1221
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1222
+
1223
+ PureCloud.configure do |config|
1224
+ config.access_token = @authToken
1225
+ end
1226
+
1227
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
1228
+
1229
+ body = PureCloud::TrustorAuditQueryRequest.new # TrustorAuditQueryRequest | Values to scope the request.
1230
+
1231
+ opts = {
1232
+ page_size: 25, # Integer | Page size
1233
+ page_number: 1, # Integer | Page number
1234
+ sort_by: "timestamp", # String | Sort by
1235
+ sort_order: "descending" # String | Sort order
1236
+ }
1237
+
1238
+ begin
1239
+ #Get Org Trustor Audits
1240
+ result = api_instance.post_orgauthorization_trustor_audits(body, opts)
1241
+ p result
1242
+ rescue PureCloud::ApiError => e
1243
+ puts "Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustor_audits: #{e}"
1244
+ end
1245
+ ~~~
1246
+
1247
+ ### Parameters
1248
+
1249
+ Name | Type | Description | Notes
1250
+ ------------- | ------------- | ------------- | -------------
1251
+ **body** | [**TrustorAuditQueryRequest**](TrustorAuditQueryRequest.html)| Values to scope the request. | |
1252
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1253
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1254
+ **sort_by** | **String**| Sort by | [optional] [default to timestamp] |
1255
+ **sort_order** | **String**| Sort order | [optional] [default to descending] |
1256
+ {: class="table table-striped"}
1257
+
1258
+
1259
+ ### Return type
1260
+
1261
+ [**AuditQueryResponse**](AuditQueryResponse.html)
1262
+
1263
+ ### HTTP request headers
1264
+
1265
+ - **Content-Type**: application/json
1266
+ - **Accept**: application/json
1267
+
1268
+
1269
+
1270
+ <a name="put_orgauthorization_trustee"></a>
1271
+
1272
+ ## -[**Trustee**](Trustee.html) put_orgauthorization_trustee(trustee_org_id, body)
1273
+
1274
+ Update Org Trust
1275
+
1276
+
1277
+
1278
+ Wraps PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}
1279
+
1280
+
1281
+ ### Example
1282
+ ~~~ruby
1283
+ # load the gem
1284
+ require 'purecloudplatformclientv2'
1285
+ # setup authorization
1286
+ @secret = ENV['PURECLOUD_SECRET']
1287
+ @id = ENV['PURECLOUD_CLIENT_ID']
1288
+ environment = "mypurecloud.com"
1289
+
1290
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1291
+
1292
+ PureCloud.configure do |config|
1293
+ config.access_token = @authToken
1294
+ end
1295
+
1296
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
1297
+
1298
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
1299
+
1300
+ body = PureCloud::Trustee.new # Trustee | Client
1301
+
1302
+
1303
+ begin
1304
+ #Update Org Trust
1305
+ result = api_instance.put_orgauthorization_trustee(trustee_org_id, body)
1306
+ p result
1307
+ rescue PureCloud::ApiError => e
1308
+ puts "Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee: #{e}"
1309
+ end
1310
+ ~~~
1311
+
1312
+ ### Parameters
1313
+
1314
+ Name | Type | Description | Notes
1315
+ ------------- | ------------- | ------------- | -------------
1316
+ **trustee_org_id** | **String**| Trustee Organization Id | |
1317
+ **body** | [**Trustee**](Trustee.html)| Client | |
1318
+ {: class="table table-striped"}
1319
+
1320
+
1321
+ ### Return type
1322
+
1323
+ [**Trustee**](Trustee.html)
1324
+
1325
+ ### HTTP request headers
1326
+
1327
+ - **Content-Type**: application/json
1328
+ - **Accept**: application/json
1329
+
1330
+
1331
+
1332
+ <a name="put_orgauthorization_trustee_user_roles"></a>
1333
+
1334
+ ## -[**UserAuthorization**](UserAuthorization.html) put_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, body)
1335
+
1336
+ Update Trustee User Roles
1337
+
1338
+
1339
+
1340
+ Wraps PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles
1341
+
1342
+
1343
+ ### Example
1344
+ ~~~ruby
1345
+ # load the gem
1346
+ require 'purecloudplatformclientv2'
1347
+ # setup authorization
1348
+ @secret = ENV['PURECLOUD_SECRET']
1349
+ @id = ENV['PURECLOUD_CLIENT_ID']
1350
+ environment = "mypurecloud.com"
1351
+
1352
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1353
+
1354
+ PureCloud.configure do |config|
1355
+ config.access_token = @authToken
1356
+ end
1357
+
1358
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
1359
+
1360
+ trustee_org_id = "trustee_org_id_example" # String | Trustee Organization Id
1361
+
1362
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
1363
+
1364
+ body = [PureCloud::Array<String>.new] # Array<String> | List of roles
1365
+
1366
+
1367
+ begin
1368
+ #Update Trustee User Roles
1369
+ result = api_instance.put_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, body)
1370
+ p result
1371
+ rescue PureCloud::ApiError => e
1372
+ puts "Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee_user_roles: #{e}"
1373
+ end
1374
+ ~~~
1375
+
1376
+ ### Parameters
1377
+
1378
+ Name | Type | Description | Notes
1379
+ ------------- | ------------- | ------------- | -------------
1380
+ **trustee_org_id** | **String**| Trustee Organization Id | |
1381
+ **trustee_user_id** | **String**| Trustee User Id | |
1382
+ **body** | **Array&lt;String&gt;**| List of roles | |
1383
+ {: class="table table-striped"}
1384
+
1385
+
1386
+ ### Return type
1387
+
1388
+ [**UserAuthorization**](UserAuthorization.html)
1389
+
1390
+ ### HTTP request headers
1391
+
1392
+ - **Content-Type**: application/json
1393
+ - **Accept**: application/json
1394
+
1395
+
1396
+
1397
+ <a name="put_orgauthorization_trustor_user"></a>
1398
+
1399
+ ## -[**TrustUser**](TrustUser.html) put_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
1400
+
1401
+ Add a Trustee user to the trust.
1402
+
1403
+
1404
+
1405
+ Wraps PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}
1406
+
1407
+
1408
+ ### Example
1409
+ ~~~ruby
1410
+ # load the gem
1411
+ require 'purecloudplatformclientv2'
1412
+ # setup authorization
1413
+ @secret = ENV['PURECLOUD_SECRET']
1414
+ @id = ENV['PURECLOUD_CLIENT_ID']
1415
+ environment = "mypurecloud.com"
1416
+
1417
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1418
+
1419
+ PureCloud.configure do |config|
1420
+ config.access_token = @authToken
1421
+ end
1422
+
1423
+ api_instance = PureCloud::OrganizationAuthorizationApi.new
1424
+
1425
+ trustor_org_id = "trustor_org_id_example" # String | Trustor Organization Id
1426
+
1427
+ trustee_user_id = "trustee_user_id_example" # String | Trustee User Id
1428
+
1429
+
1430
+ begin
1431
+ #Add a Trustee user to the trust.
1432
+ result = api_instance.put_orgauthorization_trustor_user(trustor_org_id, trustee_user_id)
1433
+ p result
1434
+ rescue PureCloud::ApiError => e
1435
+ puts "Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustor_user: #{e}"
1436
+ end
1437
+ ~~~
1438
+
1439
+ ### Parameters
1440
+
1441
+ Name | Type | Description | Notes
1442
+ ------------- | ------------- | ------------- | -------------
1443
+ **trustor_org_id** | **String**| Trustor Organization Id | |
1444
+ **trustee_user_id** | **String**| Trustee User Id | |
1445
+ {: class="table table-striped"}
1446
+
1447
+
1448
+ ### Return type
1449
+
1450
+ [**TrustUser**](TrustUser.html)
1451
+
1452
+ ### HTTP request headers
1453
+
1454
+ - **Content-Type**: application/json
1455
+ - **Accept**: application/json
1456
+
1457
+
1458
+