Mstrio-py

Major changes

- added `CacheUpdateSubscription` class to `subscription` module

Minor changes

- return specific type of subscription object when using `list_subscriptions`
- inner structure of `mstrio.distribution_services.subscription` was changed.
Please make sure to import from `mstrio.distribution_services` or
`mstrio.distribution_services.subscription` at most, since anything deeper is
considered internal implementation details and not guaranteed to remain
stable
- added arguments `user` and `user_group` to function `list_security_filters` to
allow filtering results by user or user group
- added method `list_security_filter` and property `security_filters` to
`UserGroup` class
- added method `list_security_filter` and property `security_filters` to
`User` class

Major changes

- added `job_monitor` module with `list_jobs`, `kill jobs`, `kill_all_jobs`
functions and `Job` class
- added `Object` class in `mstrio.object_management` subpackage to allow
object management
- added `list_objects` function to allow listing objects by type
- added `Folder` class in `mstrio.object_management` subpackage to allow
folder management
- added `list_folders`, `get_my_personal_objects_contents`,
`get_predefined_folder_contents` functions to allow listing folders and
getting contents of particular folders
- added enum `PredefinedFolders` with all available values of pre-defined
folders
- added `quick_search`, `quick_search_from_object`, `get_search_suggestions`
functions that use the stored results of the Quick Search engine to return
search results and suggestions
- added `full_search` which uses `start_full_search` and `get_search_results`,
that can be used to search the metadata for objects in a specific project that
match specific search criteria
- added `list_dependencies` and `list_dependents` methods to most of the classes
that provide information about dependence of an object
- added `Shortcut`class in `mstrio.object_management` subpackage

Minor changes

- changed `Subscription` class to now use `Content` and `Delivery` objects
instead of dicts
- changed owner field of `Subscription` to `User` objects
- changed all date fields to `datetime` objects
- improved filtering performance in listing objects functions
- Term `application` deprecated (see section 'Deprecated'), and renamed in
method names, method arguments, file names, class names to `project` (see
notebooks in 'examples', and demo scripts in 'demos' for details). Examples:
- `list_applications()` renamed to `list_projects()`
- `application`, `application_name`, `application_id` renamed to
`project`, `project_name`, `project_id`
- `mstrio.server.application` renamed to `mstrio.server.project`
- `Application` renamed to `Project`
- Updated notebook examples and demo scripts in 'examples' and 'demos' folders
- changed `certified_info` field of `Report` and `Document` from dict to
`CertifiedInfo` object
- added parameter `propagate_to_children` to methods in `ACLMixin` class
- `acg` property of an object now use a `Rights` enum
- `acl` property of an object now use a new class `ACE`
- `extended_type` property of an object now use a `ExtendedType` enum

Bug fixes

- fixed server memory settings issues when converting
- fixed server settings configuration for I-Server version prior to 11.3.0
- fixed bug where list_subscription is limiting data to 1000 results only
- fixed `Styler` object being returned instead of `DataFrame` in
`nodes_topology` and `services_topology` methods in `Cluster` class

Deprecated

- `application`, `application_name`, `application_id` parameters/attributes
- functions having a term 'application' in their definition
- modules having a term 'application' in their name
- class names having a term 'application' in their definition
**In all of above-mentioned changes, a new term is 'project'**
- `mstrio.browsing` is deprecated and is superceded
with `mstrio.object_management.search_operations` subpackage,
- `SearchType` enum is now `SearchPattern`

Major changes

- added `Schedule` class in `mstrio.distribution_services.schedule` subpackage
- added `ScheduleTime` class in `mstrio.distribution_services.schedule`
subpackage, local object used for specifying time related properties of
schedule
- added `Event` class in `mstrio.distribution_services.event` subpackage
- changed `Subscription` class to now use `Schedule` objects
- added datasources subpackage with `Dbms`, `DatabaseConnections`,
`DatasourceInstance`, `DatasourceLogin`, `DatasourceMap` classes covering
database management functionality
- added functions `list_available_dbms`, `list_datasource_connections`,
`list_datasource_instances`, `list_datasource_logins`,
`list_datasource_mappings` to list all datasource related objects
- added `database_connections` module allowing to browse and manage database
connections on the environment
- added ACL management functionality for all supporting objects by adding
`list_acl`, `acl_add`, `acl_remove`, `acl_alter` methods
- added `SecurityFilter` class and function `list_security_filters` in
`mstrio.access_and_security.security_filter` subpackage
- added `Qualification` class in `mstrio.access_and_security.security_filter`
subpackage which is an object used to represent qualification of security
filter
- added classes `PredicateBase`, `PredicateForm`, `PredicateElementList`,
`PredicateFilter`, `PredicateJointElementList` and `LogicOperator` in
`mstrio.access_and_security.security_filter` subpackage to represent
predicates which can be used in creation of qualification for security filter
- added classes `ParameterBase`, `ConstantParameter`,
`ObjectReferenceParameter`, `ExpressionParameter`, `PromptParameter`,
`DynamicDateTimeParameter` and `ConstantArrayParameter` in
`mstrio.access_and_security.security_filter` subpackage to represent
parameters used in `AttributeForm`

Bug fixes

- fixed urllib3 dependency installing incompatible version
- fixed GUI login to be case-insensitive

Deprecated

- `mstrio.admin.schedule` is deprecated and superceded with
`mstrio.distribution_services.schedule` subpackage
- `schedules` replace argument `schedules_id` in `create` and `alter`, methods
of `Schedule` class
- `mstrio.distribution_services.schedule.ScheduleManager` is now deprecated,
use `mstrio.distribution_services.schedule.list_schedules()` instead
- removed features deprecated in release 11.3.1.101 and aliases allowing for
backward compatibility

Major changes

- changed files structure to organize the modules in clean and readable way
- added or improved type hints across the codebase
- added Enums: `PrivilegeMode`, `IdleMode`, `GroupBy`, `ServiceAction`,
`Rights` and `Permissions`
- implemented `Node` class to be used for node management in place of a raw dict
- added `CubeCache` class in `mstrio.application_objects.datasets` subpackage
- updated method `load_cube` to load cube by name
- added functions `list_cube_caches` , `delete_cube_caches` and
`delete_cube_cache`
- added methods `create`, `update`, `get_sql_view` and `publish` for class
OlapCube
- added method `unpublish` available for classes `OlapCube` and `SuperCube`
- added `list_reports` function to `Report` module
- added `alter` and `list_properties` methods to `Report` class

Bug fixes

- fixed custom cell collapsing at re-run at certain conditions
- fixed wrong object type for `Entity.__init__()` method
- fixed `KeyError:'body'` when executing `update_properties` on an object
- fixed `TypeError: unhashable type:'dict'` after accessing `attr_elements` of
`Cube`
- fixed `mstrio.dataset` module `publish` method sending requests too frequently
to the REST API

Deprecated

- `id` replaces field `report_id` in `Report` class

Major changes

- added `SuperCube` and `OlapCube` classes in
`mstrio.application_objects.datasets` subpackage
- added `list_all_cubes`, `load_cube`, `list_super_cubes`, `list_olap_cubes`
functions that allow searching available cubes by name and construct precise
objects
- added possibility to alter `name`, `description`, `abbreviation` properties of
cubes
- added more `Cube` object attributes similar to other MSTR objects
- added `user_id`, `user_full_name`, `user_initials` attributes to `Connection`
class
- added missing parameters `trust_id` and `database_auth_login` in
`user.alter()` method

Bug fixes

- fixed `KeyError` when trying to connect on certain environments 49
- fixed initializing `Cube` object when cube Server available 46
- fixed `instance_id` attribute not being filled in `Cube` class 39

Deprecated

- `mstrio.admin` subpackage is deprecated and its modules are moved according to
new structure
- `mstrio.cube` and `mstrio.dataset` are deprecated and are superceded by
`OlapCube` and `SuperCube` from `application_objects.datasets` subpackage
- `mstrio.report` and `mstrio.library` modules are deprecated and are moved to
`application_objects` subpackage
- `date_modified` and `id` replace parameters/attributes `cube_id` and
`last_modified` in new `SuperCube` and `OlapCube` classes
- `project_id` and `project_name` parameters/attributes are deprecated across
the package in favor of `application_id` and `application_name`

- updated example links in readme.md file