[SYNPY-1347] Adds OOP Team Model

docs/reference/client.md

@@ -60,6 +60,8 @@ those memebrs. We are roughly grouping these for similar functionality. -->
         - getEvaluation
         - getEvaluationByContentSource
         - getEvaluationByName
+        - create_team
+        - delete_team
         - getProjectSetting
         - getSubmission
         - getSubmissions

docs/reference/oop/models.md

@@ -54,6 +54,17 @@ the client.
       filters:
       - "!"
 ---
+::: synapseclient.models.Team
+    options:
+        members:
+        - create
+        - delete
+        - from_id
+        - from_name
+        - members
+        - invite
+        - open_invitations
+---
 ::: synapseclient.models.UserProfile
     options:
       members:
@@ -98,6 +109,14 @@ the client.
 ```
 </details>
 
+<details class="quote">
+  <summary>Current Synapse interface for working with a project</summary>
+
+```python
+{!docs/scripts/object_orientated_programming_poc/synapse_project.py!}
+```
+</details>
+
 <details class="quote">
   <summary>Working with activities</summary>
 
@@ -107,9 +126,9 @@ the client.
 </details>
 
 <details class="quote">
-  <summary>Current Synapse interface for working with a project</summary>
+  <summary>Working with teams</summary>
 
 ```python
-{!docs/scripts/object_orientated_programming_poc/synapse_project.py!}
+{!docs/scripts/object_orientated_programming_poc/oop_poc_team.py!}
 ```
 </details>

docs/scripts/object_orientated_programming_poc/oop_poc_team.py

@@ -0,0 +1,63 @@
+"""The purpose of this script is to demonstrate how to use the new OOP interface for teams.
+The following actions are shown in this script:
+1. Creating a Team
+2. Instantiating a Team object from Synapse
+3. Getting information about the members of a Team
+4. Inviting a user to a Team
+5. Checking on invitations to join a Team
+6. Deleting a Team
+"""
+
+import asyncio
+
+from synapseclient.models.team import Team
+import synapseclient
+
+
+syn = synapseclient.Synapse(debug=True)
+syn.login()
+
+
+async def new_team():
+    # Create a team
+    new_team = Team(
+        name="python-client-test-team",
+        description="testing OOP interface",
+        can_public_join=False,
+    )
+    my_synapse_team = await new_team.create()
+    print(my_synapse_team)
+
+    # Instantiate a Team object from a Synapse team
+    my_team = await Team.from_id(id=my_synapse_team.id)
+    print(my_team)
+
+    # Sleep because the API for retrieving a team by name is eventually consistent. from_id works right away, however.
+    await asyncio.sleep(5)
+    my_team = await Team.from_name(name=my_synapse_team.name)
+    print(my_team)
+
+    # Refresh the team to get the latest information
+    await my_team.get()
+    print(my_team)
+
+    # Get information about the members of a Team
+    members = await my_team.members()
+    print(members)
+
+    # Invite a user to a Team
+    invite = await my_team.invite(
+        user="test_account_synapse_client",
+        message="testing OOP interface (do not accept)",
+    )
+    print(invite)
+
+    # Get open invitations for the Team
+    invitations = await my_team.open_invitations()
+    print(invitations)
+
+    # Delete the Team
+    await my_team.delete()
+
+
+asyncio.run(new_team())