docs/GroupsApi.md in purecloudplatformclientv2-34.0.0 vs docs/GroupsApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -26,17 +26,23 @@
<a name="delete_group"></a>
## - delete_group(group_id)
+
+
Delete group
Wraps DELETE /api/v2/groups/{groupId}
+Requires ANY permissions:
+* group_administration
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -84,17 +90,23 @@
<a name="delete_group_members"></a>
## -[**Empty**](Empty.html) delete_group_members(group_id, ids)
+
+
Remove members
Wraps DELETE /api/v2/groups/{groupId}/members
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -146,17 +158,23 @@
<a name="get_fieldconfig"></a>
## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
+
+
Fetch field config for an entity type
Wraps GET /api/v2/fieldconfig
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -205,17 +223,23 @@
<a name="get_group"></a>
## -[**Group**](Group.html) get_group(group_id)
+
+
Get group
Wraps GET /api/v2/groups/{groupId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -264,17 +288,23 @@
<a name="get_group_individuals"></a>
## -[**UserEntityListing**](UserEntityListing.html) get_group_individuals(group_id)
+
+
Get all individuals associated with the group
Wraps GET /api/v2/groups/{groupId}/individuals
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -323,17 +353,23 @@
<a name="get_group_members"></a>
## -[**UserEntityListing**](UserEntityListing.html) get_group_members(group_id, opts)
+
+
Get group members, includes individuals, owners, and dynamically included people
Wraps GET /api/v2/groups/{groupId}/members
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -392,17 +428,23 @@
<a name="get_group_profile"></a>
## -[**GroupProfile**](GroupProfile.html) get_group_profile(group_id, opts)
+
+
Get group profile
Wraps GET /api/v2/groups/{groupId}/profile
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -455,17 +497,23 @@
<a name="get_groups"></a>
## -[**GroupEntityListing**](GroupEntityListing.html) get_groups(opts)
+
+
Get a group list
Wraps GET /api/v2/groups
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -521,17 +569,23 @@
<a name="get_groups_search"></a>
## -[**GroupsSearchResponse**](GroupsSearchResponse.html) get_groups_search(q64, opts)
+
+
Search groups using the q64 value returned from a previous search
Wraps GET /api/v2/groups/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -584,17 +638,23 @@
<a name="get_profiles_groups"></a>
## -[**GroupProfileEntityListing**](GroupProfileEntityListing.html) get_profiles_groups(opts)
+
+
Get group profile listing
Wraps GET /api/v2/profiles/groups
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -650,17 +710,23 @@
<a name="post_group_members"></a>
## -[**Empty**](Empty.html) post_group_members(group_id, body)
+
+
Add members
Wraps POST /api/v2/groups/{groupId}/members
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -712,17 +778,23 @@
<a name="post_groups"></a>
## -[**Group**](Group.html) post_groups(body)
+
+
Create a group
Wraps POST /api/v2/groups
+Requires ANY permissions:
+* group_administration* group_creation
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -771,17 +843,23 @@
<a name="post_groups_search"></a>
## -[**GroupsSearchResponse**](GroupsSearchResponse.html) post_groups_search(body)
+
+
Search groups
Wraps POST /api/v2/groups/search
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -830,14 +908,20 @@
<a name="put_group"></a>
## -[**Group**](Group.html) put_group(group_id, opts)
+
+
Update group
Wraps PUT /api/v2/groups/{groupId}
+
+Requires ANY permissions:
+
+* group_administration
### Example
~~~ruby
# load the gem