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

office365/sharepoint/sites/language_collection.py

@@ -4,6 +4,7 @@ from office365.sharepoint.sites.language import Language
 
 
 class LanguageCollection(BaseEntity):
+    """Represents a collection of SPLanguage objects"""
 
     def __init__(self, context, resource_path=None):
         """Represents a collection of SPLanguage objects."""

office365/sharepoint/sites/site.py

@@ -413,6 +413,15 @@ class Site(BaseEntity):
         self.context.add_query(qry)
         return self
 
+    @property
+    def allow_create_declarative_workflow(self):
+        """
+        Specifies whether a designer can be used to create declarative workflows on this site collection
+
+        :rtype: bool or None
+        """
+        return self.properties.get("AllowCreateDeclarativeWorkflow", None)
+
     @property
     def allow_designer(self):
         """
@@ -485,7 +494,6 @@ class Site(BaseEntity):
     def lock_issue(self):
         """
         Specifies the comment that is used when a site collection is locked
-
         :rtype: str or None
         """
         return self.properties.get("LockIssue", None)
@@ -533,7 +541,6 @@ class Site(BaseEntity):
     def server_relative_url(self):
         """
         Specifies the server-relative URL of the top-level site in the site collection.
-
         :rtype: str
         """
         return self.properties.get("ServerRelativeUrl", None)
@@ -542,16 +549,22 @@ class Site(BaseEntity):
     def share_by_email_enabled(self):
         """
         When true, users will be able to grant permissions to guests for resources within the site collection.
-
         :rtype: bool or none
         """
         return self.properties.get('ShareByEmailEnabled', None)
 
+    @property
+    def status_bar_text(self):
+        """
+        Gets or sets the status bar message text for this site.
+        :rtype: str or none
+        """
+        return self.properties.get('StatusBarText', None)
+
     @property
     def trim_audit_log(self):
         """
         When this flag is set for the site, the audit events are trimmed periodically.
-
         :rtype: bool or none
         """
         return self.properties.get('TrimAuditLog', None)
@@ -583,7 +596,6 @@ class Site(BaseEntity):
     def is_hub_site(self):
         """
         Returns whether the specified site is a hub site
-
         :rtype: bool
         """
         return self.properties.get("IsHubSite", None)
@@ -591,7 +603,6 @@ class Site(BaseEntity):
     @property
     def server_relative_path(self):
         """Gets the server-relative Path of the Site.
-
         :rtype: SPResPath or None
         """
         return self.properties.get("ServerRelativePath", SPResPath())
@@ -625,6 +636,23 @@ class Site(BaseEntity):
                                    FeatureCollection(self.context,
                                                      ResourcePath("Features", self.resource_path), self))
 
+    @property
+    def max_items_per_throttled_operation(self):
+        """
+        Specifies the maximum number of list items allowed to be returned for each retrieve request before throttling
+        occurs. If throttling occurs, list items MUST NOT be returned.
+        :rtype: int or None
+        """
+        return self.properties.get("MaxItemsPerThrottledOperation", None)
+
+    @property
+    def needs_b2b_upgrade(self):
+        """
+        Specifies whether the site needs a Build-to-Build upgrade.
+        :rtype: bool or None
+        """
+        return self.properties.get("NeedsB2BUpgrade", None)
+
     @property
     def event_receivers(self):
         """

office365/sharepoint/tenant/administration/audit/search_request_status.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AuditSearchRequestStatus(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Administration.TenantAdmin.AuditSearchRequestStatus"

office365/sharepoint/tenant/administration/hubsites/permission.py

@@ -3,6 +3,16 @@ from office365.runtime.client_value import ClientValue
 
 class HubSitePermission(ClientValue):
 
+    def __init__(self, display_name=None, principal_name=None, rights=None):
+        """
+        :param str display_name:
+        :param str principal_name:
+        :param int rights:
+        """
+        self.DisplayName = display_name
+        self.PrincipalName = principal_name
+        self.Rights = rights
+
     @property
     def entity_type_name(self):
         return "Microsoft.Online.SharePoint.TenantAdministration.HubSitePermission"

office365/sharepoint/tenant/administration/tenant.py

@@ -86,6 +86,7 @@ class Tenant(BaseEntity):
         return return_type
 
     def get_collaboration_insights_data(self):
+        """"""
         return_type = ClientResult(self.context, CollaborationInsightsData())
         qry = ServiceOperationQuery(self, "GetCollaborationInsightsData", None, None, None, return_type)
         self.context.add_query(qry)

office365/sharepoint/tenant/apps/information.py

@@ -4,10 +4,12 @@ from office365.runtime.client_value import ClientValue
 class TenantAppInformation(ClientValue):
     """Specifies the information for the tenant-scoped app."""
 
-    def __init__(self, app_principal_id=None, app_web_full_url=None):
+    def __init__(self, app_principal_id=None, app_web_full_url=None, creation_time=None):
         """
         :param str app_principal_id: Specifies the OAuth Id for the tenant-scoped app.
         :param str app_web_full_url: Specifies the web full URL for the tenant-scoped app.
+        :param datetime.datetime creation_time: Specifies the creation time for the tenant-scoped app.
         """
         self.AppPrincipalId = app_principal_id
         self.AppWebFullUrl = app_web_full_url
+        self.CreationTime = creation_time

office365/sharepoint/tenant/management/office365_tenant.py

@@ -242,7 +242,6 @@ class Office365Tenant(BaseEntity):
     def delete_tenant_theme(self, name):
         """
         Removes a theme from tenant
-
         :type name: str
         """
         payload = {

office365/sharepoint/types/resource_path.py

@@ -17,6 +17,7 @@ class ResourcePath(ClientValue):
     @staticmethod
     def create_absolute(site_url, path):
         """
+        Creates absolute path
         :param str site_url: Site url
         :param str path: Resource path
         """
@@ -29,11 +30,12 @@ class ResourcePath(ClientValue):
     @staticmethod
     def create_relative(site_url, path):
         """
+        Creates server relative path
         :param str site_url: Site url
         :param str path: Resource path
         """
         site_path = urlparse(site_url).path
-        if not path.startswith(site_path):
+        if not path.lower().startswith(site_path.lower()):
             return ResourcePath("/".join([site_path, path]))
         else:
             return ResourcePath(path)

office365/sharepoint/userprofiles/people_manager.py

@@ -265,8 +265,6 @@ class PeopleManager(BaseEntity):
     def set_multi_valued_profile_property(self, account_name, property_name, property_values):
         """
         Sets the value of a multivalued user profile property.
-
-
         :param str account_name: Specifies the user by account name.
         :param str property_name: The name of the property to set.
         :param list[str] property_values: The values being set on the property.

office365/sharepoint/userprofiles/sharedwithme/document.py

@@ -1,3 +1,5 @@
+from datetime import datetime
+
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.sharepoint.base_entity import BaseEntity
 from office365.sharepoint.userprofiles.sharedwithme.document_user import SharedWithMeDocumentUser
@@ -15,12 +17,16 @@ class SharedWithMeDocument(BaseEntity):
 
     @property
     def caller_stack(self):
+        """
+        :rtype: str
+        """
         return self.properties.get('CallerStack', None)
 
     @property
     def content_type_id(self):
         """
         Specifies the identifier of the content type of the document.
+        :rtype: str
         """
         return self.properties.get('ContentTypeId', None)
 
@@ -28,6 +34,7 @@ class SharedWithMeDocument(BaseEntity):
     def doc_id(self):
         """
         Specifies the document identifier.
+        :rtype: str
         """
         return self.properties.get('DocId', None)
 
@@ -37,3 +44,12 @@ class SharedWithMeDocument(BaseEntity):
         Specifies a list of users that can edit the document.
         """
         return self.properties.get('Editors', ClientValueCollection(SharedWithMeDocumentUser))
+
+    @property
+    def modified(self):
+        """Specifies the date and time when the document was last modified."""
+        return self.properties.get("Modified", datetime.min)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.UserProfiles.SharedWithMeDocument"

office365/sharepoint/userprofiles/sharedwithme/document_user.py

@@ -4,6 +4,18 @@ from office365.runtime.client_value import ClientValue
 class SharedWithMeDocumentUser(ClientValue):
     """Represents a user of a document that is shared with the current user."""
 
+    def __init__(self, _id=None, login_name=None, sip_address=None, title=None):
+        """
+        :param str _id: Identifier
+        :param str login_name: Specifies the login name of the user.
+        :param str sip_address: Specifies the sip address of the user.
+        :param str title: Specifies the title of the user.
+        """
+        self.Id = _id
+        self.LoginName = login_name
+        self.SipAddress = sip_address
+        self.Title = title
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Portal.UserProfiles.SharedWithMeDocumentUser"

office365/sharepoint/userprofiles/sharedwithme/item_collection.py

@@ -0,0 +1,41 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class SharedWithMeItemCollection(BaseEntity):
+    """"""
+
+    @staticmethod
+    def get_shared_with_me_external_items(context, top):
+        """
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        :param int top:
+        """
+        binding_type = SharedWithMeItemCollection(context)
+        return_type = ClientResult(context, str())
+        params = {"top": top}
+        qry = ServiceOperationQuery(binding_type, "GetSharedWithMeExternalItems", params,
+                                    return_type=return_type, is_static=True)
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def get_shared_with_me_items(context, top, skip_token=None, include_sharing_history=None):
+        """
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        :param int top:
+        :param str skip_token:
+        :param bool include_sharing_history:
+        """
+        binding_type = SharedWithMeItemCollection(context)
+        return_type = ClientResult(context, str())
+        params = {
+            "top": top,
+            "skiptoken": skip_token,
+            "includeSharingHistory": include_sharing_history
+        }
+        qry = ServiceOperationQuery(binding_type, "GetSharedWithMeItems", None, params,
+                                    return_type=return_type, is_static=True)
+        context.add_query(qry)
+        return return_type

office365/sharepoint/userprofiles/sharedwithme/items.py

@@ -1,5 +1,22 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.base_entity_collection import BaseEntityCollection
+from office365.sharepoint.userprofiles.sharedwithme.document import SharedWithMeDocument
 
 
 class SharedWithMeItems(BaseEntity):
-    pass
+
+    @staticmethod
+    def shared_with_me(context):
+        """
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        """
+        binding_type = SharedWithMeItems(context)
+        return_type = BaseEntityCollection(context, SharedWithMeDocument)
+        qry = ServiceOperationQuery(binding_type, "SharedWithMe", return_type=return_type, is_static=True)
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.UserProfiles.SharedWithMeItems"

office365/sharepoint/webs/web.py

@@ -389,7 +389,6 @@ class Web(SecurableObject):
     def add_supported_ui_language(self, lcid):
         """
         Adds a supported UI language by its language identifier.
-
         :param int lcid: Specifies the language identifier to be added.
         """
         qry = ServiceOperationQuery(self, "AddSupportedUILanguage", {"lcid": lcid})
@@ -1416,8 +1415,8 @@ class Web(SecurableObject):
 
     @property
     def allow_rss_feeds(self):
-        """Gets a Boolean value that specifies whether the site collection allows RSS feeds.
-
+        """
+        Gets a Boolean value that specifies whether the site collection allows RSS feeds.
         :rtype: str
         """
         return self.properties.get("AllowRssFeeds", None)

office365/subscriptions/collection.py

@@ -14,12 +14,18 @@ class SubscriptionCollection(EntityCollection):
         Subscribes a listener application to receive change notifications when the requested type of changes occur
         to the specified resource in Microsoft Graph.
 
-        :param str change_type:
-        :param str notification_url:
-        :param ResourcePath resource_path:
-        :param datetime.datetime expiration:
-        :param str client_state:
-        :param str latest_supported_tls_version:
+        :param str change_type: Indicates the type of change in the subscribed resource that will raise a change
+           notification
+        :param str notification_url: 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.
+        :param office365.runtime.paths.resource_path.ResourcePath or str resource_path:
+        :param datetime.datetime expiration:  Specifies the date and time when the webhook subscription expires.
+        :param str client_state: Specifies the value of the clientState property sent by the service in each change
+            notification
+        :param str latest_supported_tls_version:  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.
         """
         return_type = Subscription(self.context)
         self.add_child(return_type)

office365/subscriptions/subscription.py

@@ -1,3 +1,5 @@
+import datetime
+
 from office365.entity import Entity
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
@@ -15,11 +17,119 @@ class Subscription(Entity):
     def application_id(self):
         """
         Identifier of the application used to create the subscription.
-
         :rtype: str or None
         """
         return self.properties.get("applicationId", None)
 
+    @property
+    def change_type(self):
+        """
+        Required. Indicates the type of change in the subscribed resource that will raise a change notification.
+        The supported values are: created, updated, deleted.
+        Multiple values can be combined using a comma-separated list.
+
+        Note:
+        Drive root item and list change notifications support only the updated changeType.
+        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):
+        """
+        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):
+        """
+        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):
+        """
+        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):
+        """
+        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):
+        """
+        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
+        """
+        return self.properties.get("expirationDateTime", datetime.datetime)
+
+    @property
+    def include_resource_data(self):
+        """
+        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):
+        """
+        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.
+
+        For subscribers whose notification endpoint supports a version lower than the currently recommended
+        version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated
+        version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property
+        per the timeline would result in subscription operations failing.
+
+        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):
+        """
+        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):
+        """
+        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):
         """
@@ -30,3 +140,11 @@ class Subscription(Entity):
         :rtype: str or None
         """
         return self.properties.get("resource", None)
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "expirationDateTime": self.expiration_datetime,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(Subscription, self).get_property(name, default_value)

office365/teams/channels/iIdentity.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ChannelIdentity(ClientValue):
+    """Contains basic identification information about a channel in Microsoft Teams."""

office365/teams/chats/collection.py

@@ -18,6 +18,5 @@ class ChatCollection(EntityCollection):
         :param str chat_type: Specifies the type of chat. Possible values are: group and oneOnOne.
         :rtype: Chat
         """
-        return super(ChatCollection, self).add(chatType=chat_type)
-
 
+        return super(ChatCollection, self).add(chatType=chat_type)

office365/teams/chats/messages/info.py

@@ -1,5 +1,14 @@
 from office365.entity import Entity
+from office365.outlook.mail.item_body import ItemBody
 
 
 class ChatMessageInfo(Entity):
     """Represents a preview of a chatMessage resource. This object can only be fetched as part of a list of chats."""
+
+    @property
+    def body(self):
+        """
+        Body of the chatMessage. This will still contain markers for @mentions and attachments even though the
+        object does not return @mentions and attachments..
+        """
+        return self.properties.get("body", ItemBody())

office365/teams/chats/messages/message.py

@@ -1,7 +1,9 @@
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
+from office365.outlook.mail.item_body import ItemBody
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.teams.channels.iIdentity import ChannelIdentity
 from office365.teams.chats.messages.attachment import ChatMessageAttachment
 
 
@@ -16,6 +18,21 @@ class ChatMessage(Entity):
         """The collection of replies."""
         return self.properties.get("attachments", ClientValueCollection(ChatMessageAttachment))
 
+    @property
+    def body(self):
+        """
+        Plaintext/HTML representation of the content of the chat message. Representation is specified by the
+        contentType inside the body. The content is always in HTML if the chat message contains a chatMessageMention.
+        """
+        return self.properties.get("body", ItemBody())
+
+    @property
+    def channel_identity(self):
+        """
+        If the message was sent in a channel, represents identity of the channel.
+        """
+        return self.properties.get("channelIdentity", ChannelIdentity())
+
     @property
     def replies(self):
         """
@@ -29,7 +46,6 @@ class ChatMessage(Entity):
     def web_url(self):
         """
         Link to the message in Microsoft Teams.
-
         :rtype: str
         """
         return self.properties.get("webUrl", None)
@@ -38,7 +54,6 @@ class ChatMessage(Entity):
     def importance(self):
         """
         The importance of the chat message. The possible values are: normal, high, urgent.
-
         :rtype: str
         """
         return self.properties.get("importance", None)

office365/teams/members/aad_user_conversation.py

@@ -7,8 +7,8 @@ class AadUserConversationMember(ConversationMember):
 
     @property
     def user_id(self):
-        """The guid of the user.
-
+        """
+        The guid of the user.
         :rtype: str or None
         """
         return self.properties.get("userId", None)

office365/teams/members/conversation_collection.py

@@ -7,16 +7,16 @@ class ConversationMemberCollection(EntityCollection):
     def __init__(self, context, resource_path=None):
         super(ConversationMemberCollection, self).__init__(context, ConversationMember, resource_path)
 
-    def add(self, user, roles, visible_history_start_date_time=None):
+    def add(self, user, roles, visible_history_start_datetime=None):
         """
         Add a conversationMember.
 
-        :param str  or office365.directory.users.user.User user: The conversation members that should be added.
+        :param str or office365.directory.users.user.User user: The conversation members that should be added.
             Every user who will participate in the chat, including the user who initiates the create request,
             must be specified in this list.
             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_date_time:
+        :param datetime.datetime visible_history_start_datetime:
 
         :rtype: ConversationMember
         """

office365/teams/schedule/change_tracked_entity.py

@@ -1,3 +1,5 @@
+from datetime import datetime
+
 from office365.directory.permissions.identity_set import IdentitySet
 from office365.entity import Entity
 
@@ -11,7 +13,7 @@ class ChangeTrackedEntity(Entity):
         The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
         For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
         """
-        return self.properties.get('createdDateTime', None)
+        return self.properties.get('createdDateTime', datetime.min)
 
     @property
     def last_modified_datetime(self):
@@ -19,9 +21,16 @@ class ChangeTrackedEntity(Entity):
         The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
         For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
         """
-        return self.properties.get('lastModifiedDateTime', None)
+        return self.properties.get('lastModifiedDateTime', datetime.min)
 
     @property
     def last_modified_by(self):
         """Identity of the person who last modified the entity."""
         return self.properties.get('lastModifiedBy', IdentitySet())
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+            }
+            default_value = property_mapping.get(name, None)
+        return super(ChangeTrackedEntity, self).get_property(name, default_value)