alfresco_api 1.0.0

data/docs/RevertBody.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::RevertBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**major_version** | **BOOLEAN** |  | [optional] 
+**comment** | **String** |  | [optional] 
+
+

data/docs/SharedLink.md

@@ -0,0 +1,19 @@
+# AlfrescoAPI::SharedLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**expires_at** | **DateTime** |  | [optional] 
+**node_id** | **String** |  | [optional] 
+**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.  | [optional] 
+**title** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**modified_at** | **DateTime** |  | [optional] 
+**modified_by_user** | [**UserInfo**](UserInfo.md) |  | [optional] 
+**shared_by_user** | [**UserInfo**](UserInfo.md) |  | [optional] 
+**content** | [**ContentInfo**](ContentInfo.md) |  | [optional] 
+**allowable_operations** | **Array<String>** | The allowable operations for the Quickshare link itself. See allowableOperationsOnTarget for the allowable operations pertaining to the linked content node.  | [optional] 
+**allowable_operations_on_target** | **Array<String>** | The allowable operations for the content node being shared.  | [optional] 
+
+

data/docs/SharedLinkBodyCreate.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::SharedLinkBodyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**node_id** | **String** |  | 
+**expires_at** | **DateTime** |  | [optional] 
+
+

data/docs/SharedLinkBodyEmail.md

@@ -0,0 +1,11 @@
+# AlfrescoAPI::SharedLinkBodyEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**locale** | **String** |  | [optional] 
+**recipient_emails** | **Array<String>** |  | [optional] 
+
+

data/docs/SharedLinkEntry.md

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

data/docs/SharedLinkPaging.md

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

data/docs/SharedLinkPagingList.md

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

data/docs/SharedlinksApi.md

@@ -0,0 +1,530 @@
+# AlfrescoAPI::SharedlinksApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_shared_link**](SharedlinksApi.md#create_shared_link) | **POST** /shared-links | Create a shared link to a file
+[**delete_shared_link**](SharedlinksApi.md#delete_shared_link) | **DELETE** /shared-links/{sharedId} | Deletes a shared link
+[**email_shared_link**](SharedlinksApi.md#email_shared_link) | **POST** /shared-links/{sharedId}/email | Email shared link
+[**get_shared_link**](SharedlinksApi.md#get_shared_link) | **GET** /shared-links/{sharedId} | Get a shared link
+[**get_shared_link_content**](SharedlinksApi.md#get_shared_link_content) | **GET** /shared-links/{sharedId}/content | Get shared link content
+[**get_shared_link_rendition**](SharedlinksApi.md#get_shared_link_rendition) | **GET** /shared-links/{sharedId}/renditions/{renditionId} | Get shared link rendition information
+[**get_shared_link_rendition_content**](SharedlinksApi.md#get_shared_link_rendition_content) | **GET** /shared-links/{sharedId}/renditions/{renditionId}/content | Get shared link rendition content
+[**list_shared_link_renditions**](SharedlinksApi.md#list_shared_link_renditions) | **GET** /shared-links/{sharedId}/renditions | List renditions for a shared link
+[**list_shared_links**](SharedlinksApi.md#list_shared_links) | **GET** /shared-links | List shared links
+
+
+# **create_shared_link**
+> SharedLinkEntry create_shared_link(shared_link_body_create, opts)
+
+Create a shared link to a file
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Create a shared link to the file **nodeId** in the request body. Also, an optional expiry date could be set, so the shared link would become invalid when the expiry date is reached. For example:  ```JSON   {     \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-3333333333\",     \"expiresAt\": \"2017-03-23T23:00:00.000+0000\"   } ```  **Note:** You can create shared links to more than one file  specifying a list of **nodeId**s in the JSON body like this:  ```JSON [   {     \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-4444444444\"   },   {                 \"nodeId\": \"1ff9da1a-ee2f-4b9c-8c34-5555555555\"   } ] ``` 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::SharedlinksApi.new
+
+shared_link_body_create = AlfrescoAPI::SharedLinkBodyCreate.new # SharedLinkBodyCreate | The nodeId to create a shared link for.
+
+opts = { 
+  include: ["include_example"], # Array<String> | Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path 
+  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 shared link to a file
+  result = api_instance.create_shared_link(shared_link_body_create, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->create_shared_link: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_link_body_create** | [**SharedLinkBodyCreate**](SharedLinkBodyCreate.md)| The nodeId to create a shared link for. | 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path  | [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
+
+[**SharedLinkEntry**](SharedLinkEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_shared_link**
+> delete_shared_link(shared_id, )
+
+Deletes a shared link
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Deletes the shared link with identifier **sharedId**. 
+
+### 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::SharedlinksApi.new
+
+shared_id = "shared_id_example" # String | The identifier of a shared link to a file.
+
+
+begin
+  #Deletes a shared link
+  api_instance.delete_shared_link(shared_id, )
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->delete_shared_link: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_id** | **String**| The identifier of a shared link to a file. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **email_shared_link**
+> email_shared_link(shared_id, shared_link_body_email)
+
+Email shared link
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Sends email with app-specific url including identifier **sharedId**.  The client and recipientEmails properties are mandatory in the request body. For example, to email a shared link with minimum info: ```JSON {     \"client\": \"myClient\",     \"recipientEmails\": [\"john.doe@acme.com\", \"joe.bloggs@acme.com\"] } ``` A plain text message property can be optionally provided in the request body to customise the sent email. Also, a locale property can be optionally provided in the request body to send the emails in a particular language (if the locale is supported by Alfresco). For example, to email a shared link with a messages and a locale: ```JSON {     \"client\": \"myClient\",     \"recipientEmails\": [\"john.doe@acme.com\", \"joe.bloggs@acme.com\"],     \"message\": \"myMessage\",     \"locale\":\"en-GB\" } ``` **Note:** The client must be registered before you can send a shared link email. See [server documentation]. However, out-of-the-box  share is registered as a default client, so you could pass **share** as the client name: ```JSON {     \"client\": \"share\",     \"recipientEmails\": [\"john.doe@acme.com\"] } ``` 
+
+### 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::SharedlinksApi.new
+
+shared_id = "shared_id_example" # String | The identifier of a shared link to a file.
+
+shared_link_body_email = AlfrescoAPI::SharedLinkBodyEmail.new # SharedLinkBodyEmail | The shared link email to send.
+
+
+begin
+  #Email shared link
+  api_instance.email_shared_link(shared_id, shared_link_body_email)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->email_shared_link: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_id** | **String**| The identifier of a shared link to a file. | 
+ **shared_link_body_email** | [**SharedLinkBodyEmail**](SharedLinkBodyEmail.md)| The shared link email to send. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_shared_link**
+> SharedLinkEntry get_shared_link(shared_id, , opts)
+
+Get a shared link
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets minimal information for the file with shared link identifier **sharedId**.  **Note:** No authentication is required to call this 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::SharedlinksApi.new
+
+shared_id = "shared_id_example" # String | The identifier of a shared link to a file.
+
+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 shared link
+  result = api_instance.get_shared_link(shared_id, , opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->get_shared_link: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_id** | **String**| The identifier of a shared link to a file. | 
+ **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
+
+[**SharedLinkEntry**](SharedLinkEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_shared_link_content**
+> get_shared_link_content(shared_id, , opts)
+
+Get shared link content
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets the content of the file with shared link identifier **sharedId**.  **Note:** No authentication is required to call this 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::SharedlinksApi.new
+
+shared_id = "shared_id_example" # String | The identifier of a shared link to a file.
+
+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`. 
+}
+
+begin
+  #Get shared link content
+  api_instance.get_shared_link_content(shared_id, , opts)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->get_shared_link_content: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_id** | **String**| The identifier of a shared link to a file. | 
+ **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, &#x60;Wed, 09 Mar 2016 16:56:34 GMT&#x60;.  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_shared_link_rendition**
+> RenditionEntry get_shared_link_rendition(shared_id, rendition_id)
+
+Get shared link rendition information
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets rendition information for the file with shared link identifier **sharedId**.  This API method returns rendition information where the rendition status is CREATED,  which means the rendition is available to view/download.  **Note:** No authentication is required to call this 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::SharedlinksApi.new
+
+shared_id = "shared_id_example" # String | The identifier of a shared link to a file.
+
+rendition_id = "rendition_id_example" # String | The name of a thumbnail rendition, for example *doclib*, or *pdf*.
+
+
+begin
+  #Get shared link rendition information
+  result = api_instance.get_shared_link_rendition(shared_id, rendition_id)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->get_shared_link_rendition: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_id** | **String**| The identifier of a shared link to a file. | 
+ **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_shared_link_rendition_content**
+> get_shared_link_rendition_content(shared_id, rendition_id, opts)
+
+Get shared link rendition content
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets the rendition content for file with shared link identifier **sharedId**.  **Note:** No authentication is required to call this 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::SharedlinksApi.new
+
+shared_id = "shared_id_example" # String | The identifier of a shared link to a file.
+
+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`. 
+}
+
+begin
+  #Get shared link rendition content
+  api_instance.get_shared_link_rendition_content(shared_id, rendition_id, opts)
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->get_shared_link_rendition_content: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_id** | **String**| The identifier of a shared link to a file. | 
+ **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, &#x60;Wed, 09 Mar 2016 16:56:34 GMT&#x60;.  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_shared_link_renditions**
+> RenditionPaging list_shared_link_renditions(shared_id, )
+
+List renditions for a shared link
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets a list of the rendition information for the file with shared link identifier **sharedId**.  This API method returns rendition information, including the rendition id, for each rendition where the rendition status is CREATED, which means the rendition is available to view/download.  **Note:** No authentication is required to call this 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::SharedlinksApi.new
+
+shared_id = "shared_id_example" # String | The identifier of a shared link to a file.
+
+
+begin
+  #List renditions for a shared link
+  result = api_instance.list_shared_link_renditions(shared_id, )
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->list_shared_link_renditions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shared_id** | **String**| The identifier of a shared link to a file. | 
+
+### Return type
+
+[**RenditionPaging**](RenditionPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_shared_links**
+> SharedLinkPaging list_shared_links(opts)
+
+List shared links
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Get a list of links that the current user has read permission on source node.  The list is ordered in descending modified order.  **Note:** The list of links is eventually consistent so newly created shared links may not appear immediately. 
+
+### 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::SharedlinksApi.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. 
+  where: "where_example", # String | Optionally filter the list by \"sharedByUser\" userid of person who shared the link (can also use -me-)  *   ```where=(sharedByUser='jbloggs')```  *   ```where=(sharedByUser='-me-')``` 
+  include: ["include_example"], # Array<String> | Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path 
+  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 shared links
+  result = api_instance.list_shared_links(opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling SharedlinksApi->list_shared_links: #{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]
+ **where** | **String**| Optionally filter the list by \&quot;sharedByUser\&quot; userid of person who shared the link (can also use -me-)  *   &#x60;&#x60;&#x60;where&#x3D;(sharedByUser&#x3D;&#39;jbloggs&#39;)&#x60;&#x60;&#x60;  *   &#x60;&#x60;&#x60;where&#x3D;(sharedByUser&#x3D;&#39;-me-&#39;)&#x60;&#x60;&#x60;  | [optional] 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the shared link, the following optional fields can be requested: * allowableOperations * path  | [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
+
+[**SharedLinkPaging**](SharedLinkPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+