docs/ContentManagementApi.md in purecloudplatformclientv2-49.0.0 vs docs/ContentManagementApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -48,11 +48,11 @@
[**put_contentmanagement_workspace_tagvalue**](ContentManagementApi.html#put_contentmanagement_workspace_tagvalue) | Update a workspace tag. Will update all documents with the new tag value.
{: class="table table-striped"}
<a name="delete_contentmanagement_document"></a>
-## - delete_contentmanagement_document(document_id, opts)
+## delete_contentmanagement_document(document_id, opts)
Delete a document.
@@ -63,11 +63,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -91,11 +91,11 @@
#Delete a document.
api_instance.delete_contentmanagement_document(document_id, opts)
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->delete_contentmanagement_document: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -115,11 +115,11 @@
<a name="delete_contentmanagement_share"></a>
-## - delete_contentmanagement_share(share_id)
+## delete_contentmanagement_share(share_id)
Deletes an existing share.
@@ -130,11 +130,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -155,11 +155,11 @@
#Deletes an existing share.
api_instance.delete_contentmanagement_share(share_id)
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->delete_contentmanagement_share: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -178,11 +178,11 @@
<a name="delete_contentmanagement_status_status_id"></a>
-## - delete_contentmanagement_status_status_id(status_id)
+## delete_contentmanagement_status_status_id(status_id)
Cancel the command for this status
@@ -193,11 +193,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -218,11 +218,11 @@
#Cancel the command for this status
api_instance.delete_contentmanagement_status_status_id(status_id)
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->delete_contentmanagement_status_status_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -241,11 +241,11 @@
<a name="delete_contentmanagement_workspace"></a>
-## - delete_contentmanagement_workspace(workspace_id, opts)
+## delete_contentmanagement_workspace(workspace_id, opts)
Delete a workspace
@@ -256,11 +256,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -284,11 +284,11 @@
#Delete a workspace
api_instance.delete_contentmanagement_workspace(workspace_id, opts)
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->delete_contentmanagement_workspace: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -308,11 +308,11 @@
<a name="delete_contentmanagement_workspace_member"></a>
-## - delete_contentmanagement_workspace_member(workspace_id, member_id)
+## delete_contentmanagement_workspace_member(workspace_id, member_id)
Delete a member from a workspace
@@ -323,11 +323,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -350,11 +350,11 @@
#Delete a member from a workspace
api_instance.delete_contentmanagement_workspace_member(workspace_id, member_id)
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->delete_contentmanagement_workspace_member: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -374,11 +374,11 @@
<a name="delete_contentmanagement_workspace_tagvalue"></a>
-## - delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id)
+## delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id)
Delete workspace tag
@@ -389,11 +389,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -416,11 +416,11 @@
#Delete workspace tag
api_instance.delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id)
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->delete_contentmanagement_workspace_tagvalue: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -440,11 +440,11 @@
<a name="get_contentmanagement_document"></a>
-## -[**Document**](Document.html) get_contentmanagement_document(document_id, opts)
+## [**Document**](Document.html) get_contentmanagement_document(document_id, opts)
Get a document.
@@ -455,11 +455,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -484,11 +484,11 @@
result = api_instance.get_contentmanagement_document(document_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_document: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -508,11 +508,11 @@
<a name="get_contentmanagement_document_audits"></a>
-## -[**DocumentAuditEntityListing**](DocumentAuditEntityListing.html) get_contentmanagement_document_audits(document_id, opts)
+## [**DocumentAuditEntityListing**](DocumentAuditEntityListing.html) get_contentmanagement_document_audits(document_id, opts)
Get a list of audits for a document.
@@ -523,11 +523,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -557,11 +557,11 @@
result = api_instance.get_contentmanagement_document_audits(document_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_document_audits: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -586,11 +586,11 @@
<a name="get_contentmanagement_document_content"></a>
-## -[**DownloadResponse**](DownloadResponse.html) get_contentmanagement_document_content(document_id, opts)
+## [**DownloadResponse**](DownloadResponse.html) get_contentmanagement_document_content(document_id, opts)
Download a document.
@@ -601,11 +601,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -631,11 +631,11 @@
result = api_instance.get_contentmanagement_document_content(document_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_document_content: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -656,11 +656,11 @@
<a name="get_contentmanagement_documents"></a>
-## -[**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_documents(workspace_id, opts)
+## [**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_documents(workspace_id, opts)
<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>
Get a list of documents.
@@ -671,11 +671,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -705,11 +705,11 @@
result = api_instance.get_contentmanagement_documents(workspace_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_documents: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -734,11 +734,11 @@
<a name="get_contentmanagement_query"></a>
-## -[**QueryResults**](QueryResults.html) get_contentmanagement_query(query_phrase, opts)
+## [**QueryResults**](QueryResults.html) get_contentmanagement_query(query_phrase, opts)
Query content
@@ -749,11 +749,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -782,11 +782,11 @@
result = api_instance.get_contentmanagement_query(query_phrase, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_query: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -810,11 +810,11 @@
<a name="get_contentmanagement_securityprofile"></a>
-## -[**SecurityProfile**](SecurityProfile.html) get_contentmanagement_securityprofile(security_profile_id)
+## [**SecurityProfile**](SecurityProfile.html) get_contentmanagement_securityprofile(security_profile_id)
Get a Security Profile
@@ -825,11 +825,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -851,11 +851,11 @@
result = api_instance.get_contentmanagement_securityprofile(security_profile_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_securityprofile: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -874,11 +874,11 @@
<a name="get_contentmanagement_securityprofiles"></a>
-## -[**SecurityProfileEntityListing**](SecurityProfileEntityListing.html) get_contentmanagement_securityprofiles
+## [**SecurityProfileEntityListing**](SecurityProfileEntityListing.html) get_contentmanagement_securityprofiles
Get a List of Security Profiles
@@ -889,11 +889,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -912,11 +912,11 @@
result = api_instance.get_contentmanagement_securityprofiles
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_securityprofiles: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -932,11 +932,11 @@
<a name="get_contentmanagement_share"></a>
-## -[**Share**](Share.html) get_contentmanagement_share(share_id, opts)
+## [**Share**](Share.html) get_contentmanagement_share(share_id, opts)
Retrieve details about an existing share.
@@ -947,11 +947,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -976,11 +976,11 @@
result = api_instance.get_contentmanagement_share(share_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_share: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1000,11 +1000,11 @@
<a name="get_contentmanagement_shared_shared_id"></a>
-## -[**SharedResponse**](SharedResponse.html) get_contentmanagement_shared_shared_id(shared_id, opts)
+## [**SharedResponse**](SharedResponse.html) get_contentmanagement_shared_shared_id(shared_id, opts)
Get shared documents. Securely download a shared document.
@@ -1015,11 +1015,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1047,11 +1047,11 @@
result = api_instance.get_contentmanagement_shared_shared_id(shared_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_shared_shared_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1074,11 +1074,11 @@
<a name="get_contentmanagement_shares"></a>
-## -[**ShareEntityListing**](ShareEntityListing.html) get_contentmanagement_shares(opts)
+## [**ShareEntityListing**](ShareEntityListing.html) get_contentmanagement_shares(opts)
Gets a list of shares. You must specify at least one filter (e.g. entityId).
@@ -1089,11 +1089,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1119,11 +1119,11 @@
result = api_instance.get_contentmanagement_shares(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_shares: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1145,11 +1145,11 @@
<a name="get_contentmanagement_status"></a>
-## -[**CommandStatusEntityListing**](CommandStatusEntityListing.html) get_contentmanagement_status(opts)
+## [**CommandStatusEntityListing**](CommandStatusEntityListing.html) get_contentmanagement_status(opts)
Get a list of statuses for pending operations
@@ -1160,11 +1160,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1188,11 +1188,11 @@
result = api_instance.get_contentmanagement_status(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_status: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1212,11 +1212,11 @@
<a name="get_contentmanagement_status_status_id"></a>
-## -[**CommandStatus**](CommandStatus.html) get_contentmanagement_status_status_id(status_id)
+## [**CommandStatus**](CommandStatus.html) get_contentmanagement_status_status_id(status_id)
Get a status.
@@ -1227,11 +1227,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1253,11 +1253,11 @@
result = api_instance.get_contentmanagement_status_status_id(status_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_status_status_id: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1276,11 +1276,11 @@
<a name="get_contentmanagement_usage"></a>
-## -[**Usage**](Usage.html) get_contentmanagement_usage
+## [**Usage**](Usage.html) get_contentmanagement_usage
Get usage details.
@@ -1291,11 +1291,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1314,11 +1314,11 @@
result = api_instance.get_contentmanagement_usage
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_usage: #{e}"
end
-~~~
+```
### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}
@@ -1334,11 +1334,11 @@
<a name="get_contentmanagement_workspace"></a>
-## -[**Workspace**](Workspace.html) get_contentmanagement_workspace(workspace_id, opts)
+## [**Workspace**](Workspace.html) get_contentmanagement_workspace(workspace_id, opts)
Get a workspace.
@@ -1349,11 +1349,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1378,11 +1378,11 @@
result = api_instance.get_contentmanagement_workspace(workspace_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_workspace: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1402,11 +1402,11 @@
<a name="get_contentmanagement_workspace_documents"></a>
-## -[**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_workspace_documents(workspace_id, opts)
+## [**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_workspace_documents(workspace_id, opts)
Get a list of documents.
@@ -1417,11 +1417,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1450,11 +1450,11 @@
result = api_instance.get_contentmanagement_workspace_documents(workspace_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_workspace_documents: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1478,11 +1478,11 @@
<a name="get_contentmanagement_workspace_member"></a>
-## -[**WorkspaceMember**](WorkspaceMember.html) get_contentmanagement_workspace_member(workspace_id, member_id, opts)
+## [**WorkspaceMember**](WorkspaceMember.html) get_contentmanagement_workspace_member(workspace_id, member_id, opts)
Get a workspace member
@@ -1493,11 +1493,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1524,11 +1524,11 @@
result = api_instance.get_contentmanagement_workspace_member(workspace_id, member_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_workspace_member: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1549,11 +1549,11 @@
<a name="get_contentmanagement_workspace_members"></a>
-## -[**WorkspaceMemberEntityListing**](WorkspaceMemberEntityListing.html) get_contentmanagement_workspace_members(workspace_id, opts)
+## [**WorkspaceMemberEntityListing**](WorkspaceMemberEntityListing.html) get_contentmanagement_workspace_members(workspace_id, opts)
Get a list workspace members
@@ -1564,11 +1564,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1595,11 +1595,11 @@
result = api_instance.get_contentmanagement_workspace_members(workspace_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_workspace_members: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1621,11 +1621,11 @@
<a name="get_contentmanagement_workspace_tagvalue"></a>
-## -[**TagValue**](TagValue.html) get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts)
+## [**TagValue**](TagValue.html) get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts)
Get a workspace tag
@@ -1636,11 +1636,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1667,11 +1667,11 @@
result = api_instance.get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_workspace_tagvalue: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1692,11 +1692,11 @@
<a name="get_contentmanagement_workspace_tagvalues"></a>
-## -[**TagValueEntityListing**](TagValueEntityListing.html) get_contentmanagement_workspace_tagvalues(workspace_id, opts)
+## [**TagValueEntityListing**](TagValueEntityListing.html) get_contentmanagement_workspace_tagvalues(workspace_id, opts)
Get a list of workspace tags
@@ -1707,11 +1707,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1739,11 +1739,11 @@
result = api_instance.get_contentmanagement_workspace_tagvalues(workspace_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_workspace_tagvalues: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1766,11 +1766,11 @@
<a name="get_contentmanagement_workspaces"></a>
-## -[**WorkspaceEntityListing**](WorkspaceEntityListing.html) get_contentmanagement_workspaces(opts)
+## [**WorkspaceEntityListing**](WorkspaceEntityListing.html) get_contentmanagement_workspaces(opts)
Get a list of workspaces.
@@ -1781,11 +1781,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1811,11 +1811,11 @@
result = api_instance.get_contentmanagement_workspaces(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->get_contentmanagement_workspaces: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1837,11 +1837,11 @@
<a name="post_contentmanagement_auditquery"></a>
-## -[**QueryResults**](QueryResults.html) post_contentmanagement_auditquery(body)
+## [**QueryResults**](QueryResults.html) post_contentmanagement_auditquery(body)
Query audits
@@ -1852,11 +1852,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1878,11 +1878,11 @@
result = api_instance.post_contentmanagement_auditquery(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_auditquery: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1901,11 +1901,11 @@
<a name="post_contentmanagement_document"></a>
-## -[**Document**](Document.html) post_contentmanagement_document(document_id, body, opts)
+## [**Document**](Document.html) post_contentmanagement_document(document_id, body, opts)
Update a document.
@@ -1916,11 +1916,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -1948,11 +1948,11 @@
result = api_instance.post_contentmanagement_document(document_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_document: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -1974,11 +1974,11 @@
<a name="post_contentmanagement_document_content"></a>
-## -[**ReplaceResponse**](ReplaceResponse.html) post_contentmanagement_document_content(document_id, body, opts)
+## [**ReplaceResponse**](ReplaceResponse.html) post_contentmanagement_document_content(document_id, body, opts)
Replace the contents of a document.
@@ -1989,11 +1989,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2020,11 +2020,11 @@
result = api_instance.post_contentmanagement_document_content(document_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_document_content: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2045,11 +2045,11 @@
<a name="post_contentmanagement_documents"></a>
-## -[**Document**](Document.html) post_contentmanagement_documents(body, opts)
+## [**Document**](Document.html) post_contentmanagement_documents(body, opts)
Add a document.
@@ -2060,11 +2060,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2091,11 +2091,11 @@
result = api_instance.post_contentmanagement_documents(body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_documents: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2117,11 +2117,11 @@
<a name="post_contentmanagement_query"></a>
-## -[**QueryResults**](QueryResults.html) post_contentmanagement_query(body, opts)
+## [**QueryResults**](QueryResults.html) post_contentmanagement_query(body, opts)
Query content
@@ -2132,11 +2132,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2161,11 +2161,11 @@
result = api_instance.post_contentmanagement_query(body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_query: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2185,11 +2185,11 @@
<a name="post_contentmanagement_shares"></a>
-## -[**CreateShareResponse**](CreateShareResponse.html) post_contentmanagement_shares(body)
+## [**CreateShareResponse**](CreateShareResponse.html) post_contentmanagement_shares(body)
Creates a new share or updates an existing share if the entity has already been shared
@@ -2200,11 +2200,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2226,11 +2226,11 @@
result = api_instance.post_contentmanagement_shares(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_shares: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2249,11 +2249,11 @@
<a name="post_contentmanagement_workspace_tagvalues"></a>
-## -[**TagValue**](TagValue.html) post_contentmanagement_workspace_tagvalues(workspace_id, body)
+## [**TagValue**](TagValue.html) post_contentmanagement_workspace_tagvalues(workspace_id, body)
Create a workspace tag
@@ -2264,11 +2264,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2292,11 +2292,11 @@
result = api_instance.post_contentmanagement_workspace_tagvalues(workspace_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_workspace_tagvalues: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2316,11 +2316,11 @@
<a name="post_contentmanagement_workspace_tagvalues_query"></a>
-## -[**TagValueEntityListing**](TagValueEntityListing.html) post_contentmanagement_workspace_tagvalues_query(workspace_id, body, opts)
+## [**TagValueEntityListing**](TagValueEntityListing.html) post_contentmanagement_workspace_tagvalues_query(workspace_id, body, opts)
Perform a prefix query on tags in the workspace
@@ -2331,11 +2331,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2362,11 +2362,11 @@
result = api_instance.post_contentmanagement_workspace_tagvalues_query(workspace_id, body, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_workspace_tagvalues_query: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2387,11 +2387,11 @@
<a name="post_contentmanagement_workspaces"></a>
-## -[**Workspace**](Workspace.html) post_contentmanagement_workspaces(body)
+## [**Workspace**](Workspace.html) post_contentmanagement_workspaces(body)
Create a group workspace
@@ -2402,11 +2402,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2428,11 +2428,11 @@
result = api_instance.post_contentmanagement_workspaces(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->post_contentmanagement_workspaces: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2451,11 +2451,11 @@
<a name="put_contentmanagement_workspace"></a>
-## -[**Workspace**](Workspace.html) put_contentmanagement_workspace(workspace_id, body)
+## [**Workspace**](Workspace.html) put_contentmanagement_workspace(workspace_id, body)
Update a workspace
@@ -2466,11 +2466,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2494,11 +2494,11 @@
result = api_instance.put_contentmanagement_workspace(workspace_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->put_contentmanagement_workspace: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2518,11 +2518,11 @@
<a name="put_contentmanagement_workspace_member"></a>
-## -[**WorkspaceMember**](WorkspaceMember.html) put_contentmanagement_workspace_member(workspace_id, member_id, body)
+## [**WorkspaceMember**](WorkspaceMember.html) put_contentmanagement_workspace_member(workspace_id, member_id, body)
Add a member to a workspace
@@ -2533,11 +2533,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2563,11 +2563,11 @@
result = api_instance.put_contentmanagement_workspace_member(workspace_id, member_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->put_contentmanagement_workspace_member: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -2588,11 +2588,11 @@
<a name="put_contentmanagement_workspace_tagvalue"></a>
-## -[**TagValue**](TagValue.html) put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, body)
+## [**TagValue**](TagValue.html) put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, body)
Update a workspace tag. Will update all documents with the new tag value.
@@ -2603,11 +2603,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -2633,10 +2633,10 @@
result = api_instance.put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling ContentManagementApi->put_contentmanagement_workspace_tagvalue: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------