Update People API and Person model

Resolves include phone, extension and location fields on People #137

Author: cmlccie

tests/api/test_people.py

@@ -83,6 +83,8 @@ def inner_function():
                 lastName="webexteamssdk",
                 orgId=me.orgId,
                 licenses=[licenses_dict["Advanced Messaging"].id],
+                callingData=True,
+                minResponse=False,
             )
             return person
 

webexteamssdk/api/people.py

@@ -22,7 +22,6 @@
 SOFTWARE.
 """
 
-
 from __future__ import (
     absolute_import,
     division,
@@ -80,7 +79,7 @@ def list(
         id=None,
         orgId=None,
         max=None,
-        **request_parameters
+        **request_parameters,
     ):
         """List people in your organization.
 
@@ -150,21 +149,35 @@ def list(
     def create(
         self,
         emails,
+        phoneNumbers=None,
+        extension=None,
+        locationId=None,
         displayName=None,
         firstName=None,
         lastName=None,
         avatar=None,
         orgId=None,
         roles=None,
         licenses=None,
-        **request_parameters
+        department=None,
+        manager=None,
+        managerId=None,
+        title=None,
+        addresses=None,
+        siteUrls=None,
+        callingData=None,
+        minResponse=None,
+        **request_parameters,
     ):
         """Create a new user account for a given organization
 
         Only an admin can create a new user account.
 
         Args:
             emails(`list`): Email address(es) of the person (list of strings).
+            phoneNumbers(`list`): Phone numbers for the person.
+            extension(basestring): Webex Calling extension of the person.
+            locationId(basestring): The ID of the location for this person.
             displayName(basestring): Full name of the person.
             firstName(basestring): First name of the person.
             lastName(basestring): Last name of the person.
@@ -176,6 +189,19 @@ def create(
             licenses(`list`): Licenses allocated to the person (list of
                 strings - containing the license IDs to be allocated to the
                 person).
+            department(basestring): The business department the user belongs
+                to.
+            manager(basestring): A manager identifier.
+            managerId(basestring): Person ID of the manager.
+            title(basestring): The person's title.
+            addresses(`list`): A person's addresses.
+            siteUrls(`list`): One or several site names where this user has an
+                attendee role.
+            callingData(bool): Include Webex Calling user details in the
+                response.
+            minResponse(bool): Set to true to improve performance by omitting
+                person details and returning only the ID in the response when
+                successful.
             **request_parameters: Additional request parameters (provides
                 support for parameters that may be added in the future).
 
@@ -188,28 +214,55 @@ def create(
 
         """
         check_type(emails, list)
+        check_type(phoneNumbers, list, optional=True)
+        check_type(extension, basestring, optional=True)
+        check_type(locationId, basestring, optional=True)
         check_type(displayName, basestring, optional=True)
         check_type(firstName, basestring, optional=True)
         check_type(lastName, basestring, optional=True)
         check_type(avatar, basestring, optional=True)
         check_type(orgId, basestring, optional=True)
         check_type(roles, list, optional=True)
         check_type(licenses, list, optional=True)
+        check_type(department, basestring, optional=True)
+        check_type(manager, basestring, optional=True)
+        check_type(managerId, basestring, optional=True)
+        check_type(title, basestring, optional=True)
+        check_type(addresses, list, optional=True)
+        check_type(siteUrls, list, optional=True)
+        check_type(callingData, bool, optional=True)
+        check_type(minResponse, bool, optional=True)
 
         post_data = dict_from_items_with_values(
             request_parameters,
             emails=emails,
+            phoneNumbers=phoneNumbers,
+            extension=extension,
+            locationId=locationId,
             displayName=displayName,
             firstName=firstName,
             lastName=lastName,
             avatar=avatar,
             orgId=orgId,
             roles=roles,
             licenses=licenses,
+            department=department,
+            manager=manager,
+            managerId=managerId,
+            title=title,
+            addresses=addresses,
+            siteUrls=siteUrls,
+        )
+
+        params = dict_from_items_with_values(
+            callingData=callingData,
+            minResponse=minResponse,
         )
 
         # API request
-        json_data = self._session.post(API_ENDPOINT, json=post_data)
+        json_data = self._session.post(
+            API_ENDPOINT, params=params, json=post_data
+        )
 
         # Return a person object created from the returned JSON object
         return self._object_factory(OBJECT_TYPE, json_data)
@@ -247,7 +300,7 @@ def update(
         orgId=None,
         roles=None,
         licenses=None,
-        **request_parameters
+        **request_parameters,
     ):
         """Update details for a person, by ID.
 

webexteamssdk/models/mixins/person.py

@@ -22,7 +22,6 @@
 SOFTWARE.
 """
 
-
 from __future__ import (
     absolute_import,
     division,
@@ -48,10 +47,21 @@ def emails(self):
         """The email addresses of the person."""
         return self._json_data.get("emails")
 
+    @property
     def phoneNumbers(self):
         """Phone numbers for the person."""
         return self._json_data.get("phoneNumbers")
 
+    @property
+    def extension(self):
+        """The Webex Calling extension for the person."""
+        return self._json_data.get("extension")
+
+    @property
+    def locationId(self):
+        """The location ID for the person."""
+        return self._json_data.get("locationId")
+
     @property
     def displayName(self):
         """The full name of the person."""
@@ -100,6 +110,31 @@ def licenses(self):
         """An list of license strings allocated to this person."""
         return self._json_data.get("licenses")
 
+    @property
+    def department(self):
+        """The business department the user belongs to."""
+        return self._json_data.get("department")
+
+    @property
+    def manager(self):
+        """A manager identifier."""
+        return self._json_data.get("manager")
+
+    @property
+    def managerId(self):
+        """Person ID of the manager."""
+        return self._json_data.get("managerId")
+
+    @property
+    def title(self):
+        """The person's title."""
+        return self._json_data.get("title")
+
+    @property
+    def addresses(self):
+        """A person's addresses."""
+        return self._json_data.get("addresses")
+
     @property
     def created(self):
         """The date and time the person was created."""
@@ -137,6 +172,25 @@ def lastActivity(self):
         else:
             return None
 
+    @property
+    def siteUrls(self):
+        """One or several site names where this user has a role."""
+        return self._json_data.get("siteUrls")
+
+    @property
+    def sipAddresses(self):
+        """The user's SIP addresses."""
+        return self._json_data.get("sipAddresses")
+
+    @property
+    def xmppFederationJid(self):
+        """XMPP federation identifier.
+
+        Identifier for intra-domain federation with other XMPP based messenger
+        systems.
+        """
+        return self._json_data.get("xmppFederationJid")
+
     @property
     def status(self):
         """The current presence status of the person.
@@ -161,7 +215,7 @@ def status(self):
 
             `presenting`: The user is sharing content
 
-            `unknown`: The user’s status could not be determined
+            `unknown`: The user's status could not be determined
         """
         return self._json_data.get("status")