mstrio > project_objects > applications

class mstrio.project_objects.applications.Application(connection, name=None, id=None)

Bases: Entity, CopyMixin, DeleteMixin

Python representation of a Strategy One Application object

Parameters:

• connection (Connection) –

• name (str | None) –

• id (str | None) –

class AiSettings(feedback=None, learning=None, disclaimer=None)

Bases: Dictable

AI settings of the application.

Parameters:

• feedback (bool | None) –

• learning (bool | None) –

• disclaimer (str | None) –

feedback

if True, AI assistance feedback is enabled

Type:

bool

learning

if True, AI assistance learning is enabled

Type:

bool

disclaimer

AI assistance disclaimer

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

disclaimer: str | None = None

feedback: bool | None = None

learning: bool | None = None

class AuthModes(available_modes=None, default_mode=None)

Bases: Dictable

Authentication modes of the application.

Parameters:

• available_modes (list[int] | None) –

• default_mode (int | None) –

available_modes

available authentication modes Possible values:

1: Standard 16: LDAP 1048576: SAML 4194304: OIDC

Type:

list[int]

default_mode

default authentication mode

Type:

int

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

available_modes: list[int] | None = None

default_mode: int | None = None

class EmailSettings(enabled=None, host_portal=None, show_branding_image=None, show_browser_button=None, show_mobile_button=None, show_button_description=None, show_reminder=None, show_sent_by=None, sent_by_text=None, show_social_media=None, content=None, sender=None, branding_image=None, button=None, reminder=None, social_media=None)

Bases: Dictable

Email settings of the application.

Parameters:

• enabled (bool | None) –

• host_portal (str | None) –

• show_branding_image (bool | None) –

• show_browser_button (bool | None) –

• show_mobile_button (bool | None) –

• show_button_description (bool | None) –

• show_reminder (bool | None) –

• show_sent_by (bool | None) –

• sent_by_text (str | None) –

• show_social_media (bool | None) –

• content (Content | None) –

• sender (Sender | None) –

• branding_image (dict[str, str] | None) –

• button (Button | None) –

• reminder (Reminder | None) –

• social_media (SocialMedia | None) –

enabled

whether to enable custom email settings

Type:

bool

host_portal

the host web portal in the button link

Type:

str

show_branding_image

if True, shows branding image

Type:

bool

show_browser_button

if True, shows browser button

Type:

bool

show_mobile_button

if True, shows mobile button

Type:

bool

show_button_description

if True, shows the email button description

Type:

bool

show_reminder

if True, shows reminder section

Type:

bool

show_sent_by

if True, shows sent by section

Type:

bool

sent_by_text

text in the sent by section

Type:

str

show_social_media

if True, shows social media section

Type:

bool

content

content settings

Type:

Content

sender

sender settings

Type:

Sender

branding_image

url of the branding image

Type:

str

button

button settings

Type:

Button

reminder

reminder settings

Type:

Reminder

social_media

social media settings

Type:

SocialMedia

class Button(browser_button_style=None, mobile_button_style=None, mobile_button_link_type=None, mobile_button_scheme=None, description=None)

Bases: Dictable

Button settings of the application.

Parameters:

• browser_button_style (ButtonStyle | None) –

• mobile_button_style (ButtonStyle | None) –

• mobile_button_link_type (str | None) –

• mobile_button_scheme (str | None) –

• description (str | None) –

browser_button_style

browser button style

Type:

ButtonStyle

mobile_button_style

mobile button style

Type:

ButtonStyle

mobile_button_link_type

mobile button link type Possible values:

-default -app_scheme -universal_link

Type:

str

mobile_button_scheme

mobile button scheme

Type:

str

description

button description

Type:

str

class ButtonStyle(background_color=None, font_color=None, text=None)

Bases: Dictable

Button style settings of the application.

Parameters:

• background_color (str | None) –

• font_color (str | None) –

• text (str | None) –

background_color

button background color

Type:

str

font_color

button text color

Type:

str

text

button border color

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

background_color: str | None = None

font_color: str | None = None

text: str | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

browser_button_style: ButtonStyle | None = None

description: str | None = None

mobile_button_link_type: str | None = None

mobile_button_scheme: str | None = None

mobile_button_style: ButtonStyle | None = None

class Content(share_dashboard=None, share_bookmark=None, share_bot=None, member_added=None, user_mention=None, **kwargs)

Bases: Dictable

Content settings of the application.

Parameters:

• share_dashboard (EmailDetails | None) –

• share_bookmark (EmailDetails | None) –

• share_bot (EmailDetails | None) –

• member_added (EmailDetails | None) –

• user_mention (EmailDetails | None) –

share_dashboard

settings for sharing a dashboard

Type:

EmailDetails

share_bookmark

settings for sharing a dossier with bookmark

Type:

EmailDetails

share_bot

settings for sharing a bot

Type:

EmailDetails

member_added

settings for inviting a recipient to a discussion

Type:

EmailDetails

user_mention

settings for mentioning a recipient in a comment or discussion

Type:

EmailDetails

class EmailDetails(subject=None, body=None)

Bases: Dictable

Email details settings of the application.

Parameters:

• subject (str | None) –

• body (str | None) –

subject

email subject

Type:

str

body

email body

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

body: str | None = None

subject: str | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

class Reminder(text=None, link_text=None)

Bases: Dictable

Reminder settings of the application.

Parameters:

• text (str | None) –

• link_text (str | None) –

text

reminder text

Type:

str

link_text

reminder link text

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

link_text: str | None = None

text: str | None = None

class Sender(address=None, display_name=None)

Bases: Dictable

Sender settings of the application.

Parameters:

• address (str | None) –

• display_name (str | None) –

address

sender email address

Type:

str

display_name

sender display name

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

address: str | None = None

display_name: str | None = None

class SocialMedia(show_facebook=None, facebook_link=None, show_twitter=None, twitter_link=None, show_linked_in=None, linked_in_link=None, show_you_tube=None, you_tube_link=None)

Bases: Dictable

Social media settings of the application.

Parameters:

• show_facebook (bool | None) –

• facebook_link (str | None) –

• show_twitter (bool | None) –

• twitter_link (str | None) –

• show_linked_in (bool | None) –

• linked_in_link (str | None) –

• show_you_tube (bool | None) –

• you_tube_link (str | None) –

show_facebook

whether to show the Facebook link

Type:

bool

facebook_link

Facebook link

Type:

str

show_twitter

whether to show the Twitter link

Type:

bool

twitter_link

Twitter link

Type:

str

show_linked_in

whether to show the LinkedIn link

Type:

bool

linked_in_link

LinkedIn link

Type:

str

show_youtube

whether to show the YouTube link

Type:

bool

youtube_link

YouTube link

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

facebook_link: str | None = None

linked_in_link: str | None = None

show_facebook: bool | None = None

show_linked_in: bool | None = None

show_twitter: bool | None = None

show_you_tube: bool | None = None

twitter_link: str | None = None

you_tube_link: str | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

branding_image: dict[str, str] | None = None

button: Button | None = None

content: Content | None = None

enabled: bool | None = None

host_portal: str | None = None

reminder: Reminder | None = None

sender: Sender | None = None

sent_by_text: str | None = None

show_branding_image: bool | None = None

show_browser_button: bool | None = None

show_button_description: bool | None = None

show_mobile_button: bool | None = None

show_reminder: bool | None = None

show_sent_by: bool | None = None

show_social_media: bool | None = None

social_media: SocialMedia | None = None

class Environments(current=None, other=None)

Bases: Dictable

Environments of the application.

Parameters:

• current (str | None) –

• other (list[EnvironmentLink] | None) –

current

name of the current library environment

Type:

str

other

list of other environments

Type:

list[EnvironmentLink]

class EnvironmentLink(name=None, url=None)

Bases: Dictable

Environment link settings of the application.

Parameters:

• name (str | None) –

• url (str | None) –

name

name of the environment

Type:

str

url

URL of the environment

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

name: str | None = None

url: str | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

current: str | None = None

other: list[EnvironmentLink] | None = None

class GeneralSettings(disable_advanced_settings=None, disable_preferences=None, network_timeout=None, cache_clear_mode=None, clear_cache_on_logout=None, max_log_size=None, log_level=None, update_interval=None)

Bases: Dictable

General settings of the application.

Parameters:

• disable_advanced_settings (bool | None) –

• disable_preferences (bool | None) –

• network_timeout (int | None) –

• cache_clear_mode (int | None) –

• clear_cache_on_logout (bool | None) –

• max_log_size (int | None) –

• log_level (int | None) –

• update_interval (int | None) –

disable_advanced_settings

if True, hides advanced settings menu item

Type:

bool

disable_preferences

if True, hides preferences menu item

Type:

bool

network_timeout

network timeout time in seconds

Type:

int

cache_clear_mode

cache clear mode Possible values:

1: automatic 2: on close

Type:

int

clear_cache_on_logout

if True, clears cache on logout

Type:

bool

max_log_size

maximum log size

Type:

int

log_level

log level Possible values:

0: all 10: info 12: warning 14: severe 16: off

Type:

int

update_interval

update interval in minutes

Type:

int

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

cache_clear_mode: int | None = None

clear_cache_on_logout: bool | None = None

disable_advanced_settings: bool | None = None

disable_preferences: bool | None = None

log_level: int | None = None

max_log_size: int | None = None

network_timeout: int | None = None

update_interval: int | None = None

class HomeSettings(mode=None, home_document=None, home_library=None, theme=None)

Bases: Dictable

Home Screen settings of the application.

Parameters:

• mode (str | None) –

• home_document (HomeDocument | None) –

• home_library (HomeLibrary | None) –

• theme (Theme | None) –

mode

home screen mode Possible values:

-0: use Library (default) -1: use Dashboard/Document -2: use Bot

Type:

str

home_document

home document settings

Type:

HomeDocument

home_library

home library settings

Type:

HomeLibrary

theme

theme settings

Type:

Theme

class HomeDocument(url=None, home_document_type=None, icons=None, toolbar_mode=None, toolbar_enabled=None)

Bases: Dictable

Home Screen as Document settings of the application.

Parameters:

• url (str | None) –

• home_document_type (str | None) –

• icons (list[str] | None) –

• toolbar_mode (str | None) –

• toolbar_enabled (bool | None) –

url

URL of the document

Type:

str

home_document_type

home document type Possible values:

-dashboard -document

Type:

str

icons

list of icons to be shown on the home screen toolbar Possible values:

-comments -notifications -options -table_of_contents -bookmarks -reset -filters -share -data_search -hyper_intelligence -font_size

Type:

list[str]

toolbar_mode

toolbar mode Possible values:

-0: show toolbar (default) -1: toolbar will be collapsed by default and expanded

by tapping the top right corner icon

Type:

str

toolbar_enabled

whether the toolbar is enabled

Type:

bool

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

home_document_type: str | None = None

icons: list[str] | None = None

toolbar_enabled: bool | None = None

toolbar_mode: str | None = None

url: str | None = None

class HomeLibrary(content_bundle_ids=None, show_all_contents=None, icons=None, customized_items=None, customized_item_properties=None, toolbar_mode=None, sidebars=None, toolbar_enabled=None, default_groups_name=None)

Bases: Dictable

Home Screen as Library settings of the application.

Parameters:

• content_bundle_ids (list[str] | None) –

• show_all_contents (bool | None) –

• icons (list[str] | None) –

• customized_items (CustomizedItems | None) –

• customized_item_properties (dict | None) –

• toolbar_mode (str | None) –

• sidebars (list[str] | None) –

• toolbar_enabled (bool | None) –

• default_groups_name (str | None) –

content_bundle_ids

list of content bundle IDs that the application is limited to

Type:

list[str]

show_all_contents

whether to show all library contents if the content groups are specified in the application

Type:

bool

icons

list of icons to be shown on the home screen toolbar Possible values:

-comments -notifications -options -table_of_contents -bookmarks -reset -filters -share -data_search -hyper_intelligence -font_size

Type:

list[str]

customized_items

customized settings

Type:

CustomizedItems

customized_item_properties

extra properties of the items that were customized

Type:

dict

toolbar_mode

toolbar mode Possible values:

-0: show toolbar (default) -1: toolbar will be collapsed by default and expanded

by tapping the top right corner icon

Type:

str

sidebars

menus to be shown in the library sidebar Possible values:

-all -favorites -recents -default_groups -my_groups -options

Type:

list[str]

toolbar_enabled

whether the toolbar is enabled

Type:

bool

default_groups_name

customized name for default groups

Type:

str

class CustomizedItems(my_content=None, subscriptions=None, new_dashboard=None, edit_dashboard=None, add_library_server=None, data_search=None, hyper_intelligence=None, font_size=None, undo_and_redo=None, insights=None, content_discovery=None, mobile_account_panel_user_name=None, mobile_account_panel_preferences_my_language=None, mobile_account_panel_preferences_my_time_zone=None, mobile_account_panel_preferences_face_id_login=None, mobile_account_panel_preferences_take_a_tour=None, mobile_account_panel_preferences_refresh_view_automatically=None, mobile_account_panel_preferences_smart_download=None, mobile_account_panel_preferences_automatically_add_to_library=None, mobile_account_panel_advanced_settings_app_settings=None, mobile_account_panel_advanced_settings_security_settings=None, mobile_account_panel_advanced_settings_logging=None, mobile_account_panel_help_and_legal=None, mobile_account_panel_help_and_legal_help=None, mobile_account_panel_help_and_legal_legal=None, mobile_account_panel_help_and_legal_report_a_problem=None, mobile_account_panel_log_out=None, filter_summary=None, share_panel_share=None, share_panel_export_to_excel=None, share_panel_export_to_pdf=None, share_panel_download=None, share_panel_subscribe=None, share_panel_annotate_and_share=None, web_account_panel_user_name=None, web_account_panel_my_library=None, web_account_panel_manage_library=None, web_account_panel_preference=None, web_account_panel_preference_my_language=None, web_account_panel_preference_my_time_zone=None, web_account_panel_switch_workspace=None, web_account_panel_take_a_tour=None, web_account_panel_help=None, web_account_panel_log_out=None, mobile_downloads=None, table_of_contents_header=None, table_of_contents_content_info=None, table_of_contents_chapter_and_page=None, switch_library_server=None, create_new_content_dashboard=None, create_new_content_report=None, layout_tile_view=None, layout_list_view=None, ai_assistant=None, share_panel_manage_access=None, bot_window_share_panel=None, bot_window_share_panel_share_bot=None, bot_window_share_panel_embed_bot=None, bot_window_share_panel_manage_access=None, bot_window_edit_bot=None, create_new_content_bot=None, dashboard_view_mode=None, content_info_content_creator=None, content_info_timestamp=None, content_info_description=None, content_info_project=None, content_info_path=None, content_info_object_id=None, content_info_info_window=None, control_filter_summary=None, hide_filter_summary=None, sidebars_unpin=None, table_of_contents_unpin=None, filter_panel_unpin=None, comments_panel_unpin=None, ai_assistant_unpin=None, table_of_contents_allow_close=None, filter_panel_allow_close=None, comments_panel_allow_close=None, ai_assistant_allow_close=None, use_application_name_as_library_title=None, **kwargs)

Bases: Dictable

Customized items settings of the application.

Parameters:

• my_content (bool | None) –

• subscriptions (bool | None) –

• new_dashboard (bool | None) –

• edit_dashboard (bool | None) –

• add_library_server (bool | None) –

• data_search (bool | None) –

• hyper_intelligence (bool | None) –

• font_size (bool | None) –

• undo_and_redo (bool | None) –

• insights (bool | None) –

• content_discovery (bool | None) –

• mobile_account_panel_user_name (bool | None) –

• mobile_account_panel_preferences_my_language (bool | None) –

• mobile_account_panel_preferences_my_time_zone (bool | None) –

• mobile_account_panel_preferences_face_id_login (bool | None) –

• mobile_account_panel_preferences_take_a_tour (bool | None) –

• mobile_account_panel_preferences_refresh_view_automatically (bool | None) –

• mobile_account_panel_preferences_smart_download (bool | None) –

• mobile_account_panel_preferences_automatically_add_to_library (bool | None) –

• mobile_account_panel_advanced_settings_app_settings (bool | None) –

• mobile_account_panel_advanced_settings_security_settings (bool | None) –

• mobile_account_panel_advanced_settings_logging (bool | None) –

• mobile_account_panel_help_and_legal (bool | None) –

• mobile_account_panel_help_and_legal_help (bool | None) –

• mobile_account_panel_help_and_legal_legal (bool | None) –

• mobile_account_panel_help_and_legal_report_a_problem (bool | None) –

• mobile_account_panel_log_out (bool | None) –

• filter_summary (bool | None) –

• share_panel_share (bool | None) –

• share_panel_export_to_excel (bool | None) –

• share_panel_export_to_pdf (bool | None) –

• share_panel_download (bool | None) –

• share_panel_subscribe (bool | None) –

• share_panel_annotate_and_share (bool | None) –

• web_account_panel_user_name (bool | None) –

• web_account_panel_my_library (bool | None) –

• web_account_panel_manage_library (bool | None) –

• web_account_panel_preference (bool | None) –

• web_account_panel_preference_my_language (bool | None) –

• web_account_panel_preference_my_time_zone (bool | None) –

• web_account_panel_switch_workspace (bool | None) –

• web_account_panel_take_a_tour (bool | None) –

• web_account_panel_help (bool | None) –

• web_account_panel_log_out (bool | None) –

• mobile_downloads (bool | None) –

• table_of_contents_header (bool | None) –

• table_of_contents_content_info (bool | None) –

• table_of_contents_chapter_and_page (bool | None) –

• switch_library_server (bool | None) –

• create_new_content_dashboard (bool | None) –

• create_new_content_report (bool | None) –

• layout_tile_view (bool | None) –

• layout_list_view (bool | None) –

• ai_assistant (bool | None) –

• share_panel_manage_access (bool | None) –

• bot_window_share_panel (bool | None) –

• bot_window_share_panel_share_bot (bool | None) –

• bot_window_share_panel_embed_bot (bool | None) –

• bot_window_share_panel_manage_access (bool | None) –

• bot_window_edit_bot (bool | None) –

• create_new_content_bot (bool | None) –

• dashboard_view_mode (bool | None) –

• content_info_content_creator (bool | None) –

• content_info_timestamp (bool | None) –

• content_info_description (bool | None) –

• content_info_project (bool | None) –

• content_info_path (bool | None) –

• content_info_object_id (bool | None) –

• content_info_info_window (bool | None) –

• control_filter_summary (bool | None) –

• hide_filter_summary (bool | None) –

• sidebars_unpin (bool | None) –

• table_of_contents_unpin (bool | None) –

• filter_panel_unpin (bool | None) –

• comments_panel_unpin (bool | None) –

• ai_assistant_unpin (bool | None) –

• table_of_contents_allow_close (bool | None) –

• filter_panel_allow_close (bool | None) –

• comments_panel_allow_close (bool | None) –

• ai_assistant_allow_close (bool | None) –

• use_application_name_as_library_title (bool | None) –

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

content_bundle_ids: list[str] | None = None

customized_item_properties: dict | None = None

customized_items: CustomizedItems | None = None

default_groups_name: str | None = None

icons: list[str] | None = None

show_all_contents: bool | None = None

sidebars: list[str] | None = None

toolbar_enabled: bool | None = None

toolbar_mode: str | None = None

class Theme(logos=None, color=None)

Bases: Dictable

Theme settings of the application.

Parameters:

• logos (Logos | None) –

• color (Color | None) –

logos

logos settings

Type:

Logos

color

color settings

Type:

Color

class Color(selected_theme=None, formatting=None, enable_for_bots=None)

Bases: Dictable

Color settings of the application.

Parameters:

• selected_theme (str | None) –

• formatting (Formatting | None) –

• enable_for_bots (bool | None) –

selected_theme

selected theme Possible values:

-useSystemSettings -light -dark -red -green -blue -darkBlue -yellow -custom

Type:

str

formatting

formatting settings

Type:

Formatting

enable_for_bots

whether the theme is enabled for bots

Type:

bool

class Formatting(toolbar_fill=None, toolbar_color=None, sidebar_fill=None, sidebar_color=None, sidebar_active_fill=None, sidebar_active_color=None, panel_fill=None, panel_color=None, accent_fill=None, notification_badge_fill=None, button_color=None, canvas_fill=None)

Bases: Dictable

Formatting settings of the application. All color values are in hex format.

Parameters:

• toolbar_fill (str | None) –

• toolbar_color (str | None) –

• sidebar_fill (str | None) –

• sidebar_color (str | None) –

• sidebar_active_fill (str | None) –

• sidebar_active_color (str | None) –

• panel_fill (str | None) –

• panel_color (str | None) –

• accent_fill (str | None) –

• notification_badge_fill (str | None) –

• button_color (str | None) –

• canvas_fill (str | None) –

toolbar_fill

toolbar background color

Type:

str

toolbar_color

toolbar icon/text color

Type:

str

sidebar_fill

sidebar background color

Type:

str

sidebar_color

sidebar text color

Type:

str

sidebar_active_fill

active sidebar background color

Type:

str

sidebar_active_color

active sidebar text color

Type:

str

panel_fill

panel background color

Type:

str

panel_color

panel text color

Type:

str

accent_fill

accent fill color

Type:

str

notification_badge_fill

notification badge color

Type:

str

button_color

button color

Type:

str

canvas_fill

canvas background color

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

accent_fill: str | None = None

button_color: str | None = None

canvas_fill: str | None = None

notification_badge_fill: str | None = None

panel_color: str | None = None

panel_fill: str | None = None

sidebar_active_color: str | None = None

sidebar_active_fill: str | None = None

sidebar_color: str | None = None

sidebar_fill: str | None = None

toolbar_color: str | None = None

toolbar_fill: str | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

enable_for_bots: bool | None = None

formatting: Formatting | None = None

selected_theme: str | None = None

class Logos(web=None, favicon=None, mobile=None)

Bases: Dictable

Logos settings of the application.

Parameters:

• web (Logo | None) –

• favicon (Logo | None) –

• mobile (Logo | None) –

web

web logo settings

Type:

Logo

favicon

favorite icon settings

Type:

Logo

mobile

mobile logo settings

Type:

Logo

class Logo(type=None, value=None)

Bases: Dictable

Details of a logo.

Parameters:

• type (str | None) –

• value (str | None) –

type

type of the logo

Type:

str

value

value of the logo

Type:

str

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

type: str | None = None

value: str | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

favicon: Logo | None = None

mobile: Logo | None = None

web: Logo | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

color: Color | None = None

logos: Logos | None = None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod from_dict(source, connection=None, to_snake_case=True, with_missing_value=False)

Creates an object from a dictionary. The dictionary’s keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (Dict[str, Any]) – A dictionary from which an object will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

home_document: HomeDocument | None = None

home_library: HomeLibrary | None = None

mode: str | None = None

theme: Theme | None = None

acl_add(rights, trustees, denied=False, inheritable=None, propagate_to_children=None, propagation_behavior=None)

Add Access Control Element (ACE) to the object ACL.

Note

To add rights for the Root Folder and the Freeform Objects, apply the required rights for these folders:

• Root Folder: D43364C684E34A5F9B2F9AD7108F7828

• Freeform Objects: 93D8CF3849C1F85DC1A48E8B9E4271F1

Argument propagate_to_children is used only for objects with type ObjectTypes.FOLDER.

Parameters:

• rights (int | Rights | AggregatedRights) – The degree to which the user or group is granted or denied access to the object. The available permissions are defined in Rights and AggregatedRights Enums

• trustees (list[UserOrGroup] | UserOrGroup) – list of trustees (User or UserGroup objects or ids) to update the ACE for

• denied (bool) – flag to indicate granted or denied access to the object

• inheritable (bool | None) – Applies only to folders. If set, any objects placed in the folder inherit the folder’s entry in the ACL.

• propagate_to_children (bool | None) – used for folder objects only, default value is None, if set to True/False adds propagateACLToChildren keyword to the request body and sets its value accordingly

• propagation_behavior (PropagationBehavior | str | None) – Behavior of ACL propagation to children.

• self (Entity) –

Return type:

None

Examples

>>> obj.acl_add(rights=Rights.BROWSE | Rights.EXECUTE,
>>>             trustees=user_obj, denied=True)

acl_alter(rights, trustees, denied=False, inheritable=None, propagate_to_children=None, propagation_behavior=None)

Alter an existing Access Control Element (ACE) of the object ACL.

Note

To alter rights for the Root Folder and the Freeform Objects, change the required rights for these folders:

• Root Folder: D43364C684E34A5F9B2F9AD7108F7828

• Freeform Objects: 93D8CF3849C1F85DC1A48E8B9E4271F1

Argument propagate_to_children is used only for objects with type ObjectTypes.FOLDER.

Parameters:

• rights (int | Rights | AggregatedRights) – The degree to which the user or group is granted or denied access to the object. The available permissions are defined in Rights and AggregatedRights Enums

• trustees (list[UserOrGroup] | UserOrGroup) – list of trustees (User or UserGroup objects or ids) to update the ACE for

• denied (bool) – flag to indicate granted or denied access to the object

• inheritable (bool | None) – Applies only to folders. If set, any objects placed in the folder inherit the folder’s entry in the ACL.

• propagate_to_children (bool | None) – used for folder objects only, default value is None, if set to True/False adds propagateACLToChildren keyword to the request body and sets its value accordingly

• propagation_behavior (PropagationBehavior | str | None) – Behavior of ACL propagation to children.

• self (Entity) –

Return type:

None

Examples

>>> obj.acl_alter(rights=Rights.BROWSE | Rights.EXECUTE,
>>>               trustees=user_obj, denied=True)

acl_remove(rights, trustees, denied=False, inheritable=None, propagate_to_children=None, propagation_behavior=None)

Remove Access Control Element (ACE) from the object ACL.

Note

To remove rights from the Root Folder and the Freeform Objects, remove them from these folders:

• Root Folder: D43364C684E34A5F9B2F9AD7108F7828

• Freeform Objects: 93D8CF3849C1F85DC1A48E8B9E4271F1

Argument propagate_to_children is used only for objects with type ObjectTypes.FOLDER.

Parameters:

• rights (int | Rights | AggregatedRights) – The degree to which the user or group is granted or denied access to the object. The available permissions are defined in Rights and AggregatedRights Enums

• trustees (list[UserOrGroup] | UserOrGroup) – list of trustees (User or UserGroup objects or ids) to update the ACE for

• denied (bool) – flag to indicate granted or denied access to the object

• inheritable (bool | None) – Applies only to folders. If set, any objects placed in the folder inherit the folder’s entry in the ACL.

• propagate_to_children (bool | None) – used for folder objects only, default value is None, if set to True/False adds propagateACLToChildren keyword to the request body and sets its value accordingly

• propagation_behavior (PropagationBehavior | str | None) – Behavior of ACL propagation to children.

• self (Entity) –

Return type:

None

Examples

>>> obj.acl_remove(rights=Rights.BROWSE | Rights.EXECUTE,
>>>                trustees=user_obj, denied=True)

add_translation(translations)

Adds translations to the Object.

Parameters:

• translations (list[OperationData]) – list of translations to be added to the Object

• self (Entity) –

Returns:

A list of translations for the Object.

Return type:

list[’Translation’]

alter(home_screen=None, name=None, description=None, comments=None, owner=None, managed=None, general=None, platforms=None, application_palettes=None, application_default_palette=None, show_builtin_palettes=None, is_default=None, use_config_palettes=None, email_settings=None, ai_settings=None, auth_modes=None, environments=None, application_nuggets=None)

Alter an application.

Parameters:

• home_screen (HomeSettings, optional) – home screen settings of the application

• name (str, optional) – name of the application

• description (str, optional) – description of the application

• comments (str, optional) – long description of the application

• owner (str | User | None) – (str, User, optional): owner of the application object

• managed (bool, optional) – whether the application is managed

• general (GeneralSettings, optional) – general settings of the application

• platforms (list[str], optional) –

  list of platforms for the application Available values:

  -web -mobile -desktop

• application_palettes (list[str] or list[Palette], optional) – list of customized application palettes

• application_default_palette (str or Palette, optional) – default application palette

• show_builtin_palettes (bool, optional) – whether to show built-in palettes

• is_default (bool, optional) – whether the application configuration is default

• use_config_palettes (bool, optional) – whether to use default configuration of palettes

• email_settings (EmailSettings, optional) – email settings of the application

• ai_settings (AiSettings, optional) – AI settings of the application

• auth_modes (AuthModes, optional) – authentication modes of the application

• environments (Environments, optional) – environments of the application

• application_nuggets (list[str], optional) – list of application nuggets

Return type:

None

alter_translation(translations)

Alters translations of the Object.

Parameters:

• translations (list[OperationData]) – list of translations to be added to the Object

• self (Entity) –

Return type:

None

classmethod bulk_from_dict(source_list, connection=None, to_snake_case=True, with_missing_value=False)

Creates multiple objects from a list of dictionaries. For each dictionary provided the keys in camel case are changed to object’s attribute names (by default in snake case) and dict values are composed to their proper data types such as Enums, list of Enums etc. as specified in the object’s _FROM_DICT_MAP.

Parameters:

• cls (T) – Class (type) of the objects that should be created.

• source_list (List[Dict[str, Any]]) – A list of dictionaries from which the objects will be constructed.

• connection (Connection, optional) – A MSTR Connection object. Defaults to None.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case. Defaults to True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

A list of objects of type T.

Return type:

T

classmethod create(connection, name, home_screen, description=None, managed=None, general=None, platforms=None, application_palettes=None, application_default_palette=None, show_builtin_palettes=None, is_default=None, use_config_palettes=None, email_settings=None, ai_settings=None, auth_modes=None, environments=None, application_nuggets=None)

Create a new application.

Parameters:

• connection (Connection) – Strategy One connection object returned by connection.Connection()

• name (str) – name of the application

• home_screen (HomeSettings) – home screen settings of the application

• description (str, optional) – description of the application

• managed (bool, optional) – whether the application is managed

• general (GeneralSettings, optional) – general settings of the application

• platforms (list[str], optional) –

  list of platforms for the application Available values:

  -web -mobile -desktop

• application_palettes (list[str] or list[Palette], optional) – list of customized application palettes

• application_default_palette (str or Palette, optional) – default application palette

• show_builtin_palettes (bool, optional) – whether to show built-in palettes

• is_default (bool, optional) – whether the application configuration is default

• use_config_palettes (bool, optional) – whether to use default configuration of palettes

• email_settings (EmailSettings, optional) – email settings of the application

• ai_settings (AiSettings, optional) – AI settings of the application

• auth_modes (AuthModes, optional) – authentication modes of the application

• environments (Environments, optional) – environments of the application

• application_nuggets (list[str], optional) – list of application nuggets

Returns:

The created Application object.

Return type:

Application

create_copy(name=None, folder_id=None, project=None)

Create a copy of the object on the I-Server.

Parameters:

• name (str | None) – New name of the object. If None, a default name is generated, such as ‘Old Name (1)’

• folder_id (str | None) – ID of the destination folder. If None, the object is saved in the same folder as the source object.

• project (Project | str | None) – By default, the project selected when creating Connection object. Override project to specify project where the current object exists.

• self (Entity) –

Returns:

New python object holding the copied object.

Return type:

Any

create_shortcut(target_folder_id=None, target_folder_path=None, target_folder=None, project_id=None, project_name=None, project=None, to_dictionary=False)

Create a shortcut to the object.

Parameters:

• target_folder_id (str, optional) – ID of the target folder. Target folder must be specified, but target_folder_id may be substituted with target_folder_path or target_folder.

• target_folder_path (str, optional) – Path to the target folder, e.g. ‘/MicroStrategy Tutorial/Public Objects’. May be used instead of target_folder_id.

• target_folder (Folder, optional) – Target folder object. May be used instead of target_folder_id.

• project_id (str, optional) – ID of the target project of the new shortcut. The project may be specified by either project_id, project_name or project. If the project is not specified in either way, the project from the connection object is used.

• project_name (str, optional) – Name of the target project. May be used instead of project_id.

• project (Project, optional) – Project object specifying the target project. May be used instead of project_id.

• to_dictionary (bool, optional) – If True, the method will return a dictionary with the shortcut’s properties instead of a Shortcut object. Defaults to False.

Return type:

Shortcut

delete(force=False)

Delete object.

Parameters:

• force (bool) – If True, then no additional prompt will be shown before deleting object.

• self (Entity) –

Returns:

True on success. False otherwise.

Return type:

bool

fetch(attr=None)

Fetch the latest object’s state from the I-Server.

Note

This method can overwrite local changes made to the object.

Parameters:

• attr (Optional[str]) – Attribute name to be fetched. If not specified

• dictionary. (it will use all getters specified in _API_GETTERS) –

• None. (Defaults to) –

Raises:

ValueError – If attr cannot be fetched.

Return type:

None

classmethod from_dict(source, connection, to_snake_case=True, with_missing_value=False)

Overrides Dictable.from_dict() to instantiate an object from

a dictionary without calling any additional getters.

Parameters:

• cls (T) – Class (type) of an object that should be created.

• source (dict[str, Any]) – a dictionary from which an object will be constructed.

• connection (Connection) – A Strategy One Connection object.

• to_snake_case (bool, optional) – Set to True if attribute names should be converted from camel case to snake case, default True.

• with_missing_value (bool) – (bool, optional): If True, class attributes possible to fetch and missing in source will be set as MissingValue objects.

Returns:

An object of type T.

Return type:

T

get(name)

Get object’s attribute by its name.

list_acl(to_dataframe=False, to_dictionary=False, **filters)

Get Access Control List (ACL) for this object. Optionally filter ACLs by specifying filters.

Parameters:

• to_dataframe (bool, optional) – if True, return datasets as pandas DataFrame

• to_dictionary (bool, optional) – if True, return datasets as dicts

• **filters – Available filter parameters: [deny, type, rights, trustee_id, trustee_name, trustee_type, trustee_subtype, inheritable]

Return type:

DataFrame | list[dict | mstrio.utils.acl.ACE]

Examples

>>> list_acl(deny=True, trustee_name="John")

list_dependencies(project=None, name=None, pattern=4, domain=2, object_types=None, used_by_recursive=False, root=None, root_path=None, limit=None, offset=None, results_format='LIST', to_dictionary=True, **filters)

List list_dependencies of an object.

Parameters:

• project (string) – Project object or ID

• name (string) – Value the search pattern is set to, which will be applied to the names of object types being searched. For example, search for all report objects (type) whose name begins with (pattern) B (name).

• pattern (integer or enum class object) – Pattern to search for, such as Begin With or Exactly. Possible values are available in ENUM mstrio.object_management.SearchPattern. Default value is CONTAINS (4).

• domain (integer or enum class object) – Domain where the search will be performed, such as Local or Project. Possible values are available in ENUM mstrio.object_management.SearchDomain. Default value is PROJECT (2).

• root (string, optional) – Folder ID of the root folder where the search will be performed.

• root_path (str, optional) –

  Path of the root folder in which the search will be performed. Can be provided as an alternative to root parameter. If both are provided, root is used.

  the path has to be provided in the following format:

  if it’s inside of a project, example:

  /MicroStrategy Tutorial/Public Objects/Metrics

  if it’s a root folder, example:

  /CASTOR_SERVER_CONFIGURATION/Users

• class (object_types(enum class object or integer or list of enum) – objects or integers): Type(s) of object(s) to be searched, such as Folder, Attribute or User. Possible values available in ENUMs mstrio.types.ObjectTypes and mstrio.types.ObjectSubTypes

• used_by_recursive (boolean, optional) – Control the Intelligence server to also find objects that are used by the given objects indirectly. Default value is false.

• results_format (SearchResultsFormat) – either a list or a tree format

• to_dictionary (bool) – If False returns objects, by default (True) returns dictionaries.

• limit (int) – limit the number of elements returned. If None (default), all objects are returned.

• offset (int) – Starting point within the collection of returned results. Used to control paging behavior. Default is 0.

• **filters – Available filter parameters: [‘id’, ‘name’, ‘description’ ,’date_created’, ‘date_modified’, ‘acg’]

• self (Entity) –

• object_types (TypeOrSubtype | None) –

Returns:

list of objects or list of dictionaries

list_dependents(project=None, name=None, pattern=4, domain=2, object_types=None, uses_recursive=False, root=None, root_path=None, limit=None, offset=None, results_format='LIST', to_dictionary=True, **filters)

List dependents of an object.

Parameters:

• project (string) – Project object or ID

• name (string) – Value the search pattern is set to, which will be applied to the names of object types being searched. For example, search for all report objects (type) whose name begins with (pattern) B (name).

• pattern (integer or enum class object) – Pattern to search for, such as Begin With or Exactly. Possible values are available in ENUM mstrio.object_management.SearchPattern. Default value is CONTAINS (4).

• domain (integer or enum class object) – Domain where the search will be performed, such as Local or Project. Possible values are available in ENUM mstrio.object_management.SearchDomain. Default value is PROJECT (2).

• root (string, optional) – Folder ID of the root folder where the search will be performed.

• root_path (str, optional) –

  Path of the root folder in which the search will be performed. Can be provided as an alternative to root parameter. If both are provided, root is used.

  the path has to be provided in the following format:

  if it’s inside of a project, example:

  /MicroStrategy Tutorial/Public Objects/Metrics

  if it’s a root folder, example:

  /CASTOR_SERVER_CONFIGURATION/Users

• class (object_types(enum class object or integer or list of enum) – objects or integers): Type(s) of object(s) to be searched, such as Folder, Attribute or User. Possible values available in ENUMs mstrio.types.ObjectTypes and mstrio.types.ObjectSubTypes

• uses_recursive (boolean) – Control the Intelligence server to also find objects that use the given objects indirectly. Default value is false.

• results_format (SearchResultsFormat) – either a list or a tree format

• to_dictionary (bool) – If False returns objects, by default (True) returns dictionaries.

• limit (int) – limit the number of elements returned. If None (default), all objects are returned.

• offset (int) – Starting point within the collection of returned results. Used to control paging behavior. Default is 0.

• **filters – Available filter parameters: [‘id’, ‘name’, ‘description’ ,’date_created’, ‘date_modified’, ‘acg’]

• self (Entity) –

• object_types (TypeOrSubtype | None) –

Returns:

list of objects or list of dictionaries

list_properties(excluded_properties=None)

Fetches all attributes from the server and converts all properties of the object to a dictionary.

Parameters:

excluded_properties (list[str], optional) – A list of object properties that should be excluded from the dict. Defaults to None.

Returns:

A dictionary which keys are object’s attribute names, and

which values are object’s attribute values.

Return type:

dict

list_translations(languages=None, to_dictionary=False)

Lists translations for the Object.

Parameters:

• languages (list, optional) –

  list of languages to list the translations for, only translations from these languages will be listed. Languages in the list should be one of the following:

  • lcid attribute of the language

  • ID of the language

  • Language class object

• to_dictionary (bool, optional) – If True returns dict, by default (False) returns Translation objects

• self (Entity) –

Returns:

A list of dictionaries representing translations for the Object or a list of Translation Objects.

Return type:

list[’Translation’] | list[dict]

print()

Pretty Print all properties of the object.

Return type:

None

remove_translation(translations)

Removes translations from the Object.

Parameters:

• translations (list[OperationData]) – list of translations to be added to the Object

• self (Entity) –

Return type:

None

classmethod to_csv(objects, name, path=None, properties=None)

Exports MSTR objects to a csv file.

Optionally, saves only the object properties specified in the properties parameter.

Parameters:

• objects (T | list[T]) – List of objects of the same type that

• exported. (will be) –

• name (str) – The name of the csv file ending with ‘.csv’

• path (Optional[str], optional) – A path to the directory where the file will be saved. Defaults to None.

• properties (Optional[list[str]], optional) – A list of object’s attribute names that should be included in the exported file. Defaults to None.

Raises:

• TypeError – If objects is not of type T or list of type T

• objects. –

Return type:

None

to_dataframe()

Converts all properties of the object to a dataframe.

Returns:

A DataFrame object containing object properties.

Return type:

DataFrame

to_dict(camel_case=True)

Converts an object to a dictionary excluding object’s private properties. When converting the object to a dictionary, the object’s attributes become the dictionary’s keys and are in camel case by default Attribute values stored as objects are automatically converted to non-/ primitive data structures.

Parameters:

camel_case (bool, optional) – Set to True if attribute names should be converted from snake case to camel case. Defaults to True.

Returns:

A dictionary representation of object’s attributes and values.

By default, the dictionary keys are in camel case.

Return type:

dict

update_properties()

Save compatible local changes of the object attributes to the I-Server. Changes are retrieved from the self._altered_properties dictionary. After the process of update has finished, self._altered_properties is cleared. For this method to work properly, you must override the _alter_properties() method in a subclass.

Raises:

requests.HTTPError – If I-Server raises exception

Return type:

None

mstrio.project_objects.applications.list_applications(connection, to_dictionary=False, limit=None, name=None)

Get list of available Applications.

Parameters:

• connection (Connection) – Strategy One connection object returned by connection.Connection()

• to_dictionary (bool, optional) – if True, return Applications as a list of dicts

• limit (int, optional) – Limit the number of elements returned

• name (str, optional) – filter for applications with names containing this value

Returns:

List of Application objects or list of dictionaries containing application properties.

Return type:

list[Application] | list[dict]