alfresco_api 1.0.0

data/docs/NetworkQuota.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::NetworkQuota
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**limit** | **Integer** |  | 
+**usage** | **Integer** |  | 
+
+

data/docs/NetworksApi.md

@@ -0,0 +1,189 @@
+# AlfrescoAPI::NetworksApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_network**](NetworksApi.md#get_network) | **GET** /networks/{networkId} | Get a network
+[**get_network_for_person**](NetworksApi.md#get_network_for_person) | **GET** /people/{personId}/networks/{networkId} | Get network information
+[**list_networks_for_person**](NetworksApi.md#list_networks_for_person) | **GET** /people/{personId}/networks | List network membership
+
+
+# **get_network**
+> PersonNetworkEntry get_network(network_id, opts)
+
+Get a network
+
+Gets information for a network **networkId**.
+
+### 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::NetworksApi.new
+
+network_id = "network_id_example" # String | The identifier of a network.
+
+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 network
+  result = api_instance.get_network(network_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling NetworksApi->get_network: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **network_id** | **String**| The identifier of a network. | 
+ **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
+
+[**PersonNetworkEntry**](PersonNetworkEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_network_for_person**
+> PersonNetworkEntry get_network_for_person(person_idnetwork_id, opts)
+
+Get network information
+
+Gets network information on a single network specified by **networkId** for **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::NetworksApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+network_id = "network_id_example" # String | The identifier of a network.
+
+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 network information
+  result = api_instance.get_network_for_person(person_idnetwork_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling NetworksApi->get_network_for_person: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **network_id** | **String**| The identifier of a network. | 
+ **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
+
+[**PersonNetworkEntry**](PersonNetworkEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_networks_for_person**
+> PersonNetworkPaging list_networks_for_person(person_id, opts)
+
+List network membership
+
+Gets a list of network memberships 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::NetworksApi.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 network membership
+  result = api_instance.list_networks_for_person(person_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling NetworksApi->list_networks_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
+
+[**PersonNetworkPaging**](PersonNetworkPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Node.md

@@ -0,0 +1,25 @@
+# AlfrescoAPI::Node
+
+## 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] 
+
+

data/docs/NodeAssociation.md

@@ -0,0 +1,26 @@
+# AlfrescoAPI::NodeAssociation
+
+## 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] 
+**association** | [**AssociationInfo**](AssociationInfo.md) |  | [optional] 
+
+

data/docs/NodeAssociationEntry.md

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

data/docs/NodeAssociationPaging.md

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

data/docs/NodeAssociationPagingList.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::NodeAssociationPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+**entries** | [**Array<NodeAssociationEntry>**](NodeAssociationEntry.md) |  | [optional] 
+**source** | [**Node**](Node.md) |  | [optional] 
+
+

data/docs/NodeBodyCopy.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::NodeBodyCopy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**target_parent_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.  | [optional] 
+
+

data/docs/NodeBodyCreate.md

@@ -0,0 +1,15 @@
+# AlfrescoAPI::NodeBodyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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** |  | 
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Hash<String, String>** |  | [optional] 
+**relative_path** | **String** |  | [optional] 
+**association** | [**NodeBodyCreateAssociation**](NodeBodyCreateAssociation.md) |  | [optional] 
+**secondary_children** | [**Array<ChildAssociationBody>**](ChildAssociationBody.md) |  | [optional] 
+**targets** | [**Array<AssociationBody>**](AssociationBody.md) |  | [optional] 
+
+

data/docs/NodeBodyCreateAssociation.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::NodeBodyCreateAssociation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assoc_type** | **String** |  | [optional] 
+
+

data/docs/NodeBodyLock.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::NodeBodyLock
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time_to_expire** | **Integer** |  | [optional] 
+**type** | **String** |  | [optional] [default to "ALLOW_OWNER_CHANGES"]
+**lifetime** | **String** |  | [optional] [default to "PERSISTENT"]
+
+

data/docs/NodeBodyMove.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::NodeBodyMove
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**target_parent_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.  | [optional] 
+
+

data/docs/NodeBodyUpdate.md

@@ -0,0 +1,12 @@
+# AlfrescoAPI::NodeBodyUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**node_type** | **String** |  | [optional] 
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Hash<String, String>** |  | [optional] 
+**permissions** | [**PermissionsBodyUpdate**](PermissionsBodyUpdate.md) |  | [optional] 
+
+

data/docs/NodeChildAssociation.md

@@ -0,0 +1,26 @@
+# AlfrescoAPI::NodeChildAssociation
+
+## 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] 
+**association** | [**ChildAssociationInfo**](ChildAssociationInfo.md) |  | [optional] 
+
+

data/docs/NodeChildAssociationEntry.md

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

data/docs/NodeChildAssociationPaging.md

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

data/docs/NodeChildAssociationPagingList.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::NodeChildAssociationPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+**entries** | [**Array<NodeChildAssociationEntry>**](NodeChildAssociationEntry.md) |  | [optional] 
+**source** | [**Node**](Node.md) |  | [optional] 
+
+

data/docs/NodeEntry.md

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

data/docs/NodePaging.md

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

data/docs/NodePagingList.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::NodePagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+**entries** | [**Array<NodeEntry>**](NodeEntry.md) |  | [optional] 
+**source** | [**Node**](Node.md) |  | [optional] 
+
+