alfresco_api 1.0.0

data/docs/Company.md

@@ -0,0 +1,15 @@
+# AlfrescoAPI::Company
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**organization** | **String** |  | [optional] 
+**address1** | **String** |  | [optional] 
+**address2** | **String** |  | [optional] 
+**address3** | **String** |  | [optional] 
+**postcode** | **String** |  | [optional] 
+**telephone** | **String** |  | [optional] 
+**fax** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+
+

data/docs/ContentInfo.md

@@ -0,0 +1,11 @@
+# AlfrescoAPI::ContentInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mime_type** | **String** |  | 
+**mime_type_name** | **String** |  | 
+**size_in_bytes** | **Integer** |  | 
+**encoding** | **String** |  | [optional] 
+
+

data/docs/DeletedNode.md

@@ -0,0 +1,27 @@
+# AlfrescoAPI::DeletedNode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |. The character . must not be used at the end of the name.  | 
+**node_type** | **String** |  | 
+**is_folder** | **BOOLEAN** |  | 
+**is_file** | **BOOLEAN** |  | 
+**is_locked** | **BOOLEAN** |  | [optional] [default to false]
+**modified_at** | **DateTime** |  | 
+**modified_by_user** | [**UserInfo**](UserInfo.md) |  | 
+**created_at** | **DateTime** |  | 
+**created_by_user** | [**UserInfo**](UserInfo.md) |  | 
+**parent_id** | **String** |  | [optional] 
+**is_link** | **BOOLEAN** |  | [optional] 
+**content** | [**ContentInfo**](ContentInfo.md) |  | [optional] 
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Object** |  | [optional] 
+**allowable_operations** | **Array<String>** |  | [optional] 
+**path** | [**PathInfo**](PathInfo.md) |  | [optional] 
+**permissions** | [**PermissionsInfo**](PermissionsInfo.md) |  | [optional] 
+**archived_by_user** | [**UserInfo**](UserInfo.md) |  | 
+**archived_at** | **DateTime** |  | 
+
+

data/docs/DeletedNodeEntry.md

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

data/docs/DeletedNodesPaging.md

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

data/docs/DeletedNodesPagingList.md

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

data/docs/Download.md

@@ -0,0 +1,13 @@
+# AlfrescoAPI::Download
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**files_added** | **Integer** | number of files added so far in the zip | [optional] 
+**bytes_added** | **Integer** | number of bytes added so far in the zip | [optional] 
+**id** | **String** | the id of the download node | [optional] 
+**total_files** | **Integer** | the total number of files to be added in the zip | [optional] 
+**total_bytes** | **Integer** | the total number of bytes to be added in the zip | [optional] 
+**status** | **String** | the current status of the download node creation | [optional] [default to "PENDING"]
+
+

data/docs/DownloadBodyCreate.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::DownloadBodyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**node_ids** | **Array<String>** |  | 
+
+

data/docs/DownloadEntry.md

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

data/docs/DownloadsApi.md

@@ -0,0 +1,177 @@
+# AlfrescoAPI::DownloadsApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_download**](DownloadsApi.md#cancel_download) | **DELETE** /downloads/{downloadId} | Cancel a download
+[**create_download**](DownloadsApi.md#create_download) | **POST** /downloads | Create a new download
+[**get_download**](DownloadsApi.md#get_download) | **GET** /downloads/{downloadId} | Get a download
+
+
+# **cancel_download**
+> cancel_download(download_id)
+
+Cancel a download
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Cancels the creation of a download request.  **Note:** The download node can be deleted using the **DELETE /nodes/{downloadId}** endpoint   By default, if the download node is not deleted it will be picked up by a cleaner job which removes download nodes older than a configurable amount of time (default is 1 hour)  Information about the existing progress at the time of cancelling can be retrieved by calling the **GET /downloads/{downloadId}** endpoint  The cancel operation is done asynchronously. 
+
+### 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::DownloadsApi.new
+
+download_id = "download_id_example" # String | The identifier of a download node.
+
+
+begin
+  #Cancel a download
+  api_instance.cancel_download(download_id)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling DownloadsApi->cancel_download: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **download_id** | **String**| The identifier of a download node. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_download**
+> DownloadEntry create_download(download_body_create, opts)
+
+Create a new download
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Creates a new download node asynchronously, the content of which will be the zipped content of the **nodeIds** specified in the JSON body like this:  ```JSON {     \"nodeIds\":      [        \"c8bb482a-ff3c-4704-a3a3-de1c83ccd84c\",        \"cffa62db-aa01-493d-9594-058bc058eeb1\"      ] } ```  **Note:** The content of the download node can be obtained using the **GET /nodes/{downloadId}/content** endpoint         
+
+### 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::DownloadsApi.new
+
+download_body_create = AlfrescoAPI::DownloadBodyCreate.new # DownloadBodyCreate | The nodeIds the content of which will be zipped, which zip will be set as the content of our download node.
+
+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 new download
+  result = api_instance.create_download(download_body_create, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling DownloadsApi->create_download: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **download_body_create** | [**DownloadBodyCreate**](DownloadBodyCreate.md)| The nodeIds the content of which will be zipped, which zip will be set as the content of our download node. | 
+ **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
+
+[**DownloadEntry**](DownloadEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_download**
+> DownloadEntry get_download(download_id, opts)
+
+Get a download
+
+**Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.  Retrieve status information for download node **downloadId** 
+
+### 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::DownloadsApi.new
+
+download_id = "download_id_example" # String | The identifier of a download node.
+
+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
+  #Get a download
+  result = api_instance.get_download(download_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling DownloadsApi->get_download: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **download_id** | **String**| The identifier of a download node. | 
+ **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
+
+[**DownloadEntry**](DownloadEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Error.md

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

data/docs/ErrorError.md

@@ -0,0 +1,13 @@
+# AlfrescoAPI::ErrorError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_key** | **String** |  | [optional] 
+**status_code** | **Integer** |  | 
+**brief_summary** | **String** |  | 
+**stack_trace** | **String** |  | 
+**description_url** | **String** |  | 
+**log_id** | **String** |  | [optional] 
+
+

data/docs/Favorite.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::Favorite
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**target_guid** | **String** | The guid of the object that is a favorite. | 
+**created_at** | **DateTime** | The time the object was made a favorite. | [optional] 
+**target** | **Object** |  | 
+
+

data/docs/FavoriteBodyCreate.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::FavoriteBodyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**target** | **Object** |  | 
+
+

data/docs/FavoriteEntry.md

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

data/docs/FavoritePaging.md

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

data/docs/FavoritePagingList.md

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

data/docs/FavoriteSite.md

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

data/docs/FavoriteSiteBodyCreate.md

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

data/docs/FavoriteSiteEntry.md

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

data/docs/FavoritesApi.md

@@ -0,0 +1,496 @@
+# AlfrescoAPI::FavoritesApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_favorite**](FavoritesApi.md#create_favorite) | **POST** /people/{personId}/favorites | Create a favorite
+[**create_site_favorite**](FavoritesApi.md#create_site_favorite) | **POST** /people/{personId}/favorite-sites | Create a site favorite
+[**delete_favorite**](FavoritesApi.md#delete_favorite) | **DELETE** /people/{personId}/favorites/{favoriteId} | Delete a favorite
+[**delete_site_favorite**](FavoritesApi.md#delete_site_favorite) | **DELETE** /people/{personId}/favorite-sites/{siteId} | Delete a site favorite
+[**get_favorite**](FavoritesApi.md#get_favorite) | **GET** /people/{personId}/favorites/{favoriteId} | Get a favorite
+[**get_favorite_site**](FavoritesApi.md#get_favorite_site) | **GET** /people/{personId}/favorite-sites/{siteId} | Get a favorite site
+[**list_favorite_sites_for_person**](FavoritesApi.md#list_favorite_sites_for_person) | **GET** /people/{personId}/favorite-sites | List favorite sites
+[**list_favorites**](FavoritesApi.md#list_favorites) | **GET** /people/{personId}/favorites | List favorites
+
+
+# **create_favorite**
+> FavoriteEntry create_favorite(person_idfavorite_body_create, opts)
+
+Create a favorite
+
+Favorite a **site**, **file**, or **folder** in the repository.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.  **Note:** You can favorite more than one entity by  specifying a list of objects in the JSON body like this:  ```JSON [   {        \"target\": {           \"file\": {              \"guid\": \"abcde-01234-....\"           }        }    },    {        \"target\": {           \"file\": {              \"guid\": \"abcde-09863-....\"           }        }    }, ] ``` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:  ```JSON {   \"list\": {     \"pagination\": {       \"count\": 2,       \"hasMoreItems\": false,       \"totalItems\": 2,       \"skipCount\": 0,       \"maxItems\": 100     },     \"entries\": [       {         \"entry\": {           ...         }       },       {         \"entry\": {           ...         }       }     ]   } } ``` 
+
+### 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::FavoritesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+favorite_body_create = AlfrescoAPI::FavoriteBodyCreate.new # FavoriteBodyCreate | An object identifying the entity to be favorited.   The object consists of a single property which is an object with the name `site`, `file`, or `folder`.  The content of that object is the `guid` of the target entity.  For example, to favorite a file the following body would be used:  ```JSON {    \"target\": {       \"file\": {          \"guid\": \"abcde-01234-....\"       }    } } ``` 
+
+opts = { 
+  include: ["include_example"], # Array<String> | Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders)   
+  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 favorite
+  result = api_instance.create_favorite(person_idfavorite_body_create, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->create_favorite: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **favorite_body_create** | [**FavoriteBodyCreate**](FavoriteBodyCreate.md)| An object identifying the entity to be favorited.   The object consists of a single property which is an object with the name &#x60;site&#x60;, &#x60;file&#x60;, or &#x60;folder&#x60;.  The content of that object is the &#x60;guid&#x60; of the target entity.  For example, to favorite a file the following body would be used:  &#x60;&#x60;&#x60;JSON {    \&quot;target\&quot;: {       \&quot;file\&quot;: {          \&quot;guid\&quot;: \&quot;abcde-01234-....\&quot;       }    } } &#x60;&#x60;&#x60;  | 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders)    | [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
+
+[**FavoriteEntry**](FavoriteEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_site_favorite**
+> FavoriteSiteEntry create_site_favorite(person_idfavorite_site_body_create, opts)
+
+Create a site favorite
+
+**Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use `/people/{personId}/favorites` instead.  Create a site favorite for person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.   **Note:** You can favorite more than one site by  specifying a list of sites in the JSON body like this:  ```JSON [   {     \"id\": \"test-site-1\"   },   {     \"id\": \"test-site-2\"   } ] ``` If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:  ```JSON {   \"list\": {     \"pagination\": {       \"count\": 2,       \"hasMoreItems\": false,       \"totalItems\": 2,       \"skipCount\": 0,       \"maxItems\": 100     },     \"entries\": [       {         \"entry\": {           ...         }       },       {         \"entry\": {           ...         }       }     ]   } } ``` 
+
+### 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::FavoritesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+favorite_site_body_create = AlfrescoAPI::FavoriteSiteBodyCreate.new # FavoriteSiteBodyCreate | The id of the site to favorite.
+
+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 site favorite
+  result = api_instance.create_site_favorite(person_idfavorite_site_body_create, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->create_site_favorite: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **favorite_site_body_create** | [**FavoriteSiteBodyCreate**](FavoriteSiteBodyCreate.md)| The id of the site to favorite. | 
+ **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
+
+[**FavoriteSiteEntry**](FavoriteSiteEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_favorite**
+> delete_favorite(person_idfavorite_id)
+
+Delete a favorite
+
+Deletes **favoriteId** as a favorite of person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. 
+
+### 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::FavoritesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+favorite_id = "favorite_id_example" # String | The identifier of a favorite.
+
+
+begin
+  #Delete a favorite
+  api_instance.delete_favorite(person_idfavorite_id)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->delete_favorite: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **favorite_id** | **String**| The identifier of a favorite. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_site_favorite**
+> delete_site_favorite(person_idsite_id, )
+
+Delete a site favorite
+
+**Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use `/people/{personId}/favorites/{favoriteId}` instead.  Deletes site **siteId** from the favorite site list of person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. 
+
+### 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::FavoritesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+site_id = "site_id_example" # String | The identifier of a site.
+
+
+begin
+  #Delete a site favorite
+  api_instance.delete_site_favorite(person_idsite_id, )
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->delete_site_favorite: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **site_id** | **String**| The identifier of a site. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_favorite**
+> FavoriteEntry get_favorite(person_idfavorite_id, opts)
+
+Get a favorite
+
+Gets favorite **favoriteId** for person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. 
+
+### 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::FavoritesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+favorite_id = "favorite_id_example" # String | The identifier of a favorite.
+
+opts = { 
+  include: ["include_example"], # Array<String> | Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders)   
+  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 a favorite
+  result = api_instance.get_favorite(person_idfavorite_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->get_favorite: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **favorite_id** | **String**| The identifier of a favorite. | 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders)    | [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
+
+[**FavoriteEntry**](FavoriteEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_favorite_site**
+> SiteEntry get_favorite_site(person_idsite_id, , opts)
+
+Get a favorite site
+
+**Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use `/people/{personId}/favorites/{favoriteId}` instead.  Gets information on favorite site **siteId** of person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. 
+
+### 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::FavoritesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+site_id = "site_id_example" # String | The identifier of a site.
+
+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
+  #Get a favorite site
+  result = api_instance.get_favorite_site(person_idsite_id, , opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->get_favorite_site: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **site_id** | **String**| The identifier of a site. | 
+ **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
+
+[**SiteEntry**](SiteEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_favorite_sites_for_person**
+> SitePaging list_favorite_sites_for_person(person_id, opts)
+
+List favorite sites
+
+**Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use `/people/{personId}/favorites` instead.  Gets a list of a person's favorite sites.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. 
+
+### 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::FavoritesApi.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. 
+  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 favorite sites
+  result = api_instance.list_favorite_sites_for_person(person_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->list_favorite_sites_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]
+ **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
+
+[**SitePaging**](SitePaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_favorites**
+> FavoritePaging list_favorites(person_id, opts)
+
+List favorites
+
+Gets a list of favorites for person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.  You can use the **where** parameter to restrict the list in the response to entries of a specific kind. The **where** parameter takes a value. The value is a single predicate that can include one or more **EXISTS** conditions. The **EXISTS** condition uses a single operand to limit the list to include entries that include that one property. The property values are:  *   `target/file` *   `target/folder` *   `target/site`  For example, the following **where** parameter restricts the returned list to the file favorites for a person:  ```SQL (EXISTS(target/file)) ``` You can specify more than one condition using **OR**. The predicate must be enclosed in parentheses.   For example, the following **where** parameter restricts the returned list to the file and folder favorites for a person:  ```SQL (EXISTS(target/file) OR EXISTS(target/folder)) ``` 
+
+### 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::FavoritesApi.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. 
+  where: "where_example", # String | A string to restrict the returned objects by using a predicate.
+  include: ["include_example"], # Array<String> | Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders)   
+  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 favorites
+  result = api_instance.list_favorites(person_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling FavoritesApi->list_favorites: #{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]
+ **where** | **String**| A string to restrict the returned objects by using a predicate. | [optional] 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about favorites, the following optional fields can be requested: * path (note, this only applies to files and folders)    | [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
+
+[**FavoritePaging**](FavoritePaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+