mstrio > distribution_services > subscription > file_subscription

class mstrio.distribution_services.subscription.file_subscription.FileSubscription(connection, id=None, subscription_id=None, project_id=None, project_name=None)

Bases: Subscription

Class representation of Strategy One File Subscription object.

Parameters:

  • connection (Connection) –

  • id (str | None) –

  • subscription_id (str | None) –

  • project_id (str | None) –

  • project_name (str | None) –

add_recipient(recipients=None, recipient_id=None, recipient_type=None, recipient_include_type='TO')

Adds recipient to subscription. You can either specify id, type and include_type of single recipient, or just pass recipients list as a list of dictionaries.

Parameters:

  • recipients (list[dict] | dict | list[str] | str) –

    list of ids or dicts containing recipients, dict format: {“id”: recipient_id,

    ”type”: “CONTACT_GROUP” / “USER_GROUP” / “CONTACT” /

    ”USER” / “PERSONAL_ADDRESS” / “UNSUPPORTED”

    ”includeType”: “TO” / “CC” / “BCC”}

  • recipient_id (str | None) – id of the recipient

  • recipient_type (str | None) – type of the recipient

  • recipient_include_type (str) – include type of the recipient one of the following: “TO” / “CC” / “BCC”, by default “TO”

alter(name=None, filename=None, multiple_contents=None, allow_delivery_changes=None, allow_personalization_changes=None, allow_unsubscribe=None, send_now=None, owner_id=None, schedules=None, recipients=None, delivery=None, custom_msg=None, delivery_expiration_date=None, delivery_expiration_timezone=None, contact_security=True, zip_filename=None, zip_password_protect=None, zip_password=None, file_burst_sub_folder=None, space_delimiter=None, delivery_notification_enabled=False, delivery_personal_notification_address_id=None)

Alter the subscription. :param name: name of the subscription :type name: str, optional :param filename: the filename that will be delivered when

the subscription is executed

Parameters:

  • multiple_contents (bool, optional) – whether multiple contents are allowed

  • allow_delivery_changes (bool, optional) – whether the recipients can change the delivery of the subscription

  • allow_personalization_changes (bool, optional) – whether the recipients can personalize the subscription

  • allow_unsubscribe (bool, optional) – whether the recipients can unsubscribe from the subscription

  • send_now (bool, optional) – indicates whether to execute the subscription immediately

  • owner_id (str, optional) – ID of the subscription owner, by default logged in user ID

  • schedules (list[str] | str | Schedule | list[Schedule], optional) – Schedules IDs or Schedule objects

  • recipients (list[dict] | dict, optional) – list of recipients IDs or dicts

  • delivery (dict | Delivery, optional) – delivery object or dict

  • delivery_expiration_date (str, optional) – expiration date of the subscription, format should be yyyy - MM - dd

  • delivery_expiration_timezone (str, optional) – expiration timezone of the subscription

  • contact_security (bool) – whether to use contact security for each contact group member

  • zip_filename (str, optional) – filename of the compressed content

  • zip_password_protect (bool, optional) – whether to password protect zip file

  • zip_password (str, optional) – optional password for the compressed file

  • file_burst_sub_folder (str, optional) – burst sub folder

  • space_delimiter (str, optional) – space delimiter

  • delivery_notification_enabled (bool) – Whether notification is enabled, notification applies to cache

  • delivery_personal_notification_address_id (str, optional) – Notification details

  • name (str | None) –

  • filename (str) –

  • custom_msg (str | None) –

available_bursting_attributes()

Get a list of available attributes for bursting feature.

Return type:

dict

available_recipients()

List available recipients for subscription content.

Return type:

list[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 create(connection, name, filename, project_id=None, project_name=None, multiple_contents=False, allow_delivery_changes=None, allow_personalization_changes=None, allow_unsubscribe=None, send_now=None, owner_id=None, schedules=None, contents=None, recipients=None, delivery=None, delivery_expiration_date=None, delivery_expiration_timezone=None, contact_security=True, zip_filename=None, zip_password_protect=None, zip_password=None, file_burst_sub_folder=None, space_delimiter=None, delivery_notification_enabled=False, delivery_personal_notification_address_id=None)

Creates a new file subscription. :param connection: a Strategy One connection object :type connection: Connection :param name: name of the subscription :type name: str :param filename: the filename that will be delivered when

the subscription is executed

Parameters:

  • project_id (str, optional) – project ID

  • project_name (str, optional) – project name

  • multiple_contents (bool, optional) – whether multiple contents are allowed

  • allow_delivery_changes (bool, optional) – whether the recipients can change the delivery of the subscription

  • allow_personalization_changes (bool, optional) – whether the recipients can personalize the subscription

  • allow_unsubscribe (bool, optional) – whether the recipients can unsubscribe from the subscription

  • send_now (bool, optional) – indicates whether to execute the subscription immediately

  • owner_id (str, optional) – ID of the subscription owner, by default logged in user ID

  • schedules (list[str] | str | Schedule | list[Schedule], optional) – Schedules IDs or Schedule objects

  • contents (Content, optional) – The content settings

  • recipients (list[dict] | dict, optional) – list of recipients IDs or dicts

  • delivery (dict | Delivery, optional) – delivery object or dict

  • delivery_expiration_date (string, optional) – expiration date of the subscription, format should be yyyy - MM - dd

  • delivery_expiration_timezone (str, optional) – expiration timezone of the subscription, example value ‘Europe/London’

  • contact_security (bool) – whether to use contact security for each contact group member

  • zip_filename (str, optional) – filename of the compressed content

  • zip_password_protect (bool, optional) – whether to password protect zip file

  • zip_password (str, optional) – optional password for the compressed file

  • file_burst_sub_folder (str, optional) – burst sub folder

  • space_delimiter (str, optional) – space delimiter

  • delivery_notification_enabled (bool) – Whether notification is enabled, notification applies to cache

  • delivery_personal_notification_address_id (str, optional) – Notification details

  • connection (Connection) –

  • name (str) –

  • filename (str) –

Return type:

FileSubscription

Notes

To create a subscription with prompts, you need to provide the report instance ID with answered prompts for the content. Example: >>>contents=Content( >>> id=”<report_id>”, >>> type=Content.Type.REPORT, >>> personalization=Content.Properties( >>> format_type=Content.Properties.FormatType.PDF, >>> prompt=Content.Properties.Prompt( >>> enabled=True, >>> instance_id=”<instance_id>”, >>> ), >>> ), >>>)

delete(force=False)

Delete a subscription. Returns True if deletion was successful.

Parameters:

force (bool, optional) – If True, no additional prompt will be shown before deleting the subscription. Defaults to False.

Return type:

bool

execute()

Executes a subscription with given name or GUID for given project.

Return type:

None

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=None, project_id=None, project_name=None)

Initialize Subscription object from dictionary. Specify either project_id or project_name. When project_id is provided (not None), project_name is omitted

Parameters:

  • source (dict[str, Any]) –

  • connection (Connection) –

  • project_id (str | None) –

  • project_name (str | None) –

Return type:

Subscription

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

print()

Pretty Print all properties of the object.

Return type:

None

remove_recipient(recipients)

Removes recipient from given subscription in given project.

Parameters:

recipients (list[str] | list[dict]) –

list of ids or dicts containing recipients, dict format: {“id”: recipient_id,

”type”: “CONTACT_GROUP” / “USER_GROUP” / “CONTACT” /

”USER” / “PERSONAL_ADDRESS” / “UNSUPPORTED”

”includeType”: “TO” / “CC” / “BCC”}

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