Office365-REST-Python-Client 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

office365/subscriptions/subscription.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.entity import Entity
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -15,14 +16,15 @@ class Subscription(Entity):
 
     @property
     def application_id(self):
+        # type: () -> Optional[str]
         """
         Identifier of the application used to create the subscription.
-        :rtype: str or None
         """
         return self.properties.get("applicationId", None)
 
     @property
     def change_type(self):
+        # type: () -> Optional[str]
         """
         Required. Indicates the type of change in the subscribed resource that will raise a change notification.
         The supported values are: created, updated, deleted.
@@ -33,51 +35,51 @@ class Subscription(Entity):
         User and group change notifications support updated and deleted changeType. Use updated to receive
         notifications when user or group is created, updated or soft deleted. Use deleted to receive notifications
         when user or group is permanently deleted.
-        :rtype: str or None
         """
         return self.properties.get("changeType", None)
 
     @property
     def client_state(self):
+        # type: () -> Optional[str]
         """
         Required. Specifies the value of the clientState property sent by the service in each change notification.
         The maximum length is 128 characters. The client can check that the change notification came from the service
         by comparing the value of the clientState property sent with the subscription with the value of the clientState
         property received with each change notification.
-        :rtype: str or None
         """
         return self.properties.get("clientState", None)
 
     @property
     def creator_id(self):
+        # type: () -> Optional[str]
         """
         Optional. Identifier of the user or service principal that created the subscription. If the app used
         delegated permissions to create the subscription, this field contains the id of the signed-in user the app
         called on behalf of. If the app used application permissions, this field contains the id of the service
         principal corresponding to the app. Read-only.
-        :rtype: str or None
         """
         return self.properties.get("creatorId", None)
 
     @property
     def encryption_certificate(self):
+        # type: () -> Optional[str]
         """
         Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in
         change notifications. Optional but required when includeResourceData is true.
-        :rtype: str or None
         """
         return self.properties.get("encryptionCertificate", None)
 
     @property
     def encryption_certificate_id(self):
+        # type: () -> Optional[str]
         """
         Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data.
-        :rtype: str or None
         """
         return self.properties.get("encryptionCertificateId", None)
 
     @property
     def expiration_datetime(self):
+        # type: () -> Optional[datetime.datetime]
         """
         Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be
         an amount of time from subscription creation that varies for the resource subscribed to
@@ -86,14 +88,15 @@ class Subscription(Entity):
 
     @property
     def include_resource_data(self):
+        # type: () -> Optional[bool]
         """
         Optional. When set to true, change notifications include resource data (such as content of a chat message).
-        :rtype: bool
         """
         return self.properties.get("includeResourceData", None)
 
     @property
     def latest_supported_tls_version(self):
+        # type: () -> Optional[str]
         """
         Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint,
         specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3.
@@ -105,38 +108,37 @@ class Subscription(Entity):
 
         For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional.
         In such cases, Microsoft Graph defaults the property to v1_2.
-        :rtype: str
         """
         return self.properties.get("latestSupportedTlsVersion", None)
 
     @property
     def lifecycle_notification_url(self):
+        # type: () -> Optional[str]
         """
         Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise.
         The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved,
         reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol.
         For more information, see Reduce missing subscriptions and change notifications.
-        :rtype: str or None
         """
         return self.properties.get("lifecycleNotificationUrl", None)
 
     @property
     def notification_url(self):
+        # type: () -> Optional[str]
         """
         Required. The URL of the endpoint that will receive the change notifications. This URL must make use of
         the HTTPS protocol. Any query string parameter included in the notificationUrl property will be included
         in the HTTP POST request when Microsoft Graph sends the change notifications.
-        :rtype: str or None
         """
         return self.properties.get("notificationUrl", None)
 
     @property
     def resource(self):
+        # type: () -> Optional[str]
         """
         Specifies the resource that will be monitored for changes.
         Do not include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for
         each supported resource.
-        :rtype: str or None
         """
         return self.properties.get("resource", None)
 

office365/teams/apps/app.py

@@ -9,6 +9,7 @@ class TeamsApp(Entity):
 
     @property
     def app_definitions(self):
+        # type: () -> EntityCollection[TeamsAppDefinition]
         """The details for each version of the app."""
         return self.properties.get(
             "appDefinitions",

office365/teams/channels/channel.py

@@ -90,9 +90,7 @@ class Channel(Entity):
     @property
     def messages(self):
         # type: () -> EntityCollection[ChatMessage]
-        """
-        A collection of all the messages in the channel. A navigation property. Nullable.
-        """
+        """A collection of all the messages in the channel."""
         return self.properties.get(
             "messages",
             EntityCollection(

office365/teams/collection.py

@@ -1,10 +1,10 @@
 from typing import Callable
 
+import requests
 from typing_extensions import Self
 
-from office365.directory.groups.group import Group
 from office365.entity_collection import EntityCollection
-from office365.runtime.odata.path_builder import ODataPathBuilder
+from office365.runtime.paths.builder import ODataPathBuilder
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.teams.operations.async_operation import TeamsAsyncOperation
@@ -44,26 +44,22 @@ class TeamCollection(EntityCollection[Team]):
         return_type = Team(self.context)
         self.add_child(return_type)
 
-        payload = {
-            "displayName": display_name,
-            "description": description,
-            "template@odata.bind": "https://graph.microsoft.com/v1.0/teamsTemplates('standard')",
-        }
-        qry = CreateEntityQuery(self, payload, return_type)
-        self.context.add_query(qry)
-
         def _process_response(resp):
-            """
-            :type resp: requests.Response
-            """
+            # type: (requests.Response) -> None
             content_loc = resp.headers.get("Content-Location", None)
-            team_path = ODataPathBuilder.parse(content_loc)
+            team_path = ODataPathBuilder.parse_url(content_loc)
             return_type.set_property("id", team_path.segment, False)
 
             loc = resp.headers.get("Location", None)
-            operation_path = ODataPathBuilder.parse(loc)
+            operation_path = ODataPathBuilder.parse_url(loc)
             operation = TeamsAsyncOperation(self.context, operation_path)
             return_type.operations.add_child(operation)
 
-        self.context.after_execute(_process_response)
+        payload = {
+            "displayName": display_name,
+            "description": description,
+            "template@odata.bind": "https://graph.microsoft.com/v1.0/teamsTemplates('standard')",
+        }
+        qry = CreateEntityQuery(self, payload, return_type)
+        self.context.add_query(qry).after_execute(_process_response)
         return return_type

office365/teams/info.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.runtime.paths.resource_path import ResourcePath
 
@@ -5,12 +7,13 @@ from office365.runtime.paths.resource_path import ResourcePath
 class TeamInfo(Entity):
     """Represents a team with basic information."""
 
+    def __str__(self):
+        return self.display_name
+
     @property
     def display_name(self):
-        """
-        The name of the team.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The name of the team."""
         return self.properties.get("displayName", None)
 
     @property

office365/teams/members/conversation_collection.py

@@ -2,7 +2,7 @@ from office365.entity_collection import EntityCollection
 from office365.teams.members.conversation import ConversationMember
 
 
-class ConversationMemberCollection(EntityCollection):
+class ConversationMemberCollection(EntityCollection[ConversationMember]):
     def __init__(self, context, resource_path=None):
         super(ConversationMemberCollection, self).__init__(
             context, ConversationMember, resource_path
@@ -18,8 +18,6 @@ class ConversationMemberCollection(EntityCollection):
             Each member must be assigned a role of owner or guest. Guest tenant members must be assigned the guest role
         :param list[str] roles: The roles for that user.
         :param datetime.datetime visible_history_start_datetime:
-
-        :rtype: ConversationMember
         """
         return_type = super(ConversationMemberCollection, self).add(roles=roles)
         from office365.directory.users.user import User

office365/teams/operations/async_operation.py

@@ -68,16 +68,14 @@ class TeamsAsyncOperation(Entity):
 
     @property
     def target_resource_location(self):
+        # type: () -> Optional[str]
         """The location of the object that's created or modified as result of this async operation.
         This URL should be treated as an opaque value and not parsed into its component paths.
-        :rtype: str or None
         """
         return self.properties.get("targetResourceLocation", None)
 
     @property
     def status(self):
-        """
-        Operation status.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Operation status."""
         return self.properties.get("status", None)

office365/teams/schedule/groups/group.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.runtime.types.collections import StringCollection
 from office365.teams.schedule.change_tracked_entity import ChangeTrackedEntity
 
@@ -7,6 +9,7 @@ class SchedulingGroup(ChangeTrackedEntity):
 
     @property
     def is_active(self):
+        # type: () -> Optional[bool]
         """Indicates whether the schedulingGroup can be used when creating new entities or updating existing ones"""
         return self.properties.get("isActive", None)
 

office365/teams/team.py

@@ -25,11 +25,12 @@ class Team(Entity):
     """A team in Microsoft Teams is a collection of channel objects. A channel represents a topic, and therefore a
     logical isolation of discussion, within a team."""
 
+    def __str__(self):
+        return self.display_name
+
     def execute_query_and_wait(self):
         """
         Submit request(s) to the server and waits until operation is completed
-
-        :type self: T
         """
 
         def _loaded():
@@ -79,18 +80,15 @@ class Team(Entity):
 
     @property
     def description(self):
-        """An optional description for the team.
-
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """An optional description for the team."""
         return self.properties.get("description", None)
 
     @property
     def classification(self):
+        # type: () -> Optional[str]
         """An optional label. Typically describes the data or business sensitivity of the team.
         Must match one of a pre-configured set in the tenant's directory.
-
-        :rtype: str or None
         """
         return self.properties.get("classification", None)
 
@@ -107,6 +105,7 @@ class Team(Entity):
 
     @property
     def web_url(self):
+        # type: () -> Optional[str]
         """A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when
         you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated
         as an opaque blob, and not parsed."""
@@ -119,6 +118,7 @@ class Team(Entity):
 
     @property
     def all_channels(self):
+        # type: () -> ChannelCollection
         """
         List of channels either hosted in or shared with the team (incoming channels).
         """
@@ -131,9 +131,8 @@ class Team(Entity):
 
     @property
     def incoming_channels(self):
-        """
-        List of channels shared with the team.
-        """
+        # type: () -> ChannelCollection
+        """List of channels shared with the team."""
         return self.properties.get(
             "incomingChannels",
             ChannelCollection(
@@ -164,9 +163,7 @@ class Team(Entity):
     @property
     def primary_channel(self):
         # type: () -> Channel
-        """
-        The general channel for the team.
-        """
+        """The general channel for the team."""
         return self.properties.get(
             "primaryChannel",
             Channel(self.context, ResourcePath("primaryChannel", self.resource_path)),
@@ -195,6 +192,7 @@ class Team(Entity):
 
     @property
     def operations(self):
+        # type: () -> EntityCollection[TeamsAsyncOperation]
         """The async operations that ran or are running on this team."""
         return self.properties.setdefault(
             "operations",
@@ -207,6 +205,7 @@ class Team(Entity):
 
     @property
     def permission_grants(self):
+        # type: () -> EntityCollection[ResourceSpecificPermissionGrant]
         """
         List all resource-specific permission grants
         """
@@ -226,10 +225,8 @@ class Team(Entity):
 
     @property
     def tenant_id(self):
-        """
-        The ID of the Azure Active Directory tenant.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The ID of the Azure Active Directory tenant."""
         return self.properties.get("tenantId", None)
 
     @property
@@ -293,8 +290,9 @@ class Team(Entity):
         :param str preview_text: Preview text for the notification. Microsoft Teams will only show first 150 characters
         :param dict template_parameters: Values for template variables defined in the activity feed entry corresponding
             to activityType in Teams app manifest.
-        :param teamworkNotificationRecipient template_parameters: Recipient of the notification.
+        :param dict template_parameters: Recipient of the notification.
              Only Azure AD users are supported.
+        :param teamworkNotificationRecipient recipient: Recipient of the notification
         """
         payload = {
             "topic": topic,
@@ -323,6 +321,6 @@ class Team(Entity):
     def set_property(self, name, value, persist_changes=True):
         super(Team, self).set_property(name, value, persist_changes)
         # fallback: determine whether resource path is resolved
-        if name == "id" and self._resource_path.key == "team":
+        if name == "id" and self._resource_path.segment == "team":
             self._resource_path = ResourcePath(value, ResourcePath("teams"))
         return self

office365/todo/attachments/base.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.entity import Entity
 
@@ -9,14 +10,13 @@ class AttachmentBase(Entity):
 
     @property
     def content_type(self):
-        """
-        The MIME type.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """The MIME type."""
         return self.properties.get("contentType", None)
 
     @property
     def last_modified_datetime(self):
+        # type: () -> Optional[datetime.datetime]
         """
         The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
         """
@@ -24,16 +24,14 @@ class AttachmentBase(Entity):
 
     @property
     def name(self):
+        # type: () -> Optional[str]
         """
         The display name of the attachment. This does not need to be the actual file name.
-        :rtype: str or None
         """
         return self.properties.get("name", None)
 
     @property
     def size(self):
-        """
-        The length of the attachment in bytes.
-        :rtype: int or None
-        """
+        # type: () -> Optional[int]
+        """The length of the attachment in bytes."""
         return self.properties.get("size", None)

office365/todo/linked_resource.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -9,14 +11,12 @@ class LinkedResource(Entity):
 
     @property
     def application_name(self):
-        """Field indicating the app name of the source that is sending the linkedResource.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """Field indicating the app name of the source that is sending the linkedResource."""
         return self.properties.get("applicationName", None)
 
     @property
     def display_name(self):
-        """The title of the linkedResource..
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The title of the linkedResource."""
         return self.properties.get("displayName", None)

office365/todo/tasks/list.py

@@ -10,6 +10,7 @@ class TodoTaskList(Entity):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """The collection of open extensions defined for the task list."""
         return self.properties.get(
             "extensions",

office365/todo/tasks/task.py

@@ -11,6 +11,7 @@ class TodoTask(Entity):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """The collection of open extensions defined for the task."""
         return self.properties.get(
             "extensions",
@@ -21,6 +22,7 @@ class TodoTask(Entity):
 
     @property
     def checklist_items(self):
+        # type: () -> EntityCollection[ChecklistItem]
         """A collection of checklistItems linked to a task."""
         return self.properties.get(
             "checklistItems",
@@ -33,6 +35,7 @@ class TodoTask(Entity):
 
     @property
     def linked_resources(self):
+        # type: () -> EntityCollection[LinkedResource]
         """A collection of resources linked to the task."""
         return self.properties.get(
             "linkedResources",

office365/onedrive/internal/queries/resumable_file_upload.py

@@ -1,36 +0,0 @@
-import os
-
-from office365.onedrive.driveitems.uploadable_properties import (
-    DriveItemUploadableProperties,
-)
-from office365.runtime.odata.v4.upload_session_request import UploadSessionRequest
-from office365.runtime.queries.upload_session import UploadSessionQuery
-
-
-def create_resumable_file_upload_query(
-    return_type, local_path, chunk_size, chunk_uploaded
-):
-    """
-    :type return_type: office365.onedrive.driveitems.driveItem.DriveItem
-    :type local_path: str
-    :type chunk_size: int
-    :type chunk_uploaded: (int)->None
-    """
-    item = DriveItemUploadableProperties()
-    item.name = os.path.basename(local_path)
-    qry = UploadSessionQuery(return_type, {"item": item})
-    context = return_type.context
-
-    def _start_upload(resp):
-        """
-        :type resp: requests.Response
-        """
-        resp.raise_for_status()
-        with open(local_path, "rb") as local_file:
-            session_request = UploadSessionRequest(
-                local_file, chunk_size, chunk_uploaded
-            )
-            session_request.execute_query(qry)
-
-    context.after_execute(_start_upload)
-    return qry

office365/outlook/internal/queries/attachment_upload.py

@@ -1,53 +0,0 @@
-from office365.outlook.mail.attachments.attachment_item import AttachmentItem
-from office365.runtime.compat import parse_query_string
-from office365.runtime.odata.v4.upload_session_request import UploadSessionRequest
-from office365.runtime.queries.upload_session import UploadSessionQuery
-
-
-def create_attachment_upload_query(
-    binding_type, return_type, source_path, chunk_size=1000000, chunk_uploaded=None
-):
-    """
-    :type binding_type: office365.outlook.mail.attachments.collection.AttachmentCollection
-    :type return_type: FileAttachment
-    :type source_path: str
-    :type chunk_size: int
-    :type chunk_uploaded: (int)->None
-    """
-    qry = UploadSessionQuery(
-        binding_type, {"AttachmentItem": AttachmentItem.create_file(source_path)}
-    )
-    context = binding_type.context
-
-    def _start_upload(resp):
-        """
-        :type resp: requests.Response
-        """
-        resp.raise_for_status()
-        with open(source_path, "rb") as local_file:
-            session_request = UploadSessionRequest(
-                local_file, chunk_size, chunk_uploaded
-            )
-
-            def _construct_request(request):
-                auth_token = parse_query_string(request.url, "authtoken")
-                request.set_header("Authorization", "Bearer {0}".format(auth_token))
-
-            session_request.beforeExecute += _construct_request
-
-            def _process_response(response):
-                """
-                :type response: requests.Response
-                """
-                location = response.headers.get("Location", None)
-                if location is None:
-                    return
-                attachment_id = location[location.find("Attachments(") + 13 : -2]
-                return_type.set_property("id", attachment_id)
-
-            session_request.afterExecute += _process_response
-
-            session_request.execute_query(qry)
-
-    context.after_execute(_start_upload)
-    return qry

office365/runtime/odata/path_builder.py

@@ -1,23 +0,0 @@
-import json
-import re
-
-from office365.runtime.client_value import ClientValue
-from office365.runtime.compat import is_string_type
-from office365.runtime.paths.resource_path import ResourcePath
-
-
-class ODataPathBuilder(object):
-    @staticmethod
-    def parse(path_str):
-        """
-        Parses path from a string
-
-        :param str path_str:
-        """
-        segments = [n for n in re.split(r"[('')]|/", path_str) if n]
-        if not segments:
-            raise TypeError("Invalid path")
-        path = None
-        for segment in segments:
-            path = ResourcePath(segment, path)
-        return path

office365/sharepoint/internal/key_value.py

@@ -1,28 +0,0 @@
-from office365.runtime.client_value import ClientValue
-from office365.runtime.client_value_collection import ClientValueCollection
-
-
-class KeyValue(ClientValue):
-    """Represents a key value pair."""
-
-    def __init__(self, key=None, value=None, value_type=None):
-        """
-        :param str key: The value of the key in the key value pair.
-        :param str value: The string representation of the value in the key value pair.
-        :param str value_type: The EDM type name of the value in the key value pair.
-        """
-        self.Key = key
-        self.Value = value
-        self.ValueType = value_type
-
-    @property
-    def entity_type_name(self):
-        return "SP.KeyValue"
-
-
-class KeyValueCollection(ClientValueCollection):
-    def __init__(self, initial_values=None):
-        """
-        :type initial_values: list[KeyValue] or None
-        """
-        super(KeyValueCollection, self).__init__(KeyValue, initial_values)