Merge branch 'master' of https://github.com/GearPlug/microsoftgraph-python

Author: root

microsoftgraph/client.py

@@ -42,7 +42,10 @@ def authorization_url(self, redirect_uri, scope, state=None, office365=False):
             about the user's state in the app before the authentication request occurred, such as the page or view
             they were on.
 
+            office365: Get authorization url for office 365 instead graph.
+
         Returns:
+            A string.
 
         """
         params = {
@@ -70,6 +73,8 @@ def exchange_code(self, redirect_uri, code, office365=False):
 
             code: The authorization_code that you acquired in the first leg of the flow.
 
+            office365: Exchange code for office 365 instead graph.
+
         Returns:
             A dict.
 
@@ -98,7 +103,10 @@ def refresh_token(self, redirect_uri, refresh_token, office365=False):
             after the current access token expires. Refresh tokens are long-lived, and can be used to retain access
             to resources for extended periods of time.
 
+            office365: Refresh token for office 365 instead graph.
+
         Returns:
+            A dict.
 
         """
         data = {
@@ -120,6 +128,8 @@ def set_token(self, token, office365=False):
         Args:
             token: A string with the Token.
 
+            office365: Set token for office 365 instead graph.
+
         """
         if office365:
             self.office365_token = token
@@ -138,7 +148,7 @@ def get_me(self, params=None):
             params: A dict.
 
         Returns:
-
+            A dict.
 
         """
         return self._get(self.base_url + 'me', params=params)
@@ -149,9 +159,10 @@ def get_message(self, message_id, params=None):
 
         Args:
             message_id: A dict.
+            params:
 
         Returns:
-
+            A dict.
 
         """
         return self._get(self.base_url + 'me/messages/' + message_id, params=params)
@@ -161,13 +172,15 @@ def create_subscription(self, change_type, notification_url, resource, expiratio
         """Creating a subscription is the first step to start receiving notifications for a resource.
 
         Args:
-            change_type: The event type that caused the notification. For example, created on mail receive, or updated on marking a message read.
+            change_type: The event type that caused the notification. For example, created on mail receive, or updated
+            on marking a message read.
             notification_url:
             resource: The URI of the resource relative to https://graph.microsoft.com.
             expiration_datetime: The expiration time for the subscription.
             client_state: The clientState property specified in the subscription request.
 
         Returns:
+            A dict.
 
         """
         data = {
@@ -187,8 +200,10 @@ def renew_subscription(self, subscription_id, expiration_datetime):
 
         Args:
             subscription_id:
+            expiration_datetime:
 
         Returns:
+            A dict.
 
         """
         data = {
@@ -204,6 +219,7 @@ def delete_subscription(self, subscription_id):
             subscription_id:
 
         Returns:
+            None.
 
         """
         return self._delete('https://graph.microsoft.com/beta/' + 'subscriptions/{}'.format(subscription_id))
@@ -250,7 +266,7 @@ def create_page(self, section_id, files):
 
         Args:
             section_id:
-            content:
+            files:
 
         Returns:
             A dict.
@@ -272,13 +288,9 @@ def get_me_events(self):
         return self._get(self.base_url + 'me/events')
 
     @token_required
-    def create_calendar_event(
-            self, subject, content,
-            start_datetime, start_timezone, end_datetime,
-            end_timezone, recurrence_type, recurrence_interval,
-            recurrence_days_of_week, recurrence_range_type,
-            recurrence_range_startdate, recurrence_range_enddate,
-            location, attendees, calendar=None):
+    def create_calendar_event(self, subject, content, start_datetime, start_timezone, end_datetime, end_timezone,
+                              recurrence_type, recurrence_interval, recurrence_days_of_week, recurrence_range_type,
+                              recurrence_range_startdate, recurrence_range_enddate, location, attendees, calendar=None):
         """
         Create a new calendar event.
 
@@ -304,8 +316,10 @@ def create_calendar_event(
             location:   string
             attendees: list of dicts of the form:
                         {"emailAddress": {"address": a['attendees_email'],"name": a['attendees_name']}
+            calendar:
 
         Returns:
+            A dict.
 
         """
         attendees_list = [{
@@ -362,32 +376,21 @@ def create_calendar(self, name):
             name:
 
         Returns:
+            A dict.
 
         """
         body = {
             'name': '{}'.format(name)
         }
         return self._post(self.base_url + 'me/calendars', json=body)
 
-    @token_required
-    def get_me_calendar(self, calendar_id=None):
-        """Get the properties and relationships of a calendar object. The calendar can be one for a user,
-        or the default calendar of an Office 365 group.
-
-        Args:
-            calendar_id:
-
-        Returns:
-
-        """
-        url = 'me/calendar/{}'.format(calendar_id) if calendar_id is not None else 'me/calendar'
-        return self._get(self.base_url + url)
-
     @token_required
     def get_me_calendars(self):
-        """
+        """Get all the user's calendars (/calendars navigation property), get the calendars from the default
+        calendar group or from a specific calendar group.
 
         Returns:
+            A dict.
 
         """
         return self._get(self.base_url + 'me/calendars')

microsoftgraph/decorators.py

@@ -1,4 +1,4 @@
-from microsoftgraph.exceptions import AccessTokenRequired
+from microsoftgraph.exceptions import TokenRequired
 from functools import wraps
 
 
@@ -7,7 +7,7 @@ def token_required(func):
     def helper(*args, **kwargs):
         client = args[0]
         if not client.token:
-            raise AccessTokenRequired('You must set the Token.')
+            raise TokenRequired('You must set the Token.')
         return func(*args, **kwargs)
 
     return helper

microsoftgraph/exceptions.py

@@ -6,7 +6,7 @@ class UnknownError(BaseError):
     pass
 
 
-class AccessTokenRequired(BaseError):
+class TokenRequired(BaseError):
     pass