Mstrio-py

New features

- added `list_bots` method and `Bot` class in `mstrio.project_objects.bots` subpackage to allow management of Bots
- added `list_content_groups` method and `ContentGroup` class in `mstrio.project_objects.content_group` subpackage to allow management of Content Groups
- added `list_applications` method and `Application` class in `mstrio.project_objects.applications` subpackage to allow
management of Applications
- added `StorageService` class for Storage Service configuration of an environment
- added `storage_service` property, `fetch_storage_service` and `update_storage_service` methods to the `Environment` class to manage the environment's Storage Service configuration
- official release of `Migration` class and its methods (introduces some breaking changes compared to "Preview" state)

Minor changes

- added `last_update_time` property to `Cube` based classes

Bug fixes

- fixed `utils.wip` to not configure root logger, added separate logger for the library's root module to not interfere with loggers defined in users' scripts
- fixed `DatasourceInstance.to_dict` so that incomplete REST response does not invalidate listing Datasource Instances and lookup by name

New features

- added `refresh()` method to `OlapCube` and `SuperCube` classes to allow cubes republish without interaction, creating a `Job`
- added support for providing a folder path instead of a folder ID to methods within the `Folder` class,
and also `quick_search`, `full_search` and all methods inheriting from them that accept a folder ID argument
- added `include_subfolders` flag to `get_contents` method of `Folder` class to allow getting the contents of
the children of the specified folder recursively
- added the `sql` property to `Report` class, that allows getting the SQL View of a report without executing it
- added `IncrementalRefreshReport` class in `mstrio.object_management.incremental_refresh_report` package to allow managing Incremental Refresh Reports
- added `list_incremental_refresh_reports` method to allow listing Incremental Refresh Reports in a project
- added function `quick_search_by_id()` in `mstrio.object_management.search_operations`
to allow searching for objects by object and project ID
- added function `send_email()` in `mstrio.distribution_services.email` to allow sending emails
- added `execute_query()` method to `DatasourceInstance` class to allow executing SQL queries
- added `status` property to `Subscription` class to allow checking the status of a subscription
- added support for answering prompts in `to_datasource()` method of `Report` class, along with
a `Prompt` class in `mstrio.project_objects.prompts` to support prompts
- added support for `password_auto_expire` and `password_expiration_frequency` fields to `User` class
- added support for Page By in `Report` class
- added support for VLDB properties in `Report` class

Minor changes

- added Warning message to `OlapCube` nad `SuperCube` classes that is shown when provided ID belongs to Cube of different type
- updated `PageSize` Enum values to allow proper Subscription initialization
- added support for both `name` and `display_name` in VLDB settings provided by `ModelVldbMixin`
- added `vldb_settings` property in `VldbMixin` class that stores VLDB settings in dict with setting names as keys

New features

- added `delete_object_cache()` and `delete_element_cache()` methods to `Project` class to allow deleting
object and element cache
- added new optional argument `show_description` to `ProjectSettings.list_caching_properties()` to show description
for each setting
- added `delete_server_object_cache()` and `delete_server_element_cache()` methods to `Environment` class to allow deleting
object and element cache from all projects
- added `MobileSubscription` class in `mstrio.distribution_services.subscription` package to allow
management of the new subscription type
- added new bulk methods to the `Translation` class: `to_json_from_list`, `add_translations_from_json`,
`to_database_from_list`, `add_translations_from_database`, `to_dataframe_from_list` and
`add_translations_from_dataframe`
- updated old Translation methods: `to_csv_from_list` and `add_translations_from_csv` with new functionalities
present in the new bulk methods for json, databases and dataframes
- added support for the `comments` field in MSTR objects to view and edit their long description
- added `EmbeddedConnection` class to allow access to embedded connection templates in `DatasourceInstance`
- added support for Python 3.12

Minor changes

- updated script template for datasource scripts
- `enableHtmlContentInDossier` server setting is now read-only for environments on Update 13 and newer,
and cannot be changed using mstrio-py since it is being superseded by `allowHtmlContent`

Deprecated

- `mstrio.project_objects.dossier` module is superseded by
`mstrio.project_objects.dashboard` and will be removed in the future, after 1-year deprecation period

Removed

- MicroStrategy for Jupyter Extension is no longer developed and supported
and was removed from the mstrio-py package in March 2024.
You can still use the mstrio-py library and all its current and upcoming features.

New features

- changed `list_users` to allow filtering on `enabled` field
- added support for `ldapdn`, `language`,`owner` and `default_timezone` for `Users`
- added support for `ldapdn` for `UserGroups`
- added `add_datasource()` and `remove_datasource()` methods to `Project` class to allow
adding and removing datasources from the project
- added `data_language_settings` and `metadata_language_settings` properties to `Project` class
to allow interacting with project internalization:
- `add_language()`, `alter_language()`, `remove_language()`, `alter_current_mode()`,
`alter_default_language()` methods for the `data_language_settings` property
- `add_language()`, `remove_language()` for the `metadata_language_settings` property
- added new optional argument `show_description` to `ProjectSettings.list_properties()`,
`ProjectSettings.to_csv()`, `ServerSettings.list_properties()`, `ServerSettings.to_csv()`
to show description for each setting
- added `Enums` in `mstrio.server.setting_types` to allow altering `Enum` settings by providing
`Enum` values instead of `string`

Minor changes

- updated code snippets for datasources to use `Language` class and `list_languages` function from `mstrio.server.language` package
instead of `Locale` class and `list_locales` function
- members in user groups and security roles are now instances of `User` or `UserGroup` class instead of dictionaries
- addresses in `User` class are now instances of `Address` class instead of dictionaries
- added `force_with_dependents` flag in `Schedule.delete()` method that allows to delete `Schedule` with dependent subscriptions without prompt

Bug fixes

- changed endpoint of `list_users`, allowing for listing users in environments with large number of users more efficiently

Deprecated

- possibility of providing `initials` as a filter in `list_users` is deprecated and will be removed in the future

Removed

- removed `Locale` class and `list_locales` function from `mstrio.datasources.datasource_map` module
- removed `update()` method from `OlapCube` class
- removed `mstrio.api.exceptions` and `mstrio.helpers.exceptions` modules
- removed `overwrite`, `attributes` and `meterics` parameters in `OlapCube.create()` method
- removed ability to pass instance of `Locale` class as argument in `mstrio.datasources.datasource_map` module

New features

- added support for VLDB properties for `Metric` objects by providing
`list_vldb_settings`, `reset_vldb_settings`, `alter_vldb_settings` methods
and `vldb_settings` attribute
- add `refresh` argument to `list_datasource_warehouse_tables` to allow refreshing
warehouse tables available in a datasource
- enhanced `update_physical_table_structure` and `update_physical_table_structure_for_all_tables`
methods of `LogicalTable` to work after changing `WarehouseTable` structure
- added `Translation` class in `mstrio.object_management.translation` package to allow management
of Translations for any object with the following methods: `add_translation`, `alter_translation`,
`remove_translation`, `to_csv_from_list` and `add_translations_from_csv`
- added `list_translations` to allow listing translations for objects
- added `add_translation`, `alter_translation`, `remove_translation` and `list_translations`
methods to all objects inheriting from Entity to allow translation management directly
through the objects

Minor changes

- moved `Rights`, `AggregatedRights`, `Permissions` enums to `mstrio.helpers` module

Bug fixes

- updated default values of `PackageSettings` class to allow safe initialization
- fixed `Project Not Loaded` error when trying to initialize `Project` object when
running in a cluster configuration with the project not being loaded on all nodes
- fixed `full_search`, `get_search_results` to always return correct number of objects

Removed

- removed `list_folders`, `create_folder`, `delete_folder` from `mstrio.utils.helper`
because they have been superseded by `mstrio.object_management.folder` module

New features

- added `delete()` method to `Project` class to allow deleting projects
- added parameter `hidden` to `create` methods of `Attribute` and `Metric` classes

Minor changes

- rename `ObjectTypes.NONE` to `ObjectTypes.NOT_SUPPORTED` in `mstrio.types` module

Bug fixes

- fixed `to_dataframe` method of `OlapCube` class to return dataframe containing
not only default attribute forms (The following types of Intelligent Cube are not
supported: MDX, Query Builder, Freefrom SQL, Freeform XQuery, and Data Import.)
- add printing info message to `load`, `unload` and `delete` methods of `ContentCache`
class indicating that operation could not be performed because cache was deleted,
in that case execution of `load` method will be stopped by raising error
- added support for `Date` type to `SuperCube` class
- updated `User.add_address` and `User.update_address` methods to allow more
address customizations

Deprecated

- `mstrio.api.exceptions` and `mstrio.utils.exceptions` modules are superseded by
`mstrio.helpers`, and will be removed in the future