Add support for dashboard listing pagination parameters (#1646)

Co-authored-by: ci.datadog-api-spec <[email protected]> 85108b5

Author: api-clients-generation-pipeline[bot]

datadog_api_client.v1.api.html

@@ -353,6 +353,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.list_dashboards()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.list_dashboards_with_pagination()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.restore_dashboards" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.restore_dashboards()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.send_public_dashboard_invitation" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.send_public_dashboard_invitation()</span></code></a>
@@ -1646,6 +1648,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.list_dashboards()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards_with_pagination" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.list_dashboards_with_pagination()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.restore_dashboards" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.restore_dashboards()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.send_public_dashboard_invitation" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.send_public_dashboard_invitation()</span></code></a>
@@ -2860,7 +2864,7 @@ <h1 id="datadog-api-client-v1-api--page-root">datadog_api_client.v1.api<a class=
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards">
-<span class="sig-name descname"><span class="pre">list_dashboards</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_shared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">filter_deleted</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.dashboard_summary.DashboardSummary" title="datadog_api_client.v1.model.dashboard_summary.DashboardSummary"><span class="pre">DashboardSummary</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">list_dashboards</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_shared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">filter_deleted</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">count</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">start</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><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.v1.model.html#datadog_api_client.v1.model.dashboard_summary.DashboardSummary" title="datadog_api_client.v1.model.dashboard_summary.DashboardSummary"><span class="pre">DashboardSummary</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards" title="Link to this definition">¶</a></dt>
 <dd><p>Get all dashboards.</p>
 <p>Get all dashboards.</p>
 <p><strong>Note</strong> : This query will only return custom created or cloned dashboards.
@@ -2872,6 +2876,8 @@ <h1 id="datadog-api-client-v1-api--page-root">datadog_api_client.v1.api<a class=
 or cloned dashboards.</p></li>
 <li><p><strong>filter_deleted</strong> (<em>bool</em><em>, </em><em>optional</em>) – When <code class="docutils literal notranslate"><span class="pre">true</span></code> , this query returns only deleted custom-created
 or cloned dashboards. This parameter is incompatible with <code class="docutils literal notranslate"><span class="pre">filter[shared]</span></code>.</p></li>
+<li><p><strong>count</strong> (<em>int</em><em>, </em><em>optional</em>) – The maximum number of dashboards returned in the list.</p></li>
+<li><p><strong>start</strong> (<em>int</em><em>, </em><em>optional</em>) – The specific offset to use as the beginning of the returned response.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
@@ -2880,6 +2886,30 @@ <h1 id="datadog-api-client-v1-api--page-root">datadog_api_client.v1.api<a class=
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards_with_pagination">
+<span class="sig-name descname"><span class="pre">list_dashboards_with_pagination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filter_shared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">filter_deleted</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">count</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">start</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><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.v1.model.html#datadog_api_client.v1.model.dashboard_summary_definition.DashboardSummaryDefinition" title="datadog_api_client.v1.model.dashboard_summary_definition.DashboardSummaryDefinition"><span class="pre">DashboardSummaryDefinition</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards_with_pagination" title="Link to this definition">¶</a></dt>
+<dd><p>Get all dashboards.</p>
+<p>Provide a paginated version of <a class="reference internal" href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards" title="datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards"><code class="xref py py-meth docutils literal notranslate"><span class="pre">list_dashboards()</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>filter_shared</strong> (<em>bool</em><em>, </em><em>optional</em>) – When <code class="docutils literal notranslate"><span class="pre">true</span></code> , this query only returns shared custom created
+or cloned dashboards.</p></li>
+<li><p><strong>filter_deleted</strong> (<em>bool</em><em>, </em><em>optional</em>) – When <code class="docutils literal notranslate"><span class="pre">true</span></code> , this query returns only deleted custom-created
+or cloned dashboards. This parameter is incompatible with <code class="docutils literal notranslate"><span class="pre">filter[shared]</span></code>.</p></li>
+<li><p><strong>count</strong> (<em>int</em><em>, </em><em>optional</em>) – The maximum number of dashboards returned in the list.</p></li>
+<li><p><strong>start</strong> (<em>int</em><em>, </em><em>optional</em>) – The specific offset to use as the beginning of the returned response.</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.v1.model.html#datadog_api_client.v1.model.dashboard_summary_definition.DashboardSummaryDefinition" title="datadog_api_client.v1.model.dashboard_summary_definition.DashboardSummaryDefinition">DashboardSummaryDefinition</a>]</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v1.api.dashboards_api.DashboardsApi.restore_dashboards">
 <span class="sig-name descname"><span class="pre">restore_dashboards</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</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.v1.model.html#datadog_api_client.v1.model.dashboard_restore_request.DashboardRestoreRequest" title="datadog_api_client.v1.model.dashboard_restore_request.DashboardRestoreRequest"><span class="pre">DashboardRestoreRequest</span></a></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">None</span></span></span><a class="headerlink" href="#datadog_api_client.v1.api.dashboards_api.DashboardsApi.restore_dashboards" title="Link to this definition">¶</a></dt>
 <dd><p>Restore deleted dashboards.</p>

datadog_api_client.v1.html

@@ -1027,6 +1027,7 @@ <h1 id="datadog-api-client-v1--page-root">datadog_api_client.v1<a class="headerl
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.dashboards_api.DashboardsApi.get_public_dashboard"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.get_public_dashboard()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.dashboards_api.DashboardsApi.get_public_dashboard_invitations"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.get_public_dashboard_invitations()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.list_dashboards()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.dashboards_api.DashboardsApi.list_dashboards_with_pagination"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.list_dashboards_with_pagination()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.dashboards_api.DashboardsApi.restore_dashboards"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.restore_dashboards()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.dashboards_api.DashboardsApi.send_public_dashboard_invitation"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.send_public_dashboard_invitation()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.api.html#datadog_api_client.v1.api.dashboards_api.DashboardsApi.update_dashboard"><code class="docutils literal notranslate"><span class="pre">DashboardsApi.update_dashboard()</span></code></a></li>