Add pagination helper for team memberships (#1851)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> dc9ee45

datadog_api_client.v2.api.html

@@ -1287,6 +1287,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_memberships()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_memberships_with_pagination()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_permission_settings" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_permission_settings()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_user_memberships" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_user_memberships()</span></code></a>
@@ -2830,6 +2832,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_memberships()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_memberships_with_pagination()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_permission_settings" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_permission_settings()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_user_memberships" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_user_memberships()</span></code></a>
@@ -8335,6 +8339,29 @@ <h1 id="datadog-api-client-v2-api--page-root">datadog_api_client.v2.api<a class=
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships_with_pagination">
+<span class="sig-name descname"><span class="pre">get_team_memberships_with_pagination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">team_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.get_team_memberships_sort.GetTeamMembershipsSort" title="datadog_api_client.v2.model.get_team_memberships_sort.GetTeamMembershipsSort"><span class="pre">GetTeamMembershipsSort</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_keyword</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.user_team.UserTeam" title="datadog_api_client.v2.model.user_team.UserTeam"><span class="pre">UserTeam</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships_with_pagination" title="Link to this definition">¶</a></dt>
+<dd><p>Get team memberships.</p>
+<p>Provide a paginated version of <a class="reference internal" href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships" title="datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_team_memberships()</span></code></a>, returning all items.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>team_id</strong> (<em>str</em>) – None</p></li>
+<li><p><strong>page_size</strong> (<em>int</em><em>, </em><em>optional</em>) – Size for a given page. The maximum allowed value is 100.</p></li>
+<li><p><strong>page_number</strong> (<em>int</em><em>, </em><em>optional</em>) – Specific page number to return.</p></li>
+<li><p><strong>sort</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.get_team_memberships_sort.GetTeamMembershipsSort" title="datadog_api_client.v2.model.get_team_memberships_sort.GetTeamMembershipsSort"><em>GetTeamMembershipsSort</em></a><em>, </em><em>optional</em>) – Specifies the order of returned team memberships</p></li>
+<li><p><strong>filter_keyword</strong> (<em>str</em><em>, </em><em>optional</em>) – Search query, can be user email or name</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A generator of paginated results.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>collections.abc.Iterable[<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.user_team.UserTeam" title="datadog_api_client.v2.model.user_team.UserTeam">UserTeam</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.teams_api.TeamsApi.get_team_permission_settings">
 <span class="sig-name descname"><span class="pre">get_team_permission_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">team_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_permission_settings_response.TeamPermissionSettingsResponse" title="datadog_api_client.v2.model.team_permission_settings_response.TeamPermissionSettingsResponse"><span class="pre">TeamPermissionSettingsResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_permission_settings" title="Link to this definition">¶</a></dt>
 <dd><p>Get permission settings for a team.</p>

datadog_api_client.v2.html

@@ -1530,6 +1530,7 @@ <h1 id="datadog-api-client-v2--page-root">datadog_api_client.v2<a class="headerl
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_link()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_links"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_links()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_memberships()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships_with_pagination"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_memberships_with_pagination()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_permission_settings"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_team_permission_settings()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_user_memberships"><code class="docutils literal notranslate"><span class="pre">TeamsApi.get_user_memberships()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.list_teams"><code class="docutils literal notranslate"><span class="pre">TeamsApi.list_teams()</span></code></a></li>

genindex.html

@@ -18809,6 +18809,8 @@ <h2 id="G">G</h2>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_links">get_team_links() (TeamsApi method)</a>
 </li>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships">get_team_memberships() (TeamsApi method)</a>
+</li>
+      <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_memberships_with_pagination">get_team_memberships_with_pagination() (TeamsApi method)</a>
 </li>
       <li><a href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.get_team_permission_settings">get_team_permission_settings() (TeamsApi method)</a>
 </li>