Started test cases, fixed admins API schema inconsistency

Author: 0xRy4n

docs/intercom_python_sdk/apis/admins/api.html

@@ -35,7 +35,7 @@ <h1 id="admins-api">Admins API</h1>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">&#34;&#34;&#34; 
+<pre><code class="python">&#34;&#34;&#34;
 # Admins API
 
 `apis/admins/api.py`
@@ -49,22 +49,20 @@ <h1 id="admins-api">Admins API</h1>
 &#34;&#34;&#34;
 
 # Built-ins
-import functools
-from typing import Union, cast
+from typing import Union
 
 # External
 from uplink import (
-    get, put, post, 
-    returns, args,
-    error_handler, response_handler,
-    Field, Body, json, Url, Path, Query
+    get, put,
+    returns, json,
+    response_handler,
+    Body
 )
 
 # From Current API
 from .schemas import (
-    AdminSchema, 
+    AdminSchema,
     AdminListSchema,
-    TeamPriorityLevelSchema
 )
 from .models import Admin, AdminList
 
@@ -79,18 +77,18 @@ <h1 id="admins-api">Admins API</h1>
     &#34;&#34;&#34; Admins API Client. &#34;&#34;&#34;
     URI = &#34;/admins/&#34;
 
-    @returns(AdminSchema) # type: ignore
-    @get(&#34;/me&#34;) # We are adding a leading slash here because we actually WANT to ignore the /admins URI in this case.
+    @returns(AdminSchema)  # type: ignore
+    @get(&#34;/me&#34;)  # We are adding a leading slash here because we actually WANT to ignore the /admins URI in this case.
     def me(self):
-        &#34;&#34;&#34; Get the current admin user. 
-        
+        &#34;&#34;&#34; Get the current admin user.
+
         Returns:
             Admin: The current admin user.
         &#34;&#34;&#34;
 
-    @returns(AdminSchema) # type: ignore
+    @returns(AdminSchema)  # type: ignore
     @put(&#34;{admin_id}/away&#34;)
-    def __set_away_by_id(self, admin_id: Union[str, int], data: Body(type=dict)): # type: ignore
+    def __set_away_by_id(self, admin_id: Union[str, int], data: Body(type=dict)):  # type: ignore
         &#34;&#34;&#34; Set the away status of an admin. Internal method for `set_away_by_id`.&#34;&#34;&#34;
 
     def set_away_by_id(self, admin_id: Union[str, int], away: bool = True, reassign: bool = True):
@@ -104,21 +102,21 @@ <h1 id="admins-api">Admins API</h1>
         Returns:
             HTTPResponse: The response from the API.
         &#34;&#34;&#34;
-        return self.__set_away_by_id(admin_id, {&#34;away_mode_enabled&#34;:away, &#34;away_mode_reassign&#34;:reassign})
-    
-    @returns(AdminListSchema) # type: ignore
+        return self.__set_away_by_id(admin_id, {&#34;away_mode_enabled&#34;: away, &#34;away_mode_reassign&#34;: reassign})
+
+    @returns(AdminListSchema)  # type: ignore
     @get(&#34;&#34;)
     def list_admins(self):
-        &#34;&#34;&#34; List all admins. 
-        
+        &#34;&#34;&#34; List all admins.
+
         Returns:
             AdminList: The list of admins.
         &#34;&#34;&#34;
 
-    @returns(AdminSchema) # type: ignore
+    @returns(AdminSchema)  # type: ignore
     @get(&#34;{admin_id}&#34;)
     def get_admin_by_id(self, admin_id: Union[str, int]):
-        &#34;&#34;&#34; Get an admin by ID. 
+        &#34;&#34;&#34; Get an admin by ID.
 
         Args:
             admin_id (Union[str, int]): The ID of the admin.
@@ -132,14 +130,13 @@ <h1 id="admins-api">Admins API</h1>
 
         Args:
             email (str): The email of the admin.
-        
+
         Returns:
             Admin: The matching Admin object. None if no match found.
         &#34;&#34;&#34;
         admins_list = self.list_admins()
-        for admin in admins_list.admins: # type: ignore
-            if admin.email == email:
-                return admin
+        admins_list.admins = [admin for admin in admins_list.admins if admin.email == email]  # type: ignore
+        return admins_list.admins[0] if admins_list.admins else None
 
     def get_admins_by_team_id(self, team_id: Union[int, str]) -&gt; AdminList:
         &#34;&#34;&#34; Get all admins by team ID.
@@ -151,15 +148,8 @@ <h1 id="admins-api">Admins API</h1>
             AdminList: The list of admins. None if no match found.
         &#34;&#34;&#34;
         admins_list = self.list_admins()
-
-        # Loop over list in reverse so we can delete from the list as we go.
-        for index, admin in reversed(list(enumerate(admins_list.admins))): # type: ignore
-            if team_id not in admin.team_ids:
-                del admins_list.admins[index]
-
-        return admins_list
-    
-    </code></pre>
+        admins_list.admins = [admin for admin in admins_list.admins if team_id in admin.team_ids]  # type: ignore
+        return admins_list</code></pre>
 </details>
 </section>
 <section>
@@ -195,18 +185,18 @@ <h2 id="args">Args</h2>
     &#34;&#34;&#34; Admins API Client. &#34;&#34;&#34;
     URI = &#34;/admins/&#34;
 
-    @returns(AdminSchema) # type: ignore
-    @get(&#34;/me&#34;) # We are adding a leading slash here because we actually WANT to ignore the /admins URI in this case.
+    @returns(AdminSchema)  # type: ignore
+    @get(&#34;/me&#34;)  # We are adding a leading slash here because we actually WANT to ignore the /admins URI in this case.
     def me(self):
-        &#34;&#34;&#34; Get the current admin user. 
-        
+        &#34;&#34;&#34; Get the current admin user.
+
         Returns:
             Admin: The current admin user.
         &#34;&#34;&#34;
 
-    @returns(AdminSchema) # type: ignore
+    @returns(AdminSchema)  # type: ignore
     @put(&#34;{admin_id}/away&#34;)
-    def __set_away_by_id(self, admin_id: Union[str, int], data: Body(type=dict)): # type: ignore
+    def __set_away_by_id(self, admin_id: Union[str, int], data: Body(type=dict)):  # type: ignore
         &#34;&#34;&#34; Set the away status of an admin. Internal method for `set_away_by_id`.&#34;&#34;&#34;
 
     def set_away_by_id(self, admin_id: Union[str, int], away: bool = True, reassign: bool = True):
@@ -220,21 +210,21 @@ <h2 id="args">Args</h2>
         Returns:
             HTTPResponse: The response from the API.
         &#34;&#34;&#34;
-        return self.__set_away_by_id(admin_id, {&#34;away_mode_enabled&#34;:away, &#34;away_mode_reassign&#34;:reassign})
-    
-    @returns(AdminListSchema) # type: ignore
+        return self.__set_away_by_id(admin_id, {&#34;away_mode_enabled&#34;: away, &#34;away_mode_reassign&#34;: reassign})
+
+    @returns(AdminListSchema)  # type: ignore
     @get(&#34;&#34;)
     def list_admins(self):
-        &#34;&#34;&#34; List all admins. 
-        
+        &#34;&#34;&#34; List all admins.
+
         Returns:
             AdminList: The list of admins.
         &#34;&#34;&#34;
 
-    @returns(AdminSchema) # type: ignore
+    @returns(AdminSchema)  # type: ignore
     @get(&#34;{admin_id}&#34;)
     def get_admin_by_id(self, admin_id: Union[str, int]):
-        &#34;&#34;&#34; Get an admin by ID. 
+        &#34;&#34;&#34; Get an admin by ID.
 
         Args:
             admin_id (Union[str, int]): The ID of the admin.
@@ -248,14 +238,13 @@ <h2 id="args">Args</h2>
 
         Args:
             email (str): The email of the admin.
-        
+
         Returns:
             Admin: The matching Admin object. None if no match found.
         &#34;&#34;&#34;
         admins_list = self.list_admins()
-        for admin in admins_list.admins: # type: ignore
-            if admin.email == email:
-                return admin
+        admins_list.admins = [admin for admin in admins_list.admins if admin.email == email]  # type: ignore
+        return admins_list.admins[0] if admins_list.admins else None
 
     def get_admins_by_team_id(self, team_id: Union[int, str]) -&gt; AdminList:
         &#34;&#34;&#34; Get all admins by team ID.
@@ -267,12 +256,7 @@ <h2 id="args">Args</h2>
             AdminList: The list of admins. None if no match found.
         &#34;&#34;&#34;
         admins_list = self.list_admins()
-
-        # Loop over list in reverse so we can delete from the list as we go.
-        for index, admin in reversed(list(enumerate(admins_list.admins))): # type: ignore
-            if team_id not in admin.team_ids:
-                del admins_list.admins[index]
-
+        admins_list.admins = [admin for admin in admins_list.admins if team_id in admin.team_ids]  # type: ignore
         return admins_list</code></pre>
 </details>
 <h3>Ancestors</h3>
@@ -315,21 +299,20 @@ <h2 id="returns">Returns</h2>
 
     Args:
         email (str): The email of the admin.
-    
+
     Returns:
         Admin: The matching Admin object. None if no match found.
     &#34;&#34;&#34;
     admins_list = self.list_admins()
-    for admin in admins_list.admins: # type: ignore
-        if admin.email == email:
-            return admin</code></pre>
+    admins_list.admins = [admin for admin in admins_list.admins if admin.email == email]  # type: ignore
+    return admins_list.admins[0] if admins_list.admins else None</code></pre>
 </details>
 </dd>
 <dt id="intercom_python_sdk.apis.admins.api.AdminsAPI.get_admin_by_id"><code class="name flex">
 <span>def <span class="ident">get_admin_by_id</span></span>(<span>self, admin_id: Union[str, int])</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Get an admin by ID. </p>
+<div class="desc"><p>Get an admin by ID.</p>
 <h2 id="args">Args</h2>
 <dl>
 <dt><strong><code>admin_id</code></strong> :&ensp;<code>Union[str, int]</code></dt>
@@ -344,10 +327,10 @@ <h2 id="returns">Returns</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">@returns(AdminSchema) # type: ignore
+<pre><code class="python">@returns(AdminSchema)  # type: ignore
 @get(&#34;{admin_id}&#34;)
 def get_admin_by_id(self, admin_id: Union[str, int]):
-    &#34;&#34;&#34; Get an admin by ID. 
+    &#34;&#34;&#34; Get an admin by ID.
 
     Args:
         admin_id (Union[str, int]): The ID of the admin.
@@ -386,20 +369,15 @@ <h2 id="returns">Returns</h2>
         AdminList: The list of admins. None if no match found.
     &#34;&#34;&#34;
     admins_list = self.list_admins()
-
-    # Loop over list in reverse so we can delete from the list as we go.
-    for index, admin in reversed(list(enumerate(admins_list.admins))): # type: ignore
-        if team_id not in admin.team_ids:
-            del admins_list.admins[index]
-
+    admins_list.admins = [admin for admin in admins_list.admins if team_id in admin.team_ids]  # type: ignore
     return admins_list</code></pre>
 </details>
 </dd>
 <dt id="intercom_python_sdk.apis.admins.api.AdminsAPI.list_admins"><code class="name flex">
 <span>def <span class="ident">list_admins</span></span>(<span>self)</span>
 </code></dt>
 <dd>
-<div class="desc"><p>List all admins. </p>
+<div class="desc"><p>List all admins.</p>
 <h2 id="returns">Returns</h2>
 <dl>
 <dt><code>AdminList</code></dt>
@@ -409,11 +387,11 @@ <h2 id="returns">Returns</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">@returns(AdminListSchema) # type: ignore
+<pre><code class="python">@returns(AdminListSchema)  # type: ignore
 @get(&#34;&#34;)
 def list_admins(self):
-    &#34;&#34;&#34; List all admins. 
-    
+    &#34;&#34;&#34; List all admins.
+
     Returns:
         AdminList: The list of admins.
     &#34;&#34;&#34;</code></pre>
@@ -423,7 +401,7 @@ <h2 id="returns">Returns</h2>
 <span>def <span class="ident">me</span></span>(<span>self)</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Get the current admin user. </p>
+<div class="desc"><p>Get the current admin user.</p>
 <h2 id="returns">Returns</h2>
 <dl>
 <dt><code>Admin</code></dt>
@@ -433,11 +411,11 @@ <h2 id="returns">Returns</h2>
 <summary>
 <span>Expand source code</span>
 </summary>
-<pre><code class="python">@returns(AdminSchema) # type: ignore
-@get(&#34;/me&#34;) # We are adding a leading slash here because we actually WANT to ignore the /admins URI in this case.
+<pre><code class="python">@returns(AdminSchema)  # type: ignore
+@get(&#34;/me&#34;)  # We are adding a leading slash here because we actually WANT to ignore the /admins URI in this case.
 def me(self):
-    &#34;&#34;&#34; Get the current admin user. 
-    
+    &#34;&#34;&#34; Get the current admin user.
+
     Returns:
         Admin: The current admin user.
     &#34;&#34;&#34;</code></pre>
@@ -477,7 +455,7 @@ <h2 id="returns">Returns</h2>
     Returns:
         HTTPResponse: The response from the API.
     &#34;&#34;&#34;
-    return self.__set_away_by_id(admin_id, {&#34;away_mode_enabled&#34;:away, &#34;away_mode_reassign&#34;:reassign})</code></pre>
+    return self.__set_away_by_id(admin_id, {&#34;away_mode_enabled&#34;: away, &#34;away_mode_reassign&#34;: reassign})</code></pre>
 </details>
 </dd>
 </dl>