mstrio.distribution_services package

Subpackages

• mstrio.distribution_services.device package
  • Submodules
  • mstrio.distribution_services.device.device module
  • mstrio.distribution_services.device.device_properties module
  • Module contents
• mstrio.distribution_services.schedule package
  • Submodules
  • mstrio.distribution_services.schedule.schedule module
  • mstrio.distribution_services.schedule.schedule_time module
  • Module contents
• mstrio.distribution_services.subscription package
  • Submodules
  • mstrio.distribution_services.subscription.base_subscription module
  • mstrio.distribution_services.subscription.cache_update_subscription module
  • mstrio.distribution_services.subscription.common module
  • mstrio.distribution_services.subscription.content module
  • mstrio.distribution_services.subscription.delivery module
  • mstrio.distribution_services.subscription.dynamic_recipient_list module
  • mstrio.distribution_services.subscription.email_subscription module
  • mstrio.distribution_services.subscription.file_subscription module
  • mstrio.distribution_services.subscription.ftp_subscription module
  • mstrio.distribution_services.subscription.history_list_subscription module
  • mstrio.distribution_services.subscription.mobile_subscription module
  • mstrio.distribution_services.subscription.subscription_manager module
  • mstrio.distribution_services.subscription.subscription_status module
  • Module contents
• mstrio.distribution_services.transmitter package
  • Submodules
  • mstrio.distribution_services.transmitter.transmitter module
  • Module contents

Submodules

mstrio.distribution_services.email module

mstrio.distribution_services.email.send_email(connection: Connection, users: list[str | mstrio.users_and_groups.user.User], subject: str, content: str, is_html: bool | None = None) → None

Send an email to specified recipients.

Parameters:

• connection (Connection) – MicroStrategy connection object returned by connection.Connection()

• users (list[str | User]) – List of user IDs or User objects to send the email to

• subject (str) – Subject of the email

• content (str) – Content of the email

• is_html (bool, optional) – Whether the email content is HTML-formatted

mstrio.distribution_services.event module

class mstrio.distribution_services.event.Event(connection: Connection, id: str | None = None, name: str | None = None)

Bases: Entity, DeleteMixin, TranslationMixin

Class representation of MicroStrategy Event object.

connection

A MicroStrategy connection object

name

Event name

id

Event ID

description

Event descriptions

alter(name: str | None = None, description: str | None = None, comments: str | None = None)

Alter the Event’s properties

Parameters:

• name – New name for the Event

• description – New description for the Event

• comments – long description of the Event

classmethod create(connection: Connection, name: str, description: str | None = None) → Event

Create an Event

Parameters:

• connection – MicroStrategy connection object returned by connection.Connection().

• name – Name of the new Event

• description – Description of the new Event

trigger()

Trigger the Event

mstrio.distribution_services.event.list_events(connection: Connection, to_dictionary: bool = False, limit: int = None, **filters) → list[mstrio.distribution_services.event.Event] | list[dict]

List event objects or event dictionaries. Optionally filter list.

Parameters:

• connection (object) – MicroStrategy connection object returned by ‘connection.Connection()’

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

• limit (int, optional) – maximum number of Events returned.

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

Module contents