io.Manager Documentation - Changelog > @interopio/manager-api

3.0

3.1.0
Release date: 16.08.2024
New Methods
New API methods have been added:

New Method Description

api.initialize(): Promise<void> Initializes the API client. Calling it is required before using any of the new methods described here.

api.hasCapability(capability: ServerCapability): boolean Checks whether the specified capability is supported by the io.Manager Server. Returns true if the capability is supported and false otherwise. Use the ServerCapability enumeration to specify the desired capability - e.g., api.hasCapability(ServerCapability.ADMIN_API_V2_APP_ADD).

api.appsV2.addApp(app: AddAppRequest): Promise<App> Creates a new app definition or throws an error if an app definition with the same name property already exists. Returns the created app definition.

api.appsV2.addOrUpdateApp(app: AddOrUpdateAppRequest): Promise<App> Creates a new app definition or updates an existing one if an app definition with the same name property already exists. Returns the created or updated app definition.

api.appsV2.updateApp(app: UpdateAppRequest): Promise<App> Updates an app definition or throws an error if an app definition with the specified name property isn't found. Returns the updated app definition.

api.layoutsV2.addLayout(layout: AddLayoutRequest): Promise<Layout> Creates a new Layout definition or throws an error if a Layout definition with the same combination of name, type and owner properties already exists. Returns the created Layout definition.

api.layoutsV2.addOrUpdateLayout(layout: AddOrUpdateLayoutRequest): Promise<Layout> Creates a new Layout definition or updates an existing one if a Layout definition with the same id property (or the same combination of name, type and owner properties if id isn't provided) already exists. Returns the created or updated Layout definition.

api.layoutsV2.updateLayout(layout: UpdateLayoutRequest): Promise<Layout> Updates a Layout definition or throws an error if a Layout definition with the specified id property (or the specified combination of name, type and owner properties if id isn't provided) isn't found. Returns the updated Layout definition.

Deprecated Methods
The following API methods have been deprecated:

Deprecated Method New Method

api.apps.addOrUpdate() Use api.appsV2.addOrUpdateApp() instead.

api.layouts.addCommonLayout() Use api.layoutsV2.addLayout() instead.

api.layouts.addLayout() Use api.layoutsV2.addLayout() instead.

api.layouts.addUserLayout() Use api.layoutsV2.addLayout() instead.

Improvements & Bug Fixes

Audit fix for NPM packages.

2.0

2.0.2
Release date: 15.05.2024
Improvements & Bug Fixes

Extended typings for NumberFilterCondition and DateFilterCondition with notExists option.

Updated dependencies.

2.0.1
Release date: 27.03.2024
Improvements & Bug Fixes

Moved to @interopio/schemas@9.2.0 package.

2.0.0
Release date: 22.03.2024
Breaking Changes

Remove the dataRequest parameter from systemConfig.getAll().

1.0

1.6.3
Release date: 10.02.2024
Improvements & Bug Fixes

Fixed Axios error interceptor.

1.6.2
Release date: 12.01.2024
Improvements & Bug Fixes

Audit fix for NPM packages.

1.6.0
Release date: 29.11.2023
New Features

Added a response interceptor.

Improvements & Bug Fixes

Updated Axios to from 0.28.0 to 1.6.2.

1.5.0
Release date: 15.06.2023
New Features

Added a core option in GlueInfo.

1.4.0
Release date: 19.05.2023
New Features

Added a assignLayoutToUser() API method.

Added a setExplicitUserItems() API method.

1.3.2
Release date: 16.05.2023
Improvements & Bug Fixes

Relaxed hello request.

1.3.1
Release date: 16.05.2023
Improvements & Bug Fixes

Relaxed machine configuration.

1.3.0
Release date: 27.04.2023
New Features

Exposed transformResponse options.

1.2.0
Release date: 31.03.2023
Improvements & Bug Fixes

Updated to latest @interopio/schemas.

1.1.2
Release date: 01.11.2022
Improvements & Bug Fixes

Fixed System Configuration API bug.

1.1.1
Release date: 01.11.2022
Improvements & Bug Fixes

Fixed System Configuration API bug.

1.1.0
Release date: 31.10.2022
New Features

Added a removeConfigForIdentifier() method in the System Configuration API.

1.0.2
Release date: 23.10.2022
Improvements & Bug Fixes

Added a weight property to Glue42SystemConfigIdentifier.

1.0.1
Release date: 23.10.2022
Improvements & Bug Fixes

Made some of the properties of AuditLog optional.

1.0.0
Release date: 15.10.2022
Breaking Changes

Removed Node.js core dependencies fs and path which causes breaking changes in the Client API.

0.1

0.8.0
Release date: 27.09.2022
New Features

Added an unload() method to the Client API.

0.7.6
Release date: 19.09.2022
Improvements & Bug Fixes

Fixed typings.

0.7.5
Release date: 07.06.2022
Improvements & Bug Fixes

Fixed the addFeedback() method.

0.7.3
Release date: 07.06.2022
Improvements & Bug Fixes

Fixed URL joining when using a custom request module.

0.7.2
Release date: 07.06.2022
Improvements & Bug Fixes

Removed urlJoin() and fixed URL joining when using a custom request module.

0.7.0
Release date: 22.05.2022
New Features

Added support for passing a custom request library.

0.6.0
Release date: 22.03.2022
New Features

Added a Schema API.

0.5.0
Release date: 21.03.2022
New Features

Added support for Basic authentication in Options.

Added a password property in User.

0.4.5
Release date: 13.03.2022
New Features

Added a getGroupsFeatures() method in the Groups API.

New Method	Description
`api.initialize(): Promise<void>`	Initializes the API client. Calling it is required before using any of the new methods described here.
`api.hasCapability(capability: ServerCapability): boolean`	Checks whether the specified capability is supported by the io.Manager Server. Returns `true` if the capability is supported and `false` otherwise. Use the `ServerCapability` enumeration to specify the desired capability - e.g., `api.hasCapability(ServerCapability.ADMIN_API_V2_APP_ADD)`.
`api.appsV2.addApp(app: AddAppRequest): Promise<App>`	Creates a new app definition or throws an error if an app definition with the same `name` property already exists. Returns the created app definition.
`api.appsV2.addOrUpdateApp(app: AddOrUpdateAppRequest): Promise<App>`	Creates a new app definition or updates an existing one if an app definition with the same `name` property already exists. Returns the created or updated app definition.
`api.appsV2.updateApp(app: UpdateAppRequest): Promise<App>`	Updates an app definition or throws an error if an app definition with the specified `name` property isn't found. Returns the updated app definition.
`api.layoutsV2.addLayout(layout: AddLayoutRequest): Promise<Layout>`	Creates a new Layout definition or throws an error if a Layout definition with the same combination of `name`, `type` and `owner` properties already exists. Returns the created Layout definition.
`api.layoutsV2.addOrUpdateLayout(layout: AddOrUpdateLayoutRequest): Promise<Layout>`	Creates a new Layout definition or updates an existing one if a Layout definition with the same `id` property (or the same combination of `name`, `type` and `owner` properties if `id` isn't provided) already exists. Returns the created or updated Layout definition.
`api.layoutsV2.updateLayout(layout: UpdateLayoutRequest): Promise<Layout>`	Updates a Layout definition or throws an error if a Layout definition with the specified `id` property (or the specified combination of `name`, `type` and `owner` properties if `id` isn't provided) isn't found. Returns the updated Layout definition.

Deprecated Method	New Method
`api.apps.addOrUpdate()`	Use `api.appsV2.addOrUpdateApp()` instead.
`api.layouts.addCommonLayout()`	Use `api.layoutsV2.addLayout()` instead.
`api.layouts.addLayout()`	Use `api.layoutsV2.addLayout()` instead.
`api.layouts.addUserLayout()`	Use `api.layoutsV2.addLayout()` instead.