Office365-REST-Python-Client 2.6.1__py3-none-any.whl → 2.6.2__py3-none-any.whl

office365/sharepoint/webs/regional_settings.py

@@ -96,6 +96,33 @@ class RegionalSettings(Entity):
         Specifies which week of a year is considered the first week."""
         return self.properties.get("FirstWeekOfYear", None)
 
+    @property
+    def is_east_asia(self):
+        # type: () -> Optional[bool]
+        """Returns "true" if the web locale is an East Asia locale; "false" otherwise."""
+        return self.properties.get("IsEastAsia", None)
+
+    @property
+    def is_right_to_left(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the site uses a right-to-left language. If it uses a right-to-left language,
+        this value MUST be "true". Otherwise, this value MUST be "false"."""
+        return self.properties.get("IsRightToLeft", None)
+
+    @property
+    def is_ui_right_to_left(self):
+        # type: () -> Optional[bool]
+        """Specifies whether the UI of the site (2) uses a right-to-left language. If it uses a right-to-left language,
+        this value MUST be "true". Otherwise, this value MUST be "false"."""
+        return self.properties.get("IsUIRightToLeft", None)
+
+    @property
+    def list_separator(self):
+        # type: () -> Optional[str]
+        """Specifies the separator that is used for lists on the server. For example, if the separator is ",",
+        items in a list will appear as "1,2,3,4"."""
+        return self.properties.get("ListSeparator", None)
+
     @property
     def locale_id(self):
         # type: () -> Optional[int]

office365/sharepoint/webs/web.py

@@ -190,6 +190,20 @@ class Web(SecurableObject):
         self.ensure_properties(["AccessRequestListUrl"], _get_access_request_list)
         return return_type
 
+    def get_adaptive_card_extensions(self, include_errors=None, project=None):
+        payload = {
+            "includeErrors": include_errors,
+            "project": project,
+        }
+        return_type = ClientResult(
+            self.context, ClientValueCollection(SPClientSideComponentQueryResult)
+        )
+        qry = ServiceOperationQuery(
+            self, "GetAdaptiveCardExtensions", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def get_document_by_doc_id(self, doc_id):
         """ """
         return_type = ClientResult(self.context)
@@ -252,7 +266,7 @@ class Web(SecurableObject):
         """
         if view_xml is None:
             view_xml = "<View><Query></Query></View>"
-        return_type = ClientResult(self.context, dict())
+        return_type = ClientResult(self.context, {})
 
         def _get_list_data_as_stream():
             list_abs_url = self.url + path
@@ -947,6 +961,7 @@ class Web(SecurableObject):
         return return_type
 
     def get_file_by_server_relative_url(self, server_relative_url):
+        # type: (str) -> File
         """
         Returns the file object located at the specified server-relative URL, for example:
             - "/sites/MySite/Shared Documents/MyDocument.docx"
@@ -964,6 +979,7 @@ class Web(SecurableObject):
         )
 
     def get_file_by_server_relative_path(self, path):
+        # type: (str) -> File
         """Returns the file object located at the specified server-relative path, for example:
             - "/sites/MySite/Shared Documents/MyDocument.docx"
             - "Shared Documents/MyDocument.docx"
@@ -981,6 +997,7 @@ class Web(SecurableObject):
         )
 
     def get_folder_by_server_relative_url(self, url):
+        # type: (str) -> Folder
         """Returns the folder object located at the specified server-relative URL.
 
         :param str url: Specifies the server-relative URL for the folder.
@@ -994,6 +1011,7 @@ class Web(SecurableObject):
         )
 
     def get_folder_by_server_relative_path(self, decoded_url):
+        # type: (str) -> Folder
         """Returns the folder object located at the specified server-relative URL, for example:
              - "/sites/MySite/Shared Documents"
              - "Shared Documents"
@@ -2673,6 +2691,7 @@ class Web(SecurableObject):
                 "SiteGroups": self.site_groups,
                 "SiteUsers": self.site_users,
                 "SiteUserInfoList": self.site_user_info_list,
+                "SupportedUILanguageIds": self.supported_ui_language_ids,
                 "TenantAppCatalog": self.tenant_app_catalog,
                 "TitleResource": self.title_resource,
                 "UserCustomActions": self.user_custom_actions,

office365/teams/apps/app.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -7,6 +9,21 @@ from office365.teams.apps.definition import TeamsAppDefinition
 class TeamsApp(Entity):
     """Represents an app in the Microsoft Teams app catalog."""
 
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
+    @property
+    def display_name(self):
+        # type: () -> Optional[str]
+        """The title of the TeamsApp."""
+        return self.properties.get("displayName", None)
+
+    @property
+    def distribution_method(self):
+        # type: () -> Optional[str]
+        """The title of the TeamsApp."""
+        return self.properties.get("distributionMethod", None)
+
     @property
     def app_definitions(self):
         # type: () -> EntityCollection[TeamsAppDefinition]

office365/teams/apps/authorization.py

@@ -0,0 +1,16 @@
+from office365.runtime.client_value import ClientValue
+from office365.teams.apps.permission_set import TeamsAppPermissionSet
+
+
+class TeamsAppAuthorization(ClientValue):
+    """The authorization details of a teamsApp."""
+
+    def __init__(
+        self, client_app_id=None, required_permission_set=TeamsAppPermissionSet()
+    ):
+        """
+        :param str client_app_id: 	The registration ID of the Microsoft Entra app ID associated with the teamsApp.
+        :param TeamsAppPermissionSet required_permission_set: Set of permissions required by the teamsApp.
+        """
+        self.clientAppId = client_app_id
+        self.requiredPermissionSet = required_permission_set

office365/teams/apps/permission_set.py

@@ -0,0 +1,14 @@
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.teams.apps.resource_specific_permission import (
+    TeamsAppResourceSpecificPermission,
+)
+
+
+class TeamsAppPermissionSet(ClientValue):
+    """Set of required/granted permissions that can be associated with a Teams app."""
+
+    def __init__(self, resource_specific_permissions=None):
+        self.resourceSpecificPermissions = ClientValueCollection(
+            TeamsAppResourceSpecificPermission, resource_specific_permissions
+        )

office365/teams/apps/resource_specific_permission.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TeamsAppResourceSpecificPermission(ClientValue):
+    """Represents the resource-specific permission associated with a teamsApp."""

office365/teams/chats/chat.py

@@ -1,24 +1,81 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.teams.apps.installation import TeamsAppInstallation
 from office365.teams.chats.messages.info import ChatMessageInfo
 from office365.teams.chats.messages.message import ChatMessage
+from office365.teams.chats.viewpoint import ChatViewpoint
 from office365.teams.members.conversation_collection import ConversationMemberCollection
 from office365.teams.operations.async_operation import TeamsAsyncOperation
 from office365.teams.tabs.tab import TeamsTab
+from office365.teams.teamwork.online_meeting_info import TeamworkOnlineMeetingInfo
 
 
 class Chat(Entity):
     """A chat is a collection of chatMessages between one or more participants. Participants can be users or apps."""
 
+    @property
+    def chat_type(self):
+        # type: () -> Optional[str]
+        """Specifies the type of chat. Possible values are: group, oneOnOne, meeting, unknownFutureValue."""
+        return self.properties.get("chatType", None)
+
+    @property
+    def created_datetime(self):
+        """Date and time at which the chat was created."""
+        return self.properties.get("createdDateTime", datetime.min)
+
+    @property
+    def is_hidden_for_all_members(self):
+        # type: () -> Optional[bool]
+        """Indicates whether the chat is hidden for all its members."""
+        return self.properties.get("isHiddenForAllMembers", None)
+
+    @property
+    def last_updated_datetime(self):
+        # type: () -> Optional[datetime]
+        """Date and time at which the chat was renamed or the list of members was last changed."""
+        return self.properties.get("lastUpdatedDateTime", datetime.min)
+
+    @property
+    def online_meeting_info(self):
+        # type: () -> TeamworkOnlineMeetingInfo
+        """Represents details about an online meeting. If the chat isn't associated with an online meeting,
+        the property is empty. Read-only."""
+        return self.properties.get("onlineMeetingInfo", TeamworkOnlineMeetingInfo())
+
+    @property
+    def tenant_id(self):
+        # type: () -> Optional[str]
+        """The identifier of the tenant in which the chat was created. Read-only."""
+        return self.properties.get("tenantId", None)
+
     @property
     def topic(self):
+        # type: () -> Optional[str]
         """(Optional) Subject or topic for the chat. Only available for group chats."""
         return self.properties.get("topic", None)
 
+    @property
+    def viewpoint(self):
+        # type: () -> ChatViewpoint
+        """Represents caller-specific information about the chat, such as the last message read date and time.
+        This property is populated only when the request is made in a delegated context.
+        """
+        return self.properties.get("viewpoint", ChatViewpoint())
+
+    @property
+    def web_url(self):
+        # type: () -> Optional[str]
+        """The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed."""
+        return self.properties.get("webUrl", None)
+
     @property
     def installed_apps(self):
+        # type: () -> EntityCollection[TeamsAppInstallation]
         """A collection of all the apps in the chat. Nullable."""
         return self.properties.get(
             "installedApps",
@@ -90,8 +147,11 @@ class Chat(Entity):
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "createdDateTime": self.created_datetime,
                 "installedApps": self.installed_apps,
                 "lastMessagePreview": self.last_message_preview,
+                "lastUpdatedDateTime": self.last_updated_datetime,
+                "onlineMeetingInfo": self.online_meeting_info,
             }
             default_value = property_mapping.get(name, None)
         return super(Chat, self).get_property(name, default_value)

office365/teams/chats/messages/message.py

@@ -49,6 +49,23 @@ class ChatMessage(Entity):
             ),
         )
 
+    @property
+    def subject(self):
+        # type: () -> Optional[str]
+        """
+        The subject of the chat message, in plaintext.
+        """
+        return self.properties.get("subject", None)
+
+    @property
+    def summary(self):
+        # type: () -> Optional[str]
+        """
+        Summary text of the chat message that could be used for push notifications and summary views or
+        fall back views. Only applies to channel chat messages, not chat messages in a chat.
+        """
+        return self.properties.get("summary", None)
+
     @property
     def web_url(self):
         # type: () -> Optional[str]

office365/teams/chats/type.py

@@ -0,0 +1,13 @@
+class ChatType:
+
+    oneOnOne = "oneOnOne"
+    """Indicates that the chat is a 1:1 chat. The roster size is fixed for this type of chat; members can't be
+    removed/added."""
+
+    group = "group"
+    """Indicates that the chat is a group chat. The roster size (of at least two people) can be updated for this
+    type of chat. Members can be removed/added later."""
+
+    meeting = "meeting"
+    """Indicates that the chat is associated with an online meeting. This type of chat is only created as
+    part of the creation of an online meeting."""

office365/teams/chats/viewpoint.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ChatViewpoint(ClientValue):
+    """"""

office365/teams/fun_settings.py

@@ -4,9 +4,21 @@ from office365.runtime.client_value import ClientValue
 class TeamFunSettings(ClientValue):
     """Settings to configure use of Giphy, memes, and stickers in the team."""
 
-    def __init__(self, allow_giphy=True):
+    def __init__(
+        self,
+        allow_custom_memes=None,
+        allow_giphy=None,
+        allow_stickers_and_memes=None,
+        giphy_content_rating=None,
+    ):
         """
-        :param bool allow_giphy:
+        :param bool allow_custom_memes: f set to true, enables users to include custom memes.
+        :param bool allow_giphy: If set to true, enables Giphy use.
+        :param bool allow_stickers_and_memes: 	If set to true, enables users to include stickers and memes.
+        :param str giphy_content_rating: Giphy content rating. Possible values are: moderate, strict.
         """
         super(TeamFunSettings, self).__init__()
+        self.allowCustomMemes = allow_custom_memes
         self.allowGiphy = allow_giphy
+        self.allowStickersAndMemes = allow_stickers_and_memes
+        self.giphyContentRating = giphy_content_rating

office365/teams/info.py

@@ -8,7 +8,7 @@ class TeamInfo(Entity):
     """Represents a team with basic information."""
 
     def __str__(self):
-        return self.display_name
+        return self.display_name or self.entity_type_name
 
     @property
     def display_name(self):

office365/teams/schedule/entity.py

@@ -3,3 +3,6 @@ from office365.runtime.client_value import ClientValue
 
 class ScheduleEntity(ClientValue):
     """"""
+
+    def __init__(self, end_datetime=None):
+        self.endDateTime = end_datetime

office365/teams/schedule/shifts/item.py

@@ -12,5 +12,6 @@ class ShiftItem(ScheduleEntity):
         :param list[ShiftActivity] activities: An incremental part of a shift which can cover details of when and
             where an employee is during their shift. For example, an assignment or a scheduled break or lunch.
         """
+        super(ShiftItem, self).__init__()
         self.displayName = display_name
         self.activities = ClientValueCollection(ShiftActivity, activities)

office365/teams/schedule/shifts/offer/request.py

@@ -1,7 +1,47 @@
+from datetime import datetime
+from typing import Optional
+
 from office365.teams.schedule.change_request import ScheduleChangeRequest
 
 
 class OfferShiftRequest(ScheduleChangeRequest):
     """Represents a request to offer a shift to another user in the team."""
 
-    pass
+    @property
+    def recipient_action_datetime(self):
+        """
+        The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
+        """
+        return self.properties.get("recipientActionDateTime", datetime.min)
+
+    @property
+    def recipient_action_message(self):
+        # type: () -> Optional[str]
+        """
+        Custom message sent by recipient of the offer shift request.
+        """
+        return self.properties.get("recipientActionMessage", None)
+
+    @property
+    def recipient_user_id(self):
+        # type: () -> Optional[str]
+        """
+        User ID of the recipient of the offer shift request.
+        """
+        return self.properties.get("recipientUserId", None)
+
+    @property
+    def sender_shift_id(self):
+        # type: () -> Optional[str]
+        """
+        User ID of the sender of the offer shift request.
+        """
+        return self.properties.get("senderShiftId", None)
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "recipientActionDateTime": self.recipient_action_datetime,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(OfferShiftRequest, self).get_property(name, default_value)

office365/teams/teamwork/activity_topic.py

@@ -3,3 +3,8 @@ from office365.runtime.client_value import ClientValue
 
 class TeamworkActivityTopic(ClientValue):
     """Represents the topic of an activity feed notification."""
+
+    def __init__(self, source=None, value=None, web_url=None):
+        self.source = source
+        self.value = value
+        self.webUrl = web_url

office365/teams/teamwork/online_meeting_info.py

@@ -0,0 +1,21 @@
+from office365.runtime.client_value import ClientValue
+from office365.teams.teamwork.user_identity import TeamworkUserIdentity
+
+
+class TeamworkOnlineMeetingInfo(ClientValue):
+    """Represents details about an online meeting in Microsoft Teams."""
+
+    def __init__(
+        self,
+        calendar_event_id=None,
+        join_web_url=None,
+        organizer=TeamworkUserIdentity(),
+    ):
+        """
+        :param calendar_event_id: The identifier of the calendar event associated with the meeting.
+        :param join_web_url: The URL that users click to join or uniquely identify the meeting.
+        :param organizer: The organizer associated with the meeting.
+        """
+        self.calendarEventId = calendar_event_id
+        self.joinWebUrl = join_web_url
+        self.organizer = organizer

office365/teams/teamwork/shiftmanagement/user_solution_root.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class UserSolutionRoot(Entity):
+    """Represents an identifier that relates a user to the working time schedule triggers."""

office365/teams/teamwork/user.py

@@ -1,15 +1,59 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.teams.apps.user_scope_installation import UserScopeTeamsAppInstallation
+from office365.teams.associated_info import AssociatedTeamInfo
 
 
 class UserTeamwork(Entity):
     """A container for the range of Microsoft Teams functionalities that are available per user in the tenant."""
 
+    @property
+    def locale(self):
+        # type: () -> Optional[str]
+        """Represents the location that a user selected in Microsoft Teams and doesn't follow the Office's locale
+        setting. A user's locale is represented by their preferred language and country or region.
+        For example, en-us. The language component follows two-letter codes as defined in ISO 639-1,
+        and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.
+        """
+        return self.properties.get("locale", None)
+
+    @property
+    def region(self):
+        # type: () -> Optional[str]
+        """Represents the region of the organization or the user. For users with multigeo licenses, the property
+        contains the user's region (if available). For users without multigeo licenses, the property contains
+        the organization's region.
+
+        The region value can be any region supported by the Teams payload.
+        The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada,
+        Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa,
+        Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High,
+        USGov Department of Defense, and China.
+        """
+        return self.properties.get("region", None)
+
+    @property
+    def associated_teams(self):
+        # type: () -> EntityCollection[AssociatedTeamInfo]
+        """
+        The apps installed in the personal scope of this user.
+        """
+        return self.properties.get(
+            "associatedTeams",
+            EntityCollection(
+                self.context,
+                AssociatedTeamInfo,
+                ResourcePath("associatedTeams", self.resource_path),
+            ),
+        )
+
     @property
     def installed_apps(self):
+        # type: () -> EntityCollection[UserScopeTeamsAppInstallation]
         """
         The apps installed in the personal scope of this user.
         """
@@ -51,6 +95,9 @@ class UserTeamwork(Entity):
 
     def get_property(self, name, default_value=None):
         if default_value is None:
-            property_mapping = {"installedApps": self.installed_apps}
+            property_mapping = {
+                "associatedTeams": self.associated_teams,
+                "installedApps": self.installed_apps,
+            }
             default_value = property_mapping.get(name, None)
         return super(UserTeamwork, self).get_property(name, default_value)

office365/teams/teamwork/user_identity.py

@@ -0,0 +1,5 @@
+from office365.directory.permissions.identity import Identity
+
+
+class TeamworkUserIdentity(Identity):
+    """Represents a user in Microsoft Teams."""

office365/teams/viva/community.py

@@ -0,0 +1,13 @@
+from office365.entity import Entity
+
+
+class Community(Entity):
+    """Represents a community in Viva Engage that is a central place for conversations, files, events, and
+     updates for people sharing a common interest or goal.
+
+    Every community is associated with a Microsoft 365 group, but the group doesn't have the same ID as the community.
+    For more information about managing communities in Viva Engage, see Use the Microsoft Graph API to work
+    with Viva Engage.
+
+    This resource is an open type that allows other properties to be passed in.
+    """

office365/teams/viva/employee_experience.py

@@ -1,12 +1,38 @@
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.teams.viva.community import Community
+from office365.teams.viva.learning.courses.activity import LearningCourseActivity
 from office365.teams.viva.learning.provider import LearningProvider
 
 
 class EmployeeExperience(Entity):
     """Represents a container that exposes navigation properties for employee experience resources."""
 
+    @property
+    def communities(self):
+        """A collection of communities in Viva Engage."""
+        return self.properties.get(
+            "communities",
+            EntityCollection(
+                self.context,
+                Community,
+                ResourcePath("communities", self.resource_path),
+            ),
+        )
+
+    @property
+    def learning_course_activities(self):
+        """A collection of learning course activities."""
+        return self.properties.get(
+            "learningCourseActivities",
+            EntityCollection(
+                self.context,
+                LearningCourseActivity,
+                ResourcePath("learningCourseActivities", self.resource_path),
+            ),
+        )
+
     @property
     def learning_providers(self):
         """A collection of learning providers."""
@@ -22,6 +48,7 @@ class EmployeeExperience(Entity):
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "learningCourseActivities": self.learning_course_activities,
                 "learningProviders": self.learning_providers,
             }
             default_value = property_mapping.get(name, None)

office365/teams/viva/employee_experience_user.py

@@ -1,5 +1,21 @@
 from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.teams.viva.learning.courses.activity import LearningCourseActivity
 
 
 class EmployeeExperienceUser(Entity):
     """"""
+
+    @property
+    def learning_course_activities(self):
+        # type: () -> EntityCollection[LearningCourseActivity]
+        """Get a list of the learningCourseActivity objects (assigned or self-initiated) for a user."""
+        return self.properties.get(
+            "learningCourseActivities",
+            EntityCollection(
+                self.context,
+                LearningCourseActivity,
+                ResourcePath("learningCourseActivities", self.resource_path),
+            ),
+        )

office365/teams/viva/learning/courses/self_initiated.py

@@ -0,0 +1,5 @@
+from office365.teams.viva.learning.courses.activity import LearningCourseActivity
+
+
+class LearningSelfInitiatedCourse(LearningCourseActivity):
+    """Represents the details of a learning course activity that is self-initiated by a user."""

office365/todo/attachments/task_file.py

@@ -1,3 +1,5 @@
+from typing import AnyStr, Optional
+
 from office365.todo.attachments.base import AttachmentBase
 
 
@@ -10,5 +12,6 @@ class TaskFileAttachment(AttachmentBase):
 
     @property
     def content_bytes(self):
+        # type: () -> Optional[AnyStr]
         """The base64-encoded contents of the file."""
         return self.properties.get("contentBytes", None)

office365/todo/checklist_item.py

@@ -1,6 +1,17 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
 class ChecklistItem(Entity):
     """Represents a subtask in a bigger todoTask. ChecklistItem allows breaking down a complex task into more
     actionable, smaller tasks."""
+
+    def __str__(self):
+        return self.display_name or self.entity_type_name
+
+    @property
+    def display_name(self):
+        # type: () -> Optional[str]
+        """Indicates the title of the checklistItem."""
+        return self.properties.get("displayName", None)