9090<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.list_rules"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.list_rules()</span></code></a></li>
9191<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.make_action"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.make_action()</span></code></a></li>
9292<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.make_condition"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.make_condition()</span></code></a></li>
93- <li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.make_payload_template"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.make_payload_template()</span></code></a></li>
9493<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.make_webhook_action"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.make_webhook_action()</span></code></a></li>
9594<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.reset_detector"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.reset_detector()</span></code></a></li>
9695<li class="toctree-l3"><a class="reference internal" href="#groundlight.ExperimentalApi.update_detector_escalation_type"><code class="docutils literal notranslate"><span class="pre">ExperimentalApi.update_detector_escalation_type()</span></code></a></li>
@@ -1866,23 +1865,9 @@ <h1>SDK Client<a class="headerlink" href="#sdk-client" title="Link to this headi
18661865</dl>
18671866</dd></dl>
18681867
1869- <dl class="py method">
1870- <dt class="sig sig-object py" id="groundlight.ExperimentalApi.make_payload_template">
1871- <span class="sig-name descname"><span class="pre">make_payload_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template</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"><span class="pre">PayloadTemplate</span></span></span><a class="headerlink" href="#groundlight.ExperimentalApi.make_payload_template" title="Link to this definition"></a></dt>
1872- <dd><p>Creates a PayloadTemplate object for use in creating alerts</p>
1873- <dl class="field-list simple">
1874- <dt class="field-odd">Parameters<span class="colon">:</span></dt>
1875- <dd class="field-odd"><p><strong>template</strong> (<em>str</em>)</p>
1876- </dd>
1877- <dt class="field-even">Return type<span class="colon">:</span></dt>
1878- <dd class="field-even"><p><em>PayloadTemplate</em></p>
1879- </dd>
1880- </dl>
1881- </dd></dl>
1882-
18831868<dl class="py method">
18841869<dt class="sig sig-object py" id="groundlight.ExperimentalApi.make_webhook_action">
1885- <span class="sig-name descname"><span class="pre">make_webhook_action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</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="n"><span class="pre">include_image</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PayloadTemplate</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">WebhookAction</span></span></span><a class="headerlink" href="#groundlight.ExperimentalApi.make_webhook_action" title="Link to this definition"></a></dt>
1870+ <span class="sig-name descname"><span class="pre">make_webhook_action</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</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="n"><span class="pre">include_image</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</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">WebhookAction</span></span></span><a class="headerlink" href="#groundlight.ExperimentalApi.make_webhook_action" title="Link to this definition"></a></dt>
18861871<dd><p>Creates a WebhookAction object for use in creating alerts
18871872This function serves as a convenience method; WebhookAction objects can also be created directly.
18881873<strong>Example usage</strong>:</p>
@@ -1896,9 +1881,6 @@ <h1>SDK Client<a class="headerlink" href="#sdk-client" title="Link to this headi
18961881<dd class="field-odd"><ul class="simple">
18971882<li><p><strong>url</strong> (<em>str</em>) – The URL to send the webhook to</p></li>
18981883<li><p><strong>include_image</strong> (<em>bool</em>) – Whether to include the triggering image in the webhook payload</p></li>
1899- <li><p><strong>payload_template</strong> (<em>PayloadTemplate</em><em> | </em><em>None</em>) – Optional custom template for the webhook payload. The template will be rendered with
1900- the alert data. The template must be a valid Jinja2 template which produces valid JSON when rendered. If no
1901- template is provided, the default template designed for Slack will be used.</p></li>
19021884</ul>
19031885</dd>
19041886<dt class="field-even">Return type<span class="colon">:</span></dt>
@@ -3739,19 +3721,6 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
37393721<span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Condition"</span><span class="p">,</span>
37403722<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span>
37413723<span class="w"> </span><span class="p">},</span>
3742- <span class="w"> </span><span class="nt">"PayloadTemplate"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3743- <span class="w"> </span><span class="nt">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3744- <span class="w"> </span><span class="nt">"template"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3745- <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Template"</span><span class="p">,</span>
3746- <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span>
3747- <span class="w"> </span><span class="p">}</span>
3748- <span class="w"> </span><span class="p">},</span>
3749- <span class="w"> </span><span class="nt">"required"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
3750- <span class="w"> </span><span class="s2">"template"</span>
3751- <span class="w"> </span><span class="p">],</span>
3752- <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayloadTemplate"</span><span class="p">,</span>
3753- <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span>
3754- <span class="w"> </span><span class="p">},</span>
37553724<span class="w"> </span><span class="nt">"SnoozeTimeUnitEnum"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
37563725<span class="w"> </span><span class="nt">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"* `DAYS` - DAYS\n* `HOURS` - HOURS\n* `MINUTES` - MINUTES\n* `SECONDS` - SECONDS"</span><span class="p">,</span>
37573726<span class="w"> </span><span class="nt">"enum"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
@@ -3794,17 +3763,6 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
37943763<span class="w"> </span><span class="p">],</span>
37953764<span class="w"> </span><span class="nt">"default"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
37963765<span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Include Image"</span>
3797- <span class="w"> </span><span class="p">},</span>
3798- <span class="w"> </span><span class="nt">"payload_template"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3799- <span class="w"> </span><span class="nt">"anyOf"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
3800- <span class="w"> </span><span class="p">{</span>
3801- <span class="w"> </span><span class="nt">"$ref"</span><span class="p">:</span><span class="w"> </span><span class="s2">"#/$defs/PayloadTemplate"</span>
3802- <span class="w"> </span><span class="p">},</span>
3803- <span class="w"> </span><span class="p">{</span>
3804- <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"null"</span>
3805- <span class="w"> </span><span class="p">}</span>
3806- <span class="w"> </span><span class="p">],</span>
3807- <span class="w"> </span><span class="nt">"default"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span>
38083766<span class="w"> </span><span class="p">}</span>
38093767<span class="w"> </span><span class="p">},</span>
38103768<span class="w"> </span><span class="nt">"required"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
@@ -4024,19 +3982,6 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
40243982<span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Condition"</span><span class="p">,</span>
40253983<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span>
40263984<span class="w"> </span><span class="p">},</span>
4027- <span class="w"> </span><span class="nt">"PayloadTemplate"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
4028- <span class="w"> </span><span class="nt">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
4029- <span class="w"> </span><span class="nt">"template"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
4030- <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Template"</span><span class="p">,</span>
4031- <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span>
4032- <span class="w"> </span><span class="p">}</span>
4033- <span class="w"> </span><span class="p">},</span>
4034- <span class="w"> </span><span class="nt">"required"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
4035- <span class="w"> </span><span class="s2">"template"</span>
4036- <span class="w"> </span><span class="p">],</span>
4037- <span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PayloadTemplate"</span><span class="p">,</span>
4038- <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span>
4039- <span class="w"> </span><span class="p">},</span>
40403985<span class="w"> </span><span class="nt">"Rule"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
40413986<span class="w"> </span><span class="nt">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
40423987<span class="w"> </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
@@ -4167,17 +4112,6 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
41674112<span class="w"> </span><span class="p">],</span>
41684113<span class="w"> </span><span class="nt">"default"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
41694114<span class="w"> </span><span class="nt">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Include Image"</span>
4170- <span class="w"> </span><span class="p">},</span>
4171- <span class="w"> </span><span class="nt">"payload_template"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
4172- <span class="w"> </span><span class="nt">"anyOf"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
4173- <span class="w"> </span><span class="p">{</span>
4174- <span class="w"> </span><span class="nt">"$ref"</span><span class="p">:</span><span class="w"> </span><span class="s2">"#/$defs/PayloadTemplate"</span>
4175- <span class="w"> </span><span class="p">},</span>
4176- <span class="w"> </span><span class="p">{</span>
4177- <span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"null"</span>
4178- <span class="w"> </span><span class="p">}</span>
4179- <span class="w"> </span><span class="p">],</span>
4180- <span class="w"> </span><span class="nt">"default"</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span>
41814115<span class="w"> </span><span class="p">}</span>
41824116<span class="w"> </span><span class="p">},</span>
41834117<span class="w"> </span><span class="nt">"required"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments