Examples update & SharePoint model updates

Author: vgrem

examples/onedrive/files/download.py

@@ -8,7 +8,6 @@
 
 from office365.graph_client import GraphClient
 from tests import test_client_id, test_password, test_tenant, test_username
-from tests.graph_case import acquire_token_by_username_password
 
 client = GraphClient.with_username_and_password(
     test_tenant, test_client_id, test_username, test_password

examples/onedrive/files/send_sharing_invitation.py

@@ -10,7 +10,6 @@
 
 from office365.graph_client import GraphClient
 from tests import test_client_id, test_password, test_tenant, test_username
-from tests.graph_case import acquire_token_by_username_password
 
 file_name = "Financial Sample.xlsx"
 client = GraphClient.with_username_and_password(

examples/onedrive/folders/list_files.py

@@ -4,7 +4,6 @@
 """
 from office365.graph_client import GraphClient
 from tests import test_client_id, test_password, test_tenant, test_username
-from tests.graph_case import acquire_token_by_username_password
 
 client = GraphClient.with_username_and_password(
     test_tenant, test_client_id, test_username, test_password

examples/onenote/create_page.py

@@ -5,9 +5,11 @@
 """
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 
 files = {}
 with open("../data/Sample.html", "rb") as f, open(

examples/outlook/calendars/share_with.py

@@ -7,11 +7,13 @@
 """
 from office365.graph_client import GraphClient
 from office365.outlook.calendar.role_type import CalendarRoleType
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
-my_cal = client.me.calendar
-cal_perm = my_cal.calendar_permissions.add(
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
+
+cal_perm = client.me.calendar.calendar_permissions.add(
     "[email protected]", CalendarRoleType.read
 ).execute_query()
 print(cal_perm)

examples/outlook/events/delete.py

@@ -3,9 +3,11 @@
 """
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 event_id = "--event id goes here--"
 event_to_del = client.me.calendar.events[event_id]
 event_to_del.delete_object().execute_query()

examples/outlook/events/list.py

@@ -4,11 +4,13 @@
 https://learn.microsoft.com/en-us/graph/api/calendar-list-events?view=graph-rest-1.0
 """
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 events = (
-    client.me.calendar.events.get().top(100).select(["subject", "body"]).execute_query()
+    client.me.calendar.events.get().top(10).select(["subject", "body"]).execute_query()
 )
 for event in events:
     print(event.subject)

examples/outlook/messages/create_draft_with_attachments.py

@@ -4,11 +4,13 @@
 import base64
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
 with open(r"../../data/Sample.pdf", "rb") as f:
     content = base64.b64encode(f.read()).decode()
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 client.me.messages.add(
     subject="Meet for lunch?",
     body="The new cafeteria is open.",

examples/outlook/messages/create_property.py

@@ -8,9 +8,11 @@
 import sys
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 messages = client.me.messages.top(1).get().execute_query()
 if len(messages) == 0:
     sys.exit("No messages were found")

examples/outlook/messages/create_subscription.py

@@ -6,9 +6,11 @@
 import datetime
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 
 existing_subscriptions = client.subscriptions.get().execute_query()
 

examples/outlook/messages/download.py

@@ -9,9 +9,11 @@
 import tempfile
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 messages = client.me.messages.select(["id", "subject"]).top(1).get().execute_query()
 with tempfile.TemporaryDirectory() as local_path:
     for message in messages:

examples/outlook/messages/get_with_body.py

@@ -7,9 +7,11 @@
 """
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 messages = client.me.messages.select(["subject", "body"]).top(10).get().execute_query()
 for message in messages:
     print(message.subject)

examples/outlook/messages/list_new.py

@@ -5,9 +5,11 @@
 """
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 messages = (
     client.me.mail_folders["Inbox"]
     .messages.delta.change_type("created")

examples/outlook/messages/mark_as_read.py

@@ -7,9 +7,11 @@
 import sys
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 messages = client.me.messages.top(1).get().execute_query()
 if len(messages) == 0:
     sys.exit("No messages were found")

examples/outlook/messages/move.py

@@ -2,13 +2,15 @@
 Move a message to another folder within the specified user's mailbox.
 This creates a new copy of the message in the destination folder and removes the original message.
 
-https://learn.microsoft.com/en-us/graph/api/message-move?view=graph-rest-1.0&tabs=http
+https://learn.microsoft.com/en-us/graph/api/message-move?view=graph-rest-1.0
 """
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 folder_name = "Archive"
 to_folder = client.me.mail_folders[folder_name]
 

examples/outlook/messages/reply.py

@@ -7,9 +7,11 @@
 import sys
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 messages = client.me.messages.top(1).get().execute_query()
 if len(messages) == 0:
     sys.exit("No messages were found")

examples/outlook/messages/search.py

@@ -5,10 +5,12 @@
 """
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 result = client.search.query_messages("Let's go for lunch").execute_query()
 for item in result.value:
     for hit in item.hitsContainers[0].hits:
-        print(hit.resource.properties.get("webLink"))
+        print(hit.resource.get("webLink"))

examples/outlook/messages/send_with_attachment.py

@@ -5,10 +5,17 @@
 """
 
 from office365.graph_client import GraphClient
-from tests import test_user_principal_name_alt
-from tests.graph_case import acquire_token_by_username_password
+from tests import (
+    test_client_id,
+    test_password,
+    test_tenant,
+    test_user_principal_name_alt,
+    test_username,
+)
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 client.me.send_mail(
     subject="Meet for lunch?",
     body="The new cafeteria is open.",

examples/outlook/messages/send_with_large_attachment.py

@@ -5,15 +5,23 @@
 """
 
 from office365.graph_client import GraphClient
-from tests import test_user_principal_name_alt
-from tests.graph_case import acquire_token_by_username_password
+from tests import (
+    test_client_id,
+    test_password,
+    test_tenant,
+    test_user_principal_name_alt,
+    test_username,
+)
 
 
 def print_progress(range_pos):
+    # type: (int) -> None
     print("{0} bytes uploaded".format(range_pos))
 
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 local_path = "../../../tests/data/big_buck_bunny.mp4"
 message = (
     (

examples/planner/create_task.py

@@ -5,9 +5,11 @@
 import sys
 
 from office365.graph_client import GraphClient
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 group = client.groups.get_by_name("My Sample Team").get().execute_query()
 plans = group.planner.plans.get().execute_query()
 if len(plans) == 0:

examples/sharepoint/fields/create_lookup.py

@@ -14,5 +14,5 @@
     lookup_field_name="Title",
     allow_multiple_values=True,
 ).execute_query()
-print("Field  {0} has been created", field.internal_name)
+print("Field  {0} has been created", field_name)
 field.delete_object().execute_query()  # clean up

examples/sharepoint/files/delete.py

@@ -5,6 +5,15 @@
 from tests import test_team_site_url, test_user_credentials
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_user_credentials)
-file_url = "Shared Documents/SharePoint User Guide.docx"
+file_url = "Shared Documents/Financial Sample.xlsx"
 file = ctx.web.get_file_by_server_relative_url(file_url)
-file.delete_object().execute_query()
+# file.recycle().execute_query()
+# or delete permanently via delete_object:
+# file.delete_object().execute_query()
+print("Deleted file: {0}".format(file_url))
+
+
+print("Print deleted files...")
+result = ctx.web.get_recycle_bin_items().execute_query()
+for recycle_bin_item in result:
+    print(recycle_bin_item)

examples/sharepoint/webs/get_regional_settings.py

@@ -0,0 +1,9 @@
+"""
+Retrieves the locale settings of a site
+"""
+from office365.sharepoint.client_context import ClientContext
+from tests import test_client_credentials, test_site_url
+
+client = ClientContext(test_site_url).with_credentials(test_client_credentials)
+result = client.web.regional_settings.get().execute_query()
+print(result)

examples/teams/create_team.py

@@ -8,10 +8,17 @@
 """
 
 from office365.graph_client import GraphClient
-from tests import create_unique_name
-from tests.graph_case import acquire_token_by_username_password
+from tests import (
+    create_unique_name,
+    test_client_id,
+    test_password,
+    test_tenant,
+    test_username,
+)
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 team_name = create_unique_name("Team")
 print("Creating a team '{0}' ...".format(team_name))
 team = client.teams.create(team_name).execute_query_and_wait()

examples/teams/send_message.py

@@ -6,9 +6,11 @@
 
 from office365.graph_client import GraphClient
 from office365.outlook.mail.item_body import ItemBody
-from tests.graph_case import acquire_token_by_username_password
+from tests import test_client_id, test_password, test_tenant, test_username
 
-client = GraphClient(acquire_token_by_username_password)
+client = GraphClient.with_username_and_password(
+    test_tenant, test_client_id, test_username, test_password
+)
 my_teams = client.me.joined_teams.get().top(1).execute_query()
 if len(my_teams) == 0:
     sys.exit("No teams found")

office365/sharepoint/alerts/collection.py

@@ -5,7 +5,7 @@
 from office365.sharepoint.entity_collection import EntityCollection
 
 
-class AlertCollection(EntityCollection):
+class AlertCollection(EntityCollection[Alert]):
     """Content Type resource collection"""
 
     def __init__(self, context, resource_path=None):
@@ -26,6 +26,7 @@ def add(self, parameters):
         return return_type
 
     def contains(self, id_alert):
+        # type: (str) -> ClientResult[bool]
         """
         Returns true if the given alert exists in the alert collection. False otherwise.
 

office365/sharepoint/contenttypes/content_type.py

@@ -20,7 +20,7 @@ class ContentType(Entity):
     """
 
     def __str__(self):
-        return self.name
+        return self.name or self.entity_type_name
 
     def __repr__(self):
         return self.string_id or str(self.id) or self.entity_type_name