Office365-REST-Python-Client 2.5.5__py3-none-any.whl → 2.5.7__py3-none-any.whl

office365/sharepoint/views/view.py

@@ -1,3 +1,5 @@
+from typing import TYPE_CHECKING, Optional
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -9,6 +11,9 @@ from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
 from office365.sharepoint.views.field_collection import ViewFieldCollection
 from office365.sharepoint.views.visualization import Visualization
 
+if TYPE_CHECKING:
+    from office365.sharepoint.views.collection import ViewCollection
+
 
 class View(Entity):
     """Specifies a List View."""
@@ -37,9 +42,7 @@ class View(Entity):
         return return_type
 
     def render_as_html(self):
-        """
-        Returns the list view as HTML.
-        """
+        """Returns the list view as HTML."""
         return_type = ClientResult(self.context)
         qry = ServiceOperationQuery(self, "RenderAsHtml", None, None, None, return_type)
         self.context.add_query(qry)
@@ -56,43 +59,35 @@ class View(Entity):
 
     @property
     def aggregations(self):
-        """
-        Specifies fields (2) and functions that define totals shown in a list view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies fields and functions that define totals shown in a list view."""
         return self.properties.get("Aggregations", None)
 
     @property
     def aggregations_status(self):
+        # type: () -> Optional[str]
         """
         Specifies whether totals are shown in the list view.
         It MUST be NULL If Aggregations is NULL; otherwise it MUST be "On" or "Off".
-        :rtype: str or None
         """
         return self.properties.get("AggregationsStatus", None)
 
     @property
     def associated_content_type_id(self):
-        """
-        Represents the content type identifier associated with the view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Represents the content type identifier associated with the view."""
         return self.properties.get("AssociatedContentTypeId", None)
 
     @property
     def calendar_view_styles(self):
-        """
-        Represents an object specifying the style of a SharePoint calendar view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Represents an object specifying the style of a SharePoint calendar view."""
         return self.properties.get("CalendarViewStyles", None)
 
     @property
     def column_width(self):
-        """
-        Specifies the width of columns.
-        :rtype: str or None
-        """
+        # type: () -> Optional[int]
+        """Specifies the width of columns."""
         return self.properties.get("ColumnWidth", None)
 
     @property
@@ -102,24 +97,19 @@ class View(Entity):
 
     @property
     def parent_collection(self):
-        """
-        :rtype: office365.sharepoint.views.collection.ViewCollection
-        """
+        # type: () -> ViewCollection
         return self._parent_collection
 
     @property
     def js_link(self):
-        """
-        Specifies the JavaScript files used for the view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the JavaScript files used for the view."""
         return self.properties.get("JSLink", None)
 
     @property
     def content_type_id(self):
-        """Gets the identifier of the content type with which the view is associated.
-        :rtype: ContentTypeId
-        """
+        # type: () -> Optional[ContentTypeId]
+        """Gets the identifier of the content type with which the view is associated."""
         return self.properties.get("ContentTypeId", ContentTypeId())
 
     @content_type_id.setter
@@ -129,64 +119,55 @@ class View(Entity):
 
     @property
     def custom_formatter(self):
-        """
-        Specifies the Custom Formatter used for the view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the Custom Formatter used for the view."""
         return self.properties.get("CustomFormatter", None)
 
     @property
     def custom_order(self):
-        """
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """"""
         return self.properties.get("CustomOrder", None)
 
     @property
     def editor_modified(self):
-        """Specifies whether the list view was modified in an editor.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the list view was modified in an editor."""
         return self.properties.get("EditorModified", None)
 
     def formats(self):
-        """Specifies the column and row formatting for the list view.
-        :stype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the column and row formatting for the list view."""
         return self.properties.get("Formats", None)
 
     @property
     def hidden(self):
-        """Gets whether the list view is hidden.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets whether the list view is hidden."""
         return self.properties.get("Hidden", None)
 
     @hidden.setter
     def hidden(self, value):
+        # type: (bool) -> None
         """Sets whether the list view is hidden."""
         self.set_property("Hidden", value)
 
     @property
     def default_view(self):
-        """Gets whether the list view is the default list view.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Gets whether the list view is the default list view."""
         return self.properties.get("DefaultView", None)
 
     @default_view.setter
     def default_view(self, value):
-        """
-        Sets whether the list view is the default list view.
-        """
+        # type: (bool) -> None
+        """Sets whether the list view is the default list view."""
         self.set_property("DefaultView", value)
 
     @property
     def default_view_for_content_type(self):
-        """
-        Specifies whether the list view is the default list view for the content type specified by ContentTypeId.
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """Specifies whether the list view is the default list view for the content type specified by ContentTypeId."""
         return self.properties.get("DefaultViewForContentType", None)
 
     @property
@@ -201,18 +182,18 @@ class View(Entity):
 
     @property
     def view_query(self):
-        """
-        Gets or sets a value that specifies the query that is used by the list view.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Gets or sets a value that specifies the query that is used by the list view."""
         return self.properties.get("ViewQuery", None)
 
     @property
     def base_view_id(self):
+        # type: () -> Optional[str]
         """Gets a value that specifies the base view identifier of the list view."""
         return self.properties.get("BaseViewId", None)
 
     def read_only_view(self):
+        # type: () -> Optional[bool]
         """Specifies whether the list view is read-only."""
         return self.properties.get("ReadOnlyView", None)
 
@@ -223,10 +204,8 @@ class View(Entity):
 
     @property
     def view_joins(self):
-        """
-        Specifies the joins that are used in the list view
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Specifies the joins that are used in the list view"""
         return self.properties.get("ViewJoins", None)
 
     @property

office365/sharepoint/webhooks/subscription.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Optional
 
 from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.sharepoint.entity import Entity
@@ -9,41 +10,32 @@ class Subscription(Entity):
 
     @property
     def application_id(self):
-        """
-        Identifier of the application used to create the subscription.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Identifier of the application used to create the subscription."""
         return self.properties.get("applicationId", None)
 
     @property
     def notification_url(self):
-        """
-        Gets endpoint that will be called when an event occurs.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Gets endpoint that will be called when an event occurs."""
         return self.properties.get("notificationUrl", None)
 
     @notification_url.setter
     def notification_url(self, value):
-        """
-        Sets endpoint that will be called when an event occurs.
-        """
+        # type: (str) -> None
+        """Sets endpoint that will be called when an event occurs."""
         self.set_property("notificationUrl", value)
 
     @property
     def expiration_datetime(self):
-        """
-        Gets endpoint that will be called when an event occurs.
-
-        :rtype: str
-        """
+        # type: () -> Optional[datetime]
+        """Gets endpoint that will be called when an event occurs."""
         return self.properties.get("expirationDateTime", None)
 
     @expiration_datetime.setter
     def expiration_datetime(self, value):
-        """
-        Sets endpoint that will be called when an event occurs.
-        """
+        # type: (datetime|str) -> None
+        """Sets endpoint that will be called when an event occurs."""
         if isinstance(value, datetime):
             self.set_property("expirationDateTime", value.isoformat())
         else:

office365/sharepoint/webparts/webpart.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -9,11 +11,11 @@ class WebPart(Entity):
 
     @property
     def zone_index(self):
+        # type: () -> Optional[int]
         """
         An integer that specifies the relative position of a Web Part in a Web Part zone.
         Web Parts are positioned from the smallest to the largest zone index. If two or more Web Parts have the
         same zone index they are positioned adjacent to each other in an undefined order
-        :rtype: int or None
         """
         return self.properties.get("ZoneIndex", None)
 

office365/sharepoint/webs/information_collection.py

@@ -3,7 +3,7 @@ from office365.sharepoint.entity_collection import EntityCollection
 from office365.sharepoint.webs.information import WebInformation
 
 
-class WebInformationCollection(EntityCollection):
+class WebInformationCollection(EntityCollection[WebInformation]):
     """Specifies a collection of objects containing metadata about a site"""
 
     def __init__(self, context, resource_path=None):

office365/sharepoint/webs/modernize_homepage_result.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.sharepoint.entity import Entity
 
 
@@ -6,7 +8,6 @@ class ModernizeHomepageResult(Entity):
 
     @property
     def can_modernize_homepage(self):
-        """
-        :rtype: bool or None
-        """
+        # type: () -> Optional[bool]
+        """"""
         return self.properties.get("CanModernizeHomepage", None)

office365/sharepoint/webs/regional_settings.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.entity import Entity
 from office365.sharepoint.sites.language_collection import LanguageCollection
@@ -7,42 +9,103 @@ from office365.sharepoint.webs.time_zone import TimeZone, TimeZoneCollection
 class RegionalSettings(Entity):
     """Represents regional settings that are used on the server that is running SharePoint Server."""
 
+    @property
+    def adjust_hijri_days(self):
+        # type: () -> Optional[int]
+        """Specifies the number of days to extend or reduce the current month in Hijri calendars on the site"""
+        return self.properties.get("AdjustHijriDays", None)
+
+    @property
+    def alternate_calendar_type(self):
+        # type: () -> Optional[int]
+        """Gets an alternate calendar type that is used on the site"""
+        return self.properties.get("AlternateCalendarType", None)
+
+    @property
+    def am(self):
+        # type: () -> Optional[str]
+        """Specifies the string that is used to represent time before midday on the site"""
+        return self.properties.get("AM", None)
+
+    @property
+    def calendar_type(self):
+        # type: () -> Optional[int]
+        """Specifies the calendar type that SHOULD be used when processing date values on the site"""
+        return self.properties.get("CalendarType", None)
+
     @property
     def collation(self):
+        # type: () -> Optional[int]
         """
         Specifies the collation order of the site (2), which indicates an additional sorting order that SHOULD
         be processed by any back-end database server associated with the site (2). The collation method is an
         implementation-specific capability of the front-end Web server and back-end database server.
-
-        :rtype: int or None
         """
         return self.properties.get("Collation", None)
 
     @property
-    def date_format(self):
-        """
-        Gets the date format that is used on the server.
+    def collation_lcid(self):
+        # type: () -> Optional[int]
+        """Gets the language code identifier (LCID) for the collation rules that are used on the site"""
+        return self.properties.get("CollationLCID", None)
 
-        :rtype: int or None
-        """
+    @property
+    def date_format(self):
+        # type: () -> Optional[int]
+        """Gets the date format that is used on the server."""
         return self.properties.get("DateFormat", None)
 
     @property
-    def locale_id(self):
-        """
-        Gets the locale identifier in use on the server.
+    def date_separator(self):
+        # type: () -> Optional[str]
+        """Gets the separator that is used for dates on the server."""
+        return self.properties.get("DateSeparator", None)
+
+    @property
+    def decimal_separator(self):
+        # type: () -> Optional[str]
+        """Gets the separator that is used for decimals on the server."""
+        return self.properties.get("DecimalSeparator", None)
+
+    @property
+    def digit_grouping(self):
+        # type: () -> Optional[str]
+        """Gets the separator that is used in grouping digits."""
+        return self.properties.get("DigitGrouping", None)
+
+    @property
+    def first_day_of_week(self):
+        # type: () -> Optional[int]
+        """Specifies the first day of the week used in calendars on the server.
+        The possible values are specified in the following table:
 
-        :rtype: int or None
+        - 0 Sunday
+        - 1 Monday
+        - 2 Tuesday
+        - 3 Wednesday
+        - 4 Thursday
+        - 5 Friday
+        - 6 Saturday
         """
+        return self.properties.get("FirstDayOfWeek", None)
+
+    @property
+    def first_week_of_year(self):
+        # type: () -> Optional[int]
+        """Specifies the first week of the year used in calendars on the server.
+        Specifies which week of a year is considered the first week."""
+        return self.properties.get("FirstWeekOfYear", None)
+
+    @property
+    def locale_id(self):
+        # type: () -> Optional[int]
+        """Gets the locale identifier in use on the server."""
         return self.properties.get("LocaleId", None)
 
     @property
     def work_days(self):
-        """
-        Gets a number that represents the work days of Web site calendars.
-
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Gets a number that represents the work days of Web site calendars."""
         return self.properties.get("WorkDays", None)
 
     @property

office365/sharepoint/webs/template.py

@@ -54,19 +54,17 @@ class WebTemplate(Entity):
 
     @property
     def is_sub_web_only(self):
+        # type: () -> Optional[bool]
         """
         Specifies whether the site definition configuration or site template can only be applied to subsites
         created within the site collection.
-        :rtype: bool or None
         """
         return self.properties.get("IsSubWebOnly", None)
 
     @property
     def lcid(self):
-        """
-        Specifies the LCID for the site definition configuration or site template.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """Specifies the LCID for the site definition configuration or site template."""
         return self.properties.get("Lcid", None)
 
     @property

office365/sharepoint/webs/web.py

@@ -1,6 +1,6 @@
 # coding=utf-8
 import datetime
-from typing import AnyStr, Optional
+from typing import TYPE_CHECKING, AnyStr, Optional
 
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -106,6 +106,9 @@ from office365.sharepoint.webs.regional_settings import RegionalSettings
 from office365.sharepoint.webs.template_collection import WebTemplateCollection
 from office365.sharepoint.webs.theme_info import ThemeInfo
 
+if TYPE_CHECKING:
+    from office365.sharepoint.client_context import ClientContext
+
 
 class Web(SecurableObject):
     """
@@ -549,7 +552,9 @@ class Web(SecurableObject):
         :param int order_by: the column by which to order the Recycle Bin query.
         :param int item_state: Recycle Bin stage of items to return in the query.
         """
-        return_type = RecycleBinItemCollection(self.context)
+        return_type = RecycleBinItemCollection(
+            self.context, self.recycle_bin.resource_path
+        )
         payload = {
             "rowLimit": row_limit,
             "isAscending": is_ascending,
@@ -651,15 +656,14 @@ class Web(SecurableObject):
         return return_type
 
     def get_sharing_link_data(self, link_url):
+        # type: (str) -> ClientResult[SharingLinkData]
         """
         This method determines basic information about the supplied link URL, including limited data about the object
         the link URL refers to and any additional sharing link data if the link URL is a tokenized sharing link
 
         :param str link_url: A URL that is either a tokenized sharing link or a canonical URL for a document
         """
-        return_type = ClientResult(
-            self.context, SharingLinkData()
-        )  # type: ClientResult[SharingLinkData]
+        return_type = ClientResult(self.context, SharingLinkData())
         payload = {"linkUrl": link_url}
         qry = ServiceOperationQuery(
             self, "GetSharingLinkData", None, payload, None, return_type
@@ -669,6 +673,7 @@ class Web(SecurableObject):
 
     @staticmethod
     def get_context_web_theme_data(context):
+        # type: (ClientContext) -> ClientResult[str]
         """
         Get ThemeData for the context web.
 
@@ -1068,9 +1073,7 @@ class Web(SecurableObject):
         return return_type
 
     def increment_site_client_tag(self):
-        """
-        Increments the client cache control number for this site collection.
-        """
+        """Increments the client cache control number for this site collection."""
         qry = ServiceOperationQuery(self, "IncrementSiteClientTag")
         self.context.add_query(qry)
         return self
@@ -1080,7 +1083,6 @@ class Web(SecurableObject):
         Applies the specified site definition or site template to the website that has no template applied to it.
 
         :param str web_template: The name of the site definition or the file name of the site template to be applied.
-        :return:
         """
         qry = ServiceOperationQuery(
             self, "ApplyWebTemplate", {"webTemplate": web_template}
@@ -1089,9 +1091,7 @@ class Web(SecurableObject):
         return self
 
     def get_custom_list_templates(self):
-        """
-        Specifies the collection of custom list templates for a given site.
-        """
+        """Specifies the collection of custom list templates for a given site."""
         return_type = ListTemplateCollection(self.context)
         qry = ServiceOperationQuery(
             self, "GetCustomListTemplates", None, None, None, return_type
@@ -1283,12 +1283,19 @@ class Web(SecurableObject):
         :param str email_subject: The email subject.
         :param str email_body: The email subject.
         """
+
         return_type = SharingResult(self.context)
 
-        def _share(picker_result, group):
-            # type: (ClientResult[str], Group) -> None
+        def _share(picker_result):
+            # type: (ClientResult[str]) -> None
+            groups = {
+                ExternalSharingSiteOption.View: self.associated_visitor_group,
+                ExternalSharingSiteOption.Edit: self.associated_member_group,
+                ExternalSharingSiteOption.Owner: self.associated_owner_group,
+            }  # type: dict[ExternalSharingSiteOption, Group]
+
             picker_input = "[{0}]".format(picker_result.value)
-            role_value = "group:{groupId}".format(groupId=group.id)
+            role_value = "group:{groupId}".format(groupId=groups[share_option].id)
             Web.share_object(
                 self.context,
                 self.url,
@@ -1304,15 +1311,9 @@ class Web(SecurableObject):
             )
 
         def _web_resolved():
-            groups = {
-                ExternalSharingSiteOption.View: self.associated_visitor_group,
-                ExternalSharingSiteOption.Edit: self.associated_member_group,
-                ExternalSharingSiteOption.Owner: self.associated_owner_group,
-            }  # type: dict[ExternalSharingSiteOption, Group]
-
             ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(
                 self.context, user_principal_name
-            ).after_execute(_share, groups[share_option])
+            ).after_execute(_share)
 
         self.ensure_properties(
             [
@@ -1974,9 +1975,7 @@ class Web(SecurableObject):
     @property
     def site_users(self):
         # type: () -> UserCollection
-        """
-        Specifies the collection of users in the site collection that contains the site
-        """
+        """Specifies the collection of users in the site collection that contains the site"""
         return self.properties.get(
             "SiteUsers",
             UserCollection(self.context, ResourcePath("siteUsers", self.resource_path)),

office365/teams/apps/catalog.py

@@ -9,6 +9,7 @@ class AppCatalogs(Entity):
 
     @property
     def teams_apps(self):
+        # type: () -> EntityCollection[TeamsApp]
         """List apps from the Microsoft Teams app catalog."""
         return self.properties.get(
             "teamsApps",

office365/teams/chats/chat.py

@@ -41,6 +41,7 @@ class Chat(Entity):
 
     @property
     def members(self):
+        # type: () -> ConversationMemberCollection
         """A collection of membership records associated with the chat."""
         return self.properties.setdefault(
             "members",
@@ -51,6 +52,7 @@ class Chat(Entity):
 
     @property
     def messages(self):
+        # type: () -> EntityCollection[ChatMessage]
         """A collection of all the messages in the chat. Nullable."""
         return self.properties.get(
             "messages",
@@ -61,6 +63,7 @@ class Chat(Entity):
 
     @property
     def operations(self):
+        # type: () -> EntityCollection[TeamsAsyncOperation]
         """
         A collection of all the Teams async operations that ran or are running on the chat. Nullable.
         """
@@ -75,6 +78,7 @@ class Chat(Entity):
 
     @property
     def tabs(self):
+        # type: () -> EntityCollection[TeamsTab]
         """A collection of all the tabs in the chat."""
         return self.properties.get(
             "tabs",