Server compatibility updates for v2.1

* update wire protocol for remove_from_organization with account deletion
* fix various typos in docs and doc strings

Author: adobeDan

HISTORY.md

@@ -33,3 +33,12 @@ Enhancement release:
 * (No issue)
     * fix misspellings
     * change .gitignore so that .gitignore is not ignored
+
+### Version 2.1
+
+Server-compatibility release:
+
+* (No Issue)
+    * fix typos in docs
+    * fix param documentation in functional API
+    * update wire protocol for remove_from_organization with deletion of account to match server changes

docs/usage-instructions-v2.md

@@ -96,11 +96,11 @@ a Python dictionary of its attributes.
 The following code enumerates the first 5 users, printing the email of each.
 This will only have fetched the first page of results.  Then, after the loop,
 the `all_results` call will force the fetch of all remaining pages so the
-list of all results can be constructed.  ()Once the `all_results` call has been made,
+list of all results can be constructed.  (Once the `all_results` call has been made,
 you cannot enumerate again without first calling `reload`.)
 
 ```python
-users = umapi_client.QueryUsers(conn)
+users = umapi_client.UsersQuery(conn)
 # print first 5 users
 for i, user in enumerate(users):
     if i == 5: break
@@ -109,13 +109,22 @@ for i, user in enumerate(users):
 user_count = len(users.all_results())
 ```
 
+You can also query for a particular user by email:
+
+```python
+query = umapi_client.UserQuery(conn, "[email protected]")
+jruser = query.result()
+if jruser:
+    name = jruser["lastname"] + ", " + jruser["firstname"]
+```
+
 ## Get a List of Groups
 
 This list of groups will contain both user groups and product license
 configuration groups.
 
 ```python
-groups = umapi_client.QueryGroups(conn)
+groups = umapi_client.GroupsQuery(conn)
 # print all the group details
 for group in groups:
     print(group)

tests/test_functional.py

@@ -216,22 +216,22 @@ def test_remove_role_enterpriseid():
 def test_remove_from_organization_federatedid():
     user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
     user.remove_from_organization()
-    assert user.wire_dict() == {"do": [{"removeFromOrg": {}}],
+    assert user.wire_dict() == {"do": [{"removeFromOrg": {"deleteAccount": False}}],
                                 "user": "[email protected]"}
 
 
 def test_remove_from_organization_adobeid():
     user = UserAction(id_type='adobeID', email="[email protected]")
     user.remove_from_organization()
-    assert user.wire_dict() == {"do": [{"removeFromOrg": {}}],
+    assert user.wire_dict() == {"do": [{"removeFromOrg": {"deleteAccount": False}}],
                                 "user": "[email protected]",
                                 "useAdobeID": True}
 
 
 def test_remove_from_organization_delete_federatedid():
     user = UserAction(id_type=IdentityTypes.federatedID, email="[email protected]")
     user.remove_from_organization(delete_account=True)
-    assert user.wire_dict() == {"do": [{"removeFromOrg": {}}, {"removeFromDomain": {}}],
+    assert user.wire_dict() == {"do": [{"removeFromOrg": {"deleteAccount": True}}],
                                 "user": "[email protected]"}
 
 

umapi_client/functional.py

@@ -205,7 +205,7 @@ def add_to_groups(self, groups=None, all_groups=False, group_type=None):
         Add user to some (typically PLC) groups.  Note that, if you add to no groups, the effect
         is simply to do an "add to organization Everybody group", so we let that be done.
         :param groups: list of group names the user should be added to
-        :param all_groups: a boolean meaning remove from all (don't specify groups or group_type in this case)
+        :param all_groups: a boolean meaning add to all (don't specify groups or group_type in this case)
         :param group_type: the type of group (defaults to "product")
         :return: the User, so you can do User(...).add_to_groups(...).add_role(...)
         """
@@ -252,8 +252,8 @@ def remove_from_groups(self, groups=None, all_groups=False, group_type=None):
     def add_role(self, groups=None, role_type=RoleTypes.admin):
         """
         Make user have a role (typically PLC admin) with respect to some PLC groups.
-        :param groups: list of group names the user should be an admin for
-        :param role_type: the type of role (defaults to "admin")
+        :param groups: list of group names the user should have this role for
+        :param role_type: the role (defaults to "admin")
         :return: the User, so you can do User(...).add_role(...).add_to_groups(...)
         """
         if not groups:
@@ -268,7 +268,7 @@ def add_role(self, groups=None, role_type=RoleTypes.admin):
     def remove_role(self, groups=None, role_type=RoleTypes.admin):
         """
         Remove user from a role (typically admin) of some groups.
-        :param groups: list of group names the user should NOT be an admin for
+        :param groups: list of group names the user should NOT have this role for
         :param role_type: the type of role (defaults to "admin")
         :return: the User, so you can do User(...).remove_role(...).remove_from_groups(...)
         """
@@ -288,9 +288,9 @@ def remove_from_organization(self, delete_account=False):
         :param delete_account: Whether to delete the account after removing from the organization (default false)
         :return: None, because you cannot follow this command with another.
         """
-        self.append(removeFromOrg={})
-        if delete_account:
-            self.delete_account()
+        if delete_account and self.id_type == IdentityTypes.adobeID:
+            raise ValueError("You cannot delete an Adobe ID account.")
+        self.append(removeFromOrg={"deleteAccount": delete_account == True})
         return None
 
     def delete_account(self):
@@ -356,9 +356,9 @@ def __init__(self, group_name=None, **kwargs):
 
     def add_to_products(self, products=None, all_products=False):
         """
-        Add user product to some PLC products.
+        Add user group to some product license configuration groups (PLCs), or all of them.
         :param products: list of product names the user should be added to
-        :param all_products: a boolean meaning remove from all (don't specify products in this case)
+        :param all_products: a boolean meaning add to all (don't specify products in this case)
         :return: the Group, so you can do Group(...).add_to_products(...).add_users(...)
         """
         if all_products:
@@ -373,7 +373,7 @@ def add_to_products(self, products=None, all_products=False):
 
     def remove_from_products(self, products=None, all_products=False):
         """
-        Remove user group from some PLC products, or all of them.
+        Remove user group from some product license configuration groups (PLCs), or all of them.
         :param products: list of product names the user group should be removed from
         :param all_products: a boolean meaning remove from all (don't specify products in this case)
         :return: the Group, so you can do Group(...).remove_from_products(...).add_users(...)

umapi_client/version.py

@@ -18,4 +18,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-__version__ = "2.0.3"
+__version__ = "2.1"