alfresco-js-api
Version:
JavaScript client library for the Alfresco REST API
1,096 lines (922 loc) • 49.1 kB
JavaScript
(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['../ApiClient', '../model/FavoriteEntry', '../model/FavoriteBody', '../model/Error', '../model/SiteMembershipBody', '../model/SiteMembershipRequestEntry', '../model/FavoriteSiteBody', '../model/InlineResponse201', '../model/ActivityPaging', '../model/SiteEntry', '../model/SitePaging', '../model/FavoritePaging', '../model/PersonBodyCreate', '../model/PersonEntry', '../model/PersonNetworkEntry', '../model/PersonNetworkPaging', '../model/PreferenceEntry', '../model/PreferencePaging', '../model/SiteMembershipRequestPaging', '../model/SiteMembershipBody1', '../model/GroupsPaging'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('../model/FavoriteEntry'), require('../model/FavoriteBody'), require('../model/Error'), require('../model/SiteMembershipBody'), require('../model/SiteMembershipRequestEntry'), require('../model/FavoriteSiteBody'), require('../model/InlineResponse201'), require('../model/ActivityPaging'), require('../model/SiteEntry'), require('../model/SitePaging'), require('../model/FavoritePaging'), require('../model/PersonBodyCreate'), require('../model/PersonEntry'), require('../model/PersonNetworkEntry'), require('../model/PersonNetworkPaging'), require('../model/PreferenceEntry'), require('../model/PreferencePaging'), require('../model/SiteMembershipRequestPaging'), require('../model/SiteMembershipBody1'), require('../model/GroupsPaging'));
} else {
// Browser globals (root is window)
if (!root.AlfrescoCoreRestApi) {
root.AlfrescoCoreRestApi = {};
}
root.AlfrescoCoreRestApi.PeopleApi = factory(root.AlfrescoCoreRestApi.ApiClient, root.AlfrescoCoreRestApi.FavoriteEntry, root.AlfrescoCoreRestApi.FavoriteBody, root.AlfrescoCoreRestApi.Error, root.AlfrescoCoreRestApi.SiteMembershipBody, root.AlfrescoCoreRestApi.SiteMembershipRequestEntry, root.AlfrescoCoreRestApi.FavoriteSiteBody, root.AlfrescoCoreRestApi.InlineResponse201, root.AlfrescoCoreRestApi.ActivityPaging, root.AlfrescoCoreRestApi.SiteEntry, root.AlfrescoCoreRestApi.SitePaging, root.AlfrescoCoreRestApi.FavoritePaging, root.AlfrescoCoreRestApi.PersonBodyCreate, root.AlfrescoCoreRestApi.PersonEntry, root.AlfrescoCoreRestApi.PersonNetworkEntry, root.AlfrescoCoreRestApi.PersonNetworkPaging, root.AlfrescoCoreRestApi.PreferenceEntry, root.AlfrescoCoreRestApi.PreferencePaging, root.AlfrescoCoreRestApi.SiteMembershipRequestPaging, root.AlfrescoCoreRestApi.SiteMembershipBody1, root.AlfrescoCoreRestApi.GroupsPaging);
}
}(this, function(ApiClient, FavoriteEntry, FavoriteBody, Error, SiteMembershipBody, SiteMembershipRequestEntry, FavoriteSiteBody, InlineResponse201, ActivityPaging, SiteEntry, SitePaging, FavoritePaging, PersonBodyCreate, PersonEntry, PersonNetworkEntry, PersonNetworkPaging, PreferenceEntry, PreferencePaging, SiteMembershipRequestPaging, SiteMembershipBody1, GroupsPaging) {
'use strict';
/**
* People service.
* @module api/PeopleApi
* @version 0.1.0
*/
/**
* Constructs a new PeopleApi.
* @alias module:api/PeopleApi
* @class
* @param {module:ApiClient} apiClient Optional API client implementation to use, default to {@link module:ApiClient#instance}
* if unspecified.
*/
var exports = function(apiClient) {
this.apiClient = apiClient || ApiClient.instance;
/**
* Add a favorite
* Favorite a **site**, **file**, or **folder** in the repository.
* @param {String} personId The identifier of a person.
* @param {module:model/FavoriteBody} favoriteBody An object identifying the entity to be favorited. \n\nThe object consists of a single property which is an object with the name `site`, `file`, or `folder`. \nThe content of that object is the `guid` of the target entity.\n\nFor example, to favorite a file the following body would be used:\n\n```JSON\n{\n \"target\": {\n \"file\": {\n \"guid\": \"abcde-01234\"\n }\n }\n}\n```\n
* data is of type: {module:model/FavoriteEntry}
*/
this.addFavorite = function(personId, favoriteBody) {
var postBody = favoriteBody;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling addFavorite";
}
// verify the required parameter 'favoriteBody' is set
if (favoriteBody == undefined || favoriteBody == null) {
throw "Missing the required parameter 'favoriteBody' when calling addFavorite";
}
var pathParams = {
'personId': personId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = FavoriteEntry;
return this.apiClient.callApi(
'/people/{personId}/favorites', 'POST',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Create a site membership request
* Create a site membership request for **personId** and **siteId**. The **personId** will be invited to the site as a SiteConsumer.
* @param {String} personId The identifier of a person.
* @param {module:model/SiteMembershipBody} siteMembershipBody Site membership request details
* data is of type: {module:model/SiteMembershipRequestEntry}
*/
this.addSiteMembershipRequest = function(personId, siteMembershipBody) {
var postBody = siteMembershipBody;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling addSiteMembershipRequest";
}
// verify the required parameter 'siteMembershipBody' is set
if (siteMembershipBody == undefined || siteMembershipBody == null) {
throw "Missing the required parameter 'siteMembershipBody' when calling addSiteMembershipRequest";
}
var pathParams = {
'personId': personId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = SiteMembershipRequestEntry;
return this.apiClient.callApi(
'/people/{personId}/site-membership-requests', 'POST',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Delete favorite site
* Removes site **siteId** from the favorite site list of person **personId**.\n\n**Note This method is deprecated and will be removed in the future.**\nUse `/people/{personId}/favorites/{favoriteId}` instead.\n
* @param {String} personId The identifier of a person.
* @param {String} siteId The identifier of a site.
*/
this.deleteFavoriteSite = function(personId, siteId) {
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling deleteFavoriteSite";
}
// verify the required parameter 'siteId' is set
if (siteId == undefined || siteId == null) {
throw "Missing the required parameter 'siteId' when calling deleteFavoriteSite";
}
var pathParams = {
'personId': personId,
'siteId': siteId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = null;
return this.apiClient.callApi(
'/people/{personId}/favorite-sites/{siteId}', 'DELETE',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Favorite a site
* Add a favorite site for person **personId**.\n\n**Note: that this method is deprecated and will be removed in the future**.\nUse `/people/{personId}/favorites` instead.\n
* @param {String} personId The identifier of a person.
* @param {module:model/FavoriteSiteBody} favoriteSiteBody The id of the site to favorite.
* data is of type: {module:model/InlineResponse201}
*/
this.favoriteSite = function(personId, favoriteSiteBody) {
var postBody = favoriteSiteBody;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling favoriteSite";
}
// verify the required parameter 'favoriteSiteBody' is set
if (favoriteSiteBody == undefined || favoriteSiteBody == null) {
throw "Missing the required parameter 'favoriteSiteBody' when calling favoriteSite";
}
var pathParams = {
'personId': personId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = InlineResponse201;
return this.apiClient.callApi(
'/people/{personId}/favorite-sites', 'POST',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get activities
* Returns a list of activities for person **personId**.
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Integer} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {String} opts.who A filter to include the user's activities only `-me-`, other user's activities only `-others-`'\n
* @param {String} opts.siteId Include only activity feed entries relating to this site.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/ActivityPaging}
*/
this.getActivities = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getActivities";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'who': opts['who'],
'siteId': opts['siteId'],
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = ActivityPaging;
return this.apiClient.callApi(
'/people/{personId}/activities', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get a favorite
* Returns favorite **favoriteId** for person **personId**.
* @param {String} personId The identifier of a person.
* @param {String} favoriteId The identifier of a favorite.
* @param {Object} opts Optional parameters
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/FavoriteEntry}
*/
this.getFavorite = function(personId, favoriteId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getFavorite";
}
// verify the required parameter 'favoriteId' is set
if (favoriteId == undefined || favoriteId == null) {
throw "Missing the required parameter 'favoriteId' when calling getFavorite";
}
var pathParams = {
'personId': personId,
'favoriteId': favoriteId
};
var queryParams = {
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = FavoriteEntry;
return this.apiClient.callApi(
'/people/{personId}/favorites/{favoriteId}', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get a favorite site
* Returns information on favorite site **siteId** of person **personId**.\n\n**Note: This method is deprecated and will be removed in the future.**\nUse `/people/{personId}/favorites/{favoriteId}` instead.\n
* @param {String} personId The identifier of a person.
* @param {String} siteId The identifier of a site.
* @param {Object} opts Optional parameters
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/SiteEntry}
*/
this.getFavoriteSite = function(personId, siteId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getFavoriteSite";
}
// verify the required parameter 'siteId' is set
if (siteId == undefined || siteId == null) {
throw "Missing the required parameter 'siteId' when calling getFavoriteSite";
}
var pathParams = {
'personId': personId,
'siteId': siteId
};
var queryParams = {
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = SiteEntry;
return this.apiClient.callApi(
'/people/{personId}/favorite-sites/{siteId}', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get favorite sites
* Get a person's favorite sites.\n\n**Note: This method is deprecated and will be removed in the future**.\nUse `/people/{personId}/favorites` instead.\n
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Integer} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/SitePaging}
*/
this.getFavoriteSites = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getFavoriteSites";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = SitePaging;
return this.apiClient.callApi(
'/people/{personId}/favorite-sites', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get favorites
* Returns a list of favorites for person **personId**.\n\nYou can us the `-me-` string in place of `<personId>` to get the favorites of the currently authenticated user.\n\nYou can use the **where** parameter to restrict the list in the response\nto entries of a specific kind. The **where** parameter takes a value.\nThe value is a single predicate that can include one or more **EXISTS**\nconditions. The **EXISTS** condition uses a single operand to limit the\nlist to include entries that include that one property. The property values are:\n\n* `target/file`\n* `target/folder`\n* `target/site`\n\nFor example, the following **where** parameter restricts the returned list to the file favorites for a person:\n\n```SQL\n(EXISTS(target/file))\n```\nYou can specify more than one condition using **OR**. The predicate must be enclosed in parentheses.\n\n\nFor example, the following **where** parameter restricts the returned list to the file and folder favorites for a person:\n\n```SQL\n(EXISTS(target/file) OR EXISTS(target/folder))\n```\n
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Integer} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {String} opts.where A string to restrict the returned objects by using a predicate.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/FavoritePaging}
*/
this.getFavorites = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getFavorites";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'where': opts['where'],
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = FavoritePaging;
return this.apiClient.callApi(
'/people/{personId}/favorites', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get a person
* Gets information for the person **personId**.
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/PersonEntry}
*/
this.getPerson = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getPerson";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = PersonEntry;
return this.apiClient.callApi(
'/people/{personId}', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* List people.
* Gets information for the persons
* @param {Object} opts Optional parameters
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/PersonEntry}
*/
this.getPersons = function(opts) {
opts = opts || {};
var postBody = null;
var pathParams = {
};
var headerParams = {
};
var formParams = {
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'where': opts['where'],
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = PersonEntry;
return this.apiClient.callApi(
'/people', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Add a person
*If applicable, the given person's login access can also be optionally disabled. You must have admin rights to create a person. You can set custom properties when you create a person:
* @param {PersonBodyCreate} person The PersonBodyCreate object.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/PersonEntry}
*/
this.addPerson = function(person) {
var postBody = null;
// verify the required parameter 'personId' is set
if (person == undefined || person == null) {
throw "Missing the required parameter 'person' when calling addPerson";
}
var pathParams = {
};
var postBody = person;
var headerParams = {
};
var formParams = {
};
var queryParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = PersonEntry;
return this.apiClient.callApi(
'/people', 'POST',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get network information
* Returns network information on a single network specified by **networkId** for **personId**.
* @param {String} personId The identifier of a person.
* @param {String} networkId The identifier of a network.
* @param {Object} opts Optional parameters
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/PersonNetworkEntry}
*/
this.getPersonNetwork = function(personId, networkId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getPersonNetwork";
}
// verify the required parameter 'networkId' is set
if (networkId == undefined || networkId == null) {
throw "Missing the required parameter 'networkId' when calling getPersonNetwork";
}
var pathParams = {
'personId': personId,
'networkId': networkId
};
var queryParams = {
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = PersonNetworkEntry;
return this.apiClient.callApi(
'/people/{personId}/networks/{networkId}', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get network membership for a person
* Gets a list of network memberships for person **personId**.
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Integer} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/PersonNetworkPaging}
*/
this.getPersonNetworks = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getPersonNetworks";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = PersonNetworkPaging;
return this.apiClient.callApi(
'/people/{personId}/networks', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get a preference
* Returns a specific preference for person **personId**.
* @param {String} personId The identifier of a person.
* @param {String} preferenceName The name of the preference.
* @param {Object} opts Optional parameters
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/PreferenceEntry}
*/
this.getPreference = function(personId, preferenceName, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getPreference";
}
// verify the required parameter 'preferenceName' is set
if (preferenceName == undefined || preferenceName == null) {
throw "Missing the required parameter 'preferenceName' when calling getPreference";
}
var pathParams = {
'personId': personId,
'preferenceName': preferenceName
};
var queryParams = {
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = PreferenceEntry;
return this.apiClient.callApi(
'/people/{personId}/preferences/{preferenceName}', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get preferences
* Returns a list of preferences for person **personId**.\n\nEach preference consists of an **id** and a **value**.\nThe **value** can be of any JSON type.\n
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Integer} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/PreferencePaging}
*/
this.getPreferences = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getPreferences";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = PreferencePaging;
return this.apiClient.callApi(
'/people/{personId}/preferences', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get site membership information
* Returns a list of site membership information for person **personId**.\nYou can sort the list of sites using the **orderBy** parameter.\n\n**orderBy** specifies the name of one or more\ncomma separated properties.\nFor each property you can optionally specify the order direction.\nBoth of the these **orderBy** examples retrieve sites ordered by ascending name:\n\n```\nname\nname ASC\n```\n
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Integer} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {String} opts.orderBy A string to control the order of the entities returned.
* @param {string[]} opts.relations Use the relations parameter to include one or more related entities in a single response.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/SitePaging}
*/
this.getSiteMembership = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getSiteMembership";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'orderBy': opts['orderBy'],
'relations': this.apiClient.buildCollectionParam(opts['relations'], 'csv'),
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = SitePaging;
return this.apiClient.callApi(
'/people/{personId}/sites', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get groups membership information
* Returns a list of site membership information for person **personId**.\nYou can sort the list of sites using the **orderBy** parameter.\n\n**orderBy** specifies the name of one or more\ncomma separated properties.\nFor each property you can optionally specify the order direction.\nBoth of the these **orderBy** examples retrieve sites ordered by ascending name:\n\n```\nname\nname ASC\n```\n
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Integer} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {String} opts.orderBy A string to control the order of the entities returned.
* @param {String} opts.where A string to restrict the returned objects by using a predicate.
* @param {string[]} opts.include Use the include parameter to include one or more related entities in a single response. Possible values : parentIds and zones
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/GroupsPaging}
*/
this.getGroupsMembership = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getSiteMembership";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'orderBy': opts['orderBy'],
'include': this.apiClient.buildCollectionParam(opts['relations'], 'csv'),
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv'),
'where': opts['where']
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = GroupsPaging;
return this.apiClient.callApi(
'/people/{personId}/groups', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get a site membership request
* Returns the site membership request for site **siteId** for person **personId**, if one exists.
* @param {String} personId The identifier of a person.
* @param {String} siteId The identifier of a site.
* @param {Object} opts Optional parameters
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/SiteMembershipRequestEntry}
*/
this.getSiteMembershipRequest = function(personId, siteId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getSiteMembershipRequest";
}
// verify the required parameter 'siteId' is set
if (siteId == undefined || siteId == null) {
throw "Missing the required parameter 'siteId' when calling getSiteMembershipRequest";
}
var pathParams = {
'personId': personId,
'siteId': siteId
};
var queryParams = {
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = SiteMembershipRequestEntry;
return this.apiClient.callApi(
'/people/{personId}/site-membership-requests/{siteId}', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Get site membership requests
* Returns the current site membership requests for person **personId**.
* @param {String} personId The identifier of a person.
* @param {Object} opts Optional parameters
* @param {Infteger} opts.skipCount The number of entities that exist in the collection before those included in this list.
* @param {Integer} opts.maxItems The maximum number of items to return in the list.
* @param {string[]} opts.fields A list of field names.\n\nYou can use this parameter to restrict the fields\nreturned within a response if, for example, you want to save on overall bandwidth.\n\nThe list applies to a returned individual\nentity or entries within a collection.\n\nIf the API method also supports the **include**\nparameter, then the fields specified in the **include**\nparameter are returned in addition to those specified in the **fields** parameter.\n
* data is of type: {module:model/SiteMembershipRequestPaging}
*/
this.getSiteMembershipRequests = function(personId, opts) {
opts = opts || {};
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling getSiteMembershipRequests";
}
var pathParams = {
'personId': personId
};
var queryParams = {
'skipCount': opts['skipCount'],
'maxItems': opts['maxItems'],
'fields': this.apiClient.buildCollectionParam(opts['fields'], 'csv')
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = SiteMembershipRequestPaging;
return this.apiClient.callApi(
'/people/{personId}/site-membership-requests', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Delete a favorite
* Removes **favoriteId** as a favorite of person **personId**.
* @param {String} personId The identifier of a person.
* @param {String} favoriteId The identifier of a favorite.
*/
this.removeFavoriteSite = function(personId, favoriteId) {
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling removeFavoriteSite";
}
// verify the required parameter 'favoriteId' is set
if (favoriteId == undefined || favoriteId == null) {
throw "Missing the required parameter 'favoriteId' when calling removeFavoriteSite";
}
var pathParams = {
'personId': personId,
'favoriteId': favoriteId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = null;
return this.apiClient.callApi(
'/people/{personId}/favorites/{favoriteId}', 'DELETE',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Cancel a site membership
* Cancels the site membership request to site **siteId** for person **personId**.
* @param {String} personId The identifier of a person.
* @param {String} siteId The identifier of a site.
*/
this.removeSiteMembershipRequest = function(personId, siteId) {
var postBody = null;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling removeSiteMembershipRequest";
}
// verify the required parameter 'siteId' is set
if (siteId == undefined || siteId == null) {
throw "Missing the required parameter 'siteId' when calling removeSiteMembershipRequest";
}
var pathParams = {
'personId': personId,
'siteId': siteId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = null;
return this.apiClient.callApi(
'/people/{personId}/site-membership-requests/{siteId}', 'DELETE',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Update a site membership request
* Updates the message for the site membership request to site **siteId** for person **personId**.
* @param {String} personId The identifier of a person.
* @param {String} siteId The identifier of a site.
* @param {module:model/SiteMembershipBody1} siteMembershipBody The new message to display
*/
this.updateSiteMembershipRequest = function(personId, siteId, siteMembershipBody) {
var postBody = siteMembershipBody;
// verify the required parameter 'personId' is set
if (personId == undefined || personId == null) {
throw "Missing the required parameter 'personId' when calling updateSiteMembershipRequest";
}
// verify the required parameter 'siteId' is set
if (siteId == undefined || siteId == null) {
throw "Missing the required parameter 'siteId' when calling updateSiteMembershipRequest";
}
// verify the required parameter 'siteMembershipBody' is set
if (siteMembershipBody == undefined || siteMembershipBody == null) {
throw "Missing the required parameter 'siteMembershipBody' when calling updateSiteMembershipRequest";
}
var pathParams = {
'personId': personId,
'siteId': siteId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['basicAuth'];
var contentTypes = ['application/json'];
var accepts = ['application/json'];
var returnType = null;
return this.apiClient.callApi(
'/people/{personId}/site-membership-requests/{siteId}', 'PUT',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
};
return exports;
}));