Skip to content

Commit

Permalink
Deploying to gh-pages from @ 828aeea 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartc committed Dec 2, 2024
1 parent 9984107 commit 39992d1
Show file tree
Hide file tree
Showing 57 changed files with 681 additions and 680 deletions.
2 changes: 1 addition & 1 deletion .build
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ dist/lato-latin-ext-300-normal-VPGGJKJL.woff2
dist/lato-latin-ext-400-normal-N27NCBWW.woff2
dist/lato-latin-ext-700-normal-Q2L5DVMW.woff2
dist/remixicon-NKANDIL5.woff2
dist/search_data-C43A9CA8.js
dist/search_data-953FE4C2.js
dist/sidebar_items-617E9EFB.js
index.html
provisioning.html
Expand Down
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 @@ -1692,14 +1692,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="5243276020-1">%</span><span class="nc" data-group-id="5243276020-1">HTTPoison.Request</span><span class="p" data-group-id="5243276020-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="1004220702-1">%</span><span class="nc" data-group-id="1004220702-1">HTTPoison.Request</span><span class="p" data-group-id="1004220702-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="5243276020-2">[</span><span class="p" data-group-id="5243276020-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="5243276020-3">}</span><span class="p" data-group-id="5243276020-2">]</span><span class="w">
</span><span class="p" data-group-id="5243276020-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="1004220702-2">[</span><span class="p" data-group-id="1004220702-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="1004220702-3">}</span><span class="p" data-group-id="1004220702-2">]</span><span class="w">
</span><span class="p" data-group-id="1004220702-1">}</span><span class="w">

</span><span class="n">request</span><span class="p" data-group-id="5243276020-4">(</span><span class="n">request</span><span class="p" data-group-id="5243276020-4">)</span></code></pre>
</span><span class="n">request</span><span class="p" data-group-id="1004220702-4">(</span><span class="n">request</span><span class="p" data-group-id="1004220702-4">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/5">
Expand Down Expand Up @@ -1757,7 +1757,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="0167698161-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="0167698161-2">[</span><span class="p" data-group-id="0167698161-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="0167698161-3">}</span><span class="p" data-group-id="0167698161-2">]</span><span class="p" data-group-id="0167698161-1">)</span></code></pre>
<pre><code class="makeup elixir" translate="no"><span class="n">request</span><span class="p" data-group-id="1624816769-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="1624816769-2">[</span><span class="p" data-group-id="1624816769-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="1624816769-3">}</span><span class="p" data-group-id="1624816769-2">]</span><span class="p" data-group-id="1624816769-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 @@ -141,9 +141,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="9303888535-1">(</span><span class="p" data-group-id="9303888535-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="4067462376-1">(</span><span class="p" data-group-id="4067462376-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="9303888535-2">(</span><span class="p" data-group-id="9303888535-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="4067462376-2">(</span><span class="p" data-group-id="4067462376-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 @@ -434,10 +434,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="2868971879-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="2868971879-1">)</span><span class="w">
</span><span class="p" data-group-id="2868971879-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="2868971879-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="2868971879-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="2868971879-3">)</span><span class="w">
</span><span class="p" data-group-id="2868971879-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="2868971879-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="3250712851-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="3250712851-1">)</span><span class="w">
</span><span class="p" data-group-id="3250712851-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="3250712851-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="3250712851-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="3250712851-3">)</span><span class="w">
</span><span class="p" data-group-id="3250712851-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="3250712851-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 @@ -510,8 +510,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="5387266685-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="5387266685-1">)</span><span class="w">
</span><span class="p" data-group-id="5387266685-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="5387266685-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="3026208480-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="3026208480-1">)</span><span class="w">
</span><span class="p" data-group-id="3026208480-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="3026208480-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="save_message/2">
Expand Down
Loading

0 comments on commit 39992d1

Please sign in to comment.