Skip to content

Commit

Permalink
Deploying to gh-pages from @ 170c8b2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartc committed Nov 7, 2024
1 parent 9129840 commit 287d817
Show file tree
Hide file tree
Showing 53 changed files with 664 additions and 664 deletions.
142 changes: 71 additions & 71 deletions Lightning.Accounts.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions Lightning.AdaptorRegistry.Npm.html
Original file line number Diff line number Diff line change
Expand Up @@ -1690,14 +1690,14 @@ <h1 class="signature" translate="no">request(request)</h1>
</a>
<span class="text">Examples</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="1464241522-1">%</span><span class="nc" data-group-id="1464241522-1">HTTPoison.Request</span><span class="p" data-group-id="1464241522-1">{</span><span class="w">
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p" data-group-id="8523871551-1">%</span><span class="nc" data-group-id="8523871551-1">HTTPoison.Request</span><span class="p" data-group-id="8523871551-1">{</span><span class="w">
</span><span class="ss">method</span><span class="p">:</span><span class="w"> </span><span class="ss">:post</span><span class="p">,</span><span class="w">
</span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">body</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">headers</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1464241522-2">[</span><span class="p" data-group-id="1464241522-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="1464241522-3">}</span><span class="p" data-group-id="1464241522-2">]</span><span class="w">
</span><span class="p" data-group-id="1464241522-1">}</span><span class="w">
</span><span class="ss">headers</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8523871551-2">[</span><span class="p" data-group-id="8523871551-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="8523871551-3">}</span><span class="p" data-group-id="8523871551-2">]</span><span class="w">
</span><span class="p" data-group-id="8523871551-1">}</span><span class="w">

</span><span class="n">request</span><span class="p" data-group-id="1464241522-4">(</span><span class="n">request</span><span class="p" data-group-id="1464241522-4">)</span></code></pre>
</span><span class="n">request</span><span class="p" data-group-id="8523871551-4">(</span><span class="n">request</span><span class="p" data-group-id="8523871551-4">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/5">
Expand Down Expand Up @@ -1755,7 +1755,7 @@ <h1 class="signature" translate="no">request(method, url, body \\ &quot;&quot;,
</a>
<span class="text">Examples</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="6553074668-1">(</span><span class="ss">:post</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6553074668-2">[</span><span class="p" data-group-id="6553074668-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="6553074668-3">}</span><span class="p" data-group-id="6553074668-2">]</span><span class="p" data-group-id="6553074668-1">)</span></code></pre>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="0090474231-1">(</span><span class="ss">:post</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;https://my.website.com&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;{</span><span class="se">\&quot;</span><span class="s">foo</span><span class="se">\&quot;</span><span class="s">: 3}&quot;</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0090474231-2">[</span><span class="p" data-group-id="0090474231-3">{</span><span class="s">&quot;Accept&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;application/json&quot;</span><span class="p" data-group-id="0090474231-3">}</span><span class="p" data-group-id="0090474231-2">]</span><span class="p" data-group-id="0090474231-1">)</span></code></pre>
</section>
</section>
<section class="detail" id="request!/1">
Expand Down
12 changes: 6 additions & 6 deletions Lightning.AdaptorRegistry.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,9 @@ <h1>
<p>Registry process to query and maintain a list of adaptors available for
writing jobs.</p><p>Currently it queries NPM for all modules in the <code class="inline">@openfn</code> organization and
filters out modules that are known not to be adaptors.</p><p><strong>Usage</strong></p><pre><code class="makeup elixir" translate="no"><span class="c1"># Starting the process</span><span class="w">
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="7578961888-1">(</span><span class="p" data-group-id="7578961888-1">)</span><span class="w">
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="4888859305-1">(</span><span class="p" data-group-id="4888859305-1">)</span><span class="w">
</span><span class="c1"># Getting a list of all adaptors</span><span class="w">
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="7578961888-2">(</span><span class="p" data-group-id="7578961888-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="4888859305-2">(</span><span class="p" data-group-id="4888859305-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
This does mean that the first call to the process will be delayed until
the <code class="inline">handle_continue/2</code> has finished.</p><p><strong>Timeouts</strong></p><p>There is a 'general' timeout of 30s, this is used for GenServer calls like
<a href="#all/1"><code class="inline">all/1</code></a> and also internally when the modules are being queried. NPM can
Expand Down Expand Up @@ -432,10 +432,10 @@ <h1 class="signature" translate="no">resolve_package_name(package_name)</h1>

</div>

<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="4998298789-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="4998298789-1">)</span><span class="w">
</span><span class="p" data-group-id="4998298789-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="4998298789-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="4998298789-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="4998298789-3">)</span><span class="w">
</span><span class="p" data-group-id="4998298789-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="4998298789-4">}</span></code></pre>
<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="4069141459-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="4069141459-1">)</span><span class="w">
</span><span class="p" data-group-id="4069141459-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="4069141459-2">}</span><span class="w">
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="4069141459-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="4069141459-3">)</span><span class="w">
</span><span class="p" data-group-id="4069141459-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="4069141459-4">}</span></code></pre>
</section>
</section>
<section class="detail" id="resolve_package_name!/1">
Expand Down
4 changes: 2 additions & 2 deletions Lightning.AiAssistant.html
Original file line number Diff line number Diff line change
Expand Up @@ -508,8 +508,8 @@ <h1 class="signature" translate="no">query(session, content)</h1>

</div>

<p>Queries the AI assistant with the given content.</p><p>Returns <code class="inline">{:ok, session}</code> if the query was successful, otherwise <code class="inline">:error</code>.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="nc">AiAssistant</span><span class="o">.</span><span class="n">query</span><span class="p" data-group-id="4918386890-1">(</span><span class="n">session</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;fn()&quot;</span><span class="p" data-group-id="4918386890-1">)</span><span class="w">
</span><span class="p" data-group-id="4918386890-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">session</span><span class="p" data-group-id="4918386890-2">}</span></code></pre>
<p>Queries the AI assistant with the given content.</p><p>Returns <code class="inline">{:ok, session}</code> if the query was successful, otherwise <code class="inline">:error</code>.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="nc">AiAssistant</span><span class="o">.</span><span class="n">query</span><span class="p" data-group-id="9522971122-1">(</span><span class="n">session</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;fn()&quot;</span><span class="p" data-group-id="9522971122-1">)</span><span class="w">
</span><span class="p" data-group-id="9522971122-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="n">session</span><span class="p" data-group-id="9522971122-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="save_message/2">
Expand Down
Loading

0 comments on commit 287d817

Please sign in to comment.