purecloudplatformclientv2 34.0.0 → 35.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (368) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActionEntityListing.md +1 -1
  4. data/docs/AgentActivityEntityListing.md +1 -1
  5. data/docs/AlertingApi.md +66 -0
  6. data/docs/AnalyticsApi.md +144 -0
  7. data/docs/ArchitectApi.md +492 -2
  8. data/docs/AssignedWrapupCode.md +17 -0
  9. data/docs/AttemptLimitsEntityListing.md +1 -1
  10. data/docs/AttributeEntityListing.md +1 -1
  11. data/docs/AttributesApi.md +36 -0
  12. data/docs/AuthorizationApi.md +102 -0
  13. data/docs/BillingApi.md +6 -0
  14. data/docs/CalibrationEntityListing.md +1 -1
  15. data/docs/CallConversationEntityListing.md +1 -1
  16. data/docs/CallHistoryConversationEntityListing.md +1 -1
  17. data/docs/CallableTimeSetEntityListing.md +1 -1
  18. data/docs/CallbackConversationEntityListing.md +1 -1
  19. data/docs/CampaignDivisionView.md +16 -0
  20. data/docs/CampaignDivisionViewListing.md +22 -0
  21. data/docs/CampaignEntityListing.md +1 -1
  22. data/docs/CampaignRuleEntityListing.md +1 -1
  23. data/docs/CampaignSequenceEntityListing.md +1 -1
  24. data/docs/CertificateAuthorityEntityListing.md +1 -1
  25. data/docs/ChatConversationEntityListing.md +1 -1
  26. data/docs/ClientAppEntityListing.md +1 -1
  27. data/docs/CobrowseConversationEntityListing.md +1 -1
  28. data/docs/CommandStatusEntityListing.md +1 -1
  29. data/docs/ConsumedResourcesEntityListing.md +1 -1
  30. data/docs/ConsumingResourcesEntityListing.md +1 -1
  31. data/docs/ContactListEntityListing.md +1 -1
  32. data/docs/ContactListFilterEntityListing.md +1 -1
  33. data/docs/ContactListing.md +1 -1
  34. data/docs/ContentManagementApi.md +228 -0
  35. data/docs/ConversationEntityListing.md +1 -1
  36. data/docs/ConversationsApi.md +590 -14
  37. data/docs/CredentialInfoListing.md +1 -1
  38. data/docs/CredentialTypeListing.md +1 -1
  39. data/docs/DIDEntityListing.md +1 -1
  40. data/docs/DIDPoolEntityListing.md +1 -1
  41. data/docs/DataTableRowEntityListing.md +1 -1
  42. data/docs/DataTablesDomainEntityListing.md +1 -1
  43. data/docs/DependencyObjectEntityListing.md +1 -1
  44. data/docs/DependencyTypeEntityListing.md +1 -1
  45. data/docs/DialerEventEntityListing.md +1 -1
  46. data/docs/DirectoryUserDevicesListing.md +1 -1
  47. data/docs/DncListEntityListing.md +1 -1
  48. data/docs/DocumentAuditEntityListing.md +1 -1
  49. data/docs/DocumentEntityListing.md +1 -1
  50. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  51. data/docs/DomainEntityListing.md +1 -1
  52. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  53. data/docs/DomainEntityListingQueryResult.md +1 -1
  54. data/docs/DomainEntityListingSurveyForm.md +1 -1
  55. data/docs/DomainOrganizationRole.md +1 -1
  56. data/docs/DomainOrganizationRoleCreate.md +1 -1
  57. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  58. data/docs/EdgeEntityListing.md +1 -1
  59. data/docs/EdgeGroupEntityListing.md +1 -1
  60. data/docs/EdgeLineEntityListing.md +1 -1
  61. data/docs/EmailConversationEntityListing.md +1 -1
  62. data/docs/EmailMessageListing.md +1 -1
  63. data/docs/EmergencyGroupListing.md +1 -1
  64. data/docs/EncryptionKeyEntityListing.md +1 -1
  65. data/docs/EndpointEntityListing.md +1 -1
  66. data/docs/EvaluationEntityListing.md +1 -1
  67. data/docs/EvaluationFormEntityListing.md +1 -1
  68. data/docs/EvaluatorActivityEntityListing.md +1 -1
  69. data/docs/ExtensionEntityListing.md +1 -1
  70. data/docs/ExtensionPoolEntityListing.md +1 -1
  71. data/docs/ExternalContactsApi.md +238 -69
  72. data/docs/ExternalOrganizationListing.md +1 -1
  73. data/docs/FaxApi.md +36 -0
  74. data/docs/FaxDocumentEntityListing.md +1 -1
  75. data/docs/Flow.md +1 -1
  76. data/docs/FlowDivisionViewEntityListing.md +1 -1
  77. data/docs/FlowEntityListing.md +1 -1
  78. data/docs/FlowVersionEntityListing.md +1 -1
  79. data/docs/GDPRRequestEntityListing.md +1 -1
  80. data/docs/GDPRSubjectEntityListing.md +1 -1
  81. data/docs/GeneralDataProtectionRegulationApi.md +24 -0
  82. data/docs/GeolocationApi.md +24 -0
  83. data/docs/GreetingListing.md +1 -1
  84. data/docs/GreetingsApi.md +96 -0
  85. data/docs/GroupEntityListing.md +1 -1
  86. data/docs/GroupProfileEntityListing.md +1 -1
  87. data/docs/GroupsApi.md +84 -0
  88. data/docs/IVREntityListing.md +1 -1
  89. data/docs/IdentityProviderApi.md +168 -0
  90. data/docs/InboundDomainEntityListing.md +1 -1
  91. data/docs/InboundRouteEntityListing.md +1 -1
  92. data/docs/IntegrationEntityListing.md +1 -1
  93. data/docs/IntegrationEventEntityListing.md +1 -1
  94. data/docs/IntegrationTypeEntityListing.md +1 -1
  95. data/docs/IntegrationsApi.md +246 -0
  96. data/docs/InteractionStatsAlertContainer.md +1 -1
  97. data/docs/InteractionStatsRuleContainer.md +1 -1
  98. data/docs/JsonNode.md +4 -4
  99. data/docs/KeywordSetEntityListing.md +1 -1
  100. data/docs/LanguageEntityListing.md +1 -1
  101. data/docs/LanguagesApi.md +60 -0
  102. data/docs/LibraryEntityListing.md +1 -1
  103. data/docs/LicenseApi.md +48 -0
  104. data/docs/LineBaseEntityListing.md +1 -1
  105. data/docs/LineEntityListing.md +1 -1
  106. data/docs/LocationEntityListing.md +1 -1
  107. data/docs/LocationsApi.md +24 -0
  108. data/docs/LogicalInterfaceEntityListing.md +1 -1
  109. data/docs/ManagementUnitListing.md +1 -1
  110. data/docs/MessageConversationEntityListing.md +1 -1
  111. data/docs/MobileDevicesApi.md +30 -0
  112. data/docs/NoteListing.md +1 -1
  113. data/docs/NotificationsApi.md +42 -0
  114. data/docs/OAuthApi.md +36 -0
  115. data/docs/OAuthClientEntityListing.md +1 -1
  116. data/docs/OAuthProviderEntityListing.md +1 -1
  117. data/docs/OrganizationApi.md +24 -0
  118. data/docs/OrganizationAuthorizationApi.md +138 -0
  119. data/docs/OrganizationPresenceEntityListing.md +1 -1
  120. data/docs/OrganizationRoleEntityListing.md +1 -1
  121. data/docs/OrphanRecordingListing.md +1 -1
  122. data/docs/OutboundApi.md +611 -0
  123. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  124. data/docs/OutboundRouteEntityListing.md +1 -1
  125. data/docs/PermissionCollectionEntityListing.md +1 -1
  126. data/docs/PhoneBaseEntityListing.md +1 -1
  127. data/docs/PhoneEntityListing.md +1 -1
  128. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  129. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  130. data/docs/PolicyEntityListing.md +1 -1
  131. data/docs/PresenceApi.md +48 -0
  132. data/docs/PromptAssetEntityListing.md +1 -1
  133. data/docs/PromptEntityListing.md +1 -1
  134. data/docs/QualityApi.md +300 -0
  135. data/docs/QualityAuditPage.md +1 -1
  136. data/docs/QueueEntityListing.md +1 -1
  137. data/docs/QueueMemberEntityListing.md +1 -1
  138. data/docs/RecipientListing.md +1 -1
  139. data/docs/RecordingApi.md +222 -0
  140. data/docs/RelationshipListing.md +1 -1
  141. data/docs/ReportMetaDataEntityListing.md +1 -1
  142. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  143. data/docs/ReportScheduleEntityListing.md +1 -1
  144. data/docs/ReportingExportJobListing.md +1 -1
  145. data/docs/ResponseEntityList.md +1 -1
  146. data/docs/ResponseEntityListing.md +1 -1
  147. data/docs/ResponseManagementApi.md +66 -0
  148. data/docs/ResponseSetEntityListing.md +1 -1
  149. data/docs/RoutingApi.md +351 -1
  150. data/docs/RuleSetEntityListing.md +1 -1
  151. data/docs/ScheduleEntityListing.md +1 -1
  152. data/docs/ScheduleGroupEntityListing.md +1 -1
  153. data/docs/SchemaCategoryEntityListing.md +1 -1
  154. data/docs/SchemaReferenceEntityListing.md +1 -1
  155. data/docs/ScreenRecordingSessionListing.md +1 -1
  156. data/docs/ScriptEntityListing.md +1 -1
  157. data/docs/ScriptsApi.md +66 -0
  158. data/docs/SearchApi.md +84 -0
  159. data/docs/SecurityProfileEntityListing.md +1 -1
  160. data/docs/ShareEntityListing.md +1 -1
  161. data/docs/SiteEntityListing.md +1 -1
  162. data/docs/SkillEntityListing.md +1 -1
  163. data/docs/SmsPhoneNumberEntityListing.md +1 -1
  164. data/docs/StationEntityListing.md +1 -1
  165. data/docs/StationsApi.md +30 -0
  166. data/docs/SuggestApi.md +24 -0
  167. data/docs/SurveyFormEntityListing.md +1 -1
  168. data/docs/SystemPromptAssetEntityListing.md +1 -1
  169. data/docs/SystemPromptEntityListing.md +1 -1
  170. data/docs/TagValueEntityListing.md +1 -1
  171. data/docs/TelephonyProvidersEdgeApi.md +762 -0
  172. data/docs/TextMessageListing.md +1 -1
  173. data/docs/TimeZone.md +2 -2
  174. data/docs/TimeZoneEntityListing.md +1 -1
  175. data/docs/TokensApi.md +12 -0
  176. data/docs/TrunkBaseEntityListing.md +1 -1
  177. data/docs/TrunkEntityListing.md +1 -1
  178. data/docs/TrunkMetabaseEntityListing.md +1 -1
  179. data/docs/TrustEntityListing.md +1 -1
  180. data/docs/TrustUserEntityListing.md +1 -1
  181. data/docs/TrustorEntityListing.md +1 -1
  182. data/docs/UserActionCategoryEntityListing.md +1 -1
  183. data/docs/UserEntityListing.md +1 -1
  184. data/docs/UserLanguageEntityListing.md +1 -1
  185. data/docs/UserProfileEntityListing.md +1 -1
  186. data/docs/UserQueueEntityListing.md +1 -1
  187. data/docs/UserRecordingEntityListing.md +1 -1
  188. data/docs/UserRecordingsApi.md +36 -0
  189. data/docs/UserSkillEntityListing.md +1 -1
  190. data/docs/UsersApi.md +321 -3
  191. data/docs/UtilitiesApi.md +18 -0
  192. data/docs/VoicemailApi.md +144 -0
  193. data/docs/VoicemailMessageEntityListing.md +1 -1
  194. data/docs/WebChatApi.md +48 -0
  195. data/docs/WebChatConfig.md +13 -0
  196. data/docs/WebChatDeployment.md +2 -1
  197. data/docs/WorkforceManagementApi.md +74 -2
  198. data/docs/WorkspaceEntityListing.md +1 -1
  199. data/docs/WorkspaceMemberEntityListing.md +1 -1
  200. data/docs/WrapupCodeEntityListing.md +1 -1
  201. data/lib/purecloudplatformclientv2.rb +4 -1
  202. data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
  203. data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
  204. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
  205. data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
  206. data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
  207. data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
  208. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
  209. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  210. data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
  211. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
  212. data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
  213. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
  214. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
  215. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
  216. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
  217. data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
  218. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
  219. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
  220. data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
  221. data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
  222. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
  223. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
  224. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
  225. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
  226. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
  227. data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
  228. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
  229. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
  230. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
  231. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
  232. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
  233. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
  234. data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
  235. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
  236. data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
  237. data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
  238. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
  239. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
  240. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
  241. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
  242. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
  243. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
  244. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
  245. data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
  246. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
  247. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
  248. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
  249. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
  250. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
  251. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
  252. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
  253. data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
  254. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  255. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  256. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  257. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
  258. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
  259. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
  260. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
  261. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
  262. data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
  263. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
  264. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
  265. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
  266. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
  267. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
  268. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
  269. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
  270. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
  271. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
  272. data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
  273. data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
  274. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
  275. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
  276. data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
  277. data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
  278. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
  279. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
  280. data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
  281. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
  282. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
  283. data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
  284. data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
  285. data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
  286. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
  287. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
  288. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
  289. data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
  290. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
  291. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
  292. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
  293. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
  294. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
  295. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
  296. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
  297. data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
  298. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
  299. data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
  300. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
  301. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
  302. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
  303. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
  304. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
  305. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
  306. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
  307. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
  308. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
  309. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
  310. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
  311. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
  312. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
  313. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
  314. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
  315. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
  316. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
  317. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
  318. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
  319. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
  320. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
  321. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
  322. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
  323. data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
  324. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
  325. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
  326. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
  327. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
  328. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
  329. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
  330. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
  331. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
  332. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
  333. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
  334. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
  335. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
  336. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
  337. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
  338. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
  339. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
  340. data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
  341. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
  342. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
  343. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
  344. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
  345. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
  346. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
  347. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
  348. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
  349. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
  350. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
  351. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
  352. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
  353. data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
  354. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
  355. data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
  356. data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
  357. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
  358. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
  359. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
  360. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
  361. data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
  362. data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
  363. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
  364. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
  365. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
  366. data/lib/purecloudplatformclientv2/version.rb +1 -1
  367. metadata +10 -4
  368. data/docs/AuthzDivision.md +0 -18
@@ -15,12 +15,18 @@ Method | Description
15
15
 
16
16
  ## -[**BillingUsageReport**](BillingUsageReport.html) get_billing_reports_billableusage(start_date, end_date)
17
17
 
18
+
19
+
18
20
  Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
19
21
 
20
22
 
21
23
 
22
24
  Wraps GET /api/v2/billing/reports/billableusage
23
25
 
26
+ Requires ANY permissions:
27
+
28
+ * billing:subscription:read* billing:subscription:view* billing:subscription:create* billing:subscription:add
29
+
24
30
 
25
31
  ### Example
26
32
  ~~~ruby
@@ -13,9 +13,9 @@ title: CalibrationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CallConversationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CallHistoryConversationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CallableTimeSetEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CallbackConversationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: CampaignDivisionView
3
+ ---
4
+ ## PureCloud::CampaignDivisionView
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **division** | [**UriReference**](UriReference.html) | The division to which this entity belongs. | [optional] |
13
+ | **self_uri** | **String** | The URI for this object | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: CampaignDivisionViewListing
3
+ ---
4
+ ## PureCloud::CampaignDivisionViewListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<CampaignDivisionView>**](CampaignDivisionView.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
+
@@ -13,9 +13,9 @@ title: CampaignEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CampaignRuleEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CampaignSequenceEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CertificateAuthorityEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: ChatConversationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: ClientAppEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CobrowseConversationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: CommandStatusEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: ConsumedResourcesEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: ConsumingResourcesEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: ContactListEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: ContactListFilterEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -13,9 +13,9 @@ title: ContactListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **last_uri** | **String** | | [optional] |
17
16
  | **previous_uri** | **String** | | [optional] |
18
17
  | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -52,12 +52,18 @@ Method | Description
52
52
 
53
53
  ## - delete_contentmanagement_document(document_id, opts)
54
54
 
55
+
56
+
55
57
  Delete a document.
56
58
 
57
59
 
58
60
 
59
61
  Wraps DELETE /api/v2/contentmanagement/documents/{documentId}
60
62
 
63
+ Requires NO permissions:
64
+
65
+
66
+
61
67
 
62
68
  ### Example
63
69
  ~~~ruby
@@ -114,12 +120,18 @@ nil (empty response body)
114
120
 
115
121
  ## - delete_contentmanagement_share(share_id)
116
122
 
123
+
124
+
117
125
  Deletes an existing share.
118
126
 
119
127
  This revokes sharing rights specified in the share record
120
128
 
121
129
  Wraps DELETE /api/v2/contentmanagement/shares/{shareId}
122
130
 
131
+ Requires NO permissions:
132
+
133
+
134
+
123
135
 
124
136
  ### Example
125
137
  ~~~ruby
@@ -172,12 +184,18 @@ nil (empty response body)
172
184
 
173
185
  ## - delete_contentmanagement_status_status_id(status_id)
174
186
 
187
+
188
+
175
189
  Cancel the command for this status
176
190
 
177
191
 
178
192
 
179
193
  Wraps DELETE /api/v2/contentmanagement/status/{statusId}
180
194
 
195
+ Requires NO permissions:
196
+
197
+
198
+
181
199
 
182
200
  ### Example
183
201
  ~~~ruby
@@ -230,12 +248,18 @@ nil (empty response body)
230
248
 
231
249
  ## - delete_contentmanagement_workspace(workspace_id, opts)
232
250
 
251
+
252
+
233
253
  Delete a workspace
234
254
 
235
255
 
236
256
 
237
257
  Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}
238
258
 
259
+ Requires NO permissions:
260
+
261
+
262
+
239
263
 
240
264
  ### Example
241
265
  ~~~ruby
@@ -292,12 +316,18 @@ nil (empty response body)
292
316
 
293
317
  ## - delete_contentmanagement_workspace_member(workspace_id, member_id)
294
318
 
319
+
320
+
295
321
  Delete a member from a workspace
296
322
 
297
323
 
298
324
 
299
325
  Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
300
326
 
327
+ Requires NO permissions:
328
+
329
+
330
+
301
331
 
302
332
  ### Example
303
333
  ~~~ruby
@@ -353,12 +383,18 @@ nil (empty response body)
353
383
 
354
384
  ## - delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id)
355
385
 
386
+
387
+
356
388
  Delete workspace tag
357
389
 
358
390
  Delete a tag from a workspace. Will remove this tag from all documents.
359
391
 
360
392
  Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
361
393
 
394
+ Requires NO permissions:
395
+
396
+
397
+
362
398
 
363
399
  ### Example
364
400
  ~~~ruby
@@ -414,12 +450,18 @@ nil (empty response body)
414
450
 
415
451
  ## -[**Document**](Document.html) get_contentmanagement_document(document_id, opts)
416
452
 
453
+
454
+
417
455
  Get a document.
418
456
 
419
457
 
420
458
 
421
459
  Wraps GET /api/v2/contentmanagement/documents/{documentId}
422
460
 
461
+ Requires NO permissions:
462
+
463
+
464
+
423
465
 
424
466
  ### Example
425
467
  ~~~ruby
@@ -477,12 +519,18 @@ Name | Type | Description | Notes
477
519
 
478
520
  ## -[**DocumentAuditEntityListing**](DocumentAuditEntityListing.html) get_contentmanagement_document_audits(document_id, opts)
479
521
 
522
+
523
+
480
524
  Get a list of audits for a document.
481
525
 
482
526
 
483
527
 
484
528
  Wraps GET /api/v2/contentmanagement/documents/{documentId}/audits
485
529
 
530
+ Requires NO permissions:
531
+
532
+
533
+
486
534
 
487
535
  ### Example
488
536
  ~~~ruby
@@ -550,12 +598,18 @@ Name | Type | Description | Notes
550
598
 
551
599
  ## -[**DownloadResponse**](DownloadResponse.html) get_contentmanagement_document_content(document_id, opts)
552
600
 
601
+
602
+
553
603
  Download a document.
554
604
 
555
605
 
556
606
 
557
607
  Wraps GET /api/v2/contentmanagement/documents/{documentId}/content
558
608
 
609
+ Requires NO permissions:
610
+
611
+
612
+
559
613
 
560
614
  ### Example
561
615
  ~~~ruby
@@ -615,12 +669,18 @@ Name | Type | Description | Notes
615
669
 
616
670
  ## -[**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_documents(workspace_id, opts)
617
671
 
672
+ <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
673
+
618
674
  Get a list of documents.
619
675
 
620
676
 
621
677
 
622
678
  Wraps GET /api/v2/contentmanagement/documents
623
679
 
680
+ Requires NO permissions:
681
+
682
+
683
+
624
684
 
625
685
  ### Example
626
686
  ~~~ruby
@@ -688,12 +748,18 @@ Name | Type | Description | Notes
688
748
 
689
749
  ## -[**QueryResults**](QueryResults.html) get_contentmanagement_query(query_phrase, opts)
690
750
 
751
+
752
+
691
753
  Query content
692
754
 
693
755
 
694
756
 
695
757
  Wraps GET /api/v2/contentmanagement/query
696
758
 
759
+ Requires NO permissions:
760
+
761
+
762
+
697
763
 
698
764
  ### Example
699
765
  ~~~ruby
@@ -759,12 +825,18 @@ Name | Type | Description | Notes
759
825
 
760
826
  ## -[**SecurityProfile**](SecurityProfile.html) get_contentmanagement_securityprofile(security_profile_id)
761
827
 
828
+
829
+
762
830
  Get a Security Profile
763
831
 
764
832
 
765
833
 
766
834
  Wraps GET /api/v2/contentmanagement/securityprofiles/{securityProfileId}
767
835
 
836
+ Requires NO permissions:
837
+
838
+
839
+
768
840
 
769
841
  ### Example
770
842
  ~~~ruby
@@ -818,12 +890,18 @@ Name | Type | Description | Notes
818
890
 
819
891
  ## -[**SecurityProfileEntityListing**](SecurityProfileEntityListing.html) get_contentmanagement_securityprofiles
820
892
 
893
+
894
+
821
895
  Get a List of Security Profiles
822
896
 
823
897
 
824
898
 
825
899
  Wraps GET /api/v2/contentmanagement/securityprofiles
826
900
 
901
+ Requires NO permissions:
902
+
903
+
904
+
827
905
 
828
906
  ### Example
829
907
  ~~~ruby
@@ -871,12 +949,18 @@ This endpoint does not need any parameter.
871
949
 
872
950
  ## -[**Share**](Share.html) get_contentmanagement_share(share_id, opts)
873
951
 
952
+
953
+
874
954
  Retrieve details about an existing share.
875
955
 
876
956
 
877
957
 
878
958
  Wraps GET /api/v2/contentmanagement/shares/{shareId}
879
959
 
960
+ Requires NO permissions:
961
+
962
+
963
+
880
964
 
881
965
  ### Example
882
966
  ~~~ruby
@@ -934,12 +1018,18 @@ Name | Type | Description | Notes
934
1018
 
935
1019
  ## -[**SharedResponse**](SharedResponse.html) get_contentmanagement_shared_shared_id(shared_id, opts)
936
1020
 
1021
+
1022
+
937
1023
  Get shared documents. Securely download a shared document.
938
1024
 
939
1025
  This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
940
1026
 
941
1027
  Wraps GET /api/v2/contentmanagement/shared/{sharedId}
942
1028
 
1029
+ Requires NO permissions:
1030
+
1031
+
1032
+
943
1033
 
944
1034
  ### Example
945
1035
  ~~~ruby
@@ -1003,12 +1093,18 @@ Name | Type | Description | Notes
1003
1093
 
1004
1094
  ## -[**ShareEntityListing**](ShareEntityListing.html) get_contentmanagement_shares(opts)
1005
1095
 
1096
+
1097
+
1006
1098
  Gets a list of shares. You must specify at least one filter (e.g. entityId).
1007
1099
 
1008
1100
  Failing to specify a filter will return 400.
1009
1101
 
1010
1102
  Wraps GET /api/v2/contentmanagement/shares
1011
1103
 
1104
+ Requires NO permissions:
1105
+
1106
+
1107
+
1012
1108
 
1013
1109
  ### Example
1014
1110
  ~~~ruby
@@ -1069,12 +1165,18 @@ Name | Type | Description | Notes
1069
1165
 
1070
1166
  ## -[**CommandStatusEntityListing**](CommandStatusEntityListing.html) get_contentmanagement_status(opts)
1071
1167
 
1168
+
1169
+
1072
1170
  Get a list of statuses for pending operations
1073
1171
 
1074
1172
 
1075
1173
 
1076
1174
  Wraps GET /api/v2/contentmanagement/status
1077
1175
 
1176
+ Requires NO permissions:
1177
+
1178
+
1179
+
1078
1180
 
1079
1181
  ### Example
1080
1182
  ~~~ruby
@@ -1131,12 +1233,18 @@ Name | Type | Description | Notes
1131
1233
 
1132
1234
  ## -[**CommandStatus**](CommandStatus.html) get_contentmanagement_status_status_id(status_id)
1133
1235
 
1236
+
1237
+
1134
1238
  Get a status.
1135
1239
 
1136
1240
 
1137
1241
 
1138
1242
  Wraps GET /api/v2/contentmanagement/status/{statusId}
1139
1243
 
1244
+ Requires NO permissions:
1245
+
1246
+
1247
+
1140
1248
 
1141
1249
  ### Example
1142
1250
  ~~~ruby
@@ -1190,12 +1298,18 @@ Name | Type | Description | Notes
1190
1298
 
1191
1299
  ## -[**Usage**](Usage.html) get_contentmanagement_usage
1192
1300
 
1301
+
1302
+
1193
1303
  Get usage details.
1194
1304
 
1195
1305
 
1196
1306
 
1197
1307
  Wraps GET /api/v2/contentmanagement/usage
1198
1308
 
1309
+ Requires NO permissions:
1310
+
1311
+
1312
+
1199
1313
 
1200
1314
  ### Example
1201
1315
  ~~~ruby
@@ -1243,12 +1357,18 @@ This endpoint does not need any parameter.
1243
1357
 
1244
1358
  ## -[**Workspace**](Workspace.html) get_contentmanagement_workspace(workspace_id, opts)
1245
1359
 
1360
+
1361
+
1246
1362
  Get a workspace.
1247
1363
 
1248
1364
 
1249
1365
 
1250
1366
  Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}
1251
1367
 
1368
+ Requires NO permissions:
1369
+
1370
+
1371
+
1252
1372
 
1253
1373
  ### Example
1254
1374
  ~~~ruby
@@ -1306,12 +1426,18 @@ Name | Type | Description | Notes
1306
1426
 
1307
1427
  ## -[**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_workspace_documents(workspace_id, opts)
1308
1428
 
1429
+
1430
+
1309
1431
  Get a list of documents.
1310
1432
 
1311
1433
 
1312
1434
 
1313
1435
  Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents
1314
1436
 
1437
+ Requires NO permissions:
1438
+
1439
+
1440
+
1315
1441
 
1316
1442
  ### Example
1317
1443
  ~~~ruby
@@ -1377,12 +1503,18 @@ Name | Type | Description | Notes
1377
1503
 
1378
1504
  ## -[**WorkspaceMember**](WorkspaceMember.html) get_contentmanagement_workspace_member(workspace_id, member_id, opts)
1379
1505
 
1506
+
1507
+
1380
1508
  Get a workspace member
1381
1509
 
1382
1510
 
1383
1511
 
1384
1512
  Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
1385
1513
 
1514
+ Requires NO permissions:
1515
+
1516
+
1517
+
1386
1518
 
1387
1519
  ### Example
1388
1520
  ~~~ruby
@@ -1443,12 +1575,18 @@ Name | Type | Description | Notes
1443
1575
 
1444
1576
  ## -[**WorkspaceMemberEntityListing**](WorkspaceMemberEntityListing.html) get_contentmanagement_workspace_members(workspace_id, opts)
1445
1577
 
1578
+
1579
+
1446
1580
  Get a list workspace members
1447
1581
 
1448
1582
 
1449
1583
 
1450
1584
  Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/members
1451
1585
 
1586
+ Requires NO permissions:
1587
+
1588
+
1589
+
1452
1590
 
1453
1591
  ### Example
1454
1592
  ~~~ruby
@@ -1510,12 +1648,18 @@ Name | Type | Description | Notes
1510
1648
 
1511
1649
  ## -[**TagValue**](TagValue.html) get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts)
1512
1650
 
1651
+
1652
+
1513
1653
  Get a workspace tag
1514
1654
 
1515
1655
 
1516
1656
 
1517
1657
  Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
1518
1658
 
1659
+ Requires NO permissions:
1660
+
1661
+
1662
+
1519
1663
 
1520
1664
  ### Example
1521
1665
  ~~~ruby
@@ -1576,12 +1720,18 @@ Name | Type | Description | Notes
1576
1720
 
1577
1721
  ## -[**TagValueEntityListing**](TagValueEntityListing.html) get_contentmanagement_workspace_tagvalues(workspace_id, opts)
1578
1722
 
1723
+
1724
+
1579
1725
  Get a list of workspace tags
1580
1726
 
1581
1727
 
1582
1728
 
1583
1729
  Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues
1584
1730
 
1731
+ Requires NO permissions:
1732
+
1733
+
1734
+
1585
1735
 
1586
1736
  ### Example
1587
1737
  ~~~ruby
@@ -1645,12 +1795,18 @@ Name | Type | Description | Notes
1645
1795
 
1646
1796
  ## -[**WorkspaceEntityListing**](WorkspaceEntityListing.html) get_contentmanagement_workspaces(opts)
1647
1797
 
1798
+
1799
+
1648
1800
  Get a list of workspaces.
1649
1801
 
1650
1802
  Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
1651
1803
 
1652
1804
  Wraps GET /api/v2/contentmanagement/workspaces
1653
1805
 
1806
+ Requires NO permissions:
1807
+
1808
+
1809
+
1654
1810
 
1655
1811
  ### Example
1656
1812
  ~~~ruby
@@ -1711,12 +1867,18 @@ Name | Type | Description | Notes
1711
1867
 
1712
1868
  ## -[**QueryResults**](QueryResults.html) post_contentmanagement_auditquery(body)
1713
1869
 
1870
+
1871
+
1714
1872
  Query audits
1715
1873
 
1716
1874
 
1717
1875
 
1718
1876
  Wraps POST /api/v2/contentmanagement/auditquery
1719
1877
 
1878
+ Requires NO permissions:
1879
+
1880
+
1881
+
1720
1882
 
1721
1883
  ### Example
1722
1884
  ~~~ruby
@@ -1770,12 +1932,18 @@ Name | Type | Description | Notes
1770
1932
 
1771
1933
  ## -[**Document**](Document.html) post_contentmanagement_document(document_id, body, opts)
1772
1934
 
1935
+
1936
+
1773
1937
  Update a document.
1774
1938
 
1775
1939
 
1776
1940
 
1777
1941
  Wraps POST /api/v2/contentmanagement/documents/{documentId}
1778
1942
 
1943
+ Requires NO permissions:
1944
+
1945
+
1946
+
1779
1947
 
1780
1948
  ### Example
1781
1949
  ~~~ruby
@@ -1838,12 +2006,18 @@ Name | Type | Description | Notes
1838
2006
 
1839
2007
  ## -[**ReplaceResponse**](ReplaceResponse.html) post_contentmanagement_document_content(document_id, body, opts)
1840
2008
 
2009
+
2010
+
1841
2011
  Replace the contents of a document.
1842
2012
 
1843
2013
 
1844
2014
 
1845
2015
  Wraps POST /api/v2/contentmanagement/documents/{documentId}/content
1846
2016
 
2017
+ Requires NO permissions:
2018
+
2019
+
2020
+
1847
2021
 
1848
2022
  ### Example
1849
2023
  ~~~ruby
@@ -1904,12 +2078,18 @@ Name | Type | Description | Notes
1904
2078
 
1905
2079
  ## -[**Document**](Document.html) post_contentmanagement_documents(body, opts)
1906
2080
 
2081
+
2082
+
1907
2083
  Add a document.
1908
2084
 
1909
2085
 
1910
2086
 
1911
2087
  Wraps POST /api/v2/contentmanagement/documents
1912
2088
 
2089
+ Requires NO permissions:
2090
+
2091
+
2092
+
1913
2093
 
1914
2094
  ### Example
1915
2095
  ~~~ruby
@@ -1971,12 +2151,18 @@ Name | Type | Description | Notes
1971
2151
 
1972
2152
  ## -[**QueryResults**](QueryResults.html) post_contentmanagement_query(body, opts)
1973
2153
 
2154
+
2155
+
1974
2156
  Query content
1975
2157
 
1976
2158
 
1977
2159
 
1978
2160
  Wraps POST /api/v2/contentmanagement/query
1979
2161
 
2162
+ Requires NO permissions:
2163
+
2164
+
2165
+
1980
2166
 
1981
2167
  ### Example
1982
2168
  ~~~ruby
@@ -2034,12 +2220,18 @@ Name | Type | Description | Notes
2034
2220
 
2035
2221
  ## -[**CreateShareResponse**](CreateShareResponse.html) post_contentmanagement_shares(body)
2036
2222
 
2223
+
2224
+
2037
2225
  Creates a new share or updates an existing share if the entity has already been shared
2038
2226
 
2039
2227
 
2040
2228
 
2041
2229
  Wraps POST /api/v2/contentmanagement/shares
2042
2230
 
2231
+ Requires NO permissions:
2232
+
2233
+
2234
+
2043
2235
 
2044
2236
  ### Example
2045
2237
  ~~~ruby
@@ -2093,12 +2285,18 @@ Name | Type | Description | Notes
2093
2285
 
2094
2286
  ## -[**TagValue**](TagValue.html) post_contentmanagement_workspace_tagvalues(workspace_id, body)
2095
2287
 
2288
+
2289
+
2096
2290
  Create a workspace tag
2097
2291
 
2098
2292
 
2099
2293
 
2100
2294
  Wraps POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues
2101
2295
 
2296
+ Requires NO permissions:
2297
+
2298
+
2299
+
2102
2300
 
2103
2301
  ### Example
2104
2302
  ~~~ruby
@@ -2155,12 +2353,18 @@ Name | Type | Description | Notes
2155
2353
 
2156
2354
  ## -[**TagValueEntityListing**](TagValueEntityListing.html) post_contentmanagement_workspace_tagvalues_query(workspace_id, body, opts)
2157
2355
 
2356
+
2357
+
2158
2358
  Perform a prefix query on tags in the workspace
2159
2359
 
2160
2360
 
2161
2361
 
2162
2362
  Wraps POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query
2163
2363
 
2364
+ Requires NO permissions:
2365
+
2366
+
2367
+
2164
2368
 
2165
2369
  ### Example
2166
2370
  ~~~ruby
@@ -2221,12 +2425,18 @@ Name | Type | Description | Notes
2221
2425
 
2222
2426
  ## -[**Workspace**](Workspace.html) post_contentmanagement_workspaces(body)
2223
2427
 
2428
+
2429
+
2224
2430
  Create a group workspace
2225
2431
 
2226
2432
 
2227
2433
 
2228
2434
  Wraps POST /api/v2/contentmanagement/workspaces
2229
2435
 
2436
+ Requires NO permissions:
2437
+
2438
+
2439
+
2230
2440
 
2231
2441
  ### Example
2232
2442
  ~~~ruby
@@ -2280,12 +2490,18 @@ Name | Type | Description | Notes
2280
2490
 
2281
2491
  ## -[**Workspace**](Workspace.html) put_contentmanagement_workspace(workspace_id, body)
2282
2492
 
2493
+
2494
+
2283
2495
  Update a workspace
2284
2496
 
2285
2497
 
2286
2498
 
2287
2499
  Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}
2288
2500
 
2501
+ Requires NO permissions:
2502
+
2503
+
2504
+
2289
2505
 
2290
2506
  ### Example
2291
2507
  ~~~ruby
@@ -2342,12 +2558,18 @@ Name | Type | Description | Notes
2342
2558
 
2343
2559
  ## -[**WorkspaceMember**](WorkspaceMember.html) put_contentmanagement_workspace_member(workspace_id, member_id, body)
2344
2560
 
2561
+
2562
+
2345
2563
  Add a member to a workspace
2346
2564
 
2347
2565
 
2348
2566
 
2349
2567
  Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
2350
2568
 
2569
+ Requires NO permissions:
2570
+
2571
+
2572
+
2351
2573
 
2352
2574
  ### Example
2353
2575
  ~~~ruby
@@ -2407,12 +2629,18 @@ Name | Type | Description | Notes
2407
2629
 
2408
2630
  ## -[**TagValue**](TagValue.html) put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, body)
2409
2631
 
2632
+
2633
+
2410
2634
  Update a workspace tag. Will update all documents with the new tag value.
2411
2635
 
2412
2636
 
2413
2637
 
2414
2638
  Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
2415
2639
 
2640
+ Requires NO permissions:
2641
+
2642
+
2643
+
2416
2644
 
2417
2645
  ### Example
2418
2646
  ~~~ruby