diff --git a/.gitignore b/.gitignore
index 1671a35347..6e29c0966f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,6 +11,6 @@ target
*.tgz
*.DS_Store
/package/
-/scripts/
/dist/
.history
+package-lock.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000000..98038bf80e
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,13 @@
+{
+ "cSpell.words": [
+ "Sharedlinks",
+ "activiti",
+ "bodyadd",
+ "colspan",
+ "guid",
+ "hotfix",
+ "site",
+ "unclaim",
+ "webscript"
+ ]
+}
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b3cdc9e42b..2c8a4b2229 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,7 +3,25 @@
# Alfresco JS API
-
+
+
+# [2.0.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/2.0.0) (28-11-2017)
+
+## Features
+- [Missing Create a person API call](https://issues.alfresco.com/jira/browse/ADF-282)
+- [Versions (partial) end points](https://issues.alfresco.com/jira/browse/ADF-1589)
+
+## Fix
+- [Many validation errors for "index.d.ts" of alfresco-js-api](https://issues.alfresco.com/jira/browse/ADF-1678)
+- [APS ContentApi is not present on index.d.ts](https://issues.alfresco.com/jira/browse/ADF-245)
+- [getFileContent response returns empty object when it's a PDF file (JPG files works fine) ](https://issues.alfresco.com/jira/browse/ADF-271)
+- [Fix the Github markdown for README.md](https://issues.alfresco.com/jira/browse/ADF-279)
+- [PeopleApi - getSiteMembership wrong returned type](https://issues.alfresco.com/jira/browse/ADF-1829)
+- [Update superagent to 3.7.0 ](https://issues.alfresco.com/jira/browse/ADF-1833)
+- [NodesApi.getNodeChildren has wrong return type](https://issues.alfresco.com/jira/browse/ADF-1860)
+- [diagrams.service.ts is not using the alfresco-js-api](https://issues.alfresco.com/jira/browse/ADF-1800)
+- [getContentThumbnailUrl returns file data instead or URL](https://issues.alfresco.com/jira/browse/ADF-1962)
+- [ContentApi is missing the preview rendition API](https://issues.alfresco.com/jira/browse/ADF-1963)
# [1.9.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.9.0) (09-10-2017)
@@ -12,6 +30,7 @@
- [Wrong StatusEnum implementation for Rendition](https://issues.alfresco.com/jira/browse/ADF-1535)
- [APS task form remains disabled when no custom outcome is provided in ADF 1.8.0](https://issues.alfresco.com/jira/browse/ADF-1523)
+
# [1.8.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.8.0) (05-09-2017)
## Features
@@ -507,4 +526,4 @@ After:
## Chore
- chore add alfresco log anf gitter chat in readme
- ([9547122b](https://github.com/Alfresco/dev-platform-js-api/commit/9547122bc1609c898382016481e6867934e95b73))
+ ([9547122b](https://github.com/Alfresco/dev-platform-js-api/commit/9547122bc1609c898382016481e6867934e95b73))
\ No newline at end of file
diff --git a/README.md b/README.md
index e43b8414ea..2eeddda708 100644
--- a/README.md
+++ b/README.md
@@ -38,52 +38,111 @@ This project provides a JavaScript client API into the Alfresco REST API and Act
- [Authentication JS-API](#authentication-js-api)
* [Login](#login)
+ [Login with Username and Password BPM and ECM](#login-with-username-and-password-bpm-and-ecm)
+ - [Example](#example)
+ [Login with Username and Password ECM](#login-with-username-and-password-ecm)
+ - [Example](#example-1)
+ [Login with ticket](#login-with-ticket)
- [Login with ticket ECM](#login-with-ticket-ecm)
+ - [Example](#example-2)
- [Login with ticket ECM/BPM as parameter in the constructor](#login-with-ticket-ecmbpm-as-parameter-in-the-constructor)
+ * [Example](#example-3)
+ [Login with Username and Password BPM](#login-with-username-and-password-bpm)
+ + [Example](#example-4)
+ [Login with OAUTH2 Alfresco authorization server](#login-with-oauth2-alfresco-authorization-server)
+ + [Example](#example-5)
+ + [Example](#example-6)
* [Logout](#logout)
+ + [Example](#example-7)
* [isLoggedIn](#isloggedin)
+ + [Example](#example-8)
* [Get tickets](#get-tickets)
* [Events login/logout](#events-loginlogout)
+ + [Example](#example-9)
- [ECM](#ecm)
* [Get Node content](#get-node--content)
+ + [Example](#example-10)
* [Get File or Folder Info](#get-file-or-folder-info)
+ + [Example](#example-11)
* [Get Folder Children Info](#get-folder-children-info)
+ + [Example](#example-12)
* [Create Folder](#create-folder)
+ + [Example](#example-13)
+ + [Example](#example-14)
* [Upload File](#upload-file)
+ + [Example](#example-15)
* [Events Upload File](#events-upload-file)
+ + [Example](#example-16)
* [Delete File or Folder](#delete-file-or-folder)
+ + [Example](#example-17)
* [Delete File or Folder Permanent](#delete-file-or-folder-permanent)
+ + [Example](#example-18)
* [Get thumbnail Url](#get-thumbnail-url)
+ + [Example](#example-19)
* [Get preview Url](#get-preview-url)
+ + [Example](#example-20)
* [Get content Url](#get-content-url)
+ + [Example](#example-21)
* [Custom web scripts call](#custom-web-scripts-call)
+ + [Parameters](#parameters)
- [BPM](#bpm)
* [Task Api](#task-api)
+ [List Task](#list-task)
+ - [Parameters](#parameters-1)
+ - [Example](#example-22)
+ [Get Task](#get-task)
+ - [Parameters](#parameters-2)
+ - [Example](#example-23)
+ [Filter Task](#filter-task)
+ - [Parameters](#parameters-3)
+ - [Example](#example-24)
+ [Complete Task](#complete-task)
+ - [Parameters](#parameters-4)
+ - [Example](#example-25)
+ [Get Task Form](#get-task-form)
+ - [Parameters](#parameters-5)
+ - [Example](#example-26)
+ [Complete Task Form](#complete-task-form)
+ - [Parameters](#parameters-6)
+ - [Example](#example-27)
* [Process Api](#process-api)
+ [Get Process Instances](#get-process-instances)
+ - [Parameters](#parameters-7)
+ - [Example](#example-28)
* [Models Api](#models-api)
+ [Get Model](#get-model)
+ - [Parameters](#parameters-8)
+ - [Example](#example-29)
* [Report Api](#report-api)
+ [Create default Reports](#create-default-reports)
+ - [Parameters](#parameters-9)
+ - [Example](#example-30)
+ [Get Reports](#get-reports)
+ - [Parameters](#parameters-10)
+ - [Example](#example-31)
+ [Report Params](#report-params)
+ - [Parameters](#parameters-11)
+ - [Example](#example-32)
* [Report Process Definitions](#report-process-definitions)
+ - [Parameters](#parameters-12)
+ - [Example](#example-33)
* [Tasks of process definition](#tasks-of-process-definition)
+ - [Parameters](#parameters-13)
+ - [Example](#example-34)
* [Generate reports](#generate-reports)
+ - [Parameters](#parameters-14)
+ - [Example](#example-35)
* [Update report details](#update-report-details)
+ - [Parameters](#parameters-15)
+ - [Example](#example-36)
* [Export to csv](#export-to-csv)
+ - [Parameters](#parameters-16)
+ - [Example](#example-37)
* [Save Report](#save-report)
+ - [Parameters](#parameters-17)
+ - [Example](#example-38)
* [Delete report](#delete-report)
+ - [Parameters](#parameters-18)
+ - [Example](#example-39)
- [Development](#development)
- [Release History](#release-history)
@@ -159,7 +218,7 @@ disableCsrf| To disable CSRF Token to be submitted. Only for Activiti call.| fal
### Login with Username and Password BPM and ECM
-####Example
+#### Example
```javascript
this.alfrescoJsApi = new AlfrescoApi({ provider:'ALL' });
@@ -173,7 +232,7 @@ this.alfrescoJsApi.login('admin', 'admin').then(function (data) {
### Login with Username and Password ECM
-####Example
+#### Example
```javascript
this.alfrescoJsApi = new AlfrescoApi();
@@ -196,7 +255,7 @@ If you already know thw ticket when you invoke the constructor you can pass it a
This authentication validate also the ticket against the server
-####Example
+#### Example
```javascript
var ticket = 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1';
@@ -211,7 +270,7 @@ this.alfrescoJsApi.loginTicket(ticket).then(function (data) {
With this authentication the ticket is not validated against the server
-#####Example
+##### Example
```javascript
//Login ticket ECM
@@ -226,7 +285,7 @@ this.alfrescoJsApi = new AlfrescoApi({ ticketEcm:'TICKET_4479f4d3bb155195879bfbb
### Login with Username and Password BPM
-###Example
+### Example
```javascript
this.alfrescoJsApi = new AlfrescoApi({ provider:'BPM' });
@@ -241,7 +300,7 @@ this.alfrescoJsApi.login('admin', 'admin').then(function (data) {
If you have installed the Alfresco authorization server you can login with this option.
-###Example
+### Example
```javascript
this.alfrescoJsApi = new AlfrescoApi({
oauth2: {
@@ -262,7 +321,7 @@ this.alfrescoJsApi.login('admin', 'admin').then(function (data) {
After the login if you want refresh your token you can use this call
-###Example
+### Example
```javascript
this.alfrescoJsApi.refreshToken()then(function (data) {
@@ -276,7 +335,7 @@ this.alfrescoJsApi.refreshToken()then(function (data) {
logout()
-###Example
+### Example
```javascript
@@ -294,7 +353,7 @@ isLoggedIn()
> return true if you are logged in false if you are not.
-###Example
+### Example
```javascript
@@ -336,7 +395,7 @@ getTicketBpm()
* success (If this event is triggered the login was success you can use this event instead the login promise)
* logout (If this event is triggered the client is successfully logout)
-###Example
+### Example
```javascript
@@ -364,7 +423,7 @@ getFileContent(nodeId, opts)
>Returns the file content of the node with identifier **nodeId**.
- ###Example
+ ### Example
```javascript
var nodeId = '80a94ac8-3ece-47ad-864e-5d939424c47c';
@@ -388,7 +447,7 @@ getNodeInfo(fileOrFolderId, opts)
>Get information for the File/Folder with the identifier nodeId. The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- as NodeId
-###Example
+### Example
```javascript
@@ -410,7 +469,7 @@ You can use the include parameter to return additional information.
returns a promise with the Info about the children of the node if resolved and {error} if rejected.
You can also use one of these well-known aliases: -my- , -shared- or -root- as NodeId
-###Example
+### Example
```javascript
@@ -430,7 +489,7 @@ createFolder(name, relativePath, nodeIdParentFolder, opts)
>createFolder return a promise that is resolved if the folder is created and {error} if rejected.
You can also use one of these well-known aliases: -my- , -shared- or -root- as nodeIdParentFolder
-###Example
+### Example
```javascript
@@ -464,7 +523,7 @@ createFolderAutoRename(name, relativePath, nodeIdParentFolder, opts)
>is the same of createFolder(name, relativePath, nodeId, {autoRename: true}) is just syntactic sugar
You can also use one of these well-known aliases: -my- , -shared- or -root- as nodeIdParentFolder
-###Example
+### Example
```javascript
@@ -488,7 +547,7 @@ File Definition are generally retrieved from a FileList object returned as a res
*Node File Definition
File Definition are generally retrieved from a read Stram
-###Example
+### Example
```javascript
@@ -580,7 +639,7 @@ promiseUpload.abort();
* error
* unauthorized
-###Example
+### Example
```javascript
var fs = require('fs');
@@ -614,7 +673,7 @@ deleteNode(fileOrFolderId)
>Delete File/Folder with the identifier nodeId, if the nodeId is a folder, then its children are also deleted
Deleted nodes move to the trash bin is still possible to recover it
-###Example
+### Example
```javascript
@@ -635,7 +694,7 @@ deleteNodePermanent(fileOrFolderId)
>Delete File/Folder with the identifier nodeId, if the nodeId is a folder, then its children are also deleted
If Deleted Permanent is used will not be possible recover the files
-###Example
+### Example
```javascript
@@ -653,7 +712,7 @@ this.alfrescoJsApi.nodes.deleteNodePermanent(fileOrFolderId).then(function (data
getDocumentThumbnailUrl(documentId)
-###Example
+### Example
```javascript
@@ -665,7 +724,7 @@ var thumbnailUrl = this.alfrescoJsApi.content.getDocumentThumbnailUrl('1a0b110f-
getDocumentPreviewUrl(documentId)
-###Example
+### Example
```javascript
@@ -677,7 +736,7 @@ var previewUrl = this.alfrescoJsApi.content.getDocumentPreviewUrl('1a0b110f-1e09
getContentUrl(documentId)
-###Example
+### Example
```javascript
@@ -694,7 +753,7 @@ executeWebScript(httpMethod, scriptPath, scriptArgs, contextRoot, servicePath)
> Anatomy of a Web Script URI **http(s)://(host):(port)/(contextPath)/(servicePath)/(scriptPath)?(scriptArgs)**
A Web Script is simply a service bound to a URI which responds to HTTP methods such as GET, POST, PUT and DELETE. While using the same underlying code, there are broadly two kinds of Web Scripts.
-###Parameters
+### Parameters
Name | Description
------------- | -------------
**httpMethod** | possible value GET, POST, PUT and DELETE
@@ -747,13 +806,13 @@ listTasks(requestNode)
>return a list of task based on the requestNode query
-####Parameters
+#### Parameters
Name | Type | Description
------------- | ------------- | -------------
**requestNode** | [**Representation**](/src/alfresco-activiti-rest-api/docs/TaskQueryRequestRepresentation.md)| requestNode
-####Example
+#### Example
```javascript
var requestTasks = new this.alfrescoJsApi.activiti.TaskQueryRequestRepresentation();
@@ -771,13 +830,13 @@ getTask(taskId)
>return the [**TaskRepresentation**](/src/alfresco-activiti-rest-api/docs/TaskRepresentation.md) of single task by id
-####Parameters
+#### Parameters
Name | Type | Description
------------- | ------------- | -------------
**taskId** | **String**| taskId
-####Example
+#### Example
```javascript
@@ -796,14 +855,14 @@ filterTasks(requestTasks)
>return the [**ResultListDataRepresentation**](/src/alfresco-activiti-rest-api/docs/ResultListDataRepresentation.md) that is a list of all the task filered
-####Parameters
+#### Parameters
Name | Type | Description
------------- | ------------- | -------------
**requestTasks** | [**TaskFilterRequestRepresentation**](/src/alfresco-activiti-rest-api/docs/TaskFilterRequestRepresentation.md)| requestTasks
-####Example
+#### Example
```javascript
@@ -823,13 +882,13 @@ completeTask(taskId)
>To complete a task (standalone or without a task form) :
-####Parameters
+#### Parameters
Name | Type | Description
------------- | ------------- | -------------
**taskId** | **String**| taskId
-####Example
+#### Example
```javascript
@@ -847,13 +906,13 @@ getTaskForm(taskId)
>Retrieve the Task Form representation. [**FormDefinitionRepresentation**](/src/alfresco-activiti-rest-api/docs/FormDefinitionRepresentation.md)
-####Parameters
+#### Parameters
Name | Type | Description
------------- | ------------- | -------------
**taskId** | **String**| taskId
-####Example
+#### Example
```javascript
@@ -872,14 +931,14 @@ completeTaskForm(taskId, completeTaskFormRepresentation)
>Complete a Task Form
-####Parameters
+#### Parameters
Name | Type | Description
------------- | ------------- | -------------
**taskId** | **String**| taskId
**completeTaskFormRepresentation** | [**CompleteFormRepresentation**](/src/alfresco-activiti-rest-api/docs/CompleteFormRepresentation.md)| completeTaskFormRepresentation
-####Example
+#### Example
```javascript
@@ -903,13 +962,13 @@ getProcessInstances(requestNode)
>Retrieve a list of process instances [**ResultListDataRepresentation**](/src/alfresco-activiti-rest-api/docs/ResultListDataRepresentation.md)
-####Parameters
+#### Parameters
Name | Type | Description
------------- | ------------- | -------------
**requestNode** | [**ProcessFilterRequestRepresentation**](/src/alfresco-activiti-rest-api/docs/ProcessFilterRequestRepresentation.md)| requestNode
-####Example
+#### Example
```javascript
var requestNode = new this.alfrescoJsApi.activiti.ProcessFilterRequestRepresentation();
@@ -947,14 +1006,14 @@ getModel(modelId, opts)
>To retrieve details about a particular model (process, form, decision rule or app) return a [**ModelRepresentation**](ModelRepresentation.md)
-####Parameters
+#### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **Integer**| modelId |
**includePermissions** | **Boolean**| includePermissions | [optional]
-####Example
+#### Example
```javascript
var opts = {
@@ -979,11 +1038,11 @@ createDefaultReports()
>Create the default reports
-####Parameters
+#### Parameters
No parameters required.
-####Example
+#### Example
```javascript
@@ -996,11 +1055,11 @@ getReportList()
> Retrieve the available report list
-####Parameters
+#### Parameters
No parameters required.
-####Example
+#### Example
```javascript
@@ -1013,13 +1072,13 @@ getReportParams(reportId)
> Retrieve the parameters referring to the reportId.
-####Parameters
+#### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**| reportId |
+Name | Type | Description | Notes|
+------------- | ------------- | ------------- | -------------|
+ **reportId** | **String**| reportId ||
-####Example
+#### Example
```javascript
@@ -1034,11 +1093,11 @@ getProcessDefinitions()
> Retrieve the process definition list for all the apps.
-####Parameters
+#### Parameters
No parameters required.
-####Example
+#### Example
```javascript
@@ -1051,13 +1110,13 @@ getTasksByProcessDefinitionId(reportId, processDefinitionId)
> Retrieves all tasks that refer to the processDefinitionId
-####Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**| reportId |
- **processDefinitionId** | **String**| process definition id |
+#### Parameters
+Name | Type | Description | Notes|
+------------- | ------------- | ------------- | -------------|
+ **reportId** | **String**| reportId ||
+ **processDefinitionId** | **String**| process definition id ||
-####Example
+#### Example
```javascript
@@ -1073,13 +1132,13 @@ getReportsByParams(reportId, paramsQuery)
> Generate the reports based on the input parameters
-####Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**| reportId |
- **paramsQuery** | **Object**| Query parameters |
+#### Parameters
+Name | Type | Description | Notes|
+------------- | ------------- | ------------- | -------------|
+ **reportId** | **String**| reportId ||
+ **paramsQuery** | **Object**| Query parameters ||
-####Example
+#### Example
```javascript
@@ -1094,13 +1153,13 @@ updateReport(reportId, name)
> Update the report details
-####Parameters
+#### Parameters
Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**| reportId |
- **name** | **String**| The report name |
+------------- | ------------- | ------------- | -------------|
+ **reportId** | **String**| reportId ||
+ **name** | **String**| The report name ||
-####Example
+#### Example
```javascript
@@ -1115,13 +1174,13 @@ exportToCsv(reportId, queryParms)
> Export a report as csv
-####Parameters
+#### Parameters
Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**| reportId |
- **queryParms** | **Object**| Query parameters |
+------------- | ------------- | ------------- | -------------|
+ **reportId** | **String**| reportId ||
+ **queryParms** | **Object**| Query parameters ||
-####Example
+#### Example
```javascript
var reportId = "1"; // String | reportId
@@ -1146,13 +1205,13 @@ saveReport(reportId, queryParams)
> Save a report
-####Parameters
+#### Parameters
Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**| reportId |
- **queryParms** | **Object**| Query parameters |
+------------- | ------------- | ------------- | -------------|
+ **reportId** | **String**| reportId ||
+ **queryParms** | **Object**| Query parameters ||
-####Example
+#### Example
```javascript
var reportId = "1"; // String | reportId
@@ -1176,12 +1235,12 @@ deleteReport(reportId)
> Delete a report
-####Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**| reportId |
+#### Parameters
+Name | Type | Description | Notes |
+------------- | ------------- | ------------- | ------------- |
+ **reportId** | **String**| reportId | |
-####Example
+#### Example
```javascript
var reportId = "1"; // String | reportId
diff --git a/index.d.ts b/index.d.ts
index b24972a833..4a61c28dfc 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -1,6 +1,6 @@
declare class AlfrescoApi {
- constructor(config: AlfrescoApiConfig): AlfrescoApi;
+ constructor(config: AlfrescoApi.AlfrescoApiConfig);
changeEcmHost(ecmHost: string): void;
@@ -26,33 +26,31 @@ declare class AlfrescoApi {
setTicket(ticketEcm: any, ticketBpm: any): void;
- config: AlfrescoApiConfig;
+ config: AlfrescoApi.AlfrescoApiConfig;
- Activiti: Activiti;
- Auth: Auth;
- Core: Core;
- Discovery: Discovery;
+ Activiti: AlfrescoApi.Activiti;
+ Auth: AlfrescoApi.Auth;
+ Core: AlfrescoApi.Core;
+ Discovery: AlfrescoApi.Discovery;
- bpmAuth: BpmAuthApi;
- ecmAuth: EcmAuthApi;
- oauth2Auth: OauthApi;
-
- activiti: Activiti;
- core: Core;
- discovery: Discovery;
- upload: AlfrescoUpload;
+ bpmAuth: AlfrescoApi.BpmAuthApi;
+ ecmAuth: AlfrescoApi.EcmAuthApi;
+ oauth2Auth: AlfrescoApi.OauthApi;
+ activiti: AlfrescoApi.Activiti;
+ core: AlfrescoApi.Core;
+ discovery: AlfrescoApi.Discovery;
search: any;
- nodes: NodesApi;
- content: ContentApi;
- upload: UploadApi;
- webScript: WebscriptApi;
+ nodes: AlfrescoApi.NodesApi;
+ content: AlfrescoApi.ContentApi;
+ upload: AlfrescoApi.UploadApi;
+ webScript: AlfrescoApi.WebscriptApi;
- ecmClient: EcmClient;
- bpmClient: BpmClient;
- searchClient: SearchClient;
- ecmPrivateClient: EcmPrivateClient;
+ ecmClient: AlfrescoApi.EcmClient;
+ bpmClient: AlfrescoApi.BpmClient;
+ searchClient: AlfrescoApi.SearchClient;
+ ecmPrivateClient: AlfrescoApi.EcmPrivateClient;
}
@@ -63,17 +61,25 @@ declare namespace AlfrescoApi {
new(config: AlfrescoApiConfig): AlfrescoApi;
changeEcmHost(ecmHost: string): void;
+
changeBpmHost(bpmHost: string): void;
+
changeCsrfConfig(disableCsrf: boolean): void;
isLoggedIn(): boolean;
+
login(username: string, password: string): Promise;
+
logout(): Promise;
+
loginTicket(ticket: string): any;
+
refresh(): Promise;
getTicket(): Array;
+
getTicketBpm(): string;
+
getTicketEcm(): string;
setTicket(ticketEcm: any, ticketBpm: any): void;
@@ -106,11 +112,15 @@ declare namespace AlfrescoApi {
}
- export interface FolderEntity {
+ export class FolderEntity {
+ constructor(obj?: any);
+
items: DocumentEntity[];
}
- export interface DocumentEntity {
+ export class DocumentEntity {
+ constructor(obj?: any);
+
nodeRef: string;
nodeType: string;
type: string;
@@ -141,7 +151,9 @@ declare namespace AlfrescoApi {
location: LocationEntity;
}
- export interface LocationEntity {
+ export class LocationEntity {
+ constructor(obj?: any);
+
repositoryId: string;
site: string;
siteTitle: string;
@@ -151,38 +163,28 @@ declare namespace AlfrescoApi {
parent: LocationParentEntity;
}
- export interface LocationParentEntity {
+ export class LocationParentEntity {
+ constructor(obj?: any);
+
nodeRef: string;
}
- export interface NodePaging {
- list: NodePagingList;
- }
+ export class DeletedNodesPaging {
+ constructor(obj?: any);
- export interface DeletedNodesPaging {
list: DeletedNodesPagingList;
}
- export interface NodePagingList {
- pagination: Pagination;
- entries: MinimalNodeEntity[];
- source?: Source;
- }
+ export class DeletedNodesPagingList {
+ constructor(obj?: any);
- export interface DeletedNodesPagingList {
pagination: Pagination;
entries: DeletedNodeEntity[];
}
- export interface Pagination {
- count: number;
- hasMoreItems: boolean;
- totalItems: number;
- skipCount: number;
- maxItems: number;
- }
+ export class Source {
+ constructor(obj?: any);
- export interface Source {
id: string;
name?: string;
createdAt?: Date;
@@ -196,15 +198,21 @@ declare namespace AlfrescoApi {
nodeType?: string;
}
- export interface MinimalNodeEntity {
- entry: MinimalNodeEntryEntity;
+ export class MinimalNodeEntity {
+ constructor(obj?: any);
+
+ entry?: MinimalNodeEntryEntity;
}
- export interface DeletedNodeEntity {
- entry: DeletedNodeMinimalEntry;
+ export class DeletedNodeEntity {
+ constructor(obj?: any);
+
+ entry?: DeletedNodeMinimalEntry;
}
- export interface Node {
+ export class Node {
+ constructor(obj?: any);
+
id?: string;
name?: string;
nodeType?: string;
@@ -223,79 +231,76 @@ declare namespace AlfrescoApi {
allowableOperations?: Array;
path?: PathInfo;
permissions?: PermissionsInfo;
+ createdAt?: Date;
+ createdByUser?: UserInfo;
}
- export interface MinimalNode extends Node {
- id: string;
- parentId: string;
- name: string;
- nodeType: string;
- isFolder: boolean;
- isFile: boolean;
- modifiedAt: Date;
- modifiedByUser: UserInfo;
- createdAt: Date;
- createdByUser: UserInfo;
- content: ContentInfo;
- path: PathInfoEntity;
- properties: NodeProperties;
+ export class MinimalNode extends Node {
+ constructor(obj?: any);
+
}
export interface EcmClient {
new(config: AlfrescoApiConfig): EcmClient;
+
changeHost(host: string): void;
+
setAuthentications(authentications: any): void;
}
export interface BpmClient {
new(config: AlfrescoApiConfig): BpmClient;
+
changeHost(host: string): void;
+
setAuthentications(authentications: any): void;
}
export interface SearchClient {
new(config: AlfrescoApiConfig): SearchClient;
+
changeHost(): void;
+
setAuthentications(authentications: any): void;
}
export interface EcmPrivateClient {
new(config: AlfrescoApiConfig): EcmPrivateClient;
+
changeHost(host: string): void;
+
setAuthentications(authentications: any): void;
}
- export interface MinimalNodeEntryEntity extends MinimalNode {
+ export class MinimalNodeEntryEntity extends MinimalNode {
+ constructor(obj?: any);
+
}
- export interface NodeProperties {
+ export class NodeProperties {
+ constructor(obj?: any);
+
[key: string]: any;
}
- export interface DeletedNodeMinimalEntry extends MinimalNode {
+ export class DeletedNodeMinimalEntry extends MinimalNode {
+ constructor(obj?: any);
+
archivedAt: Date;
archivedByUser: UserInfo;
}
- export interface UserInfo {
- displayName: string;
- id: string;
- }
-
- export interface ContentInfo {
- mimeType: string;
- mimeTypeName: string;
- sizeInBytes: number;
- encoding: string;
- }
+ export class PathInfoEntity {
+ constructor(obj?: any);
- export interface PathInfoEntity {
elements: PathElementEntity[];
isComplete: boolean;
name: string;
}
- export interface PathElementEntity {
+ export class PathElementEntity {
+ constructor(obj?: any);
+
id: string;
name: string;
}
@@ -303,28 +308,6 @@ declare namespace AlfrescoApi {
export interface Auth {
}
- export interface NodesApi {
- new(client: ApiClient): NodesApi;
-
- addNode(nodeId: string, nodeBody: any, opts?: any): Promise;
- copyNode(nodeId: string, copyBody: any, opts?: any): Promise;
- deleteNode(nodeId: string): Promise;
- getDeletedNode(nodeId: string, opts?: any): Promise;
- getDeletedNodes(opts?: any): Promise;
- getFileContent(nodeId: string, opts?: any): Promise;
- getNode(nodeId: string, opts?: any): Promise;
- getNodeChildren(nodeId: string, opts?: any): Promise;
- moveNode(nodeId: string, moveBody: any, opts?: any): Promise;
- purgeDeletedNode(nodeId: string): Promise;
- restoreNode(nodeId: string): Promise;
- updateFileContent(nodeId: string, contentBody: string, opts?: any): Promise;
- updateNode(nodeId: string, nodeBody: any, opts?: any): Promise;
- getNodeInfo(nodeId: string, opts?: any): Promise;
- deleteNodePermanent(nodeId: string): Promise;
- createFolder(name: string, relativePath: string, nodeId?: string, opts?: any): Promise;
- createFolderAutoRename(name: string, relativePath: string, nodeId: string, opts): Promise;
- }
-
export interface ApiClient {
new(client: any): ApiClient;
}
@@ -349,27 +332,23 @@ declare namespace AlfrescoApi {
entry: RepositoryEntry;
}
- export interface EntitlementsInfo {
+ export class EntitlementsInfo {
+ constructor(obj?: any);
+
maxUsers?: number;
maxDocs?: number;
isClusterEnabled?: boolean;
isCryptodocEnabled?: boolean;
}
+
export interface Error {
error?: ErrorError;
}
- export interface ErrorError {
- errorKey?: string;
- briefSummary: string;
- descriptionURL: string;
- logId?: string;
- stackTrace: string;
- statusCode: number;
- }
+ export class LicenseInfo {
+ constructor(obj?: any);
- export interface LicenseInfo {
issuedAt: Date;
expiresAt: Date;
remainingDays: number;
@@ -378,7 +357,9 @@ declare namespace AlfrescoApi {
entitlements?: EntitlementsInfo;
}
- export interface ModuleInfo {
+ export class ModuleInfo {
+ constructor(obj?: any);
+
id?: string;
title?: string;
description?: string;
@@ -389,7 +370,9 @@ declare namespace AlfrescoApi {
versionMax?: string;
}
- export interface RepositoryInfo {
+ export class RepositoryInfo {
+ constructor(obj?: any);
+
edition: string;
version: VersionInfo;
status: StatusInfo;
@@ -397,18 +380,24 @@ declare namespace AlfrescoApi {
modules?: Array;
}
- export interface RepositoryEntry {
+ export class RepositoryEntry {
+ constructor(obj?: any);
+
repository: RepositoryInfo;
}
- export interface StatusInfo {
+ export class StatusInfo {
+ constructor(obj?: any);
+
isReadOnly: boolean;
isAuditEnabled: boolean;
isQuickShareEnabled: boolean;
isThumbnailGenerationEnabled: boolean;
}
- export interface VersionInfo {
+ export class VersionInfo {
+ constructor(obj?: any);
+
major: string;
minor: string;
patch: string;
@@ -418,6 +407,17 @@ declare namespace AlfrescoApi {
display: string;
}
+ export class PersonBodyCreate {
+ constructor(obj?: any);
+
+ id: string;
+ firstName: string;
+ lastName: string;
+ email: string;
+ password: number;
+ properties: any;
+ }
+
// ======= Discovery end ======
@@ -427,12 +427,17 @@ declare namespace AlfrescoApi {
new(client: ApiClient): FavoritesApi;
addFavorite(personId?: string, favoriteBody?: FavoriteBody): Promise;
+
// addSiteFavorite(personId?: string, favoriteSiteBody?: FavoriteSiteBody, fields?: Array, opts?: any): Promise;
- // removeFavorite(personId?: string, favoriteId?: string, opts?: any): Promise<{}>;
- removeFavoriteSite(personId?: string, favoriteId?: string): Promise<{}>;
+ // removeFavorite(personId?: string, favoriteId?: string, opts?: any): Promise;
+ removeFavoriteSite(personId?: string, favoriteId?: string): Promise;
+
getFavorite(personId?: string, favoriteId?: string, opts?: any): Promise;
+
getFavorites(personId?: string, opts?: { skipCount?: number, maxItems?: number, where?: string, fields?: Array }): Promise;
+
getFavoriteSite(personId?: string, siteId?: string, opts?: any): Promise;
+
// listFavoriteSitesForPerson(personId?: string, skipCount?: number, maxItems?: number, fields?: Array, opts?: any): Promise;
// listFavorites(personId?: string, skipCount?: number, maxItems?: number, where?: string, fields?: Array, opts?: any): Promise;
}
@@ -440,22 +445,31 @@ declare namespace AlfrescoApi {
export interface ChildAssociationsApi {
new(client: ApiClient): ChildAssociationsApi;
- addNode(nodeld?: string, nodeBody?: NodeBody, opts?: { autoRename?: boolean, include?: Array, fields?: Array }): Promise<{}>;
- addSecondaryChildAssoc(parentld?: string, assocChildBody?: AssocChildBody): Promise<{}>;
- deleteNode(nodeld?: string, opts?: { permanent?: boolean }): Promise<{}>;
- getNodeChildren(nodeld?: string, opts?: { skipCount?: number, maxltems?: number, orderBy?: string, where?: string, include?: Array, relativePath?: string, includeSource?: boolean, fields?: Array }): Promise<{}>;
- listParents(childld?: string, opts?: { where?: string, include?: string, fields?: Array }): Promise<{}>;
- listSecondaryChildAssociations(parentld?: string, opts?: { assocType?: string, where?: string, include?: string, fields?: Array }): Promise<{}>;
- moveNode(nodeld?: string, moveBody?: MoveBody, opts?: { include?: Array, fields?: Array }): Promise<{}>;
+ addNode(nodeId?: string, nodeBody?: NodeBody, opts?: { autoRename?: boolean, include?: Array, fields?: Array }): Promise;
+
+ addSecondaryChildAssoc(parentId?: string, assocChildBody?: AssocChildBody): Promise;
+
+ deleteNode(nodeId?: string, opts?: { permanent?: boolean }): Promise;
+
+ getNodeChildren(nodeId?: string, opts?: { skipCount?: number, maxItems?: number, orderBy?: string, where?: string, include?: Array, relativePath?: string, includeSource?: boolean, fields?: Array }): Promise;
+
+ listParents(childId?: string, opts?: { where?: string, include?: string, fields?: Array }): Promise;
+
+ listSecondaryChildAssociations(parentId?: string, opts?: { assocType?: string, where?: string, include?: string, fields?: Array }): Promise;
+
+ moveNode(nodeId?: string, moveBody?: MoveBody, opts?: { include?: Array, fields?: Array }): Promise;
}
export interface AssociationsApi {
new(client: ApiClient): AssociationsApi;
- addAssoc(sourceld?: string, assocTargetBody?: AssocTargetBody): Promise<{}>;
- listSourceNodeAssociations(targetld?: string, opts?: { where?: string, include?: string, fields?: Array }): Promise<{}>;
- listTargetAssociations(sourceld?: string, opts?: { where?: string, include?: string, fields?: Array }): Promise<{}>;
- removeAssoc(sourceld?: string, targetld?: string, opts?: { assocType?: string }): Promise<{}>;
+ addAssoc(sourceId?: string, assocTargetBody?: AssocTargetBody): Promise;
+
+ listSourceNodeAssociations(targetId?: string, opts?: { where?: string, include?: string, fields?: Array }): Promise;
+
+ listTargetAssociations(sourceId?: string, opts?: { where?: string, include?: string, fields?: Array }): Promise;
+
+ removeAssoc(sourceId?: string, targetId?: string, opts?: { assocType?: string }): Promise;
}
@@ -463,8 +477,11 @@ declare namespace AlfrescoApi {
new(client: ApiClient): CommentsApi;
addComment(nodeId?: string, commentBody?: CommentBody, opts?: any): Promise;
- removeComment(nodeId?: string, commentId?: string): Promise<{}>;
- getomments(nodeId?: string, opts?: any): Promise;
+
+ getComments(nodeId?: string, opts?: any): Promise;
+
+ removeComment(nodeId?: string, commentId?: string): Promise;
+
updateComment(nodeId?: string, commentId?: string, commentBody?: CommentBody, opts?: any): Promise;
}
@@ -472,75 +489,140 @@ declare namespace AlfrescoApi {
new(client: ApiClient): NetworksApi;
getNetwork(networkId?: string, opts?: any): Promise;
+
getNetworkForPerson(personId?: string, networkId?: string, opts?: any): Promise;
+
listNetworksForPerson(personId?: string, opts?: any): Promise;
}
export interface NodesApi {
new(client: ApiClient): NodesApi;
- addNode(nodeld?: string, nodeBody?: NodeBody, opts?: { autoRename?: boolean, include?: Array, fields?: Array }): Promise;
- copyNode(nodeld?: string, copyBody?: CopyBody, opts?: { include?: Array, fields?: Array }): Promise;
- deleteNode(nodeld?: string, opts?: { permanent?: boolean }): Promise<{}>;
- getDeletedNode(nodeld?: string, opts?: { include?: Array }): Promise;
- getDeletedNodes(opts?: { skipCount?: number, maxltems?: number, include?: Array }): Promise;
- getFileContent(nodeld?: string, opts?: { attachment?: boolean, ifModifiedSince?: Date }): Promise<{}>;
- getNode(nodeld?: string, opts?: { include?: Array, relativePath?: string, fields?: Array }): Promise<{}>;
- getNodeContent(nodeId?: string, opts?: any): Promise<{}>;
- getNodeChildren(nodeld?: string, opts?: { skipCount?: number, maxltems?: number, orderBy?: string, where?: string, include?: Array, relativePath?: string, includeSource?: boolean, fields?: Array }): Promise<{}>;
- getParents(nodeld?: string, opts?: { where?: string, include?: Array, skipCount?: number, maxltems?: number, includeSource?: boolean, fields?: Array }): Promise<{}>;
- getSecondaryChildren(nodeld?: string, opts?: { where?: string, include?: Array, skipCount?: number, maxltems?: number, includeSource?: boolean, fields?: Array }): Promise<{}>;
- getSourceAssociations(nodeld?: string, opts?: { where?: string, include?: Array, fields?: Array }): Promise<{}>;
- getTargetAssociations(nodeld?: string, opts?: { where?: string, include?: Array, fields?: Array }): Promise<{}>;
- lockNode(nodeld?: string, nodeBodyLock?: NodeBodyLock, opts?: { include?: Array, fields?: Array }): Promise<{}>;
- unlockNode(nodeld?: string, opts?: { include?: Array, fields?: Array }): Promise<{}>;
- moveNode(nodeld?: string, moveBody?: MoveBody, opts?: { include?: Array, fields?: Array }): Promise<{}>;
- purgeDeletedNode(nodeld?: string): Promise<{}>;
- restoreNode(nodeld?: string): Promise;
- updateFileContent(nodeld?: string, contentBody?: string, opts?: { majorVersion?: boolean, comment?: string, include?: Array, fields?: Array }): Promise;
+ addNode(nodeId: string, nodeBody: any, opts?: { autoRename?: boolean, include?: Array, fields?: Array }): Promise;
+
+ copyNode(nodeId: string, copyBody: any, opts?: { include?: Array, fields?: Array }): Promise;
+
+ deleteNode(nodeId?: string, opts?: { permanent?: boolean }): Promise;
+
+ purgeDeletedNode(nodeId: string): Promise;
+
+ // custom API not exposed by the platform
+ getNodeInfo(nodeId: string, opts?: any): Promise;
+
+ // custom API not exposed by the platform
+ deleteNodePermanent(nodeId: string): Promise;
+
+ // custom API not exposed by the platform
+ createFolder(name: string, relativePath: string, nodeId?: string, opts?: any): Promise;
+
+ // custom API not exposed by the platform
+ createFolderAutoRename(name: string, relativePath: string, nodeId: string, opts): Promise;
+
+ getDeletedNode(nodeId?: string, opts?: { include?: Array }): Promise;
+
+ getDeletedNodes(opts?: { skipCount?: number, maxItems?: number, include?: Array }): Promise;
+
+ getFileContent(nodeId?: string, opts?: { attachment?: boolean, ifModifiedSince?: Date }): Promise;
+
+ getNode(nodeId?: string, opts?: { include?: Array, relativePath?: string, fields?: Array }): Promise;
+
+ getNodeContent(nodeId?: string, opts?: any): Promise;
+
+ getNodeChildren(nodeId?: string, opts?: { skipCount?: number, maxItems?: number, orderBy?: string, where?: string, include?: Array, relativePath?: string, includeSource?: boolean, fields?: Array }): Promise;
+
+ getParents(nodeId?: string, opts?: { where?: string, include?: Array, skipCount?: number, maxItems?: number, includeSource?: boolean, fields?: Array }): Promise;
+
+ getSecondaryChildren(nodeId?: string, opts?: { where?: string, include?: Array, skipCount?: number, maxItems?: number, includeSource?: boolean, fields?: Array }): Promise;
+
+ getSourceAssociations(nodeId?: string, opts?: { where?: string, include?: Array, fields?: Array }): Promise;
+
+ getTargetAssociations(nodeId?: string, opts?: { where?: string, include?: Array, fields?: Array }): Promise;
+
+ lockNode(nodeId?: string, nodeBodyLock?: NodeBodyLock, opts?: { include?: Array, fields?: Array }): Promise;
+
+ unlockNode(nodeId?: string, opts?: { include?: Array, fields?: Array }): Promise;
+
+ moveNode(nodeId?: string, moveBody?: MoveBody, opts?: { include?: Array, fields?: Array }): Promise;
+
+ restoreNode(nodeId?: string): Promise;
+
+ updateFileContent(nodeId?: string, contentBody?: string, opts?: { majorVersion?: boolean, comment?: string, include?: Array, fields?: Array }): Promise;
+
updateNodeContent(nodeId?: string, contentBody?: string, opts?: any): Promise;
- updateNode(nodeld?: string, nodeBody?: NodeBody, opts?: { include?: Array, fields?: Array }): Promise;
+
+ updateNode(nodeId?: string, nodeBody?: NodeBody, opts?: { include?: Array, fields?: Array }): Promise;
}
export interface SitesApi {
new(client?: ApiClient): SitesApi;
- addSiteMember(siteld?: string, siteMemberBody?: SiteMemberBody): Promise<{}>;
- createSite(siteBody?: SiteBody, opts?: { skipConfiguration?: Boolean, skipAddToFavorites?: Boolean }): Promise<{}>;
- deleteSite(siteld?: string, opts?: { permanent?: Boolean }): Promise<{}>;
- getSite(siteld?: string, opts?: { relations?: Array, fields?: Array }): Promise<{}>;
- getSiteContainer(siteld?: string, containerld?: string, opts?: Array): Promise<{}>;
- getSiteContainers(siteld?: string, opts?: { skipCount?: number, maxltems?: number, fields?: Array }): Promise<{}>;
- getSiteMember(siteld?: string, personld?: string, opts?: { fields?: Array }): Promise<{}>;
- getSiteMembers(siteld?: string, opts?: { skipCount?: number, maxltems?: number, fields?: Array }): Promise<{}>;
- getSites(opts?: { skipCount?: number, maxltems?: number, orderBy?: string, relations?: Array, fields?: Array }): Promise<{}>;
- removeSiteMember(siteld?: string, personld?: string): Promise<{}>;
- updateSiteMember(siteld?: string, personld?: string, siteMemberRoleBody?: SiteMemberRoleBody): Promise<{}>;
+ addSiteMember(siteId?: string, siteMemberBody?: SiteMemberBody): Promise;
+
+ createSite(siteBody?: SiteBody, opts?: { skipConfiguration?: Boolean, skipAddToFavorites?: Boolean }): Promise;
+
+ deleteSite(siteId?: string, opts?: { permanent?: Boolean }): Promise;
+
+ getSite(siteId?: string, opts?: { relations?: Array, fields?: Array }): Promise;
+
+ getSiteContainer(siteId?: string, containerId?: string, opts?: Array): Promise;
+
+ getSiteContainers(siteId?: string, opts?: { skipCount?: number, maxItems?: number, fields?: Array }): Promise;
+
+ getSiteMember(siteId?: string, personId?: string, opts?: { fields?: Array }): Promise;
+
+ getSiteMembers(siteId?: string, opts?: { skipCount?: number, maxItems?: number, fields?: Array }): Promise;
+
+ getSites(opts?: { skipCount?: number, maxItems?: number, orderBy?: string, relations?: Array, fields?: Array }): Promise;
+
+ removeSiteMember(siteId?: string, personId?: string): Promise;
+
+ updateSiteMember(siteId?: string, personId?: string, siteMemberRoleBody?: SiteMemberRoleBody): Promise;
}
export interface PeopleApi {
new(client: ApiClient): PeopleApi;
- addFavorite(personld?: string, favoriteBody?: FavoriteBody): Promise;
- addSiteMembershipRequest(personld?: string, siteMembershipBody?: SiteMembershipRequestBody): Promise;
- deleteFavoriteSite(personld?: string, siteld?: string): Promise<{}>;
- favoriteSite(personld?: string, favoriteSiteBody?: FavoriteSiteBody): Promise;
- getActivities(personld?: string, opts?: { skipCount?: number, maxltems?: number, who?: string, siteld?: string, fields?: Array }): Promise;
- getFavorite(personld?: string, favoriteld?: string, opts?: { fields?: Array }): Promise;
- getFavoriteSite(personld?: string, siteld?: string, opts?: { fields?: Array }): Promise;
- getFavoriteSites(personld?: string, opts?: { skipCount?: number, maxltems?: number, fields?: Array }): Promise;
- getFavorites(personld?: string, opts?: { skipCount?: number, maxltems?: number, where?: string, fields?: Array }): Promise;
- getPerson(personld?: string, opts?: { fields?: Array }): Promise;
- getPersonNetwork(personld?: string, networkld?: string, opts?: { fields?: Array }): Promise;
- getPersonNetworks(personld?: string, opts?: { skipCount?: number, maxltems?: number, fields?: Array }): Promise;
- getPreference(personld?: string, preferenceName?: string, opts?: { fields?: Array }): Promise;
- getPreferences(personld?: string, opts?: { skipCount?: number, maxltems?: number, fields?: Array }): Promise;
- getSiteMembership(personld?: string, opts?: { skipCount?: number, maxltems?: number, orderBy?: string, relations?: Array, fields?: Array }): Promise;
- getSiteMembershipRequest(personld?: string, siteld?: string, opts?: { fields?: Array }): Promise;
- getSiteMembershipRequests(personld?: string, opts?: { skipCount?: number, maxltems?: number, fields?: Array }): Promise;
- removeFavoriteSite(personld?: string, favoriteld?: string): Promise<{}>;
- removeSiteMembershipRequest(personld?: string, siteld?: string): Promise<{}>;
- updateSiteMembershipRequest(personld?: string, siteld?: string, siteMembershipBody?: SiteMembershipRequestBody): Promise<{}>;
+ addPerson(person: PersonBodyCreate): Promise;
+
+ addFavorite(personId?: string, favoriteBody?: FavoriteBody): Promise;
+
+ addSiteMembershipRequest(personId?: string, siteMembershipBody?: SiteMembershipRequestBody): Promise;
+
+ deleteFavoriteSite(personId?: string, siteId?: string): Promise;
+
+ favoriteSite(personId?: string, favoriteSiteBody?: FavoriteSiteBody): Promise;
+
+ getActivities(personId?: string, opts?: { skipCount?: number, maxItems?: number, who?: string, siteId?: string, fields?: Array }): Promise;
+
+ getFavorite(personId?: string, favoriteId?: string, opts?: { fields?: Array }): Promise;
+
+ getFavoriteSite(personId?: string, siteId?: string, opts?: { fields?: Array }): Promise;
+
+ getFavoriteSites(personId?: string, opts?: { skipCount?: number, maxItems?: number, fields?: Array }): Promise;
+
+ getFavorites(personId?: string, opts?: { skipCount?: number, maxItems?: number, where?: string, fields?: Array }): Promise;
+
+ getPerson(personId?: string, opts?: { fields?: Array }): Promise;
+
+ getPersonNetwork(personId?: string, networkId?: string, opts?: { fields?: Array }): Promise;
+
+ getPersonNetworks(personId?: string, opts?: { skipCount?: number, maxItems?: number, fields?: Array }): Promise;
+
+ getPreference(personId?: string, preferenceName?: string, opts?: { fields?: Array }): Promise;
+
+ getPreferences(personId?: string, opts?: { skipCount?: number, maxItems?: number, fields?: Array }): Promise;
+
+ getSiteMembership(personId?: string, opts?: { skipCount?: number, maxItems?: number, orderBy?: string, relations?: Array, fields?: Array }): Promise;
+
+ getSiteMembershipRequest(personId?: string, siteId?: string, opts?: { fields?: Array }): Promise;
+
+ getSiteMembershipRequests(personId?: string, opts?: { skipCount?: number, maxItems?: number, fields?: Array }): Promise;
+
+ removeFavoriteSite(personId?: string, favoriteId?: string): Promise;
+
+ removeSiteMembershipRequest(personId?: string, siteId?: string): Promise