docs/GroupsApi.md in purecloudplatformclientv2-49.0.0 vs docs/GroupsApi.md in purecloudplatformclientv2-49.0.1
- old
+ new
@@ -24,11 +24,11 @@
[**put_group**](GroupsApi.html#put_group) | Update group
{: class="table table-striped"}
<a name="delete_group"></a>
-## - delete_group(group_id)
+## delete_group(group_id)
Delete group
@@ -41,11 +41,11 @@
* group_administration
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -66,11 +66,11 @@
#Delete group
api_instance.delete_group(group_id)
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->delete_group: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -89,11 +89,11 @@
<a name="delete_group_members"></a>
-## -[**Empty**](Empty.html) delete_group_members(group_id, ids)
+## [**Empty**](Empty.html) delete_group_members(group_id, ids)
Remove members
@@ -104,11 +104,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -132,11 +132,11 @@
result = api_instance.delete_group_members(group_id, ids)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->delete_group_members: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -156,11 +156,11 @@
<a name="get_fieldconfig"></a>
-## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
+## [**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
Fetch field config for an entity type
@@ -171,11 +171,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -197,11 +197,11 @@
result = api_instance.get_fieldconfig(type)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_fieldconfig: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -220,11 +220,11 @@
<a name="get_group"></a>
-## -[**Group**](Group.html) get_group(group_id)
+## [**Group**](Group.html) get_group(group_id)
Get group
@@ -235,11 +235,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -261,11 +261,11 @@
result = api_instance.get_group(group_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_group: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -284,11 +284,11 @@
<a name="get_group_individuals"></a>
-## -[**UserEntityListing**](UserEntityListing.html) get_group_individuals(group_id)
+## [**UserEntityListing**](UserEntityListing.html) get_group_individuals(group_id)
Get all individuals associated with the group
@@ -299,11 +299,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -325,11 +325,11 @@
result = api_instance.get_group_individuals(group_id)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_group_individuals: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -348,11 +348,11 @@
<a name="get_group_members"></a>
-## -[**UserEntityListing**](UserEntityListing.html) get_group_members(group_id, opts)
+## [**UserEntityListing**](UserEntityListing.html) get_group_members(group_id, opts)
Get group members, includes individuals, owners, and dynamically included people
@@ -363,11 +363,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -395,11 +395,11 @@
result = api_instance.get_group_members(group_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_group_members: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -422,11 +422,11 @@
<a name="get_group_profile"></a>
-## -[**GroupProfile**](GroupProfile.html) get_group_profile(group_id, opts)
+## [**GroupProfile**](GroupProfile.html) get_group_profile(group_id, opts)
Get group profile
@@ -437,11 +437,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -466,11 +466,11 @@
result = api_instance.get_group_profile(group_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_group_profile: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -490,11 +490,11 @@
<a name="get_groups"></a>
-## -[**GroupEntityListing**](GroupEntityListing.html) get_groups(opts)
+## [**GroupEntityListing**](GroupEntityListing.html) get_groups(opts)
Get a group list
@@ -505,11 +505,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -535,11 +535,11 @@
result = api_instance.get_groups(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_groups: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -561,11 +561,11 @@
<a name="get_groups_search"></a>
-## -[**GroupsSearchResponse**](GroupsSearchResponse.html) get_groups_search(q64, opts)
+## [**GroupsSearchResponse**](GroupsSearchResponse.html) get_groups_search(q64, opts)
Search groups using the q64 value returned from a previous search
@@ -576,11 +576,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -605,11 +605,11 @@
result = api_instance.get_groups_search(q64, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_groups_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -629,11 +629,11 @@
<a name="get_profiles_groups"></a>
-## -[**GroupProfileEntityListing**](GroupProfileEntityListing.html) get_profiles_groups(opts)
+## [**GroupProfileEntityListing**](GroupProfileEntityListing.html) get_profiles_groups(opts)
Get group profile listing
@@ -644,11 +644,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -674,11 +674,11 @@
result = api_instance.get_profiles_groups(opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->get_profiles_groups: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -700,11 +700,11 @@
<a name="post_group_members"></a>
-## -[**Empty**](Empty.html) post_group_members(group_id, body)
+## [**Empty**](Empty.html) post_group_members(group_id, body)
Add members
@@ -715,11 +715,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -743,11 +743,11 @@
result = api_instance.post_group_members(group_id, body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->post_group_members: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -767,11 +767,11 @@
<a name="post_groups"></a>
-## -[**Group**](Group.html) post_groups(body)
+## [**Group**](Group.html) post_groups(body)
Create a group
@@ -784,11 +784,11 @@
* group_administration
* group_creation
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -810,11 +810,11 @@
result = api_instance.post_groups(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->post_groups: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -833,11 +833,11 @@
<a name="post_groups_search"></a>
-## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_groups_search(body)
+## [**GroupsSearchResponse**](GroupsSearchResponse.html) post_groups_search(body)
Search groups
@@ -848,11 +848,11 @@
Requires NO permissions:
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -874,11 +874,11 @@
result = api_instance.post_groups_search(body)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->post_groups_search: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
@@ -897,11 +897,11 @@
<a name="put_group"></a>
-## -[**Group**](Group.html) put_group(group_id, opts)
+## [**Group**](Group.html) put_group(group_id, opts)
Update group
@@ -914,11 +914,11 @@
* group_administration
* admin
### Example
-~~~ruby
+```{"language":"ruby"}
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
@@ -943,10 +943,10 @@
result = api_instance.put_group(group_id, opts)
p result
rescue PureCloud::ApiError => e
puts "Exception when calling GroupsApi->put_group: #{e}"
end
-~~~
+```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------