alfresco_api 1.0.0

data/docs/Group.md

@@ -0,0 +1,12 @@
+# AlfrescoAPI::Group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**display_name** | **String** |  | 
+**is_root** | **BOOLEAN** |  | [default to true]
+**parent_ids** | **Array<String>** |  | [optional] 
+**zones** | **Array<String>** |  | [optional] 
+
+

data/docs/GroupBodyCreate.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::GroupBodyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**display_name** | **String** |  | 
+**parent_ids** | **Array<String>** |  | [optional] 
+
+

data/docs/GroupBodyUpdate.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::GroupBodyUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** |  | 
+
+

data/docs/GroupEntry.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::GroupEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | [**Group**](Group.md) |  | 
+
+

data/docs/GroupMember.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::GroupMember
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**display_name** | **String** |  | 
+**member_type** | **String** |  | 
+
+

data/docs/GroupMemberEntry.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::GroupMemberEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | [**GroupMember**](GroupMember.md) |  | 
+
+

data/docs/GroupMemberPaging.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::GroupMemberPaging
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | [**GroupMemberPagingList**](GroupMemberPagingList.md) |  | [optional] 
+
+

data/docs/GroupMemberPagingList.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::GroupMemberPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+**entries** | [**Array<GroupMemberEntry>**](GroupMemberEntry.md) |  | [optional] 
+
+

data/docs/GroupMembershipBodyCreate.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::GroupMembershipBodyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**member_type** | **String** |  | 
+
+

data/docs/GroupPaging.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::GroupPaging
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | [**GroupPagingList**](GroupPagingList.md) |  | [optional] 
+
+

data/docs/GroupPagingList.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::GroupPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+**entries** | [**Array<GroupEntry>**](GroupEntry.md) |  | [optional] 
+
+

data/docs/GroupsApi.md

@@ -0,0 +1,564 @@
+# AlfrescoAPI::GroupsApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_group**](GroupsApi.md#create_group) | **POST** /groups | Create a group
+[**create_group_membership**](GroupsApi.md#create_group_membership) | **POST** /groups/{groupId}/members | Create a group membership
+[**delete_group**](GroupsApi.md#delete_group) | **DELETE** /groups/{groupId} | Delete a group
+[**delete_group_membership**](GroupsApi.md#delete_group_membership) | **DELETE** /groups/{groupId}/members/{groupMemberId} | Delete a group membership
+[**get_group**](GroupsApi.md#get_group) | **GET** /groups/{groupId} | Get group details
+[**list_group_memberships**](GroupsApi.md#list_group_memberships) | **GET** /groups/{groupId}/members | List memberships of a group
+[**list_group_memberships_for_person**](GroupsApi.md#list_group_memberships_for_person) | **GET** /people/{personId}/groups | List group memberships
+[**list_groups**](GroupsApi.md#list_groups) | **GET** /groups | List groups
+[**update_group**](GroupsApi.md#update_group) | **PUT** /groups/{groupId} | Update group details
+
+
+# **create_group**
+> GroupEntry create_group(group_body_create, opts)
+
+Create a group
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Create a group.  The group id must start with \"GROUP\\_\". If this is omitted it will be added automatically. This format is also returned when listing groups or group memberships. It should be noted that the other group-related operations also expect the id to start with \"GROUP\\_\".  If one or more parentIds are specified then the group will be created and become a member of each of the specified parent groups.  If no parentIds are specified then the group will be created as a root group.  The group will be created in the **APP.DEFAULT** and **AUTH.ALF** zones.  You must have admin rights to create a group.  
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+group_body_create = AlfrescoAPI::GroupBodyCreate.new # GroupBodyCreate | The group to create.
+
+opts = { 
+  include: ["include_example"], # Array<String> | Returns additional information about the group. The following optional fields can be requested: * parentIds * zones 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #Create a group
+  result = api_instance.create_group(group_body_create, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->create_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_body_create** | [**GroupBodyCreate**](GroupBodyCreate.md)| The group to create. | 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the group. The following optional fields can be requested: * parentIds * zones  | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**GroupEntry**](GroupEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_group_membership**
+> GroupMemberEntry create_group_membership(group_id, group_membership_body_create, opts)
+
+Create a group membership
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Create a group membership (for an existing person or group) within a group **groupId**.  If the added group was previously a root group then it becomes a non-root group since it now has a parent.  It is an error to specify an **id** that does not exist.  You must have admin rights to create a group membership. 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+group_id = "group_id_example" # String | The identifier of a group.
+
+group_membership_body_create = AlfrescoAPI::GroupMembershipBodyCreate.new # GroupMembershipBodyCreate | The group membership to add (person or sub-group).
+
+opts = { 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #Create a group membership
+  result = api_instance.create_group_membership(group_id, group_membership_body_create, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->create_group_membership: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The identifier of a group. | 
+ **group_membership_body_create** | [**GroupMembershipBodyCreate**](GroupMembershipBodyCreate.md)| The group membership to add (person or sub-group). | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**GroupMemberEntry**](GroupMemberEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_group**
+> delete_group(group_id, , opts)
+
+Delete a group
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Delete group **groupId**.   The option to cascade delete applies this recursively to any hierarchy of group members. In this case, removing a group member does not delete the person or sub-group itself. If a removed sub-group no longer has any parent groups then it becomes a root group.  You must have admin rights to delete a group. 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+group_id = "group_id_example" # String | The identifier of a group.
+
+opts = { 
+  cascade: false # BOOLEAN | If **true** then the delete will be applied in cascade to sub-groups. 
+}
+
+begin
+  #Delete a group
+  api_instance.delete_group(group_id, , opts)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->delete_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The identifier of a group. | 
+ **cascade** | **BOOLEAN**| If **true** then the delete will be applied in cascade to sub-groups.  | [optional] [default to false]
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_group_membership**
+> delete_group_membership(group_id, group_member_id)
+
+Delete a group membership
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Delete group member **groupMemberId** (person or sub-group) from group **groupId**.  Removing a group member does not delete the person or sub-group itself.  If a removed sub-group no longer has any parent groups then it becomes a root group.  You must have admin rights to delete a group membership. 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+group_id = "group_id_example" # String | The identifier of a group.
+
+group_member_id = "group_member_id_example" # String | The identifier of a person or group.
+
+
+begin
+  #Delete a group membership
+  api_instance.delete_group_membership(group_id, group_member_id)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->delete_group_membership: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The identifier of a group. | 
+ **group_member_id** | **String**| The identifier of a person or group. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_group**
+> GroupEntry get_group(group_id, , opts)
+
+Get group details
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Get details for group **groupId**.  You can use the **include** parameter to return additional information. 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+group_id = "group_id_example" # String | The identifier of a group.
+
+opts = { 
+  include: ["include_example"], # Array<String> | Returns additional information about the group. The following optional fields can be requested: * parentIds * zones 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #Get group details
+  result = api_instance.get_group(group_id, , opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->get_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The identifier of a group. | 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the group. The following optional fields can be requested: * parentIds * zones  | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**GroupEntry**](GroupEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_group_memberships**
+> GroupMemberPaging list_group_memberships(group_id, , opts)
+
+List memberships of a group
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Gets a list of the group memberships for the group **groupId**.  You can use the **where** parameter to filter the returned groups by **memberType**.  Example to filter by **memberType**, use any one of:  ``` (memberType='GROUP') (memberType='PERSON') ```  The default sort order for the returned list is for group members to be sorted by ascending displayName. You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter: * id * displayName 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+group_id = "group_id_example" # String | The identifier of a group.
+
+opts = { 
+  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0. 
+  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100. 
+  order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. 
+  where: "where_example", # String | A string to restrict the returned objects by using a predicate.
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #List memberships of a group
+  result = api_instance.list_group_memberships(group_id, , opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->list_group_memberships: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The identifier of a group. | 
+ **skip_count** | **Integer**| The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.  | [optional] [default to 0]
+ **max_items** | **Integer**| The maximum number of items to return in the list.  If not supplied then the default value is 100.  | [optional] [default to 100]
+ **order_by** | [**Array&lt;String&gt;**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.  | [optional] 
+ **where** | **String**| A string to restrict the returned objects by using a predicate. | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**GroupMemberPaging**](GroupMemberPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_group_memberships_for_person**
+> GroupPaging list_group_memberships_for_person(person_id, opts)
+
+List group memberships
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.            Gets a list of group membership information for person **personId**.    You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.   You can use the **include** parameter to return additional information.   You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where**  clause will return just the root groups:   ```  (isRoot=true)  ```   The **where** parameter can also be used to filter by ***zone***. This may be combined with isRoot to narrow  a result set even further. For example, the following where clause will only return groups belonging to the  `MY.ZONE` zone.   ```  where=(zones in ('MY.ZONE'))  ```   This may be combined with the isRoot filter, as shown below:   ```  where=(isRoot=false AND zones in ('MY.ZONE'))  ```   ***Note:*** restrictions include  * `AND` is the only supported operator when combining `isRoot` and `zones` filters  * Only one zone is supported by the filter  * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted.    The default sort order for the returned list is for groups to be sorted by ascending displayName.  You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter:  * id  * displayName 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+opts = { 
+  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0. 
+  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100. 
+  order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. 
+  include: ["include_example"], # Array<String> | Returns additional information about the group. The following optional fields can be requested: * parentIds * zones 
+  where: "where_example", # String | A string to restrict the returned objects by using a predicate.
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #List group memberships
+  result = api_instance.list_group_memberships_for_person(person_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->list_group_memberships_for_person: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **skip_count** | **Integer**| The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.  | [optional] [default to 0]
+ **max_items** | **Integer**| The maximum number of items to return in the list.  If not supplied then the default value is 100.  | [optional] [default to 100]
+ **order_by** | [**Array&lt;String&gt;**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.  | [optional] 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the group. The following optional fields can be requested: * parentIds * zones  | [optional] 
+ **where** | **String**| A string to restrict the returned objects by using a predicate. | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**GroupPaging**](GroupPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_groups**
+> GroupPaging list_groups(opts)
+
+List groups
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Gets a list of groups.   You can use the **include** parameter to return additional information.  You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where**  clause will return just the root groups:    ``` (isRoot=true) ```  The **where** parameter can also be used to filter by ***zone***. This may be combined with isRoot to narrow a result set even further. For example, the following where clause will only return groups belonging to the `MY.ZONE` zone.  ``` where=(zones in ('MY.ZONE')) ```  This may be combined with the isRoot filter, as shown below:  ``` where=(isRoot=false AND zones in ('MY.ZONE')) ```  ***Note:*** restrictions include * `AND` is the only supported operator when combining `isRoot` and `zones` filters * Only one zone is supported by the filter * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted.  The default sort order for the returned list is for groups to be sorted by ascending displayName. You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter: * id * displayName 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+opts = { 
+  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0. 
+  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100. 
+  order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. 
+  include: ["include_example"], # Array<String> | Returns additional information about the group. The following optional fields can be requested: * parentIds * zones 
+  where: "where_example", # String | A string to restrict the returned objects by using a predicate.
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #List groups
+  result = api_instance.list_groups(opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->list_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **skip_count** | **Integer**| The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.  | [optional] [default to 0]
+ **max_items** | **Integer**| The maximum number of items to return in the list.  If not supplied then the default value is 100.  | [optional] [default to 100]
+ **order_by** | [**Array&lt;String&gt;**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.  | [optional] 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the group. The following optional fields can be requested: * parentIds * zones  | [optional] 
+ **where** | **String**| A string to restrict the returned objects by using a predicate. | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**GroupPaging**](GroupPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_group**
+> GroupEntry update_group(group_id, group_body_update, opts)
+
+Update group details
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Update details (displayName) for group **groupId**.  You must have admin rights to update a group. 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::GroupsApi.new
+
+group_id = "group_id_example" # String | The identifier of a group.
+
+group_body_update = AlfrescoAPI::GroupBodyUpdate.new # GroupBodyUpdate | The group information to update.
+
+opts = { 
+  include: ["include_example"], # Array<String> | Returns additional information about the group. The following optional fields can be requested: * parentIds * zones 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #Update group details
+  result = api_instance.update_group(group_id, group_body_update, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling GroupsApi->update_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The identifier of a group. | 
+ **group_body_update** | [**GroupBodyUpdate**](GroupBodyUpdate.md)| The group information to update. | 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the group. The following optional fields can be requested: * parentIds * zones  | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**GroupEntry**](GroupEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+