inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

AAE-29442 moving to node 20.18.1 (#10500)

Browse Source 
* AAE-0000 - moving to node 20.18.1

* AAE-29442 Adjusted to the new eslint rule
This commit is contained in:
Vito Albano
2024-12-18 11:14:52 +00:00
committed by GitHub
parent dd44e492b7
commit 872fb16b62
144 changed files with 5267 additions and 6842 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
lib/js-api/src/api/content-rest-api/api/actions.api.ts
View File

@@ -29,7 +29,6 @@ export class ActionsApi extends BaseApi {
* Retrieve the details of an action definition
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param actionDefinitionId The identifier of an action definition.
* @returns Promise<ActionDefinitionEntry>
*/
@@ -50,7 +49,6 @@ export class ActionsApi extends BaseApi {
* Execute an action
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param actionBodyExec Action execution details
* @returns Promise<ActionExecResultEntry>
*/
@@ -76,8 +74,6 @@ export class ActionsApi extends BaseApi {
* You can use any of the following fields to order the results:
* - name
* - title
*
*
* @param opts Optional parameters
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
* sort the list by one or more fields.
@@ -114,7 +110,6 @@ export class ActionsApi extends BaseApi {
* You can use any of the following fields to order the results:
* - name
* - title
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to

1
lib/js-api/src/api/content-rest-api/api/activities.api.ts
View File

@@ -30,7 +30,6 @@ export class ActivitiesApi extends BaseApi {
*
* Gets a list of activities for person **personId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @param opts.who A filter to include the user's activities only me, other user's activities only others'

1
lib/js-api/src/api/content-rest-api/api/agents.api.ts
View File

@@ -25,7 +25,6 @@ import { BaseApi } from '../../hxi-connector-api/api/base.api';
export class AgentsApi extends BaseApi {
/**
* Gets all agents.
*
* @returns AgentPaging object containing the agents.
*/
getAgents(): Promise<AgentPaging> {

8
lib/js-api/src/api/content-rest-api/api/audit.api.ts
View File

@@ -37,7 +37,6 @@ export class AuditApi extends BaseApi {
* - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
* - where=(id BETWEEN ('1234', '4321')
* You must have admin rights to delete audit information.
*
* @param auditApplicationId The identifier of an audit application.
* @param where Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example:
* - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
@@ -68,7 +67,6 @@ export class AuditApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
* You must have admin rights to delete audit information.
*
* @param auditApplicationId The identifier of an audit application.
* @param auditEntryId The identifier of an audit entry.
* @return Promise<{}>
@@ -95,7 +93,6 @@ export class AuditApi extends BaseApi {
* You must have admin rights to retrieve audit information.
*
* You can use the **include** parameter to return the minimum and/or maximum audit record id for the application.
*
* @param auditApplicationId The identifier of an audit application.
* @param opts Optional parameters
* @return Promise<AuditApp>
@@ -124,7 +121,6 @@ export class AuditApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
* You must have admin rights to access audit information.
*
* @param auditApplicationId The identifier of an audit application.
* @param auditEntryId The identifier of an audit entry.
* @param opts Optional parameters
@@ -164,7 +160,6 @@ export class AuditApi extends BaseApi {
* - Alfresco Sync Service (used by Enterprise Cloud Sync)
*
* You must have admin rights to retrieve audit information.
*
* @param opts Optional parameters
* @return Promise<AuditAppPaging>
*/
@@ -201,7 +196,6 @@ export class AuditApi extends BaseApi {
*
* For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order.
* You must have admin rights to retrieve audit information.
*
* @param auditApplicationId The identifier of an audit application.
* @param opts Optional parameters
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
@@ -262,7 +256,6 @@ export class AuditApi extends BaseApi {
*
* For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order.
* This relies on the pre-configured 'alfresco-access' audit application.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
@@ -319,7 +312,6 @@ export class AuditApi extends BaseApi {
* Note, it is still possible to query &/or delete any existing audit entries even
* if auditing is disabled for the audit application.
* You must have admin rights to update audit application.
*
* @param auditApplicationId The identifier of an audit application.
* @param auditAppBodyUpdate The audit application to update.
* @param opts Optional parameters

8
lib/js-api/src/api/content-rest-api/api/categories.api.ts
View File

@@ -34,7 +34,6 @@ export class CategoriesApi extends BaseApi {
* The parameter categoryId can be set to the alias -root- to obtain a list of top level categories.
*
* You can use the **include** parameter to return additional **values** information.
*
* @param categoryId The identifier of a category.
* @param opts Optional parameters
* @returns Promise<CategoryPaging>
@@ -66,7 +65,6 @@ export class CategoriesApi extends BaseApi {
*
* Get a specific category with categoryId.
* You can use the **include** parameter to return additional **values** information.
*
* @param categoryId The identifier of a category.
* @param opts Optional parameters
* @returns Promise<CategoryEntry>
@@ -93,7 +91,6 @@ export class CategoriesApi extends BaseApi {
/**
* List of categories that node is assigned to
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @returns Promise<CategoryPaging>
@@ -125,7 +122,6 @@ export class CategoriesApi extends BaseApi {
*
* This will cause everything to be removed from the category.
* You must have admin rights to delete a category.
*
* @param categoryId The identifier of a category.
* @returns Promise<{}>
*/
@@ -144,7 +140,6 @@ export class CategoriesApi extends BaseApi {
/**
* Unassign a node from category
*
* @param nodeId The identifier of a node.
* @param categoryId The identifier of a category.
* @returns Promise<{}>
@@ -169,7 +164,6 @@ export class CategoriesApi extends BaseApi {
*
* Updates the category **categoryId**.
* You must have admin rights to update a category.
*
* @param categoryId The identifier of a category.
* @param categoryBodyUpdate The updated category
* @param opts Optional parameters
@@ -203,7 +197,6 @@ export class CategoriesApi extends BaseApi {
* Creates new categories within the category **categoryId**.
* The parameter categoryId can be set to the alias -root- to create a new top level category.
* You must have admin rights to create a category.
*
* @param categoryId The identifier of a category.
* @param categoryBodyCreate List of categories to create.
* @param opts Optional parameters.
@@ -233,7 +226,6 @@ export class CategoriesApi extends BaseApi {
/**
* Assign a node to a category
*
* @param nodeId The identifier of a node.
* @param categoryLinkBodyCreate The new category link
* @param opts Optional parameters

4
lib/js-api/src/api/content-rest-api/api/comments.api.ts
View File

@@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
export class CommentsApi extends BaseApi {
/**
* Create a comment
*
* @param nodeId The identifier of a node.
* @param commentBodyCreate The comment text. Note that you can also provide a list of comments.
* @param opts Optional parameters
@@ -58,7 +57,6 @@ export class CommentsApi extends BaseApi {
/**
* Delete a comment
*
* @param nodeId The identifier of a node.
* @param commentId The identifier of a comment.
* @returns Promise<{}>
@@ -82,7 +80,6 @@ export class CommentsApi extends BaseApi {
* List comments
*
* Gets a list of comments for the node **nodeId**, sorted chronologically with the newest comment first.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @returns Promise<CommentPaging>
@@ -110,7 +107,6 @@ export class CommentsApi extends BaseApi {
/**
* Update a comment
*
* @param nodeId The identifier of a node.
* @param commentId The identifier of a comment.
* @param commentBodyUpdate The JSON representing the comment to be updated.

3
lib/js-api/src/api/content-rest-api/api/downloads.api.ts
View File

@@ -36,7 +36,6 @@ export class DownloadsApi extends BaseApi {
* 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 downloadId The identifier of a download node.
* @returns Promise<{}>
*/
@@ -58,7 +57,6 @@ export class DownloadsApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
* **Note:** The content of the download node can be obtained using the **GET /nodes/{downloadId}/content** endpoint
*
* @param downloadBodyCreate The nodeIds the content of which will be zipped, which zip will be set as the content of our download node.
* @param opts Optional parameters
* @param opts.fields A list of field names. You can use this parameter to restrict the fields
@@ -86,7 +84,6 @@ export class DownloadsApi extends BaseApi {
* Get a download
*
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
*
* @param downloadId The identifier of a download node.
* @param opts Optional parameters
* @param opts.fields A list of field names. You can use this parameter to restrict the fields

8
lib/js-api/src/api/content-rest-api/api/favorites.api.ts
View File

@@ -30,7 +30,6 @@ export class FavoritesApi extends BaseApi {
*
* Favorite a **site**, **file**, or **folder** in the repository.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param favoriteBodyCreate An object identifying the entity to be favorited.
* The object consists of a single property which is an object with the name site, file, or folder.
@@ -76,7 +75,6 @@ export class FavoritesApi extends BaseApi {
* Create a site favorite
*
* **Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use /people/{personId}/favorites instead.
*
* @param personId The identifier of a person.
* @param favoriteSiteBodyCreate The id of the site to favorite.
* @param opts Optional parameters
@@ -106,7 +104,6 @@ export class FavoritesApi extends BaseApi {
* Delete a favorite
*
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param favoriteId The identifier of a favorite.
* @returns Promise<{}>
@@ -133,7 +130,6 @@ export class FavoritesApi extends BaseApi {
* Use /people/{personId}/favorites/{favoriteId} instead.
*
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param siteId The identifier of a site.
* @returns Promise<{}>
@@ -158,7 +154,6 @@ export class FavoritesApi extends BaseApi {
*
* Gets favorite **favoriteId** for person **personId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param favoriteId The identifier of a favorite.
* @param opts Optional parameters
@@ -201,7 +196,6 @@ export class FavoritesApi extends BaseApi {
* Use /people/{personId}/favorites/{favoriteId} instead.
*
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param siteId The identifier of a site.
* @param opts Optional parameters
@@ -240,7 +234,6 @@ export class FavoritesApi extends BaseApi {
* Use /people/{personId}/favorites instead.
*
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @returns Promise<SitePaging>
@@ -271,7 +264,6 @@ export class FavoritesApi extends BaseApi {
*
* Gets a list of favorites for person **personId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param opts optional parameters
* @returns Promise<FavoritePaging>

9
lib/js-api/src/api/content-rest-api/api/groups.api.ts
View File

@@ -75,7 +75,6 @@ export class GroupsApi extends BaseApi {
* The group will be created in the **APP.DEFAULT** and **AUTH.ALF** zones.
*
* You must have admin rights to create a group.
*
* @param groupBodyCreate The group to create.
* @param opts Optional parameters
* @returns Promise<GroupEntry>
@@ -104,7 +103,6 @@ export class GroupsApi extends BaseApi {
* If the added group was previously a root group then it becomes a non-root group since it now has a parent.
* It is an error to specify an **id** that does not exist.
* You must have admin rights to create a group membership.
*
* @param groupId The identifier of a group.
* @param groupMembershipBodyCreate The group membership to add (person or sub-group).
* @param opts Optional parameters
@@ -140,7 +138,6 @@ export class GroupsApi extends BaseApi {
* In this case, removing a group member does not delete the person or sub-group itself.
* If a removed sub-group no longer has any parent groups then it becomes a root group.
* You must have admin rights to delete a group.
*
* @param groupId The identifier of a group.
* @param opts Optional parameters
* @returns Promise
@@ -174,7 +171,6 @@ export class GroupsApi extends BaseApi {
* Delete group member **groupMemberId** (person or sub-group) from group **groupId**.
* Removing a group member does not delete the person or sub-group itself.\
* If a removed sub-group no longer has any parent groups then it becomes a root group.
*
* @param groupId The identifier of a group.
* @param groupMemberId The identifier of a person or group.
* @returns Promise<{}>
@@ -201,7 +197,6 @@ export class GroupsApi extends BaseApi {
*
* Get details for group **groupId**.
* You can use the **include** parameter to return additional information.
*
* @param groupId The identifier of a group.
* @param opts Optional parameters
* @returns Promise<GroupEntry>
@@ -241,7 +236,6 @@ export class GroupsApi extends BaseApi {
* You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter:
* - id
* - displayName
*
* @param groupId The identifier of a group.
* @param opts Optional parameters
* @returns Promise<GroupMemberPaging>
@@ -273,7 +267,6 @@ export class GroupsApi extends BaseApi {
* List group memberships
*
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @param opts.skipCount The number of entities that exist in the collection before those included in this list.
@@ -327,7 +320,6 @@ export class GroupsApi extends BaseApi {
* List groups
*
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
*
* @param opts Optional parameters
* @returns Promise<GroupPaging>
*/
@@ -353,7 +345,6 @@ export class GroupsApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
* You must have admin rights to update a group.
*
* @param groupId The identifier of a group.
* @param groupBodyUpdate The group information to update.
* @param opts Optional parameters

3
lib/js-api/src/api/content-rest-api/api/networks.api.ts
View File

@@ -28,7 +28,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
export class NetworksApi extends BaseApi {
/**
* Get a network
*
* @param networkId The identifier of a network.
* @param opts Optional parameters
* @returns Promise<PersonNetworkEntry>
@@ -56,7 +55,6 @@ export class NetworksApi extends BaseApi {
* Get network information
*
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param networkId The identifier of a network.
* @param opts Optional parameters
@@ -88,7 +86,6 @@ export class NetworksApi extends BaseApi {
*
* 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.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @returns Promise<PersonNetworkPaging>

22
lib/js-api/src/api/content-rest-api/api/nodes.api.ts
View File

@@ -91,7 +91,6 @@ export class NodesApi extends BaseApi {
* If the source **nodeId** is a folder, then all of its children are also copied.
*
* If the source **nodeId** is a file, it's properties, aspects and tags are copied, it's ratings, comments and locks are not.
*
* @param nodeId The identifier of a node.
* @param nodeBodyCopy The targetParentId and, optionally, a new name which should include the file extension.
* @param opts Optional parameters
@@ -123,7 +122,6 @@ export class NodesApi extends BaseApi {
* Create node association
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a source node.
* @param associationBodyCreate The target node id and assoc type.
* @param opts Optional parameters
@@ -159,7 +157,6 @@ export class NodesApi extends BaseApi {
* Create a node
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
* -my-
* -shared-
@@ -223,7 +220,6 @@ export class NodesApi extends BaseApi {
/**
* Create a folder
*
* @param name - folder name
* @param relativePath - The relativePath specifies the folder structure to create relative to the node identified by nodeId.
* @param nodeId default value root.The identifier of a node where add the folder. You can also use one of these well-known aliases: -my- | -shared- | -root-
@@ -246,7 +242,6 @@ export class NodesApi extends BaseApi {
* Create secondary child
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a parent node.
* @param secondaryChildAssociationBodyCreate The child node id and assoc type.
* @param opts Optional parameters
@@ -292,7 +287,6 @@ export class NodesApi extends BaseApi {
* If the association type is **not** specified, then all peer associations, of any type, in the direction
* from source to target, are deleted.
* **Note:** After removal of the peer association, or associations, from source to target, the two nodes may still have peer associations in the other direction.
*
* @param nodeId The identifier of a source node.
* @param targetId The identifier of a target node.
* @param opts Optional parameters
@@ -333,7 +327,6 @@ export class NodesApi extends BaseApi {
* child association is restored. This applies recursively for any primary children. No other secondary child associations or
* peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original
* associations were to nodes inside or outside the restored hierarchy.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.permanent If **true** then the node is deleted permanently, without moving to the trashcan.
@@ -359,7 +352,6 @@ export class NodesApi extends BaseApi {
}
/**
* Delete multiple nodes
*
* @param nodeIds The list of node IDs to delete.
* @param opts Optional parameters
* @param opts.permanent If **true** then nodes are deleted permanently, without moving to the trashcan.
@@ -388,7 +380,6 @@ export class NodesApi extends BaseApi {
* If the association type is **not** specified, then all secondary child associations, of any type in the direction
* from parent to secondary child, will be deleted. The child will still have a primary parent and may still be
* associated as a secondary child with other secondary parents.
*
* @param nodeId The identifier of a parent node.
* @param childId The identifier of a child node.
* @param opts Optional parameters
@@ -417,7 +408,6 @@ export class NodesApi extends BaseApi {
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* You can use the **include** parameter to return additional information.
*
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
* - -my-
* - -shared-
@@ -451,7 +441,6 @@ export class NodesApi extends BaseApi {
* Get node content
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
@@ -536,7 +525,6 @@ export class NodesApi extends BaseApi {
* - createdAt
* - modifiedByUser
* - createdByUser
*
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
* - -my-
* - -shared-
@@ -600,7 +588,6 @@ export class NodesApi extends BaseApi {
*
* Gets a list of parent nodes that are associated with the current child **nodeId**.
* The list includes both the primary parent and any secondary parents.
*
* @param nodeId The identifier of a child node. You can also use one of these well-known aliases:
* - -my-
* - -shared-
@@ -651,7 +638,6 @@ export class NodesApi extends BaseApi {
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* Gets a list of secondary child nodes that are associated with the current parent **nodeId**, via a secondary child association.
*
* @param nodeId The identifier of a parent node. You can also use one of these well-known aliases:
* -my-
* -shared-
@@ -698,7 +684,6 @@ export class NodesApi extends BaseApi {
* List source associations
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a target node.
* @param opts Optional parameters
* @param opts.where Optionally filter the list by **assocType**. Here's an example:
@@ -738,7 +723,6 @@ export class NodesApi extends BaseApi {
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* Gets a list of target nodes that are associated with the current source **nodeId**.
*
* @param nodeId The identifier of a source node.
* @param opts Optional parameters
* @param opts.where Optionally filter the list by **assocType**. Here's an example:
@@ -781,7 +765,6 @@ export class NodesApi extends BaseApi {
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* If a lock on the node cannot be taken, then an error is returned.
*
* @param nodeId The identifier of a node.
* @param nodeBodyLock Lock details.
* @param opts Optional parameters
@@ -818,7 +801,6 @@ export class NodesApi extends BaseApi {
* The moved node retains its name unless you specify a new **name** in the request body.
* If the source **nodeId** is a folder, then its children are also moved.
* The move will effectively change the primary parent.
*
* @param nodeId The identifier of a node.
* @param nodeBodyMove The targetParentId and, optionally, a new name which should include the file extension.
* @param opts Optional parameters
@@ -853,7 +835,6 @@ export class NodesApi extends BaseApi {
*
* The current user must be the owner of the locks or have admin rights, otherwise an error is returned.
* If a lock on the node cannot be released, then an error is returned.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @returns Promise<NodeEntry>
@@ -882,7 +863,6 @@ export class NodesApi extends BaseApi {
* Update a node
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param nodeBodyUpdate The node information to update.
* @param opts Optional parameters
@@ -913,7 +893,6 @@ export class NodesApi extends BaseApi {
* Update node content
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param contentBodyUpdate The binary content
* @param opts Optional parameters
@@ -965,7 +944,6 @@ export class NodesApi extends BaseApi {
* Generate a direct access content url for a given node
*
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
*
* @param nodeId The identifier of a node.
* @returns Promise<DirectAccessUrlEntry>
*/

9
lib/js-api/src/api/content-rest-api/api/people.api.ts
View File

@@ -30,7 +30,6 @@ export class PeopleApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
* **Note:** setting properties of type d:content and d:category are not supported.
*
* @param personBodyCreate The person details.
* @param opts Optional parameters
* @returns Promise<PersonEntry>
@@ -58,7 +57,6 @@ export class PeopleApi extends BaseApi {
* Deletes the avatar image related to person **personId**.
* You must be the person or have admin rights to update a person's avatar.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @returns Promise<{}>
*/
@@ -84,7 +82,6 @@ export class PeopleApi extends BaseApi {
* the **placeholder** query parameter can be optionally used to request a placeholder image to be returned.
*
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
@@ -131,7 +128,6 @@ export class PeopleApi extends BaseApi {
* Get a person
*
* You can use the `-me-` string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @returns Promise<PersonEntry>
@@ -171,7 +167,6 @@ export class PeopleApi extends BaseApi {
* - id
* - firstName
* - lastName
*
* @param opts Optional parameters
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
* sort the list by one or more fields.
@@ -209,7 +204,6 @@ export class PeopleApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
* **Note:** No authentication is required to call this endpoint.
*
* @param personId The identifier of a person.
* @param clientBody The client name to send email with app-specific url.
* @returns Promise<{}>
@@ -234,7 +228,6 @@ export class PeopleApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
* **Note:** No authentication is required to call this endpoint.
*
* @param personId The identifier of a person.
* @param passwordResetBody The reset password details
* @returns Promise<{}>
@@ -267,7 +260,6 @@ export class PeopleApi extends BaseApi {
* You must be the person or have admin rights to update a person's avatar.
*
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param contentBodyUpdate The binary content
* @returns Promise<{}>
@@ -304,7 +296,6 @@ export class PeopleApi extends BaseApi {
* Admin users cannot be disabled by setting enabled to false.
* Non-admin users may not disable themselves.
* **Note:** setting properties of type d:content and d:category are not supported.
*
* @param personId The identifier of a person.
* @param personBodyUpdate The person details.
* @param opts Optional parameters

2
lib/js-api/src/api/content-rest-api/api/preferences.api.ts
View File

@@ -30,7 +30,6 @@ export class PreferencesApi extends BaseApi {
*
* Gets a specific preference for person **personId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param preferenceName The name of the preference.
* @param opts Optional parameters
@@ -63,7 +62,6 @@ export class PreferencesApi extends BaseApi {
* Note that each preference consists of an **id** and a **value**.
*
* The **value** can be of any JSON type.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @returns Promise<PreferencePaging>

1
lib/js-api/src/api/content-rest-api/api/probes.api.ts
View File

@@ -32,7 +32,6 @@ export class ProbesApi extends BaseApi {
* The readiness probe is normally only used to check repository startup.
* The liveness probe should then be used to check the repository is still responding to requests.
* **Note:** No authentication is required to call this endpoint.
*
* @param probeId The name of the probe:
* - -ready-
* - -live-

3
lib/js-api/src/api/content-rest-api/api/queries.api.ts
View File

@@ -79,7 +79,6 @@ export class QueriesApi extends BaseApi {
* - name
* - modifiedAt
* - createdAt
*
* @param term The term to search for.
* @param opts Optional parameters
* @returns Promise<NodePaging>
@@ -122,7 +121,6 @@ export class QueriesApi extends BaseApi {
* - id
* - firstName
* - lastName
*
* @param term The term to search for.
* @param opts Optional parameters
* @returns Promise<PersonPaging>
@@ -164,7 +162,6 @@ export class QueriesApi extends BaseApi {
* - id
* - title
* - description
*
* @param term The term to search for.
* @param opts Optional parameters
* @returns Promise<SitePaging>

4
lib/js-api/src/api/content-rest-api/api/ratings.api.ts
View File

@@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
export class RatingsApi extends BaseApi {
/**
* Create a rating
*
* @param nodeId The identifier of a node.
* @param ratingBodyCreate For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar.
* For example, to \"like\" a file the following body would be used:
@@ -67,7 +66,6 @@ export class RatingsApi extends BaseApi {
* Delete a rating
*
* Deletes rating **ratingId** from node **nodeId**.
*
* @param nodeId The identifier of a node.
* @param ratingId The identifier of a rating.
* @returns Promise<{}>
@@ -91,7 +89,6 @@ export class RatingsApi extends BaseApi {
* Get a rating
*
* Get the specific rating **ratingId** on node **nodeId**.
*
* @param nodeId The identifier of a node.
* @param ratingId The identifier of a rating.
* @param opts Optional parameters
@@ -122,7 +119,6 @@ export class RatingsApi extends BaseApi {
* List ratings
*
* Gets a list of ratings for node **nodeId**.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @returns Promise<RatingPaging>

5
lib/js-api/src/api/content-rest-api/api/renditions.api.ts
View File

@@ -27,7 +27,6 @@ export class RenditionsApi extends BaseApi {
* Create rendition
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param renditionBodyCreate The rendition \"id\".
* @returns Promise<{}>
@@ -51,7 +50,6 @@ export class RenditionsApi extends BaseApi {
* Get rendition information
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
* @returns Promise<RenditionEntry>
@@ -76,7 +74,6 @@ export class RenditionsApi extends BaseApi {
* Get rendition content
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
* @param opts Optional parameters
@@ -143,7 +140,6 @@ export class RenditionsApi extends BaseApi {
* You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where**
* clause will return just the CREATED renditions:
* - (status='CREATED')
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.where A string to restrict the returned objects by using a predicate.
@@ -168,7 +164,6 @@ export class RenditionsApi extends BaseApi {
* Generate a direct access content url for a given rendition of a node
*
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
*
* @param nodeId The identifier of a node.
* @param renditionId The identifier of a version
* @returns Promise<DirectAccessUrlEntry>

3
lib/js-api/src/api/content-rest-api/api/search-ai.api.ts
View File

@@ -24,7 +24,6 @@ import { BaseApi } from '../../hxi-connector-api/api/base.api';
export class SearchAiApi extends BaseApi {
/**
* Ask a question to the AI.
*
* @param questions QuestionRequest array containing questions to ask.
* @returns QuestionModel object containing information about questions.
*/
@@ -41,7 +40,6 @@ export class SearchAiApi extends BaseApi {
/**
* Get an answer to specific question.
*
* @param questionId The ID of the question to get an answer for.
* @returns AiAnswerEntry object containing the answer.
*/
@@ -53,7 +51,6 @@ export class SearchAiApi extends BaseApi {
/**
* Get the knowledge retrieval configuration.
*
* @returns KnowledgeRetrievalConfigEntry object containing the configuration.
*/
getConfig(): Promise<KnowledgeRetrievalConfigEntry> {

9
lib/js-api/src/api/content-rest-api/api/sharedlinks.api.ts
View File

@@ -34,7 +34,6 @@ export class SharedlinksApi extends BaseApi {
* Create a shared link to a file
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param sharedLinkBodyCreate The nodeId to create a shared link for.
* @param opts Optional parameters
* @returns Promise<SharedLinkEntry>
@@ -59,7 +58,6 @@ export class SharedlinksApi extends BaseApi {
* Deletes a shared link
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param sharedId The identifier of a shared link to a file.
* @returns Promise<{}>
*/
@@ -80,7 +78,6 @@ export class SharedlinksApi extends BaseApi {
* Email shared link
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param sharedId The identifier of a shared link to a file.
* @param sharedLinkBodyEmail The shared link email to send.
* @returns Promise<{}>
@@ -105,7 +102,6 @@ export class SharedlinksApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
* **Note:** No authentication is required to call this endpoint.
*
* @param sharedId The identifier of a shared link to a file.
* @param opts Optional parameters
* @returns Promise<SharedLinkEntry>
@@ -134,7 +130,6 @@ export class SharedlinksApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
* **Note:** No authentication is required to call this endpoint.
*
* @param sharedId The identifier of a shared link to a file.
* @param opts Optional parameters
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
@@ -190,7 +185,6 @@ export class SharedlinksApi extends BaseApi {
* which means the rendition is available to view/download.
*
* **Note:** No authentication is required to call this endpoint.
*
* @param sharedId The identifier of a shared link to a file.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
* @returns Promise<RenditionEntry>
@@ -216,7 +210,6 @@ export class SharedlinksApi extends BaseApi {
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
* **Note:** No authentication is required to call this endpoint.
*
* @param sharedId The identifier of a shared link to a file.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
* @param opts Optional parameters
@@ -278,7 +271,6 @@ export class SharedlinksApi extends BaseApi {
* where the rendition status is CREATED, which means the rendition is available to view/download.
*
* **Note:** No authentication is required to call this endpoint.
*
* @param sharedId The identifier of a shared link to a file.
* @returns Promise<RenditionPaging>
*/
@@ -305,7 +297,6 @@ export class SharedlinksApi extends BaseApi {
* 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.
*
* @param opts Optional parameters
* @param opts.where Optionally filter the list by \"sharedByUser\" `userId` of person who shared the link (can also use -me-)
* where=(sharedByUser='jbloggs')

29
lib/js-api/src/api/content-rest-api/api/sites.api.ts
View File

@@ -47,7 +47,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
export class SitesApi extends BaseApi {
/**
* Approve a site membership request
*
* @param siteId The identifier of a site.
* @param inviteeId The invitee username.
* @param opts Optional parameters
@@ -76,7 +75,6 @@ export class SitesApi extends BaseApi {
* Create a site
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param siteBodyCreate The site details
* @param opts Optional parameters
* @param opts.skipConfiguration Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created. (default to false)
@@ -111,7 +109,6 @@ export class SitesApi extends BaseApi {
/**
* Create a site membership
*
* @param siteId The identifier of a site.
* @param siteMembershipBodyCreate The person to add and their role
* @param opts Optional parameters
@@ -144,7 +141,6 @@ export class SitesApi extends BaseApi {
/**
* Create a site membership request
*
* @param personId The identifier of a person.
* @param siteMembershipRequestBodyCreate Site membership request details
* @param opts Optional parameters
@@ -178,7 +174,6 @@ export class SitesApi extends BaseApi {
/**
* Delete a site
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param siteId The identifier of a site.
* @param opts Optional parameters
* @param opts.permanent Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan. (default to false)
@@ -205,7 +200,6 @@ export class SitesApi extends BaseApi {
/**
* Delete a site membership
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param siteId The identifier of a site.
* @param personId The identifier of a person.
* @returns Promise<{}>
@@ -230,7 +224,6 @@ export class SitesApi extends BaseApi {
*
* Deletes person **personId** as a member of site **siteId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param siteId The identifier of a site.
* @returns Promise<{}>
@@ -255,7 +248,6 @@ export class SitesApi extends BaseApi {
*
* Deletes the site membership request to site **siteId** for person **personId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param siteId The identifier of a site.
* @returns Promise<{}>
@@ -289,7 +281,6 @@ export class SitesApi extends BaseApi {
* objects related to the site **siteId**:
*
* containers,members
*
* @param siteId The identifier of a site.
* @param opts Optional parameters
* @param opts.relations Use the relations parameter to include one or more related entities in a single response.
@@ -319,7 +310,6 @@ export class SitesApi extends BaseApi {
* Get a site container
*
* Gets information on the container **containerId** in site **siteId**.
*
* @param siteId The identifier of a site.
* @param containerId The unique identifier of a site container.
* @param opts Optional parameters
@@ -350,7 +340,6 @@ export class SitesApi extends BaseApi {
*
* Gets site membership information for person **personId** on site **siteId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param siteId The identifier of a site.
* @param personId The identifier of a person.
* @param opts Optional parameters
@@ -382,7 +371,6 @@ export class SitesApi extends BaseApi {
*
* Gets site membership information for person **personId** on site **siteId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param siteId The identifier of a site.
* @returns Promise<SiteRoleEntry>
@@ -408,7 +396,6 @@ export class SitesApi extends BaseApi {
*
* Gets the site membership request for site **siteId** for person **personId**, if one exists.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param siteId The identifier of a site.
* @param opts Optional parameters
@@ -449,7 +436,6 @@ export class SitesApi extends BaseApi {
* This may be combined with the siteId filter, as shown below:
*
* where=(siteId=mySite AND personId=person))
*
* @param opts Optional parameters
* @param opts.where A string to restrict the returned objects by using a predicate.
* @returns Promise<SiteMembershipRequestWithPersonPaging>
@@ -473,7 +459,6 @@ export class SitesApi extends BaseApi {
* List site containers
*
* Gets a list of containers for the site **siteId**.
*
* @param siteId The identifier of a site.
* @param opts Optional parameters
* @returns Promise<SiteContainerPaging>
@@ -504,7 +489,6 @@ export class SitesApi extends BaseApi {
*
* Gets a list of the current site membership requests for person **personId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @returns Promise<SiteMembershipRequestPaging>
@@ -534,7 +518,6 @@ export class SitesApi extends BaseApi {
* List site memberships
*
* Gets a list of site memberships for site **siteId**.
*
* @param siteId The identifier of a site.
* @param opts Optional parameters
* @returns Promise<SiteMemberPaging>
@@ -585,7 +568,6 @@ export class SitesApi extends BaseApi {
* - id
* - title
* - role
*
* @param personId The identifier of a person.
* @param opts Optional parameters
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
@@ -657,8 +639,6 @@ export class SitesApi extends BaseApi {
* objects related to each site:
*
* containers,members
*
*
* @param opts Optional parameters
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
* sort the list by one or more fields.
@@ -695,7 +675,6 @@ export class SitesApi extends BaseApi {
/**
* Reject a site membership request
*
* @param siteId The identifier of a site.
* @param inviteeId The invitee username.
* @param opts Optional parameters
@@ -729,7 +708,6 @@ export class SitesApi extends BaseApi {
* (site) admin can update title, description or visibility.
*
* Note: the id of a site cannot be updated once the site has been created.
*
* @param siteId The identifier of a site.
* @param siteBodyUpdate The site information to update.
* @param opts Optional parameters
@@ -768,7 +746,6 @@ export class SitesApi extends BaseApi {
* - SiteCollaborator
* - SiteContributor
* - SiteManager
*
* @param siteId The identifier of a site.
* @param personId The identifier of a person.
* @param siteMembershipBodyUpdate The persons new role
@@ -808,7 +785,6 @@ export class SitesApi extends BaseApi {
*
* Updates the message for the site membership request to site **siteId** for person **personId**.
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
*
* @param personId The identifier of a person.
* @param siteId The identifier of a site.
* @param siteMembershipRequestBodyUpdate The new message to display
@@ -852,7 +828,6 @@ export class SitesApi extends BaseApi {
* - SiteCollaborator
* - SiteContributor
* - SiteManager
*
* @param siteId The identifier of a site.
* @param siteMembershipBodyCreate The group to add and it role
* @param opts Optional parameters
@@ -887,7 +862,6 @@ export class SitesApi extends BaseApi {
* List group membership for site
*
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
*
* @param siteId The identifier of a site.
* @param opts Optional parameters
* @returns Promise<SiteGroupPaging>
@@ -917,7 +891,6 @@ export class SitesApi extends BaseApi {
* Get information about site membership of group
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
* Gets site membership information for group **groupId** on site **siteId**.
*
* @param siteId The identifier of a site.
* @param groupId The authorityId of a group.
* @param opts Optional parameters
@@ -954,7 +927,6 @@ export class SitesApi extends BaseApi {
* - SiteCollaborator
* - SiteContributor
* - SiteManager
*
* @param siteId The identifier of a site.
* @param groupId The authorityId of a group.
* @param siteMembershipBodyUpdate The group new role
@@ -991,7 +963,6 @@ export class SitesApi extends BaseApi {
/**
* Delete a group membership for site
*
* @param siteId The identifier of a site.
* @param groupId The authorityId of a group.
* @returns Promise<{}>

10
lib/js-api/src/api/content-rest-api/api/tags.api.ts
View File

@@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t
export class TagsApi extends BaseApi {
/**
* Create a tag for a node
*
* @param nodeId The identifier of a node.
* @param tagBodyCreate The new tag
* @param opts Optional parameters
@@ -58,7 +57,6 @@ export class TagsApi extends BaseApi {
/**
* Delete a tag from a node
*
* @param nodeId The identifier of a node.
* @param tagId The identifier of a tag.
* @returns Promise<{}>
@@ -80,7 +78,6 @@ export class TagsApi extends BaseApi {
/**
* Get a tag
*
* @param tagId The identifier of a tag.
* @param opts Optional parameters
* @returns Promise<TagEntry>
@@ -106,7 +103,6 @@ export class TagsApi extends BaseApi {
/**
* List tags
*
* @param opts Optional parameters
* @param opts.tag Name or pattern for which tag is returned. Example of pattern: *test* which returns tags like 'my test 1'
* @param opts.matching Switches filtering to pattern mode instead of exact mode.
@@ -139,7 +135,6 @@ export class TagsApi extends BaseApi {
/**
* List tags for a node
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @returns Promise<TagPaging>
@@ -167,7 +162,6 @@ export class TagsApi extends BaseApi {
/**
* Update a tag
*
* @param tagId The identifier of a tag.
* @param tagBodyUpdate The updated tag
* @param opts Optional parameters
@@ -196,7 +190,6 @@ export class TagsApi extends BaseApi {
/**
* Deletes a tag by **tagId**. This will cause the tag to be removed from all nodes.
*
* @param tagId The identifier of a tag.
* @returns Promise<{}>
*/
@@ -215,7 +208,6 @@ export class TagsApi extends BaseApi {
/**
* Create specified by **tags** list of tags.
*
* @param tags List of tags to create.
* @returns Promise<TagEntry[]>
*/
@@ -230,7 +222,6 @@ export class TagsApi extends BaseApi {
/**
* Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned.
*
* @param nodeId Id of node to which tags should be assigned.
* @param tags List of tags to create and assign or just assign if they already exist.
* @returns Promise<TagPaging>
@@ -246,7 +237,6 @@ export class TagsApi extends BaseApi {
/**
* Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned.
*
* @param nodeId Id of node to which tags should be assigned.
* @param tag List of tags to create and assign or just assign if they already exist.
* @returns Promise<TagEntry>

11
lib/js-api/src/api/content-rest-api/api/trashcan.api.ts
View File

@@ -28,7 +28,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t
/**
* Trashcan service.
*
* @module TrashcanApi
*/
export class TrashcanApi extends BaseApi {
@@ -36,7 +35,6 @@ export class TrashcanApi extends BaseApi {
* Permanently delete a deleted node
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @returns Promise<{}>
*/
@@ -57,7 +55,6 @@ export class TrashcanApi extends BaseApi {
* Get rendition information for a deleted node
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
* @returns Promise<RenditionEntry>
@@ -82,7 +79,6 @@ export class TrashcanApi extends BaseApi {
* Get rendition content of a deleted node
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
* @param opts Optional parameters
@@ -142,7 +138,6 @@ export class TrashcanApi extends BaseApi {
* Get a deleted node
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @returns Promise<DeletedNodeEntry>
@@ -170,7 +165,6 @@ export class TrashcanApi extends BaseApi {
* Get deleted node content
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
@@ -232,7 +226,6 @@ export class TrashcanApi extends BaseApi {
* clause will return just the CREATED renditions:
*
* - (status='CREATED')
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.where A string to restrict the returned objects by using a predicate.
@@ -265,7 +258,6 @@ export class TrashcanApi extends BaseApi {
* Gets a list of deleted nodes for the current user.
* If the current user is an administrator deleted nodes for all users will be returned.
* The list of deleted nodes will be ordered with the most recently deleted node at the top of the list.
*
* @param opts Optional parameters
* @returns Promise<DeletedNodesPaging>
*/
@@ -298,7 +290,6 @@ export class TrashcanApi extends BaseApi {
*
* Also, any previously shared link will not be restored since it is deleted at the time
* of delete of each node.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @param opts.deletedNodeBodyRestore The targetParentId if the node is restored to a new location.
@@ -336,7 +327,6 @@ export class TrashcanApi extends BaseApi {
* Generate a direct access content url for a given deleted node
*
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
*
* @param nodeId The identifier of a node.
* @returns Promise<DirectAccessUrlEntry>
*/
@@ -358,7 +348,6 @@ export class TrashcanApi extends BaseApi {
* Generate a direct access content url for a given rendition of a deleted node
*
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
*
* @param nodeId The identifier of a node.
* @param renditionId The identifier of a version
* @returns Promise<DirectAccessUrlEntry>

11
lib/js-api/src/api/content-rest-api/api/versions.api.ts
View File

@@ -23,7 +23,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t
/**
* Versions service.
*
* @module VersionsApi
*/
export class VersionsApi extends BaseApi {
@@ -31,7 +30,6 @@ export class VersionsApi extends BaseApi {
* Create rendition for a file version
*
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @param renditionBodyCreate The rendition \"id\".
@@ -70,7 +68,6 @@ export class VersionsApi extends BaseApi {
* can remove the \"cm:versionable\" aspect (via update node) which will also disable versioning. In this
* case, you can re-enable versioning by adding back the \"cm:versionable\" aspect or using the version
* params (majorVersion and comment) on a subsequent file content update.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @returns Promise<{}>
@@ -94,7 +91,6 @@ export class VersionsApi extends BaseApi {
* Get version information
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @returns Promise<VersionEntry>
@@ -119,7 +115,6 @@ export class VersionsApi extends BaseApi {
* Get version content
*
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @param opts Optional parameters
@@ -177,7 +172,6 @@ export class VersionsApi extends BaseApi {
* Get rendition information for a file version
*
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
@@ -205,7 +199,6 @@ export class VersionsApi extends BaseApi {
* Get rendition content for a file version
*
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
@@ -281,7 +274,6 @@ export class VersionsApi extends BaseApi {
*
* The list is ordered in descending modified order. So the most recent version is first and
* the original version is last in the list.
*
* @param nodeId The identifier of a node.
* @param opts Optional parameters
* @returns Promise<VersionPaging>
@@ -317,7 +309,6 @@ export class VersionsApi extends BaseApi {
* Each rendition returned has a **status**: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested.
* You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where**
* clause will return just the CREATED renditions: (status='CREATED')
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @param opts Optional parameters
@@ -349,7 +340,6 @@ export class VersionsApi extends BaseApi {
* Attempts to revert the version identified by **versionId** and **nodeId** to the live node.
* If the node is successfully reverted then the content and metadata for that versioned node
* will be promoted to the live node and a new version will appear in the version history.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
* @param revertBody Optionally, specify a version comment and whether this should be a major version, or not.
@@ -383,7 +373,6 @@ export class VersionsApi extends BaseApi {
* Generate a direct access content url for a given version of a node
*
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
*
* @param nodeId The identifier of a node.
* @param versionId The identifier of a version
* @returns Promise<DirectAccessUrlEntry>