Office365-REST-Python-Client 2.4.2__py3-none-any.whl → 2.4.4__py3-none-any.whl

office365/sharepoint/forms/customization.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class FormsCustomization(BaseEntity):
+
+    @property
+    def entity_type_name(self):
+        return "SP.Internal.FormsCustomization"

office365/sharepoint/listitems/listitem.py

@@ -2,6 +2,7 @@ import json
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.paths.key import KeyPath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.service_operation import ServiceOperationPath
@@ -13,7 +14,6 @@ from office365.sharepoint.fields.image_value import ImageFieldValue
 from office365.sharepoint.fields.lookup_value import FieldLookupValue
 from office365.sharepoint.fields.multi_lookup_value import FieldMultiLookupValue
 from office365.sharepoint.fields.string_values import FieldStringValues
-from office365.sharepoint.internal.paths.entity import EntityPath
 from office365.sharepoint.likes.liked_by_information import LikedByInformation
 from office365.sharepoint.listitems.compliance_info import ListItemComplianceInfo
 from office365.sharepoint.listitems.form_update_value import ListItemFormUpdateValue
@@ -48,19 +48,26 @@ class ListItem(SecurableObject):
         if parent_list is not None:
             self.set_property("ParentList", parent_list, False)
 
-    def share_link(self, link_kind, expiration=None):
+    def share_link(self, link_kind, expiration=None, role=None, password=None):
         """Creates a tokenized sharing link for a list item based on the specified parameters and optionally
         sends an email to the people that are listed in the specified parameters.
 
         :param int link_kind: The kind of the tokenized sharing link to be created/updated or retrieved.
-        :param datetime or None expiration: A date/time string for which the format conforms to the ISO 8601:2004(E)
+        :param datetime.datetime or None expiration: A date/time string for which the format conforms to the ISO 8601:2004(E)
             complete representation for calendar date and time of day and which represents the time and date of expiry
             for the tokenized sharing link. Both the minutes and hour value MUST be specified for the difference
             between the local and UTC time. Midnight is represented as 00:00:00. A null value indicates no expiry.
             This value is only applicable to tokenized sharing links that are anonymous access links.
+        :param int role: The role to be used for the tokenized sharing link. This is required for Flexible links
+            and ignored for all other kinds.
+        :param str password: Optional password value to apply to the tokenized sharing link,
+            if it can support password protection.
         """
         return_type = ClientResult(self.context, ShareLinkResponse())
-        request = ShareLinkRequest(settings=ShareLinkSettings(link_kind=link_kind, expiration=expiration))
+        request = ShareLinkRequest(settings=ShareLinkSettings(link_kind=link_kind,
+                                                              expiration=expiration,
+                                                              role=role,
+                                                              password=password))
         payload = {"request": request}
         qry = ServiceOperationQuery(self, "ShareLink", None, payload, None, return_type)
         self.context.add_query(qry)
@@ -268,9 +275,9 @@ class ListItem(SecurableObject):
 
     def set_comments_disabled(self, value):
         """
-        Sets the value of CommentsDisabled (section 3.2.5.87.1.1.8) for the item.
+        Sets the value of CommentsDisabled for the item.
 
-        :type value: bool
+        :param bool value: Indicates whether comments for this item are disabled or not.
         """
         qry = ServiceOperationQuery(self, "SetCommentsDisabled", [value])
         self.context.add_query(qry)
@@ -476,29 +483,41 @@ class ListItem(SecurableObject):
         # fallback: create a new resource path
         if self._resource_path is None and self.parent_collection is not None:
             if name == "Id":
-                self._resource_path = EntityPath(value, self.parent_collection.resource_path)
+                self._resource_path = KeyPath(value, self.parent_collection.resource_path)
         return self
 
     def _set_taxonomy_field_value(self, name, value):
+        """
+        Sets taxonomy field value
+
+        :param str name: Taxonomy field name
+        :param TaxonomyFieldValueCollection value: Taxonomy field value
+        """
         tax_field = self.parent_list.fields.get_by_internal_name_or_title(name)
 
         def _tax_field_loaded():
             tax_text_field = self.parent_list.fields.get_by_id(tax_field.properties["TextField"])
 
-            def _tax_text_field_loaded():
+            def _tax_text_field_loaded(return_type):
                 self.set_property(tax_text_field.properties["StaticName"], str(value))
-            tax_text_field.ensure_property("StaticName", _tax_text_field_loaded)
+            tax_text_field.select(["StaticName"]).get().after_execute(_tax_text_field_loaded, execute_first=True)
 
         tax_field.ensure_property("TextField", _tax_field_loaded)
 
-    def ensure_type_name(self, target_list):
+    def ensure_type_name(self, target_list, action=None):
         """
         Determine metadata annotation for ListItem entity
 
         :param office365.sharepoint.lists.list.List target_list: List resource
+        :param () -> None action: Event handler
         """
         if self._entity_type_name is None:
             def _list_loaded():
                 self._entity_type_name = target_list.properties['ListItemEntityTypeFullName']
+                if callable(action):
+                    action()
             target_list.ensure_property("ListItemEntityTypeFullName", _list_loaded)
+        else:
+            if callable(action):
+                action()
         return self

office365/sharepoint/lists/bloom_filter.py

@@ -9,7 +9,6 @@ class ListBloomFilter(BaseEntity):
     def bloom_filter_size(self):
         """
         The length of the Bloom Filter
-
         :rtype: int or None
         """
         return self.properties.get("BloomFilterSize", None)

office365/sharepoint/lists/creation_information.py

@@ -4,19 +4,33 @@ from office365.runtime.client_value import ClientValue
 class ListCreationInformation(ClientValue):
     """Represents metadata about list creation."""
 
-    def __init__(self, title=None, description=None, base_template=None, allow_content_types=False):
+    def __init__(self, title=None, description=None, base_template=None, allow_content_types=False,
+                 custom_schema_xml=None, document_template_type=None, quick_launch_option=None,
+                 template_feature_id=None, template_type=None):
         """
-
-        :type base_template: int or None
-        :type allow_content_types: bool
+        :param int or None base_template:
+        :param bool allow_content_types:
         :poram str or None description: Specifies the description of the new list.
         :param str title: Specifies the display name of the new list.
+        :param str custom_schema_xml: Specifies the list schema of the new list.
+        :param str document_template_type: Specifies the identifier of the document template for the new list.
+        :param int quick_launch_option: Specifies whether the new list is displayed on the Quick Launch of the site
+        :param int template_feature_id: Specifies the feature identifier of the feature that contains the list schema
+            for the new list. It MUST be empty GUID if the list schema for the new list is not contained within
+            a feature.
+        :param int template_type: Specifies the list server template of the new list.
         """
         super(ListCreationInformation, self).__init__()
         self.Title = title
         self.Description = description
         self.BaseTemplate = base_template
         self.AllowContentTypes = allow_content_types
+        self.CustomSchemaXml = custom_schema_xml
+        self.DataSourceProperties = None
+        self.DocumentTemplateType = document_template_type
+        self.QuickLaunchOption = quick_launch_option
+        self.TemplateFeatureId = template_feature_id
+        self.TemplateType = template_type
 
     @property
     def entity_type_name(self):

office365/sharepoint/lists/list.py

@@ -1,3 +1,5 @@
+from datetime import datetime
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -25,6 +27,7 @@ from office365.sharepoint.lists.bloom_filter import ListBloomFilter
 from office365.sharepoint.lists.creatables_info import CreatablesInfo
 from office365.sharepoint.lists.data_source import ListDataSource
 from office365.sharepoint.lists.rule import SPListRule
+from office365.sharepoint.navigation.configured_metadata_items import ConfiguredMetadataNavigationItemCollection
 from office365.sharepoint.pages.wiki_page_creation_information import WikiPageCreationInformation
 from office365.sharepoint.permissions.securable_object import SecurableObject
 from office365.sharepoint.principal.users.user import User
@@ -39,7 +42,8 @@ from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 
 
 class List(SecurableObject):
-    """Represents a list on a SharePoint Web site.
+    """
+    Represents a list on a SharePoint Web site.
 
     A container within a SharePoint site that stores list items. A list has a customizable schema that is
     composed of one or more fields.
@@ -91,6 +95,20 @@ class List(SecurableObject):
         self.context.add_query(qry)
         return return_type
 
+    def get_metadata_navigation_settings(self):
+        """
+        Retrieves the configured metadata navigation settings for the list.
+        """
+        from office365.sharepoint.navigation.metadata_settings import MetadataNavigationSettings
+        return_type = ClientResult(self.context, ConfiguredMetadataNavigationItemCollection())
+
+        def _loaded():
+           MetadataNavigationSettings.get_configured_settings(self.context, self.root_folder.serverRelativeUrl,
+                                                              return_type)
+
+        self.root_folder.ensure_property("ServerRelativeUrl", _loaded)
+        return return_type
+
     def get_site_script(self, options=None):
         """Creates site script syntax
 
@@ -391,13 +409,13 @@ class List(SecurableObject):
             qry = ServiceOperationQuery(self, "items", None, return_type, None, return_type)
             self.context.add_query(qry)
         else:
-            def _folder_loaded():
+            def _add_item():
                 creation_information.FolderUrl = self.context.base_url + self.root_folder.serverRelativeUrl
                 payload = {"parameters": creation_information}
                 next_qry = ServiceOperationQuery(self, "addItem", None, payload, None, return_type)
                 self.context.add_query(next_qry)
 
-            self.root_folder.ensure_property("ServerRelativeUrl", _folder_loaded)
+            self.root_folder.ensure_property("ServerRelativeUrl", _add_item)
         return return_type
 
     def create_wiki_page(self, page_name, page_content):
@@ -533,6 +551,14 @@ class List(SecurableObject):
         """
         return self.properties.get("Id", None)
 
+    @property
+    def additional_ux_properties(self):
+        """
+
+        :rtype: str
+        """
+        return self.properties.get("AdditionalUXProperties", None)
+
     @property
     def author(self):
         """Specifies the user who created the list."""
@@ -543,16 +569,22 @@ class List(SecurableObject):
     def allow_content_types(self):
         """
         Specifies whether the list supports content types.
-
         :rtype: bool or None
         """
         return self.properties.get("AllowContentTypes", None)
 
+    @property
+    def allow_deletion(self):
+        """
+        Specifies whether the list could be deleted.
+        :rtype: bool or None
+        """
+        return self.properties.get("AllowDeletion", None)
+
     @property
     def base_template(self):
         """
         Specifies the list server template of the list.
-
         :rtype: int or None
         """
         return self.properties.get("BaseTemplate", None)
@@ -562,16 +594,30 @@ class List(SecurableObject):
         """
         Specifies the base type of the list.
         It MUST be one of the following values: GenericList, DocumentLibrary, DiscussionBoard, Survey, or Issue.
-
         :rtype: int or None
         """
         return self.properties.get("BaseType", None)
 
+    @property
+    def browser_file_handling(self):
+        """
+        Specifies the override at the list level for the BrowserFileHandling property of the Web application.
+        If the BrowserFileHandling property of the Web application is BrowserFileHandling.Strict,
+        then this setting MUST be ignored. If the BrowserFileHandling property of the Web application is
+        BrowserFileHandling.Permissive, then this setting MUST be respected.
+        :rtype: int or None
+        """
+        return self.properties.get("BrowserFileHandling", None)
+
+    @property
+    def created(self):
+        """Specifies when the list was created."""
+        return self.properties.get("Created", datetime.min)
+
     @property
     def default_display_form_url(self):
         """
         Specifies the location of the default display form for the list.
-
         :rtype: str or None
         """
         return self.properties.get("DefaultDisplayFormUrl", None)
@@ -587,7 +633,6 @@ class List(SecurableObject):
     def default_view_url(self):
         """
         Specifies the server-relative URL of the default view for the list.
-
         :rtype: str or None
         """
         return self.properties.get("DefaultViewUrl", None)
@@ -597,7 +642,6 @@ class List(SecurableObject):
         """
         Specifies whether or not the crawler indexes the non-default views of the list.
         Specify a value of true if the crawler indexes the list's non-default views; specify false if otherwise.
-
         :rtype: bool or None
         """
         return self.properties.get("CrawlNonDefaultViews", None)
@@ -629,15 +673,6 @@ class List(SecurableObject):
         """
         return self.properties.get("DataSource", ListDataSource())
 
-    @property
-    def enable_folder_creation(self):
-        """
-        Specifies whether new list folders can be added to the list.
-
-        :rtype: bool or None
-        """
-        return self.properties.get("EnableFolderCreation", None)
-
     @property
     def default_edit_form_url(self):
         """
@@ -654,10 +689,66 @@ class List(SecurableObject):
         """
         return self.properties.get("DefaultItemOpenInBrowser", None)
 
+    @property
+    def default_item_open_use_list_setting(self):
+        """
+        This property returns whether to use the List setting or the server wide setting for
+        DefaultItemOpen (BrowserEnabledDocuments setting) in the Web application. This property can only be set to
+        false, thereby using the server-wide setting. To set it to use List setting, set the value for DefaultItemOpen.
+        :rtype: bool or None
+        """
+        return self.properties.get("DefaultItemOpenUseListSetting", None)
+
+    @property
+    def disable_commenting(self):
+        """
+        :rtype: bool or None
+        """
+        return self.properties.get("DisableCommenting", None)
+
+    @property
+    def disable_grid_editing(self):
+        """
+        :rtype: bool or None
+        """
+        return self.properties.get("DisableGridEditing", None)
+
+    @property
+    def enable_folder_creation(self):
+        """
+        Specifies whether new list folders can be added to the list.
+        :rtype: bool or None
+        """
+        return self.properties.get("EnableFolderCreation", None)
+
     @enable_folder_creation.setter
     def enable_folder_creation(self, value):
         self.set_property("EnableFolderCreation", value, True)
 
+    @property
+    def enable_minor_versions(self):
+        """
+        Specifies whether minor versions are enabled for the list.
+        :rtype: bool or None
+        """
+        return self.properties.get("EnableMinorVersions", None)
+
+    @property
+    def enable_moderation(self):
+        """
+        Specifies whether content approval is enabled for the list.
+        :rtype: bool or None
+        """
+        return self.properties.get("EnableModeration", None)
+
+    @property
+    def enable_versioning(self):
+        """
+        Specifies whether content approval is enabled for the list.
+        :rtype: bool or None
+        """
+        return self.properties.get("EnableVersioning", None)
+
     @property
     def items(self):
         """Get list items"""
@@ -706,11 +797,37 @@ class List(SecurableObject):
     @property
     def content_types_enabled(self):
         """Specifies whether content types are enabled for the list.
-
         :rtype: bool or None
         """
         return self.properties.get('ContentTypesEnabled', None)
 
+    @property
+    def is_private(self):
+        """
+        Specifies whether the list is a private list with restricted permissions.
+        True if the list is a private list, otherwise False.
+        :rtype: bool or None
+        """
+        return self.properties.get('IsPrivate', None)
+
+    @property
+    def is_site_assets_library(self):
+        """
+        Specifies whether the list is designated as a default asset location for images or other files which the
+        users upload to their wiki pages.
+        :rtype: bool or None
+        """
+        return self.properties.get('IsSiteAssetsLibrary', None)
+
+    @property
+    def is_system_list(self):
+        """
+        Indicates whether the list is system list that does not contain end user data and created by system account.
+        A value of True means yes.
+        :rtype: bool or None
+        """
+        return self.properties.get('IsSystemList', None)
+
     @property
     def user_custom_actions(self):
         """Gets the User Custom Actions that are associated with the list."""
@@ -745,16 +862,65 @@ class List(SecurableObject):
 
     @property
     def item_count(self):
-        """Gets a value that specifies the number of list items in the list.
-
+        """
+        Gets a value that specifies the number of list items in the list.
         :rtype: int or None
         """
         return self.properties.get('ItemCount', None)
 
     @property
-    def title(self):
-        """Gets the displayed title for the list.
+    def last_item_deleted_date(self):
+        """
+        Specifies the last time a list item was deleted from the list. It MUST return Created if no list item has
+        been deleted from the list yet.
+        """
+        return self.properties.get('LastItemDeletedDate', datetime.min)
+
+    @property
+    def last_item_modified_date(self):
+        """
+        Specifies the last time a list item, field, or property of the list was modified.
+        It MUST return Created if the list has not been modified.
+        """
+        return self.properties.get('LastItemModifiedDate', datetime.min)
+
+    @property
+    def list_form_customized(self):
+        """
+        :rtype: bool or None
+        """
+        return self.properties.get('ListFormCustomized', None)
+
+    @property
+    def list_item_entity_type_full_name(self):
+        """
+        Specifies the full type name of the list item.
+        :rtype: str or None
+        """
+        return self.properties.get('ListItemEntityTypeFullName', None)
+
+    @property
+    def major_version_limit(self):
+        """
+        Gets the maximum number of major versions allowed for an item in a document library that uses version
+        control with major versions only.
+        :rtype: int or None
+        """
+        return self.properties.get('MajorVersionLimit', None)
+
+    @property
+    def major_with_minor_versions_limit(self):
+        """
+        Gets the maximum number of major versions that are allowed for an item in a document library that uses
+        version control with both major and minor versions.
+        :rtype: int or None
+        """
+        return self.properties.get('MajorWithMinorVersionsLimit', None)
 
+    @property
+    def title(self):
+        """
+        Gets the displayed title for the list.
         :rtype: str or None
         """
         return self.properties.get('Title', None)
@@ -764,6 +930,16 @@ class List(SecurableObject):
         """Sets the displayed title for the list."""
         self.set_property('Title', val)
 
+
+    @property
+    def default_content_approval_workflow_id(self):
+        """
+        Specifies the default workflow identifier for content approval on the list. It MUST be an empty GUID
+        if there is no default content approval workflow.
+        :rtype: str
+        """
+        return self.properties.get("DefaultContentApprovalWorkflowId", None)
+
     @property
     def description(self):
         """Gets the description for the list.
@@ -789,8 +965,8 @@ class List(SecurableObject):
 
     @property
     def schema_xml(self):
-        """Specifies the list schema of the list.
-
+        """
+        Specifies the list schema of the list.
         :rtype: str or None
         """
         return self.properties.get("SchemaXml", None)
@@ -800,7 +976,6 @@ class List(SecurableObject):
         """
         Specifies the feature identifier of the feature that contains the list schema for the list.
         It MUST be an empty GUID if the list schema for the list is not contained within a feature.
-
         :rtype: str or None
         """
         return self.properties.get("TemplateFeatureId", None)
@@ -815,7 +990,6 @@ class List(SecurableObject):
     def validation_formula(self):
         """
         Specifies the data validation criteria for a list item.
-
         :rtype: str or None
         """
         return self.properties.get("ValidationFormula", None)
@@ -839,6 +1013,8 @@ class List(SecurableObject):
                 "DefaultView": self.default_view,
                 "DefaultViewPath": self.default_view_path,
                 "EventReceivers": self.event_receivers,
+                "LastItemDeletedDate": self.last_item_deleted_date,
+                "LastItemModifiedDate": self.last_item_modified_date,
                 "ParentWeb": self.parent_web,
                 "ParentWebPath": self.parent_web_path,
                 "RootFolder": self.root_folder,

office365/sharepoint/lists/render_data_parameters.py

@@ -4,13 +4,33 @@ from office365.runtime.client_value import ClientValue
 class RenderListDataParameters(ClientValue):
     """Specifies the parameters to be used to render list data as a JSON string"""
 
-    def __init__(self, add_all_fields=None, add_required_fields=None):
+    def __init__(self, add_all_fields=None, add_all_view_fields=None, add_regional_settings=None,
+                 add_required_fields=None, allow_multiple_value_filter_for_taxonomy_fields=None,
+                 audience_target=None, dates_in_utc=None, expand_groups=None, expand_user_field=None,
+                 filter_out_channel_folders_in_default_doc_lib=None):
         """
         :param bool add_all_fields:
+        :param bool add_all_view_fields:
+        :param bool add_regional_settings:
         :param bool add_required_fields: This parameter indicates if we return required fields.
+        :param bool allow_multiple_value_filter_for_taxonomy_fields: This parameter indicates whether multi value
+            filtering is allowed for taxonomy fields.
+        :param bool audience_target:
+        :param bool dates_in_utc: Specifies if the DateTime field is returned in UTC or local time.
+        :param bool expand_groups: Specifies whether to expand the grouping or not.
+        :param bool expand_user_field:
+        :param bool filter_out_channel_folders_in_default_doc_lib:
         """
         self.AddAllFields = add_all_fields
+        self.AddAllViewFields = add_all_view_fields
+        self.AddRegionalSettings = add_regional_settings
         self.AddRequiredFields = add_required_fields
+        self.AllowMultipleValueFilterForTaxonomyFields = allow_multiple_value_filter_for_taxonomy_fields
+        self.AudienceTarget = audience_target
+        self.DatesInUtc = dates_in_utc
+        self.ExpandGroups = expand_groups
+        self.ExpandUserField = expand_user_field
+        self.FilterOutChannelFoldersInDefaultDocLib = filter_out_channel_folders_in_default_doc_lib
 
     @property
     def entity_type_name(self):

office365/sharepoint/lists/template_type.py

@@ -19,27 +19,37 @@ class ListTemplateType:
     """Specifies a survey list."""
 
     Links = 103
+    """Specifies a links list."""
 
     Announcements = 104
+    """Specifies an announcements list."""
 
     Contacts = 105
     """Specifies a contacts list."""
 
     Events = 106
+    """Specifies a calendar list."""
 
     Tasks = 107
+    """Specifies a task list."""
 
     DiscussionBoard = 108
+    """Specifies a discussion board."""
 
     PictureLibrary = 109
+    """Specifies a picture library."""
 
     DataSources = 110
+    """Specifies a list of data sources for a site """
 
     WebTemplateCatalog = 111
+    """Specifies a list template gallery."""
 
     UserInformation = 112
+    """Specifies a user information list"""
 
     WebPartCatalog = 113
+    """"""
 
     ListTemplateCatalog = 114
 

office365/sharepoint/navigation/configured_metadata_items.py

@@ -1,6 +1,30 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class ConfiguredMetadataNavigationItem(ClientValue):
+    """Represents a configured metadata navigation item."""
+
+    def __init__(self, field_display_name=None, field_title=None, field_type_as_string=None,
+                 is_content_type_field=None, is_folder_hierarchy=None, is_hierarchy=None):
+        """
+        :param str field_display_name: The display name of the field that this item refers to.
+        :param str field_title: The internal name of the field that this item refers to.
+        :param str field_type_as_string: The type of the field that this item refers to.
+        :param bool is_content_type_field: Indicates whether the type of this field is a content type.
+        :param bool is_folder_hierarchy: Indicates whether this item is a folder hierarchy.
+        :param bool is_hierarchy: Indicates whether this item is hierarchical.
+        """
+        self.FieldDisplayName = field_display_name
+        self.FieldTitle = field_title
+        self.FieldTypeAsString = field_type_as_string
+        self.IsContentTypeField = is_content_type_field
+        self.IsFolderHierarchy = is_folder_hierarchy
+        self.IsHierarchy = is_hierarchy
 
 
 class ConfiguredMetadataNavigationItemCollection(ClientValue):
     """A collection of configured metadata navigation items."""
-    pass
+
+    def __init__(self, items=None):
+        self.Items = ClientValueCollection(ConfiguredMetadataNavigationItem, items)