contensis-management-api

# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [2.4.0] - 2025-06-02 ### Added - support for *tags* and *taggroups* API ### Changed - export new *PagedUsageList* type with additional attributes for methods that return lists of entry usage ## [2.3.0] - 2025-05-26 ### Added - support for *aggregations* in entries search ## [2.2.0] - 2024-10-10 ### Added - users: supports *search* in user operations - users: supports *setPasswordToExpirable* action in user operations - groups: add child groups to a group in bulk with *addChildGroups* in group operations - groups: added *includeSelf* option when getting child groups of a group ### Changed - updated project README ## [2.1.9] - 2024-03-04 ### Changed - updated *Node* model to include all attributes - updated interfaces for *create* and *update* node methods ## [2.1.8] - 2024-01-19 ### Changed - users: added *excludedGroups* option for listing users of a group, but not if they are from a particular subgroup. - groups: added *excludedGroups* option for listing groups of a group, but not if they are from a particular subgroup. ## [2.1.7] - 2023-12-08 ### Changed - users: added *zenQL* option for listing users of a group via zenQL - groups: added *zenQL* option for listing groups of a group via zenQL ## [2.1.6] - 2023-11-23 ### Changed - users: added *zenQL* option for listing users via zenQL - groups: added *zenQL* option for listing groups via zenQL ## [2.1.5] - 2023-10-18 ### Changed - export `UniversalClient` in package root ## [2.1.4] - 2023-10-16 ### Added - redirects: get, create, update, list and delete support added. ## [2.1.3] - 2022-09-20 ### Changes - users: added *optOutOfNotifications* property to a user that will be available in 16.0 ## [2.1.2] - 2022-09-13 ### Changes - roles: added support for all permissions types available in Contensis 15.5 ## [2.1.1] - 2022-11-01 ### Changes - users: added *isClassic* option for getting a user by id ## [2.1.0] - 2022-08-16 ### Changes - users: added *UserToCreate* type for creating a user to support optional id - groups: added *GroupToCreate* type for creating a group to support optional id - upgraded to TypeScript 4 ## [2.0.9] - 2022-07-08 ### Added - users: added pagination to *getUserGroups* operation ## [2.0.8] - 2022-06-21 ### Added - groups: added *includeInherited* option to *groups.getUsersByGroupId*, *groups.getUsersByGroupName*, *groups.getChildGroupsByGroupId* and *groups.getChildGroupsByGroupName* operations ## [2.0.7] - 2022-06-07 ### Changed - entries: changed *entries.search* to use either a *string*, a *ManagementQuery* or a *ManagementZenqlQuery* type ## [2.0.6] - 2022-05-11 ### Added - entries: added usage operation to get the usage for a given entry ## [2.0.5] - 2022-04-14 ### Added - add new options for handling entries in recycle bin supported in Contensis 15.2 onwards - search query accepts new parameters _includeDeleted_ and _includeArchived_ - add new optional argument to delete entries _permanent_ - default is false ### Changed - updated @types/node package to be compatible with the installed TypeScript version ## [2.0.4] - 2022-01-28 ### Added - add paging/search options to group "child group" and "user" listings ### Changed - updated packages ## [2.0.3] - 2021-10-15 ### Added - added additional parameters to _freeText_ ## [2.0.2] - 2021-08-19 ### Added - added _owner_ and _slug_ fields to _EntrySys_ class ### Changed - the "Authorization" header is using the correct prefix of "Bearer " ## [2.0.1] - 2021-05-26 ### Changed - general release for version 2.0 ## [2.0.0-beta.7] - 2021-05-24 ### Changed - Query: removed _fields_ property ## [2.0.0-beta.6] - 2021-04-08 ### Changed - users: renamed user properties to 'firstName' and 'lastName' ## [2.0.0-beta.5] - 2021-04-01 ### Changed - users: renamed user properties to 'username', 'firstname' and 'lastname' - roles: changed role 'name' and 'description' properties type to string ## [1.0.2-beta.4] - 2021-03-12 ### Changed - updated reference to contensis-core-api ## [1.0.2-beta.4] - 2021-03-12 ### Changed - updated reference to contensis-core-api ## [1.0.2-beta.3] - 2021-02-26 ### Added - events: initial support ## [1.0.2-beta.2] - 2020-11-30 ### Added - users: create a user with initial status of suspended ## [1.0.2-beta.1] - 2020-11-17 ### Added - users: added suspend, unlock, unsuspend operations ## [1.0.1] - 2020-11-04 ### Changed - client creation: the default _Client_ object targets a platform that already provides a global 'fetch' (e.g. a modern browser). There are _UniversalClient_ and _NodejsClient_ objects for other platforms and scenarios; - updated _EntrySys_ type definition; ## [1.0.0-rc.4] - 2020-09-02 ### Changed - users and groups: removed 'management' from requests path; ## [1.0.0-rc.3] - 2020-08-13 ### Changed - groups: updated path for adding and removing child groups; ## [1.0.0-rc.2] - 2020-08-05 ### Added - groups: added _addUsers_ method; ## [1.0.0-rc.1] - 2020-07-24 ### Added - entries: added search via GET; ### Changed - users and groups: added _security._ namespace for _users_ and _groups_ methods ## [1.0.0-beta.20] - 2020-07-21 ### Changed - client: improved exception handling ## [1.0.0-beta.18] - 2020-07-20 ### Added - client: added contensisClassicToken field for internal use ## [1.0.0-beta.17] - 2020-07-17 ### Added - client: added refresh token expiry date and _isBearerTokenExpired()_, _isRefreshTokenExpired()_ methods ## [1.0.0-beta.16] - 2020-07-13 ### Changed - users: use PATCH instead of PUT for _update()_ , updated _User_ property names ## [1.0.0-beta.15] - 2020-07-08 ### Added - users: added _getCurrent()_ ## [1.0.0-beta.14] - 2020-07-07 ### Changed - added suport for 'contensis_classic' and 'contensis_classic_refresh_token' flows and changed how a client is created; ## [1.0.0-beta.13] - 2020-06-23 ### Changed - check if running in Node.js when calling specific functions; - use graceful-fs instead of Node.js module fs for better cross platform support; - corrected access token expiry check; ## [1.0.0-beta.12] - 2020-06-10 ### Changed - users and groups: changed _isInGroup/isinGroups_ to _userIsMemberOf_, changed _getGroups_ to _getUserGroups_; ## [1.0.0-beta.11] - 2020-06-04 ### Added - full users and groups api implementation; ## [1.0.0-beta.10] - 2020-05-29 ### Added - initial users api for get and list methods; - initial groups api for get and list methods; ## [1.0.0-beta.9] - 2020-05-26 ### Changed - use cross-fetch to make configuration identical between browser and Node.js; - the fetch function can now be injected to support better testing; - added unit tests for get and list methods; - fixed bugs discovered by unit tests; ## [1.0.0-beta.8] - 2020-05-21 ### Added - entries search method; ## [1.0.0-beta.7] - 2019-12-19 ### Added - support for non language specific workflow events for entries; ## [1.0.0-beta.6] - 2019-12-18 ### Added - support for deleting entry variations; - support for defaultHeaders; ## [1.0.0-beta.5] - 2019-12-12 ### Changed - updated Component and Node models; ## [1.0.0-beta.4] - 2019-12-11 ### Added - full api support for components, roles and permissions; ## [1.0.0-beta.3] - 2019-12-06 ### Added - full api support for projects, content types, entries and nodes; ## [1.0.0-beta.2] - 2019-11-28 ### Added - content type and entries api bugfixes; ## [1.0.0-beta.1] - 2019-11-28 ### Added - added full entries api support; ## [1.0.0-beta.0] - 2019-11-28 ### Added - added read only content types and entries api support; - added basic node api support;