diff --git a/CHANGELOG.md b/CHANGELOG.md index 7f3bde49d6..5aacb41d0b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,21 @@

# Alfresco JS API + + +# [1.8.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.8.0) (05-09-2017) + +## Features + +- [Process Audit Log end points](https://github.com/Alfresco/alfresco-js-api/issues/263) +- [Downloads API (requries 5.2.1 platform)](https://issues.alfresco.com/jira/browse/ADF-1225) +- [getProfilePictures returns null](https://github.com/Alfresco/alfresco-js-api/issues/262) +- [Adding a new method to retrieve the Profile Picture Url](https://github.com/Alfresco/alfresco-js-api/265) + +## Fix + +- [Favorites Api not passing the "include" settings to server](https://issues.alfresco.com/jira/browse/ADF-1394) + # [1.7.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.7.0) (01-08-2017) ## Fix diff --git a/index.d.ts b/index.d.ts index 9ee1213aa6..d8ba4187b1 100644 --- a/index.d.ts +++ b/index.d.ts @@ -587,6 +587,31 @@ declare namespace AlfrescoApi { getSharedLinkContent(sharedId?: string, opts?: any): Promise<{}>; } + export interface DownloadsApi { + new(client: ApiClient): DownloadsApi; + + createDownload(payload: DownloadBodyCreate, opts?: any): Promise; + getDownload(downloadId: string, opts?: any): Promise; + cancelDownload(downloadId: string): Promise; + } + + export interface DownloadBodyCreate { + nodeIds?: string[]; + } + + export interface DownloadEntry { + entry?: Download; + } + + export interface Download { + filesAdded?: number; + bytesAdded?: number; + id: string; + totalFiles: number; + totalBytes: number; + status: string; + } + export interface TagsApi { new(client: ApiClient): TagsApi; @@ -1623,6 +1648,7 @@ declare namespace AlfrescoApi { childAssociationsApi: ChildAssociationsApi; commentsApi: CommentsApi; customModelApi: CustomModelApi; + downloadsApi: DownloadsApi; favoritesApi: FavoritesApi; networksApi: NetworksApi; nodesApi: NodesApi; diff --git a/package.json b/package.json index 1e485c4863..83b0e6b33e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "alfresco-js-api", - "version": "1.7.0", + "version": "1.8.0", "description": "JavaScript client library for the Alfresco REST API", "author": "Alfresco Software, Ltd.", "main": "main.js", diff --git a/src/alfresco-activiti-rest-api/docs/ProcessApi.md b/src/alfresco-activiti-rest-api/docs/ProcessApi.md index 8446a44837..f544aba955 100755 --- a/src/alfresco-activiti-rest-api/docs/ProcessApi.md +++ b/src/alfresco-activiti-rest-api/docs/ProcessApi.md @@ -9,6 +9,8 @@ Method | HTTP request | Description [**getProcessDefinitionStartForm**](ProcessApi.md#getProcessDefinitionStartForm) | **GET** /api/enterprise/process-definitions/{processDefinitionId}/start-form | Retrieve the start form for a process definition [**getProcessDefinitions**](ProcessApi.md#getProcessDefinitions) | **GET** /api/enterprise/process-definitions | Retrieve a list of process definitions [**getProcessInstanceContent**](ProcessApi.md#getProcessInstanceContent) | **GET** /api/enterprise/process-instances/{processInstanceId}/field-content | Retrieve content attached to process instance fields +[**getProcessAuditJson**](ProcessApi.md#getProcessAuditJson) | **GET** /api/enterprise/process-instances/{processId}/audit-log | Retrieve process audit infromation in json format +[**getProcessAuditPdf**](ProcessApi.md#getProcessAuditPdf) | **GET** /app/rest/process-instances/{processId}/audit | Retrieve the process audit infromation in pdf format [**getProcessInstanceStartForm**](ProcessApi.md#getProcessInstanceStartForm) | **GET** /api/enterprise/process-instances/{processInstanceId}/start-form | Get process start form [**getProcessInstance**](ProcessApi.md#getProcessInstance) | **GET** /api/enterprise/process-instances/{processInstanceId} | Retrieve a process instance information [**getProcessInstances**](ProcessApi.md#getProcessInstances) | **POST** /api/enterprise/process-instances/query | Retrieve a list of process instances @@ -182,6 +184,73 @@ Name | Type | Description | Notes No authorization required +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **getProcessAuditJson** +> ProcessInstanceAuditRepresentation getProcessAuditJson(processId) + +Retrieve process audit infromation in json format + +### Example +```javascript + +var processId = "processId_example"; // String | processId + + +this.alfrescoJsApi.activiti.processApi.getProcessAuditJson(processId); +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **processId** | **String**| processId | + +### Return type + +[**ProcessInstanceAuditRepresentation**](ProcessInstanceAuditRepresentation.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **getProcessAuditPdf** +> Blob getProcessAuditPdf(processId) + +Retrieve process audit infromation in pdf format + +### Example +```javascript + +var processId = "processId_example"; // String | processId + +this.alfrescoJsApi.activiti.processApi.getProcessAuditPdf(processId); +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **processId** | **String**| processId | + +### Return type + +[Blob] + +### Authorization + +No authorization required + ### HTTP request headers - **Content-Type**: application/json diff --git a/src/alfresco-activiti-rest-api/docs/ProcessInstanceAuditRepresentation.md b/src/alfresco-activiti-rest-api/docs/ProcessInstanceAuditRepresentation.md new file mode 100755 index 0000000000..bb674d555e --- /dev/null +++ b/src/alfresco-activiti-rest-api/docs/ProcessInstanceAuditRepresentation.md @@ -0,0 +1,14 @@ +# ActivitiPublicRestApi.ProcessInstanceAuditRepresentation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processInstanceId** | **Integer** | | [optional] +**processInstanceName | **String** | | [optional] +**processDefinitionName** | **String** | | [optional] +**processDefinitionVersion** | **Integer** | | [optional] +**processInstanceStartTime** | **Date** | | [optional] +**processInstanceEndTime** | **Date** | | [optional] +**processInstanceInitiator** | **String** | | [optional] +**entries** | **Object** | | [optional] +**decisionInfo** | **Object** | | [optional] diff --git a/src/alfresco-activiti-rest-api/docs/UserApi.md b/src/alfresco-activiti-rest-api/docs/UserApi.md index 8717d31305..6d0da39e36 100755 --- a/src/alfresco-activiti-rest-api/docs/UserApi.md +++ b/src/alfresco-activiti-rest-api/docs/UserApi.md @@ -83,6 +83,39 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + +# **getProfilePictureUrl** +> getProfilePictureUrl(userId) + +Retrieve user profile picture + +### Example +```javascript + +var userId = 789; // Integer | userId + +this.alfrescoJsApi.activiti.userApi.getProfilePictureUrl(userId); +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **userId** | **String**| userId | + +### Return type + +string + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + # **getUser** > UserRepresentation getUser(userId) diff --git a/src/alfresco-activiti-rest-api/src/api/ProcessApi.js b/src/alfresco-activiti-rest-api/src/api/ProcessApi.js index 35f56a23be..fa6f4a4354 100755 --- a/src/alfresco-activiti-rest-api/src/api/ProcessApi.js +++ b/src/alfresco-activiti-rest-api/src/api/ProcessApi.js @@ -1,18 +1,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['../../../alfrescoApiClient', '../model/ProcessInstanceFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormDefinitionRepresentation', '../model/ProcessInstanceRepresentation', '../model/ProcessFilterRequestRepresentation', '../model/FormValueRepresentation', '../model/CreateProcessInstanceRepresentation'], factory); + define(['../../../alfrescoApiClient', '../model/ProcessInstanceFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormDefinitionRepresentation', '../model/ProcessInstanceRepresentation', '../model/ProcessInstanceAuditRepresentation', '../model/ProcessFilterRequestRepresentation', '../model/FormValueRepresentation', '../model/CreateProcessInstanceRepresentation'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../../../alfrescoApiClient'), require('../model/ProcessInstanceFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ProcessInstanceRepresentation'), require('../model/ProcessFilterRequestRepresentation'), require('../model/FormValueRepresentation'), require('../model/CreateProcessInstanceRepresentation')); + module.exports = factory(require('../../../alfrescoApiClient'), require('../model/ProcessInstanceFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ProcessInstanceRepresentation'), require('../model/ProcessInstanceAuditRepresentation'), require('../model/ProcessFilterRequestRepresentation'), require('../model/FormValueRepresentation'), require('../model/CreateProcessInstanceRepresentation')); } else { // Browser globals (root is window) if (!root.ActivitiPublicRestApi) { root.ActivitiPublicRestApi = {}; } - root.ActivitiPublicRestApi.ProcessApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.ProcessInstanceFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ProcessInstanceRepresentation, root.ActivitiPublicRestApi.ProcessFilterRequestRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.CreateProcessInstanceRepresentation); + root.ActivitiPublicRestApi.ProcessApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.ProcessInstanceFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ProcessInstanceRepresentation, root.ActivitiPublicRestApi.ProcessInstanceAuditRepresentation, root.ActivitiPublicRestApi.ProcessFilterRequestRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.CreateProcessInstanceRepresentation); } -}(this, function(ApiClient, ProcessInstanceFilterRequestRepresentation, ResultListDataRepresentation, FormDefinitionRepresentation, ProcessInstanceRepresentation, ProcessFilterRequestRepresentation, FormValueRepresentation, CreateProcessInstanceRepresentation) { +}(this, function(ApiClient, ProcessInstanceFilterRequestRepresentation, ResultListDataRepresentation, FormDefinitionRepresentation, ProcessInstanceRepresentation, ProcessInstanceAuditRepresentation, ProcessFilterRequestRepresentation, FormValueRepresentation, CreateProcessInstanceRepresentation) { 'use strict'; /** @@ -368,6 +368,76 @@ ); } + /** + * Retrieve the process audit in the JSON format + * @param {String} processId processId + */ + this.getProcessAuditJson = function(processId) { + var postBody = null; + + // verify the required parameter 'processId' is set + if (processId == undefined || processId == null) { + throw "Missing the required parameter 'processId' when calling getProcessAuditJson"; + } + + var pathParams = { + 'processId': processId + }; + var queryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = []; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = ProcessInstanceAuditRepresentation; + + return this.apiClient.callApi( + '/api/enterprise/process-instances/{processId}/audit-log', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * Retrieve the process audit in the JSON format + * @param {String} processId processId + */ + this.getProcessAuditPdf = function(processId) { + var postBody = null; + + // verify the required parameter 'processId' is set + if (processId == undefined || processId == null) { + throw "Missing the required parameter 'processId' when calling getProcessAuditPdf"; + } + + var pathParams = { + 'processId': processId + }; + var queryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = []; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = Object; + var contextRoot = null; + var responseType = 'blob'; + + return this.apiClient.callApi( + '/app/rest/process-instances/{processId}/audit', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, contextRoot, responseType + ); + } + /** * Function to receive the result of the getRestFieldValues operation. * @param {String} error Error message, if any. diff --git a/src/alfresco-activiti-rest-api/src/api/UserApi.js b/src/alfresco-activiti-rest-api/src/api/UserApi.js index ece78cad5b..e317ad7826 100755 --- a/src/alfresco-activiti-rest-api/src/api/UserApi.js +++ b/src/alfresco-activiti-rest-api/src/api/UserApi.js @@ -114,15 +114,21 @@ var authNames = []; var contentTypes = ['application/json']; var accepts = ['application/json']; - var returnType = null; + var returnType = Object; + var contextRoot = null; + var responseType = 'blob'; return this.apiClient.callApi( '/api/enterprise/users/{userId}/picture', 'GET', pathParams, queryParams, headerParams, formParams, postBody, - authNames, contentTypes, accepts, returnType + authNames, contentTypes, accepts, returnType, contextRoot, responseType ); } + this.getUserProfilePictureUrl = function(userId) { + return this.apiClient.basePath + '/app/rest/users/'+userId+'/picture'; + } + /** * Function to receive the result of the getUser operation. * @param {String} error Error message, if any. diff --git a/src/alfresco-activiti-rest-api/src/model/ProcessInstanceAuditRepresentation.js b/src/alfresco-activiti-rest-api/src/model/ProcessInstanceAuditRepresentation.js new file mode 100755 index 0000000000..0c1d087a83 --- /dev/null +++ b/src/alfresco-activiti-rest-api/src/model/ProcessInstanceAuditRepresentation.js @@ -0,0 +1,136 @@ +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['../../../alfrescoApiClient', '../model/LightUserRepresentation', '../model/RestVariable'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../../../alfrescoApiClient'), require('./LightUserRepresentation'), require('./RestVariable')); + } else { + // Browser globals (root is window) + if (!root.ActivitiPublicRestApi) { + root.ActivitiPublicRestApi = {}; + } + root.ActivitiPublicRestApi.ProcessInstanceAuditRepresentation = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.LightUserRepresentation, root.ActivitiPublicRestApi.RestVariable); + } +}(this, function(ApiClient, LightUserRepresentation, RestVariable) { + 'use strict'; + + + + + /** + * The ProcessInstanceAuditRepresentation model module. + * @module model/ProcessInstanceAuditRepresentation + * @version 1.4.0 + */ + + /** + * Constructs a new ProcessInstanceAuditRepresentation. + * @alias module:model/ProcessInstanceAuditRepresentation + * @class + */ + var exports = function() { + var _this = this; + + + + + + + + + + + + + + + + + + + }; + + /** + * Constructs a ProcessInstanceAuditRepresentation from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ProcessInstanceAuditRepresentation} obj Optional instance to populate. + * @return {module:model/ProcessInstanceAuditRepresentation} The populated ProcessInstanceAuditRepresentation instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = data || new exports(); + + if (data.hasOwnProperty('processInstanceId')) { + obj['processInstanceId'] = ApiClient.convertToType(data['processInstanceId'], 'Integer'); + } + if (data.hasOwnProperty('processInstanceName')) { + obj['processInstanceName'] = ApiClient.convertToType(data['processInstanceName'], 'String'); + } + if (data.hasOwnProperty('processDefinitionName')) { + obj['processDefinitionName'] = ApiClient.convertToType(data['processDefinitionName'], 'String'); + } + if (data.hasOwnProperty('processDefinitionVersion')) { + obj['processDefinitionVersion'] = ApiClient.convertToType(data['processDefinitionVersion'], 'Integer'); + } + if (data.hasOwnProperty('processInstanceStartTime')) { + obj['processInstanceStartTime'] = ApiClient.convertToType(data['processInstanceStartTime'], 'Date'); + } + if (data.hasOwnProperty('processInstanceEndTime')) { + obj['processInstanceEndTime'] = ApiClient.convertToType(data['processInstanceEndTime'], 'Date'); + } + if (data.hasOwnProperty('processInstanceInitiator')) { + obj['processInstanceInitiator'] = ApiClient.convertToType(data['processInstanceInitiator'], 'String'); + } + if (data.hasOwnProperty('entries')) { + obj['entries'] = ApiClient.convertToType(data['entries'], [Object]); + } + if (data.hasOwnProperty('decisionInfo')) { + obj['decisionInfo'] = ApiClient.convertToType(data['decisionInfo'], [Object]); + } + } + return obj; + } + + /** + * @member {Integer} processInstanceId + */ + exports.prototype['processInstanceId'] = undefined; + /** + * @member {String} processInstanceName + */ + exports.prototype['processInstanceName'] = undefined; + /** + * @member {String} processDefinitionName + */ + exports.prototype['processDefinitionName'] = undefined; + /** + * @member {String} processDefinitionVersion + */ + exports.prototype['processDefinitionVersion'] = undefined; + /** + * @member {Date} processInstanceStartTime + */ + exports.prototype['processInstanceStartTime'] = undefined; + /** + * @member {Date} processInstanceEndTime + */ + exports.prototype['processInstanceEndTime'] = undefined; + /** + * @member {String} processInstanceInitiator + */ + exports.prototype['processInstanceInitiator'] = undefined; + /** + * @member {Object} entries + */ + exports.prototype['entries'] = undefined; + /** + * @member {Object} decisionInfo + */ + exports.prototype['decisionInfo'] = undefined; + + return exports; +})); + + diff --git a/src/alfresco-core-rest-api/README.md b/src/alfresco-core-rest-api/README.md index 52d4341b50..2035d7feaf 100644 --- a/src/alfresco-core-rest-api/README.md +++ b/src/alfresco-core-rest-api/README.md @@ -13,6 +13,8 @@ An **entity** is of a specific **type**, and has a unique **id**. ## Documentation for API Endpoints +- [Downloads](docs/DownloadsApi.md) + All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1* Class | Method | HTTP request | Description @@ -155,6 +157,9 @@ Class | Method | HTTP request | Description - [AlfrescoCoreRestApi.DeletedNodeMinimalEntry](docs/DeletedNodeMinimalEntry.md) - [AlfrescoCoreRestApi.DeletedNodesPaging](docs/DeletedNodesPaging.md) - [AlfrescoCoreRestApi.DeletedNodesPagingList](docs/DeletedNodesPagingList.md) + - [AlfrescoCoreRestApi.Download](docs/Download.md) + - [AlfrescoCoreRestApi.DownloadBodyCreate](docs/DownloadBodyCreate.md) + - [AlfrescoCoreRestApi.DownloadEntry](docs/DownloadEntry.md) - [AlfrescoCoreRestApi.EmailSharedLinkBody](docs/EmailSharedLinkBody.md) - [AlfrescoCoreRestApi.Error](docs/Error.md) - [AlfrescoCoreRestApi.ErrorError](docs/ErrorError.md) diff --git a/src/alfresco-core-rest-api/docs/Download.md b/src/alfresco-core-rest-api/docs/Download.md new file mode 100755 index 0000000000..652dee3b8b --- /dev/null +++ b/src/alfresco-core-rest-api/docs/Download.md @@ -0,0 +1,30 @@ +# AlfrescoCoreRestApi.Download + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filesAdded** | **Number** | number of files added so far in the zip | [optional] +**bytesAdded** | **Number** | number of bytes added so far in the zip | [optional] +**id** | **String** | the id of the download node | [optional] +**totalFiles** | **Number** | the total number of files to be added in the zip | [optional] +**totalBytes** | **Number** | 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'] + + + +## Enum: StatusEnum + + +* `PENDING` (value: `"PENDING"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `IN_PROGRESS` (value: `"IN_PROGRESS"`) + +* `DONE` (value: `"DONE"`) + +* `MAX_CONTENT_SIZE_EXCEEDED` (value: `"MAX_CONTENT_SIZE_EXCEEDED"`) + + + + diff --git a/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md b/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md new file mode 100755 index 0000000000..b8d6725ead --- /dev/null +++ b/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md @@ -0,0 +1,8 @@ +# AlfrescoCoreRestApi.DownloadBodyCreate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nodeIds** | **[String]** | | + + diff --git a/src/alfresco-core-rest-api/docs/DownloadEntry.md b/src/alfresco-core-rest-api/docs/DownloadEntry.md new file mode 100755 index 0000000000..ca4ca172b9 --- /dev/null +++ b/src/alfresco-core-rest-api/docs/DownloadEntry.md @@ -0,0 +1,8 @@ +# AlfrescoCoreRestApi.DownloadEntry + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entry** | [**Download**](Download.md) | | + + diff --git a/src/alfresco-core-rest-api/docs/DownloadsApi.md b/src/alfresco-core-rest-api/docs/DownloadsApi.md new file mode 100755 index 0000000000..1a158ef595 --- /dev/null +++ b/src/alfresco-core-rest-api/docs/DownloadsApi.md @@ -0,0 +1,148 @@ +# AlfrescoCoreRestApi.DownloadsApi + +All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelDownload**](DownloadsApi.md#cancelDownload) | **DELETE** /downloads/{downloadId} | Cancel a download +[**createDownload**](DownloadsApi.md#createDownload) | **POST** /downloads | Create a new download +[**getDownload**](DownloadsApi.md#getDownload) | **GET** /downloads/{downloadId} | Get a download + + + +# **cancelDownload** +> cancelDownload(downloadId) + +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 +```javascript +var downloadId = "downloadId_example"; // String | The identifier of a download node. + + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}; + +this.alfrescoJsApi.core.downloadsApi.cancelDownload(downloadId, callback); +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **downloadId** | **String**| The identifier of a download node. | + +### Return type + +null (empty response body) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **createDownload** +> DownloadEntry createDownload(downloadBodyCreate, 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 +```javascript +var downloadBodyCreate = new AlfrescoCoreRestApi.DownloadBodyCreate(); // DownloadBodyCreate | The nodeIds the content of which will be zipped, which zip will be set as the content of our download node. + +var opts = { + 'fields': ["fields_example"] // [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. +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; + +this.alfrescoJsApi.core.downloadsApi.createDownload(downloadBodyCreate, opts, callback); +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **downloadBodyCreate** | [**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** | [**[String]**](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 + + +# **getDownload** +> DownloadEntry getDownload(downloadId, 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 +```javascript +var downloadId = "downloadId_example"; // String | The identifier of a download node. + +var opts = { + 'fields': ["fields_example"] // [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. +}; + +var callback = function(error, data, response) { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}; + +this.alfrescoJsApi.core.downloadsApi.getDownload(downloadId, opts, callback); +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **downloadId** | **String**| The identifier of a download node. | + **fields** | [**[String]**](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 + diff --git a/src/alfresco-core-rest-api/src/api/DownloadsApi.js b/src/alfresco-core-rest-api/src/api/DownloadsApi.js new file mode 100644 index 0000000000..7577c2f29e --- /dev/null +++ b/src/alfresco-core-rest-api/src/api/DownloadsApi.js @@ -0,0 +1,181 @@ +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['../ApiClient', '../model/DownloadBodyCreate', '../model/DownloadEntry', '../model/Error'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('../model/DownloadBodyCreate'), require('../model/DownloadEntry'), require('../model/Error')); + } else { + // Browser globals (root is window) + if (!root.AlfrescoCoreRestApi) { + root.AlfrescoCoreRestApi = {}; + } + root.AlfrescoCoreRestApi.DownloadsApi = factory(root.AlfrescoCoreRestApi.ApiClient, root.AlfrescoCoreRestApi.DownloadBodyCreate, root.AlfrescoCoreRestApi.DownloadEntry, root.AlfrescoCoreRestApi.Error); + } +}(this, function(ApiClient, DownloadBodyCreate, DownloadEntry, Error) { + 'use strict'; + + /** + * Downloads service. + * @module api/DownloadsApi + * @version 0.1.0 + */ + + /** + * Constructs a new DownloadsApi. + * @alias module:api/DownloadsApi + * @class + * @param {module:ApiClient} apiClient Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. + */ + var exports = function(apiClient) { + this.apiClient = apiClient || ApiClient.instance; + + + /** + * Callback function to receive the result of the cancelDownload operation. + * @callback module:api/DownloadsApi~cancelDownloadCallback + * @param {String} error Error message, if any. + * @param data This operation does not return a value. + * @param {String} response The complete HTTP response. + */ + + /** + * 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. + * @param {String} downloadId The identifier of a download node. + * @param {module:api/DownloadsApi~cancelDownloadCallback} callback The callback function, accepting three arguments: error, data, response + */ + this.cancelDownload = function(downloadId, callback) { + var postBody = null; + + // verify the required parameter 'downloadId' is set + if (downloadId == undefined || downloadId == null) { + throw new Error("Missing the required parameter 'downloadId' when calling cancelDownload"); + } + + + var pathParams = { + 'downloadId': downloadId + }; + var queryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['basicAuth']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = null; + + return this.apiClient.callApi( + '/downloads/{downloadId}', 'DELETE', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, callback + ); + } + + /** + * Callback function to receive the result of the createDownload operation. + * @callback module:api/DownloadsApi~createDownloadCallback + * @param {String} error Error message, if any. + * @param {module:model/DownloadEntry} data The data returned by the service call. + * @param {String} response The complete HTTP response. + */ + + /** + * 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 + * @param {module:model/DownloadBodyCreate} downloadBodyCreate The nodeIds the content of which will be zipped, which zip will be set as the content of our download node. + * @param {Object} opts Optional parameters + * @param {Array.} opts.fields 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. + * @param {module:api/DownloadsApi~createDownloadCallback} callback The callback function, accepting three arguments: error, data, response + * data is of type: {@link module:model/DownloadEntry} + */ + this.createDownload = function(downloadBodyCreate, opts, callback) { + opts = opts || {}; + var postBody = downloadBodyCreate; + + // verify the required parameter 'downloadBodyCreate' is set + if (downloadBodyCreate == undefined || downloadBodyCreate == null) { + throw new Error("Missing the required parameter 'downloadBodyCreate' when calling createDownload"); + } + + + var pathParams = { + }; + var queryParams = { + 'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv') + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['basicAuth']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = DownloadEntry; + + return this.apiClient.callApi( + '/downloads', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, callback + ); + } + + /** + * Callback function to receive the result of the getDownload operation. + * @callback module:api/DownloadsApi~getDownloadCallback + * @param {String} error Error message, if any. + * @param {module:model/DownloadEntry} data The data returned by the service call. + * @param {String} response The complete HTTP response. + */ + + /** + * Get a download + * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. Retrieve status information for download node **downloadId** + * @param {String} downloadId The identifier of a download node. + * @param {Object} opts Optional parameters + * @param {Array.} opts.fields 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. + * @param {module:api/DownloadsApi~getDownloadCallback} callback The callback function, accepting three arguments: error, data, response + * data is of type: {@link module:model/DownloadEntry} + */ + this.getDownload = function(downloadId, opts, callback) { + opts = opts || {}; + var postBody = null; + + // verify the required parameter 'downloadId' is set + if (downloadId == undefined || downloadId == null) { + throw new Error("Missing the required parameter 'downloadId' when calling getDownload"); + } + + + var pathParams = { + 'downloadId': downloadId + }; + var queryParams = { + 'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv') + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['basicAuth']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = DownloadEntry; + + return this.apiClient.callApi( + '/downloads/{downloadId}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, callback + ); + } + }; + + return exports; +})); diff --git a/src/alfresco-core-rest-api/src/api/FavoritesApi.js b/src/alfresco-core-rest-api/src/api/FavoritesApi.js index d2ac4607fb..677ef4d765 100644 --- a/src/alfresco-core-rest-api/src/api/FavoritesApi.js +++ b/src/alfresco-core-rest-api/src/api/FavoritesApi.js @@ -22,7 +22,7 @@ */ /** - * Constructs a new FavoritesApi. + * Constructs a new FavoritesApi. * @alias module:api/FavoritesApi * @class * @param {module:ApiClient} apiClient Optional API client implementation to use, default to {@link module:ApiClient#instance} @@ -154,7 +154,8 @@ 'skipCount': opts['skipCount'], 'maxItems': opts['maxItems'], 'where': opts['where'], - 'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv') + 'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv'), + 'include': this.apiClient.buildCollectionParam(opts['include'], 'csv') }; var headerParams = { }; diff --git a/src/alfresco-core-rest-api/src/index.js b/src/alfresco-core-rest-api/src/index.js index 57d87eee90..934021cc78 100644 --- a/src/alfresco-core-rest-api/src/index.js +++ b/src/alfresco-core-rest-api/src/index.js @@ -1,12 +1,12 @@ (function(factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['./ApiClient', './model/Activity', './model/ActivityActivitySummary', './model/ActivityEntry', './model/ActivityPaging', './model/ActivityPagingList', './model/AssocChildBody', './model/AssocInfo', './model/AssocTargetBody', './model/ChildAssocInfo', './model/ChildAssociationInfo', './model/Comment', './model/CommentBody', './model/CommentBody1', './model/CommentEntry', './model/CommentPaging', './model/CommentPagingList', './model/Company', './model/ContentInfo', './model/CopyBody', './model/DeletedNode', './model/DeletedNodeEntry', './model/DeletedNodeMinimal', './model/DeletedNodeMinimalEntry', './model/DeletedNodesPaging', './model/DeletedNodesPagingList', './model/EmailSharedLinkBody', './model/Error', './model/ErrorError', './model/Favorite', './model/FavoriteBody', './model/FavoriteEntry', './model/FavoritePaging', './model/FavoritePagingList', './model/FavoriteSiteBody', './model/InlineResponse201', './model/InlineResponse201Entry', './model/MoveBody', './model/NetworkQuota', './model/NodeAssocMinimal', './model/NodeAssociationPaging', './model/NodeAssociationPagingList', './model/NodeBodyLock', './model/NodeChildAssociation', './model/NodeChildAssociationEntry', './model/NodeChildAssociationPaging', './model/NodeChildAssociationPagingList', './model/Node', './model/NodeAssociation', './model/NodeAssociationEntry', './model/NodeAssocMinimalEntry', './model/NodeAssocPaging', './model/NodeAssocPagingList', './model/NodeBody', './model/NodeChildAssocMinimal', './model/NodeChildAssocMinimalEntry', './model/NodeChildAssocPaging', './model/NodeChildAssocPagingList', './model/NodeEntry', './model/NodeFull', './model/NodeMinimal', './model/NodeMinimalEntry', './model/NodePaging', './model/NodePagingList', './model/NodeSharedLink', './model/NodeSharedLinkEntry', './model/NodeSharedLinkPaging', './model/NodeSharedLinkPagingList', './model/NodesnodeIdchildrenContent', './model/Pagination', './model/PathElement', './model/PathInfo', './model/PermissionElement', './model/PermissionsInfo', './model/PersonPaging', './model/PersonPagingList', './model/Person', './model/PersonEntry', './model/PersonNetwork', './model/PersonNetworkEntry', './model/PersonNetworkPaging', './model/PersonNetworkPagingList', './model/Preference', './model/PreferenceEntry', './model/PreferencePaging', './model/PreferencePagingList', './model/Rating', './model/RatingAggregate', './model/RatingBody', './model/RatingEntry', './model/RatingPaging', './model/RatingPagingList', './model/Rendition', './model/RenditionBody', './model/RenditionEntry', './model/RenditionPaging', './model/RenditionPagingList', './model/SharedLinkBody', './model/Site', './model/SiteBody', './model/SiteContainer', './model/SiteContainerEntry', './model/SiteContainerPaging', './model/SiteEntry', './model/SiteMember', './model/SiteMemberBody', './model/SiteMemberEntry', './model/SiteMemberPaging', './model/SiteMemberRoleBody', './model/SiteMembershipBody', './model/SiteMembershipBody1', './model/SiteMembershipRequest', './model/SiteMembershipRequestEntry', './model/SiteMembershipRequestPaging', './model/SiteMembershipRequestPagingList', './model/SitePaging', './model/SitePagingList', './model/Tag', './model/TagBody', './model/TagBody1', './model/TagEntry', './model/TagPaging', './model/TagPagingList', './model/UserInfo', './model/AssociationInfo','./api/AssociationsApi', './api/ChangesApi', './api/ChildAssociationsApi', './api/CommentsApi', './api/FavoritesApi', './api/NetworksApi', './api/NodesApi', './api/PeopleApi', './api/RatingsApi', './api/RenditionsApi', './api/QueriesApi', './api/SharedlinksApi', './api/SitesApi', './api/TagsApi', './api/WebscriptApi'], factory); + define(['./ApiClient', './model/Activity', './model/ActivityActivitySummary', './model/ActivityEntry', './model/ActivityPaging', './model/ActivityPagingList', './model/AssocChildBody', './model/AssocInfo', './model/AssocTargetBody', './model/ChildAssocInfo', './model/ChildAssociationInfo', './model/Comment', './model/CommentBody', './model/CommentBody1', './model/CommentEntry', './model/CommentPaging', './model/CommentPagingList', './model/Company', './model/ContentInfo', './model/CopyBody', './model/DeletedNode', './model/DeletedNodeEntry', './model/DeletedNodeMinimal', './model/DeletedNodeMinimalEntry', './model/DeletedNodesPaging', './model/DeletedNodesPagingList', './model/EmailSharedLinkBody', './model/Error', './model/ErrorError', './model/Favorite', './model/FavoriteBody', './model/FavoriteEntry', './model/FavoritePaging', './model/FavoritePagingList', './model/FavoriteSiteBody', './model/InlineResponse201', './model/InlineResponse201Entry', './model/MoveBody', './model/NetworkQuota', './model/NodeAssocMinimal', './model/NodeAssociationPaging', './model/NodeAssociationPagingList', './model/NodeBodyLock', './model/NodeChildAssociation', './model/NodeChildAssociationEntry', './model/NodeChildAssociationPaging', './model/NodeChildAssociationPagingList', './model/Node', './model/NodeAssociation', './model/NodeAssociationEntry', './model/NodeAssocMinimalEntry', './model/NodeAssocPaging', './model/NodeAssocPagingList', './model/NodeBody', './model/NodeChildAssocMinimal', './model/NodeChildAssocMinimalEntry', './model/NodeChildAssocPaging', './model/NodeChildAssocPagingList', './model/NodeEntry', './model/NodeFull', './model/NodeMinimal', './model/NodeMinimalEntry', './model/NodePaging', './model/NodePagingList', './model/NodeSharedLink', './model/NodeSharedLinkEntry', './model/NodeSharedLinkPaging', './model/NodeSharedLinkPagingList', './model/NodesnodeIdchildrenContent', './model/Pagination', './model/PathElement', './model/PathInfo', './model/PermissionElement', './model/PermissionsInfo', './model/PersonPaging', './model/PersonPagingList', './model/Person', './model/PersonEntry', './model/PersonNetwork', './model/PersonNetworkEntry', './model/PersonNetworkPaging', './model/PersonNetworkPagingList', './model/Preference', './model/PreferenceEntry', './model/PreferencePaging', './model/PreferencePagingList', './model/Rating', './model/RatingAggregate', './model/RatingBody', './model/RatingEntry', './model/RatingPaging', './model/RatingPagingList', './model/Rendition', './model/RenditionBody', './model/RenditionEntry', './model/RenditionPaging', './model/RenditionPagingList', './model/SharedLinkBody', './model/Site', './model/SiteBody', './model/SiteContainer', './model/SiteContainerEntry', './model/SiteContainerPaging', './model/SiteEntry', './model/SiteMember', './model/SiteMemberBody', './model/SiteMemberEntry', './model/SiteMemberPaging', './model/SiteMemberRoleBody', './model/SiteMembershipBody', './model/SiteMembershipBody1', './model/SiteMembershipRequest', './model/SiteMembershipRequestEntry', './model/SiteMembershipRequestPaging', './model/SiteMembershipRequestPagingList', './model/SitePaging', './model/SitePagingList', './model/Tag', './model/TagBody', './model/TagBody1', './model/TagEntry', './model/TagPaging', './model/TagPagingList', './model/UserInfo', './model/AssociationInfo','./api/AssociationsApi', './api/ChangesApi', './api/ChildAssociationsApi', './api/CommentsApi', './api/FavoritesApi', './api/NetworksApi', './api/NodesApi', './api/PeopleApi', './api/RatingsApi', './api/RenditionsApi', './api/QueriesApi', './api/SharedlinksApi', './api/SitesApi', './api/TagsApi', './api/WebscriptApi', './api/DownloadsApi'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('./ApiClient'), require('./model/Activity'), require('./model/ActivityActivitySummary'), require('./model/ActivityEntry'), require('./model/ActivityPaging'), require('./model/ActivityPagingList'), require('./model/AssocChildBody'), require('./model/AssocInfo'), require('./model/AssocTargetBody'), require('./model/ChildAssocInfo'), require('./model/ChildAssociationInfo'), require('./model/Comment'), require('./model/CommentBody'), require('./model/CommentBody1'), require('./model/CommentEntry'), require('./model/CommentPaging'), require('./model/CommentPagingList'), require('./model/Company'), require('./model/ContentInfo'), require('./model/CopyBody'), require('./model/DeletedNode'), require('./model/DeletedNodeEntry'), require('./model/DeletedNodeMinimal'), require('./model/DeletedNodeMinimalEntry'), require('./model/DeletedNodesPaging'), require('./model/DeletedNodesPagingList'), require('./model/EmailSharedLinkBody'), require('./model/Error'), require('./model/ErrorError'), require('./model/Favorite'), require('./model/FavoriteBody'), require('./model/FavoriteEntry'), require('./model/FavoritePaging'), require('./model/FavoritePagingList'), require('./model/FavoriteSiteBody'), require('./model/InlineResponse201'), require('./model/InlineResponse201Entry'), require('./model/MoveBody'), require('./model/NetworkQuota'), require('./model/NodeAssocMinimal'), require('./model/NodeAssociationPaging'), require('./model/NodeAssociationPagingList'), require('./model/NodeBodyLock'), require('./model/NodeChildAssociation'), require('./model/NodeChildAssociationEntry'), require('./model/NodeChildAssociationPaging'), require('./model/NodeChildAssociationPagingList'), require('./model/Node') ,require('./model/NodeAssociation'), require('./model/NodeAssociationEntry'), require('./model/NodeAssocMinimalEntry'), require('./model/NodeAssocPaging'), require('./model/NodeAssocPagingList'), require('./model/NodeBody'), require('./model/NodeChildAssocMinimal'), require('./model/NodeChildAssocMinimalEntry'), require('./model/NodeChildAssocPaging'), require('./model/NodeChildAssocPagingList'), require('./model/NodeEntry'), require('./model/NodeFull'), require('./model/NodeMinimal'), require('./model/NodeMinimalEntry'), require('./model/NodePaging'), require('./model/NodePagingList'), require('./model/NodeSharedLink'), require('./model/NodeSharedLinkEntry'), require('./model/NodeSharedLinkPaging'), require('./model/NodeSharedLinkPagingList'), require('./model/NodesnodeIdchildrenContent'), require('./model/Pagination'), require('./model/PathElement'), require('./model/PathInfo'), require('./model/PermissionElement'), require('./model/PermissionsInfo'), require('./model/PersonPaging'), require('./model/PersonPagingList'), require('./model/Person'), require('./model/PersonEntry'), require('./model/PersonNetwork'), require('./model/PersonNetworkEntry'), require('./model/PersonNetworkPaging'), require('./model/PersonNetworkPagingList'), require('./model/Preference'), require('./model/PreferenceEntry'), require('./model/PreferencePaging'), require('./model/PreferencePagingList'), require('./model/Rating'), require('./model/RatingAggregate'), require('./model/RatingBody'), require('./model/RatingEntry'), require('./model/RatingPaging'), require('./model/RatingPagingList'), require('./model/Rendition'), require('./model/RenditionBody'), require('./model/RenditionEntry'), require('./model/RenditionPaging'), require('./model/RenditionPagingList'), require('./model/SharedLinkBody'), require('./model/Site'), require('./model/SiteBody'), require('./model/SiteContainer'), require('./model/SiteContainerEntry'), require('./model/SiteContainerPaging'), require('./model/SiteEntry'), require('./model/SiteMember'), require('./model/SiteMemberBody'), require('./model/SiteMemberEntry'), require('./model/SiteMemberPaging'), require('./model/SiteMemberRoleBody'), require('./model/SiteMembershipBody'), require('./model/SiteMembershipBody1'), require('./model/SiteMembershipRequest'), require('./model/SiteMembershipRequestEntry'), require('./model/SiteMembershipRequestPaging'), require('./model/SiteMembershipRequestPagingList'), require('./model/SitePaging'), require('./model/SitePagingList'), require('./model/Tag'), require('./model/TagBody'), require('./model/TagBody1'), require('./model/TagEntry'), require('./model/TagPaging'), require('./model/TagPagingList'), require('./model/UserInfo'), require('./model/AssociationInfo'), require('./api/AssociationsApi'), require('./api/ChangesApi'), require('./api/ChildAssociationsApi'), require('./api/CommentsApi'), require('./api/FavoritesApi'), require('./api/NetworksApi'), require('./api/NodesApi'), require('./api/PeopleApi'), require('./api/RatingsApi'), require('./api/RenditionsApi'), require('./api/QueriesApi'), require('./api/SharedlinksApi'), require('./api/SitesApi'), require('./api/TagsApi'), require('./api/WebscriptApi')); + module.exports = factory(require('./ApiClient'), require('./model/Activity'), require('./model/ActivityActivitySummary'), require('./model/ActivityEntry'), require('./model/ActivityPaging'), require('./model/ActivityPagingList'), require('./model/AssocChildBody'), require('./model/AssocInfo'), require('./model/AssocTargetBody'), require('./model/ChildAssocInfo'), require('./model/ChildAssociationInfo'), require('./model/Comment'), require('./model/CommentBody'), require('./model/CommentBody1'), require('./model/CommentEntry'), require('./model/CommentPaging'), require('./model/CommentPagingList'), require('./model/Company'), require('./model/ContentInfo'), require('./model/CopyBody'), require('./model/DeletedNode'), require('./model/DeletedNodeEntry'), require('./model/DeletedNodeMinimal'), require('./model/DeletedNodeMinimalEntry'), require('./model/DeletedNodesPaging'), require('./model/DeletedNodesPagingList'), require('./model/EmailSharedLinkBody'), require('./model/Error'), require('./model/ErrorError'), require('./model/Favorite'), require('./model/FavoriteBody'), require('./model/FavoriteEntry'), require('./model/FavoritePaging'), require('./model/FavoritePagingList'), require('./model/FavoriteSiteBody'), require('./model/InlineResponse201'), require('./model/InlineResponse201Entry'), require('./model/MoveBody'), require('./model/NetworkQuota'), require('./model/NodeAssocMinimal'), require('./model/NodeAssociationPaging'), require('./model/NodeAssociationPagingList'), require('./model/NodeBodyLock'), require('./model/NodeChildAssociation'), require('./model/NodeChildAssociationEntry'), require('./model/NodeChildAssociationPaging'), require('./model/NodeChildAssociationPagingList'), require('./model/Node') ,require('./model/NodeAssociation'), require('./model/NodeAssociationEntry'), require('./model/NodeAssocMinimalEntry'), require('./model/NodeAssocPaging'), require('./model/NodeAssocPagingList'), require('./model/NodeBody'), require('./model/NodeChildAssocMinimal'), require('./model/NodeChildAssocMinimalEntry'), require('./model/NodeChildAssocPaging'), require('./model/NodeChildAssocPagingList'), require('./model/NodeEntry'), require('./model/NodeFull'), require('./model/NodeMinimal'), require('./model/NodeMinimalEntry'), require('./model/NodePaging'), require('./model/NodePagingList'), require('./model/NodeSharedLink'), require('./model/NodeSharedLinkEntry'), require('./model/NodeSharedLinkPaging'), require('./model/NodeSharedLinkPagingList'), require('./model/NodesnodeIdchildrenContent'), require('./model/Pagination'), require('./model/PathElement'), require('./model/PathInfo'), require('./model/PermissionElement'), require('./model/PermissionsInfo'), require('./model/PersonPaging'), require('./model/PersonPagingList'), require('./model/Person'), require('./model/PersonEntry'), require('./model/PersonNetwork'), require('./model/PersonNetworkEntry'), require('./model/PersonNetworkPaging'), require('./model/PersonNetworkPagingList'), require('./model/Preference'), require('./model/PreferenceEntry'), require('./model/PreferencePaging'), require('./model/PreferencePagingList'), require('./model/Rating'), require('./model/RatingAggregate'), require('./model/RatingBody'), require('./model/RatingEntry'), require('./model/RatingPaging'), require('./model/RatingPagingList'), require('./model/Rendition'), require('./model/RenditionBody'), require('./model/RenditionEntry'), require('./model/RenditionPaging'), require('./model/RenditionPagingList'), require('./model/SharedLinkBody'), require('./model/Site'), require('./model/SiteBody'), require('./model/SiteContainer'), require('./model/SiteContainerEntry'), require('./model/SiteContainerPaging'), require('./model/SiteEntry'), require('./model/SiteMember'), require('./model/SiteMemberBody'), require('./model/SiteMemberEntry'), require('./model/SiteMemberPaging'), require('./model/SiteMemberRoleBody'), require('./model/SiteMembershipBody'), require('./model/SiteMembershipBody1'), require('./model/SiteMembershipRequest'), require('./model/SiteMembershipRequestEntry'), require('./model/SiteMembershipRequestPaging'), require('./model/SiteMembershipRequestPagingList'), require('./model/SitePaging'), require('./model/SitePagingList'), require('./model/Tag'), require('./model/TagBody'), require('./model/TagBody1'), require('./model/TagEntry'), require('./model/TagPaging'), require('./model/TagPagingList'), require('./model/UserInfo'), require('./model/AssociationInfo'), require('./api/AssociationsApi'), require('./api/ChangesApi'), require('./api/ChildAssociationsApi'), require('./api/CommentsApi'), require('./api/FavoritesApi'), require('./api/NetworksApi'), require('./api/NodesApi'), require('./api/PeopleApi'), require('./api/RatingsApi'), require('./api/RenditionsApi'), require('./api/QueriesApi'), require('./api/SharedlinksApi'), require('./api/SitesApi'), require('./api/TagsApi'), require('./api/WebscriptApi'), require('./api/DownloadsApi')); } -}(function(ApiClient, Activity, ActivityActivitySummary, ActivityEntry, ActivityPaging, ActivityPagingList, AssocChildBody, AssocInfo, AssocTargetBody, ChildAssocInfo, ChildAssociationInfo, Comment, CommentBody, CommentBody1, CommentEntry, CommentPaging, CommentPagingList, Company, ContentInfo, CopyBody, DeletedNode, DeletedNodeEntry, DeletedNodeMinimal, DeletedNodeMinimalEntry, DeletedNodesPaging, DeletedNodesPagingList, EmailSharedLinkBody, Error, ErrorError, Favorite, FavoriteBody, FavoriteEntry, FavoritePaging, FavoritePagingList, FavoriteSiteBody, InlineResponse201, InlineResponse201Entry, MoveBody, NetworkQuota, NodeAssocMinimal, NodeAssociationPaging, NodeAssociationPagingList, NodeBodyLock, NodeChildAssociation, NodeChildAssociationEntry, NodeChildAssociationPaging, NodeChildAssociationPagingList, Node, NodeAssociation, NodeAssociationEntry, NodeAssocMinimalEntry, NodeAssocPaging, NodeAssocPagingList, NodeBody, NodeChildAssocMinimal, NodeChildAssocMinimalEntry, NodeChildAssocPaging, NodeChildAssocPagingList, NodeEntry, NodeFull, NodeMinimal, NodeMinimalEntry, NodePaging, NodePagingList, NodeSharedLink, NodeSharedLinkEntry, NodeSharedLinkPaging, NodeSharedLinkPagingList, NodesnodeIdchildrenContent, Pagination, PathElement, PathInfo, PermissionElement, PermissionsInfo, PersonPaging, PersonPagingList, Person, PersonEntry, PersonNetwork, PersonNetworkEntry, PersonNetworkPaging, PersonNetworkPagingList, Preference, PreferenceEntry, PreferencePaging, PreferencePagingList, Rating, RatingAggregate, RatingBody, RatingEntry, RatingPaging, RatingPagingList, Rendition, RenditionBody, RenditionEntry, RenditionPaging, RenditionPagingList, SharedLinkBody, Site, SiteBody, SiteContainer, SiteContainerEntry, SiteContainerPaging, SiteEntry, SiteMember, SiteMemberBody, SiteMemberEntry, SiteMemberPaging, SiteMemberRoleBody, SiteMembershipBody, SiteMembershipBody1, SiteMembershipRequest, SiteMembershipRequestEntry, SiteMembershipRequestPaging, SiteMembershipRequestPagingList, SitePaging, SitePagingList, Tag, TagBody, TagBody1, TagEntry, TagPaging, TagPagingList, UserInfo, AssociationInfo, AssociationsApi, ChangesApi, ChildAssociationsApi, CommentsApi, FavoritesApi, NetworksApi, NodesApi, PeopleApi, RatingsApi, RenditionsApi, QueriesApi, SharedlinksApi, SitesApi, TagsApi, WebscriptApi) { +}(function(ApiClient, Activity, ActivityActivitySummary, ActivityEntry, ActivityPaging, ActivityPagingList, AssocChildBody, AssocInfo, AssocTargetBody, ChildAssocInfo, ChildAssociationInfo, Comment, CommentBody, CommentBody1, CommentEntry, CommentPaging, CommentPagingList, Company, ContentInfo, CopyBody, DeletedNode, DeletedNodeEntry, DeletedNodeMinimal, DeletedNodeMinimalEntry, DeletedNodesPaging, DeletedNodesPagingList, EmailSharedLinkBody, Error, ErrorError, Favorite, FavoriteBody, FavoriteEntry, FavoritePaging, FavoritePagingList, FavoriteSiteBody, InlineResponse201, InlineResponse201Entry, MoveBody, NetworkQuota, NodeAssocMinimal, NodeAssociationPaging, NodeAssociationPagingList, NodeBodyLock, NodeChildAssociation, NodeChildAssociationEntry, NodeChildAssociationPaging, NodeChildAssociationPagingList, Node, NodeAssociation, NodeAssociationEntry, NodeAssocMinimalEntry, NodeAssocPaging, NodeAssocPagingList, NodeBody, NodeChildAssocMinimal, NodeChildAssocMinimalEntry, NodeChildAssocPaging, NodeChildAssocPagingList, NodeEntry, NodeFull, NodeMinimal, NodeMinimalEntry, NodePaging, NodePagingList, NodeSharedLink, NodeSharedLinkEntry, NodeSharedLinkPaging, NodeSharedLinkPagingList, NodesnodeIdchildrenContent, Pagination, PathElement, PathInfo, PermissionElement, PermissionsInfo, PersonPaging, PersonPagingList, Person, PersonEntry, PersonNetwork, PersonNetworkEntry, PersonNetworkPaging, PersonNetworkPagingList, Preference, PreferenceEntry, PreferencePaging, PreferencePagingList, Rating, RatingAggregate, RatingBody, RatingEntry, RatingPaging, RatingPagingList, Rendition, RenditionBody, RenditionEntry, RenditionPaging, RenditionPagingList, SharedLinkBody, Site, SiteBody, SiteContainer, SiteContainerEntry, SiteContainerPaging, SiteEntry, SiteMember, SiteMemberBody, SiteMemberEntry, SiteMemberPaging, SiteMemberRoleBody, SiteMembershipBody, SiteMembershipBody1, SiteMembershipRequest, SiteMembershipRequestEntry, SiteMembershipRequestPaging, SiteMembershipRequestPagingList, SitePaging, SitePagingList, Tag, TagBody, TagBody1, TagEntry, TagPaging, TagPagingList, UserInfo, AssociationInfo, AssociationsApi, ChangesApi, ChildAssociationsApi, CommentsApi, FavoritesApi, NetworksApi, NodesApi, PeopleApi, RatingsApi, RenditionsApi, QueriesApi, SharedlinksApi, SitesApi, TagsApi, WebscriptApi, DownloadsApi) { 'use strict'; /** @@ -681,6 +681,11 @@ * @property {module:api/CommentsApi} */ CommentsApi: CommentsApi, + /** + * The DownloadsApi service constructor. + * @property {module:api/DownloadsApi} + */ + DownloadsApi: DownloadsApi, /** * The FavoritesApi service constructor. * @property {module:api/FavoritesApi} diff --git a/src/alfresco-core-rest-api/src/model/Download.js b/src/alfresco-core-rest-api/src/model/Download.js new file mode 100644 index 0000000000..8b9ced3424 --- /dev/null +++ b/src/alfresco-core-rest-api/src/model/Download.js @@ -0,0 +1,133 @@ +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['../ApiClient'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient')); + } else { + // Browser globals (root is window) + if (!root.AlfrescoCoreRestApi) { + root.AlfrescoCoreRestApi = {}; + } + root.AlfrescoCoreRestApi.Download = factory(root.AlfrescoCoreRestApi.ApiClient); + } +}(this, function(ApiClient) { + 'use strict'; + + /** + * The Download model module. + * @module model/Download + * @version 0.1.0 + */ + + /** + * Constructs a new Download. + * @alias module:model/Download + * @class + */ + var exports = function() { + var _this = this; + }; + + /** + * Constructs a Download from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Download} obj Optional instance to populate. + * @return {module:model/Download} The populated Download instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('filesAdded')) { + obj['filesAdded'] = ApiClient.convertToType(data['filesAdded'], 'Number'); + } + if (data.hasOwnProperty('bytesAdded')) { + obj['bytesAdded'] = ApiClient.convertToType(data['bytesAdded'], 'Number'); + } + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'String'); + } + if (data.hasOwnProperty('totalFiles')) { + obj['totalFiles'] = ApiClient.convertToType(data['totalFiles'], 'Number'); + } + if (data.hasOwnProperty('totalBytes')) { + obj['totalBytes'] = ApiClient.convertToType(data['totalBytes'], 'Number'); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + } + return obj; + } + + /** + * number of files added so far in the zip + * @member {Number} filesAdded + */ + exports.prototype['filesAdded'] = undefined; + /** + * number of bytes added so far in the zip + * @member {Number} bytesAdded + */ + exports.prototype['bytesAdded'] = undefined; + /** + * the id of the download node + * @member {String} id + */ + exports.prototype['id'] = undefined; + /** + * the total number of files to be added in the zip + * @member {Number} totalFiles + */ + exports.prototype['totalFiles'] = undefined; + /** + * the total number of bytes to be added in the zip + * @member {Number} totalBytes + */ + exports.prototype['totalBytes'] = undefined; + /** + * the current status of the download node creation + * @member {module:model/Download.StatusEnum} status + * @default 'PENDING' + */ + exports.prototype['status'] = 'PENDING'; + + + /** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ + exports.StatusEnum = { + /** + * value: "PENDING" + * @const + */ + "PENDING": "PENDING", + /** + * value: "CANCELLED" + * @const + */ + "CANCELLED": "CANCELLED", + /** + * value: "IN_PROGRESS" + * @const + */ + "IN_PROGRESS": "IN_PROGRESS", + /** + * value: "DONE" + * @const + */ + "DONE": "DONE", + /** + * value: "MAX_CONTENT_SIZE_EXCEEDED" + * @const + */ + "MAX_CONTENT_SIZE_EXCEEDED": "MAX_CONTENT_SIZE_EXCEEDED" }; + + + return exports; +})); diff --git a/src/alfresco-core-rest-api/src/model/DownloadBodyCreate.js b/src/alfresco-core-rest-api/src/model/DownloadBodyCreate.js new file mode 100644 index 0000000000..d3f3969435 --- /dev/null +++ b/src/alfresco-core-rest-api/src/model/DownloadBodyCreate.js @@ -0,0 +1,60 @@ +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['../ApiClient'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient')); + } else { + // Browser globals (root is window) + if (!root.AlfrescoCoreRestApi) { + root.AlfrescoCoreRestApi = {}; + } + root.AlfrescoCoreRestApi.DownloadBodyCreate = factory(root.AlfrescoCoreRestApi.ApiClient); + } +}(this, function(ApiClient) { + 'use strict'; + + /** + * The DownloadBodyCreate model module. + * @module model/DownloadBodyCreate + * @version 0.1.0 + */ + + /** + * Constructs a new DownloadBodyCreate. + * @alias module:model/DownloadBodyCreate + * @class + * @param nodeIds {Array.} + */ + var exports = function(nodeIds) { + var _this = this; + + _this['nodeIds'] = nodeIds; + }; + + /** + * Constructs a DownloadBodyCreate from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/DownloadBodyCreate} obj Optional instance to populate. + * @return {module:model/DownloadBodyCreate} The populated DownloadBodyCreate instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('nodeIds')) { + obj['nodeIds'] = ApiClient.convertToType(data['nodeIds'], ['String']); + } + } + return obj; + } + + /** + * @member {Array.} nodeIds + */ + exports.prototype['nodeIds'] = undefined; + + return exports; +})); diff --git a/src/alfresco-core-rest-api/src/model/DownloadEntry.js b/src/alfresco-core-rest-api/src/model/DownloadEntry.js new file mode 100644 index 0000000000..cd0dc46437 --- /dev/null +++ b/src/alfresco-core-rest-api/src/model/DownloadEntry.js @@ -0,0 +1,60 @@ +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['../ApiClient', '../model/Download'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./Download')); + } else { + // Browser globals (root is window) + if (!root.AlfrescoCoreRestApi) { + root.AlfrescoCoreRestApi = {}; + } + root.AlfrescoCoreRestApi.DownloadEntry = factory(root.AlfrescoCoreRestApi.ApiClient, root.AlfrescoCoreRestApi.Download); + } +}(this, function(ApiClient, Download) { + 'use strict'; + + /** + * The DownloadEntry model module. + * @module model/DownloadEntry + * @version 0.1.0 + */ + + /** + * Constructs a new DownloadEntry. + * @alias module:model/DownloadEntry + * @class + * @param entry {module:model/Download} + */ + var exports = function(entry) { + var _this = this; + + _this['entry'] = entry; + }; + + /** + * Constructs a DownloadEntry from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/DownloadEntry} obj Optional instance to populate. + * @return {module:model/DownloadEntry} The populated DownloadEntry instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('entry')) { + obj['entry'] = Download.constructFromObject(data['entry']); + } + } + return obj; + } + + /** + * @member {module:model/Download} entry + */ + exports.prototype['entry'] = undefined; + + return exports; +}));