deploy: 9a98f9c

Author: mattzcarey

available-tools/index.html

@@ -363,12 +363,14 @@
 <section id="mkdocs-terminal-content">
     <h1 id="available-tools">Available Tools<a class="headerlink" href="#available-tools" title="Anchor link to this section for reference">#</a></h1>
 <p>Get available tools from your StackOne organisation based on the account id.</p>
-<p>This example demonstrates different ways to filter and organize tools:
-1. Getting all available tools
-2. Filtering by vertical
-3. Using multiple patterns for cross-vertical functionality
-4. Filtering by specific operations
-5. Combining multiple operation patterns</p>
+<p>This example demonstrates different ways to filter and organize tools:</p>
+<ol>
+<li>Getting all available tools</li>
+<li>Filtering by vertical</li>
+<li>Using multiple patterns for cross-vertical functionality</li>
+<li>Filtering by specific operations</li>
+<li>Combining multiple operation patterns</li>
+</ol>
 <p>TODO: experimental - get_available_tools(account_id="your_account_id")</p>
 <div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>uv<span style="color: #A89028"> </span>run<span style="color: #A89028"> </span>examples/available_tools.py
 </code></pre></div>
@@ -381,17 +383,17 @@ <h1 id="available-tools">Available Tools<a class="headerlink" href="#available-t
 
 <span style="color: #2838B0">def</span><span style="color: #A89028"> </span><span style="color: #785840">get_available_tools</span><span style="color: #888">()</span> <span style="color: #666">-&gt;</span> <span style="color: #444; font-style: italic">None</span><span style="color: #888">:</span>
     toolset <span style="color: #666">=</span> StackOneToolSet<span style="color: #888">()</span>
-
-    <span style="color: #888; font-style: italic"># First, get all tools</span>
-    all_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">()</span>
+</code></pre></div>
+<p>We can get all tools using the <code>get_tools</code> method.</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>all_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">()</span>
     <span style="color: #2838B0">assert</span> <span style="color: #388038">len</span><span style="color: #888">(</span>all_tools<span style="color: #888">)</span> <span style="color: #666">&gt;</span> <span style="color: #444">100</span><span style="color: #888">,</span> <span style="color: #B83838">&quot;Expected at least 100 tools in total&quot;</span>
-
-    <span style="color: #888; font-style: italic"># Then, let&#39;s get just HRIS tools using a vertical filter</span>
-    hris_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;hris_*&quot;</span><span style="color: #888">)</span>
+</code></pre></div>
+<p>Then, let's get just HRIS tools using a filter. This filter accepts glob patterns.</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>hris_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;hris_*&quot;</span><span style="color: #888">)</span>
     <span style="color: #2838B0">assert</span> <span style="color: #388038">len</span><span style="color: #888">(</span>hris_tools<span style="color: #888">)</span> <span style="color: #666">&gt;</span> <span style="color: #444">10</span><span style="color: #888">,</span> <span style="color: #B83838">&quot;Expected at least 10 HRIS tools&quot;</span>
-
-    <span style="color: #888; font-style: italic"># Now, let&#39;s get people-related tools across verticals</span>
-    people_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span>
+</code></pre></div>
+<p>Filter with multiple patterns. This will return all tools that match either pattern (OR operator).</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>people_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span>
         <span style="color: #888">[</span>
             <span style="color: #B83838">&quot;hris_*employee*&quot;</span><span style="color: #888">,</span>
             <span style="color: #B83838">&quot;crm_*contact*&quot;</span><span style="color: #888">,</span>
@@ -402,21 +404,21 @@ <h1 id="available-tools">Available Tools<a class="headerlink" href="#available-t
         <span style="color: #2838B0">assert</span> <span style="color: #B83838">&quot;employee&quot;</span> <span style="color: #A848A8">in</span> tool<span style="color: #666">.</span>name <span style="color: #A848A8">or</span> <span style="color: #B83838">&quot;contact&quot;</span> <span style="color: #A848A8">in</span> tool<span style="color: #666">.</span>name<span style="color: #888">,</span> <span style="color: #888">(</span>
             <span style="color: #444">f</span><span style="color: #B83838">&quot;Tool </span><span style="color: #B83838; text-decoration: underline">{</span>tool<span style="color: #666">.</span>name<span style="color: #B83838; text-decoration: underline">}</span><span style="color: #B83838"> doesn&#39;t contain &#39;employee&#39; or &#39;contact&#39;&quot;</span>
         <span style="color: #888">)</span>
-
-    <span style="color: #888; font-style: italic"># We can also filter by specific operations across all verticals</span>
-    upload_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;*upload*&quot;</span><span style="color: #888">)</span>
+</code></pre></div>
+<p>Filter by specific operations across all verticals using a glob pattern.</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>upload_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;*upload*&quot;</span><span style="color: #888">)</span>
     <span style="color: #2838B0">assert</span> <span style="color: #388038">len</span><span style="color: #888">(</span>upload_tools<span style="color: #888">)</span> <span style="color: #666">&gt;</span> <span style="color: #444">0</span><span style="color: #888">,</span> <span style="color: #B83838">&quot;Expected at least one upload tool&quot;</span>
     <span style="color: #2838B0">for</span> tool <span style="color: #A848A8">in</span> upload_tools<span style="color: #888">:</span>
         <span style="color: #2838B0">assert</span> <span style="color: #B83838">&quot;upload&quot;</span> <span style="color: #A848A8">in</span> tool<span style="color: #666">.</span>name<span style="color: #666">.</span>lower<span style="color: #888">(),</span> <span style="color: #444">f</span><span style="color: #B83838">&quot;Tool </span><span style="color: #B83838; text-decoration: underline">{</span>tool<span style="color: #666">.</span>name<span style="color: #B83838; text-decoration: underline">}</span><span style="color: #B83838"> doesn&#39;t contain &#39;upload&#39;&quot;</span>
-
-    <span style="color: #888; font-style: italic"># Get all tools except HRIS</span>
-    non_hris_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;!hris_*&quot;</span><span style="color: #888">)</span>
+</code></pre></div>
+<p>The exclude pattern is also supported.</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>non_hris_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;!hris_*&quot;</span><span style="color: #888">)</span>
     <span style="color: #2838B0">assert</span> <span style="color: #388038">len</span><span style="color: #888">(</span>non_hris_tools<span style="color: #888">)</span> <span style="color: #666">&gt;</span> <span style="color: #444">0</span><span style="color: #888">,</span> <span style="color: #B83838">&quot;Expected at least one non-HRIS tool&quot;</span>
     <span style="color: #2838B0">for</span> tool <span style="color: #A848A8">in</span> non_hris_tools<span style="color: #888">:</span>
         <span style="color: #2838B0">assert</span> <span style="color: #A848A8">not</span> tool<span style="color: #666">.</span>name<span style="color: #666">.</span>startswith<span style="color: #888">(</span><span style="color: #B83838">&quot;hris_&quot;</span><span style="color: #888">),</span> <span style="color: #444">f</span><span style="color: #B83838">&quot;Tool </span><span style="color: #B83838; text-decoration: underline">{</span>tool<span style="color: #666">.</span>name<span style="color: #B83838; text-decoration: underline">}</span><span style="color: #B83838"> should not be an HRIS tool&quot;</span>
-
-    <span style="color: #888; font-style: italic"># Complex filtering with positive and negative patterns</span>
-    list_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span>
+</code></pre></div>
+<p>More hectic example:</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>list_tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span>
         <span style="color: #888">[</span>
             <span style="color: #B83838">&quot;*list*&quot;</span><span style="color: #888">,</span>  <span style="color: #888; font-style: italic"># Include list operations</span>
             <span style="color: #B83838">&quot;*search*&quot;</span><span style="color: #888">,</span>  <span style="color: #888; font-style: italic"># Include search operations</span>

error-handling/index.html

@@ -378,8 +378,9 @@ <h1 id="error-handling">Error Handling<a class="headerlink" href="#error-handlin
 
 
 <span style="color: #2838B0">def</span><span style="color: #A89028"> </span><span style="color: #785840">error_handling</span><span style="color: #888">()</span> <span style="color: #666">-&gt;</span> <span style="color: #444; font-style: italic">None</span><span style="color: #888">:</span>
-    <span style="color: #888; font-style: italic"># Example 1: Configuration error - missing API key</span>
-    original_api_key <span style="color: #666">=</span> os<span style="color: #666">.</span>environ<span style="color: #666">.</span>pop<span style="color: #888">(</span><span style="color: #B83838">&quot;STACKONE_API_KEY&quot;</span><span style="color: #888">,</span> <span style="color: #444; font-style: italic">None</span><span style="color: #888">)</span>
+</code></pre></div>
+<p>Example 1: Configuration error - missing API key</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>original_api_key <span style="color: #666">=</span> os<span style="color: #666">.</span>environ<span style="color: #666">.</span>pop<span style="color: #888">(</span><span style="color: #B83838">&quot;STACKONE_API_KEY&quot;</span><span style="color: #888">,</span> <span style="color: #444; font-style: italic">None</span><span style="color: #888">)</span>
     <span style="color: #2838B0">try</span><span style="color: #888">:</span>
         <span style="color: #2838B0">try</span><span style="color: #888">:</span>
             StackOneToolSet<span style="color: #888">(</span>api_key<span style="color: #666">=</span><span style="color: #444; font-style: italic">None</span><span style="color: #888">)</span>
@@ -392,19 +393,19 @@ <h1 id="error-handling">Error Handling<a class="headerlink" href="#error-handlin
     <span style="color: #2838B0">finally</span><span style="color: #888">:</span>
         <span style="color: #2838B0">if</span> original_api_key<span style="color: #888">:</span>
             os<span style="color: #666">.</span>environ<span style="color: #888">[</span><span style="color: #B83838">&quot;STACKONE_API_KEY&quot;</span><span style="color: #888">]</span> <span style="color: #666">=</span> original_api_key
-
-    <span style="color: #888; font-style: italic"># Example 2: Invalid vertical error</span>
-    toolset <span style="color: #666">=</span> StackOneToolSet<span style="color: #888">()</span>
+</code></pre></div>
+<p>Example 2: Invalid vertical error</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>toolset <span style="color: #666">=</span> StackOneToolSet<span style="color: #888">()</span>
     <span style="color: #2838B0">try</span><span style="color: #888">:</span>
         <span style="color: #888; font-style: italic"># Use a non-existent vertical to trigger error</span>
         tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;nonexistent_vertical_*&quot;</span><span style="color: #888">)</span>
         <span style="color: #888; font-style: italic"># If we get here, no tools were found but no error was raised</span>
         <span style="color: #2838B0">assert</span> <span style="color: #388038">len</span><span style="color: #888">(</span>tools<span style="color: #888">)</span> <span style="color: #666">==</span> <span style="color: #444">0</span><span style="color: #888">,</span> <span style="color: #B83838">&quot;Expected no tools for nonexistent vertical&quot;</span>
     <span style="color: #2838B0">except</span> ToolsetLoadError <span style="color: #2838B0">as</span> e<span style="color: #888">:</span>
         <span style="color: #2838B0">assert</span> <span style="color: #B83838">&quot;Error loading tools&quot;</span> <span style="color: #A848A8">in</span> <span style="color: #388038">str</span><span style="color: #888">(</span>e<span style="color: #888">)</span>
-
-    <span style="color: #888; font-style: italic"># Example 3: API error - invalid request</span>
-    toolset <span style="color: #666">=</span> StackOneToolSet<span style="color: #888">()</span>
+</code></pre></div>
+<p>Example 3: API error - invalid request</p>
+<div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>toolset <span style="color: #666">=</span> StackOneToolSet<span style="color: #888">()</span>
     tools <span style="color: #666">=</span> toolset<span style="color: #666">.</span>get_tools<span style="color: #888">(</span><span style="color: #B83838">&quot;crm_*&quot;</span><span style="color: #888">)</span>
 
     <span style="color: #888; font-style: italic"># Try to make an API call without required parameters</span>

file-uploads/index.html

@@ -380,7 +380,7 @@ <h1 id="file-uploads">File Uploads<a class="headerlink" href="#file-uploads" tit
 account_id <span style="color: #666">=</span> <span style="color: #B83838">&quot;45072196112816593343&quot;</span>
 employee_id <span style="color: #666">=</span> <span style="color: #B83838">&quot;c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA&quot;</span>
 </code></pre></div>
-<h2 id="resume-content">Resume content<a class="headerlink" href="#resume-content" title="Anchor link to this section for reference">#</a></h2>
+<h1 id="resume-content">Resume content<a class="headerlink" href="#resume-content" title="Anchor link to this section for reference">#</a></h1>
 <p>This is a sample resume content that will be uploaded to StackOne.</p>
 <div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code>resume_content <span style="color: #666">=</span> <span style="color: #B83838">&quot;&quot;&quot;</span>
 <span style="color: #B83838">        JOHN DOE</span>
@@ -397,7 +397,7 @@ <h2 id="resume-content">Resume content<a class="headerlink" href="#resume-conten
 <span style="color: #B83838">        University of Technology</span>
 <span style="color: #B83838">        2016-2020 &quot;&quot;&quot;</span>
 </code></pre></div>
-<h2 id="upload-employee-document">Upload employee document<a class="headerlink" href="#upload-employee-document" title="Anchor link to this section for reference">#</a></h2>
+<h1 id="upload-employee-document">Upload employee document<a class="headerlink" href="#upload-employee-document" title="Anchor link to this section for reference">#</a></h1>
 <p>This function uploads a resume using the <code>hris_upload_employee_document</code> tool.</p>
 <div class="highlight" style="background: #ffffff"><pre style="line-height: 125%;"><span></span><code><span style="color: #2838B0">def</span><span style="color: #A89028"> </span><span style="color: #785840">upload_employee_document</span><span style="color: #888">()</span> <span style="color: #666">-&gt;</span> <span style="color: #444; font-style: italic">None</span><span style="color: #888">:</span>
     <span style="color: #2838B0">with</span> tempfile<span style="color: #666">.</span>TemporaryDirectory<span style="color: #888">()</span> <span style="color: #2838B0">as</span> temp_dir<span style="color: #888">:</span>