alfresco_api 1.0.0

data/docs/Rating.md

@@ -0,0 +1,11 @@
+# AlfrescoAPI::Rating
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**aggregate** | [**RatingAggregate**](RatingAggregate.md) |  | [optional] 
+**rated_at** | **DateTime** |  | [optional] 
+**my_rating** | **String** | The rating. The type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar. | [optional] 
+
+

data/docs/RatingAggregate.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::RatingAggregate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_ratings** | **Integer** |  | 
+**average** | **Integer** |  | [optional] 
+
+

data/docs/RatingBody.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::RatingBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The rating scheme type. Possible values are likes and fiveStar. | [default to "likes"]
+**my_rating** | **String** | The rating. The type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar | 
+
+

data/docs/RatingEntry.md

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

data/docs/RatingPaging.md

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

data/docs/RatingPagingList.md

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

data/docs/RatingsApi.md

@@ -0,0 +1,248 @@
+# AlfrescoAPI::RatingsApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_rating**](RatingsApi.md#create_rating) | **POST** /nodes/{nodeId}/ratings | Create a rating
+[**delete_rating**](RatingsApi.md#delete_rating) | **DELETE** /nodes/{nodeId}/ratings/{ratingId} | Delete a rating
+[**get_rating**](RatingsApi.md#get_rating) | **GET** /nodes/{nodeId}/ratings/{ratingId} | Get a rating
+[**list_ratings**](RatingsApi.md#list_ratings) | **GET** /nodes/{nodeId}/ratings | List ratings
+
+
+# **create_rating**
+> RatingEntry create_rating(node_idrating_body_create, opts)
+
+Create a rating
+
+Create a rating for the node with identifier **nodeId**
+
+### 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::RatingsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+rating_body_create = AlfrescoAPI::RatingBody.new # RatingBody | For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar.  For example, to \"like\" a file the following body would be used:  ```JSON   {     \"id\": \"likes\",     \"myRating\": true   } ``` 
+
+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 rating
+  result = api_instance.create_rating(node_idrating_body_create, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RatingsApi->create_rating: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **rating_body_create** | [**RatingBody**](RatingBody.md)| For \&quot;myRating\&quot; the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar.  For example, to \&quot;like\&quot; a file the following body would be used:  &#x60;&#x60;&#x60;JSON   {     \&quot;id\&quot;: \&quot;likes\&quot;,     \&quot;myRating\&quot;: true   } &#x60;&#x60;&#x60;  | 
+ **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
+
+[**RatingEntry**](RatingEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_rating**
+> delete_rating(node_idrating_id)
+
+Delete a rating
+
+Deletes rating **ratingId** from node **nodeId**.
+
+### 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::RatingsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+rating_id = "rating_id_example" # String | The identifier of a rating.
+
+
+begin
+  #Delete a rating
+  api_instance.delete_rating(node_idrating_id)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RatingsApi->delete_rating: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **rating_id** | **String**| The identifier of a rating. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_rating**
+> RatingEntry get_rating(node_idrating_id, opts)
+
+Get a rating
+
+Get the specific rating **ratingId** on node **nodeId**.
+
+### 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::RatingsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+rating_id = "rating_id_example" # String | The identifier of a rating.
+
+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 rating
+  result = api_instance.get_rating(node_idrating_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RatingsApi->get_rating: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **rating_id** | **String**| The identifier of a rating. | 
+ **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
+
+[**RatingEntry**](RatingEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_ratings**
+> RatingPaging list_ratings(node_id, opts)
+
+List ratings
+
+Gets a list of ratings for node **nodeId**.
+
+### 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::RatingsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+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 ratings
+  result = api_instance.list_ratings(node_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RatingsApi->list_ratings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **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
+
+[**RatingPaging**](RatingPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Rendition.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::Rendition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**content** | [**ContentInfo**](ContentInfo.md) |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/RenditionBodyCreate.md

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

data/docs/RenditionEntry.md

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

data/docs/RenditionPaging.md

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

data/docs/RenditionPagingList.md

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

data/docs/RenditionsApi.md

@@ -0,0 +1,243 @@
+# AlfrescoAPI::RenditionsApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_rendition**](RenditionsApi.md#create_rendition) | **POST** /nodes/{nodeId}/renditions | Create rendition
+[**get_rendition**](RenditionsApi.md#get_rendition) | **GET** /nodes/{nodeId}/renditions/{renditionId} | Get rendition information
+[**get_rendition_content**](RenditionsApi.md#get_rendition_content) | **GET** /nodes/{nodeId}/renditions/{renditionId}/content | Get rendition content
+[**list_renditions**](RenditionsApi.md#list_renditions) | **GET** /nodes/{nodeId}/renditions | List renditions
+
+
+# **create_rendition**
+> create_rendition(node_idrendition_body_create)
+
+Create rendition
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  An asynchronous request to create a rendition for file **nodeId**.  The rendition is specified by name **id** in the request body: ```JSON {   \"id\":\"doclib\" } ``` 
+
+### 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::RenditionsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+rendition_body_create = AlfrescoAPI::RenditionBodyCreate.new # RenditionBodyCreate | The rendition \"id\".
+
+
+begin
+  #Create rendition
+  api_instance.create_rendition(node_idrendition_body_create)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RenditionsApi->create_rendition: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **rendition_body_create** | [**RenditionBodyCreate**](RenditionBodyCreate.md)| The rendition \"id\". | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_rendition**
+> RenditionEntry get_rendition(node_idrendition_id)
+
+Get rendition information
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets the rendition information for **renditionId** of file **nodeId**. 
+
+### 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::RenditionsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+rendition_id = "rendition_id_example" # String | The name of a thumbnail rendition, for example *doclib*, or *pdf*.
+
+
+begin
+  #Get rendition information
+  result = api_instance.get_rendition(node_idrendition_id)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RenditionsApi->get_rendition: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **rendition_id** | **String**| The name of a thumbnail rendition, for example *doclib*, or *pdf*. | 
+
+### Return type
+
+[**RenditionEntry**](RenditionEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_rendition_content**
+> get_rendition_content(node_idrendition_id, opts)
+
+Get rendition content
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets the rendition content for **renditionId** of file **nodeId**. 
+
+### 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::RenditionsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+rendition_id = "rendition_id_example" # String | The name of a thumbnail rendition, for example *doclib*, or *pdf*.
+
+opts = { 
+  attachment: true, # BOOLEAN | **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file.  You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files.  If the content type is not supported for preview, then a value of **false**  is ignored, and the attachment will be returned in the response. 
+  if_modified_since: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`. 
+  placeholder: false # BOOLEAN | If **true** and there is no rendition for this **nodeId** and **renditionId**,  then the placeholder image for the mime type of this rendition is returned, rather  than a 404 response. 
+}
+
+begin
+  #Get rendition content
+  api_instance.get_rendition_content(node_idrendition_id, opts)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RenditionsApi->get_rendition_content: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **rendition_id** | **String**| The name of a thumbnail rendition, for example *doclib*, or *pdf*. | 
+ **attachment** | **BOOLEAN**| **true** enables a web browser to download the file as an attachment. **false** means a web browser may preview the file in a new tab or window, but not download the file.  You can only set this parameter to **false** if the content type of the file is in the supported list; for example, certain image files and PDF files.  If the content type is not supported for preview, then a value of **false**  is ignored, and the attachment will be returned in the response.  | [optional] [default to true]
+ **if_modified_since** | **DateTime**| Only returns the content if it has been modified since the date provided. Use the date format defined by HTTP. For example, `Wed, 09 Mar 2016 16:56:34 GMT`.  | [optional] 
+ **placeholder** | **BOOLEAN**| If **true** and there is no rendition for this **nodeId** and **renditionId**,  then the placeholder image for the mime type of this rendition is returned, rather  than a 404 response.  | [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
+
+
+
+# **list_renditions**
+> RenditionPaging list_renditions(node_id, opts)
+
+List renditions
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets a list of the rendition information for each rendition of the the file **nodeId**, including the rendition id.  Each rendition returned has a **status**: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested.  You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where**  clause will return just the CREATED renditions:    ``` (status='CREATED') ``` 
+
+### 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::RenditionsApi.new
+
+node_id = "node_id_example" # String | The identifier of a node.
+
+opts = { 
+  where: "where_example", # String | A string to restrict the returned objects by using a predicate.
+}
+
+begin
+  #List renditions
+  result = api_instance.list_renditions(node_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling RenditionsApi->list_renditions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **node_id** | **String**| The identifier of a node. | 
+ **where** | **String**| A string to restrict the returned objects by using a predicate. | [optional] 
+
+### Return type
+
+[**RenditionPaging**](RenditionPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+