Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/authorization/authorize_result.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_bolt.authorization.authorize_result.AuthorizeResult"><code class="flex name class">
<span>class <span class="ident">AuthorizeResult</span></span>
<span>(</span><span>*,<br>enterprise_id: str | None,<br>team_id: str | None,<br>team: str | None = None,<br>url: str | None = None,<br>bot_user_id: str | None = None,<br>bot_id: str | None = None,<br>bot_token: str | None = None,<br>bot_scopes: str | Sequence[str] | None = None,<br>user_id: str | None = None,<br>user: str | None = None,<br>user_token: str | None = None,<br>user_scopes: str | Sequence[str] | None = None)</span>
<span>(</span><span>*,<br>enterprise_id: str | None,<br>team_id: str | None,<br>team: str | None = None,<br>url: str | None = None,<br>bot_user_id: str | None = None,<br>bot_id: str | None = None,<br>bot_token: str | None = None,<br>bot_scopes: Sequence[str] | str | None = None,<br>user_id: str | None = None,<br>user: str | None = None,<br>user_token: str | None = None,<br>user_scopes: Sequence[str] | str | None = None)</span>
</code></dt>
<dd>
<details class="source">
Expand Down Expand Up @@ -246,7 +246,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_bolt.authorization.authorize_result.AuthorizeResult.from_auth_test_response"><code class="name flex">
<span>def <span class="ident">from_auth_test_response</span></span>(<span>*,<br>bot_token: str | None = None,<br>user_token: str | None = None,<br>bot_scopes: str | Sequence[str] | None = None,<br>user_scopes: str | Sequence[str] | None = None,<br>auth_test_response: slack_sdk.web.slack_response.SlackResponse | ForwardRef('AsyncSlackResponse'),<br>user_auth_test_response: slack_sdk.web.slack_response.SlackResponse | ForwardRef('AsyncSlackResponse') | None = None)</span>
<span>def <span class="ident">from_auth_test_response</span></span>(<span>*,<br>bot_token: str | None = None,<br>user_token: str | None = None,<br>bot_scopes: Sequence[str] | str | None = None,<br>user_scopes: Sequence[str] | str | None = None,<br>auth_test_response: slack_sdk.web.slack_response.SlackResponse | AsyncSlackResponse,<br>user_auth_test_response: slack_sdk.web.slack_response.SlackResponse | AsyncSlackResponse | None = None)</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/authorization/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_bolt.authorization.AuthorizeResult"><code class="flex name class">
<span>class <span class="ident">AuthorizeResult</span></span>
<span>(</span><span>*,<br>enterprise_id: str | None,<br>team_id: str | None,<br>team: str | None = None,<br>url: str | None = None,<br>bot_user_id: str | None = None,<br>bot_id: str | None = None,<br>bot_token: str | None = None,<br>bot_scopes: str | Sequence[str] | None = None,<br>user_id: str | None = None,<br>user: str | None = None,<br>user_token: str | None = None,<br>user_scopes: str | Sequence[str] | None = None)</span>
<span>(</span><span>*,<br>enterprise_id: str | None,<br>team_id: str | None,<br>team: str | None = None,<br>url: str | None = None,<br>bot_user_id: str | None = None,<br>bot_id: str | None = None,<br>bot_token: str | None = None,<br>bot_scopes: Sequence[str] | str | None = None,<br>user_id: str | None = None,<br>user: str | None = None,<br>user_token: str | None = None,<br>user_scopes: Sequence[str] | str | None = None)</span>
</code></dt>
<dd>
<details class="source">
Expand Down Expand Up @@ -273,7 +273,7 @@ <h3>Class variables</h3>
<h3>Static methods</h3>
<dl>
<dt id="slack_bolt.authorization.AuthorizeResult.from_auth_test_response"><code class="name flex">
<span>def <span class="ident">from_auth_test_response</span></span>(<span>*,<br>bot_token: str | None = None,<br>user_token: str | None = None,<br>bot_scopes: str | Sequence[str] | None = None,<br>user_scopes: str | Sequence[str] | None = None,<br>auth_test_response: slack_sdk.web.slack_response.SlackResponse | ForwardRef('AsyncSlackResponse'),<br>user_auth_test_response: slack_sdk.web.slack_response.SlackResponse | ForwardRef('AsyncSlackResponse') | None = None)</span>
<span>def <span class="ident">from_auth_test_response</span></span>(<span>*,<br>bot_token: str | None = None,<br>user_token: str | None = None,<br>bot_scopes: Sequence[str] | str | None = None,<br>user_scopes: Sequence[str] | str | None = None,<br>auth_test_response: slack_sdk.web.slack_response.SlackResponse | AsyncSlackResponse,<br>user_auth_test_response: slack_sdk.web.slack_response.SlackResponse | AsyncSlackResponse | None = None)</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_bolt.context.assistant.thread_context_store.file.FileAssistantThreadContextStore"><code class="flex name class">
<span>class <span class="ident">FileAssistantThreadContextStore</span></span>
<span>(</span><span>base_dir: str = '/Users/eden.zimbelman/.bolt-app-assistant-thread-contexts')</span>
<span>(</span><span>base_dir: str = '/Users/wbergamin/.bolt-app-assistant-thread-contexts')</span>
</code></dt>
<dd>
<details class="source">
Expand Down
40 changes: 39 additions & 1 deletion docs/reference/context/complete/async_complete.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<pre><code class="python">class AsyncComplete:
client: AsyncWebClient
function_execution_id: Optional[str]
_called: bool

def __init__(
self,
Expand All @@ -66,6 +67,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
):
self.client = client
self.function_execution_id = function_execution_id
self._called = False

async def __call__(self, outputs: Optional[Dict[str, Any]] = None) -&gt; AsyncSlackResponse:
&#34;&#34;&#34;Signal the successful completion of the custom function.
Expand All @@ -82,9 +84,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if self.function_execution_id is None:
raise ValueError(&#34;complete is unsupported here as there is no function_execution_id&#34;)

self._called = True
return await self.client.functions_completeSuccess(
function_execution_id=self.function_execution_id, outputs=outputs or {}
)</code></pre>
)

def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this complete function has been called.

Returns:
bool: True if the complete function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"></div>
<h3>Class variables</h3>
Expand All @@ -98,6 +109,32 @@ <h3>Class variables</h3>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_bolt.context.complete.async_complete.AsyncComplete.has_been_called"><code class="name flex">
<span>def <span class="ident">has_been_called</span></span>(<span>self) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this complete function has been called.

Returns:
bool: True if the complete function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"><p>Check if this complete function has been called.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>bool</code></dt>
<dd>True if the complete function has been called, False otherwise.</dd>
</dl></div>
</dd>
</dl>
</dd>
</dl>
</section>
Expand All @@ -119,6 +156,7 @@ <h4><code><a title="slack_bolt.context.complete.async_complete.AsyncComplete" hr
<ul class="">
<li><code><a title="slack_bolt.context.complete.async_complete.AsyncComplete.client" href="#slack_bolt.context.complete.async_complete.AsyncComplete.client">client</a></code></li>
<li><code><a title="slack_bolt.context.complete.async_complete.AsyncComplete.function_execution_id" href="#slack_bolt.context.complete.async_complete.AsyncComplete.function_execution_id">function_execution_id</a></code></li>
<li><code><a title="slack_bolt.context.complete.async_complete.AsyncComplete.has_been_called" href="#slack_bolt.context.complete.async_complete.AsyncComplete.has_been_called">has_been_called</a></code></li>
</ul>
</li>
</ul>
Expand Down
40 changes: 39 additions & 1 deletion docs/reference/context/complete/complete.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<pre><code class="python">class Complete:
client: WebClient
function_execution_id: Optional[str]
_called: bool

def __init__(
self,
Expand All @@ -66,6 +67,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
):
self.client = client
self.function_execution_id = function_execution_id
self._called = False

def __call__(self, outputs: Optional[Dict[str, Any]] = None) -&gt; SlackResponse:
&#34;&#34;&#34;Signal the successful completion of the custom function.
Expand All @@ -82,7 +84,16 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if self.function_execution_id is None:
raise ValueError(&#34;complete is unsupported here as there is no function_execution_id&#34;)

return self.client.functions_completeSuccess(function_execution_id=self.function_execution_id, outputs=outputs or {})</code></pre>
self._called = True
return self.client.functions_completeSuccess(function_execution_id=self.function_execution_id, outputs=outputs or {})

def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this complete function has been called.

Returns:
bool: True if the complete function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"></div>
<h3>Class variables</h3>
Expand All @@ -96,6 +107,32 @@ <h3>Class variables</h3>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_bolt.context.complete.complete.Complete.has_been_called"><code class="name flex">
<span>def <span class="ident">has_been_called</span></span>(<span>self) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this complete function has been called.

Returns:
bool: True if the complete function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"><p>Check if this complete function has been called.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>bool</code></dt>
<dd>True if the complete function has been called, False otherwise.</dd>
</dl></div>
</dd>
</dl>
</dd>
</dl>
</section>
Expand All @@ -117,6 +154,7 @@ <h4><code><a title="slack_bolt.context.complete.complete.Complete" href="#slack_
<ul class="">
<li><code><a title="slack_bolt.context.complete.complete.Complete.client" href="#slack_bolt.context.complete.complete.Complete.client">client</a></code></li>
<li><code><a title="slack_bolt.context.complete.complete.Complete.function_execution_id" href="#slack_bolt.context.complete.complete.Complete.function_execution_id">function_execution_id</a></code></li>
<li><code><a title="slack_bolt.context.complete.complete.Complete.has_been_called" href="#slack_bolt.context.complete.complete.Complete.has_been_called">has_been_called</a></code></li>
</ul>
</li>
</ul>
Expand Down
40 changes: 39 additions & 1 deletion docs/reference/context/complete/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<pre><code class="python">class Complete:
client: WebClient
function_execution_id: Optional[str]
_called: bool

def __init__(
self,
Expand All @@ -77,6 +78,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
):
self.client = client
self.function_execution_id = function_execution_id
self._called = False

def __call__(self, outputs: Optional[Dict[str, Any]] = None) -&gt; SlackResponse:
&#34;&#34;&#34;Signal the successful completion of the custom function.
Expand All @@ -93,7 +95,16 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if self.function_execution_id is None:
raise ValueError(&#34;complete is unsupported here as there is no function_execution_id&#34;)

return self.client.functions_completeSuccess(function_execution_id=self.function_execution_id, outputs=outputs or {})</code></pre>
self._called = True
return self.client.functions_completeSuccess(function_execution_id=self.function_execution_id, outputs=outputs or {})

def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this complete function has been called.

Returns:
bool: True if the complete function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"></div>
<h3>Class variables</h3>
Expand All @@ -107,6 +118,32 @@ <h3>Class variables</h3>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_bolt.context.complete.Complete.has_been_called"><code class="name flex">
<span>def <span class="ident">has_been_called</span></span>(<span>self) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this complete function has been called.

Returns:
bool: True if the complete function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"><p>Check if this complete function has been called.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>bool</code></dt>
<dd>True if the complete function has been called, False otherwise.</dd>
</dl></div>
</dd>
</dl>
</dd>
</dl>
</section>
Expand Down Expand Up @@ -134,6 +171,7 @@ <h4><code><a title="slack_bolt.context.complete.Complete" href="#slack_bolt.cont
<ul class="">
<li><code><a title="slack_bolt.context.complete.Complete.client" href="#slack_bolt.context.complete.Complete.client">client</a></code></li>
<li><code><a title="slack_bolt.context.complete.Complete.function_execution_id" href="#slack_bolt.context.complete.Complete.function_execution_id">function_execution_id</a></code></li>
<li><code><a title="slack_bolt.context.complete.Complete.has_been_called" href="#slack_bolt.context.complete.Complete.has_been_called">has_been_called</a></code></li>
</ul>
</li>
</ul>
Expand Down
40 changes: 39 additions & 1 deletion docs/reference/context/fail/async_fail.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<pre><code class="python">class AsyncFail:
client: AsyncWebClient
function_execution_id: Optional[str]
_called: bool

def __init__(
self,
Expand All @@ -66,6 +67,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
):
self.client = client
self.function_execution_id = function_execution_id
self._called = False

async def __call__(self, error: str) -&gt; AsyncSlackResponse:
&#34;&#34;&#34;Signal that the custom function failed to complete.
Expand All @@ -82,7 +84,16 @@ <h2 class="section-title" id="header-classes">Classes</h2>
if self.function_execution_id is None:
raise ValueError(&#34;fail is unsupported here as there is no function_execution_id&#34;)

return await self.client.functions_completeError(function_execution_id=self.function_execution_id, error=error)</code></pre>
self._called = True
return await self.client.functions_completeError(function_execution_id=self.function_execution_id, error=error)

def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this fail function has been called.

Returns:
bool: True if the fail function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"></div>
<h3>Class variables</h3>
Expand All @@ -96,6 +107,32 @@ <h3>Class variables</h3>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="slack_bolt.context.fail.async_fail.AsyncFail.has_been_called"><code class="name flex">
<span>def <span class="ident">has_been_called</span></span>(<span>self) ‑> bool</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def has_been_called(self) -&gt; bool:
&#34;&#34;&#34;Check if this fail function has been called.

Returns:
bool: True if the fail function has been called, False otherwise.
&#34;&#34;&#34;
return self._called</code></pre>
</details>
<div class="desc"><p>Check if this fail function has been called.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>bool</code></dt>
<dd>True if the fail function has been called, False otherwise.</dd>
</dl></div>
</dd>
</dl>
</dd>
</dl>
</section>
Expand All @@ -117,6 +154,7 @@ <h4><code><a title="slack_bolt.context.fail.async_fail.AsyncFail" href="#slack_b
<ul class="">
<li><code><a title="slack_bolt.context.fail.async_fail.AsyncFail.client" href="#slack_bolt.context.fail.async_fail.AsyncFail.client">client</a></code></li>
<li><code><a title="slack_bolt.context.fail.async_fail.AsyncFail.function_execution_id" href="#slack_bolt.context.fail.async_fail.AsyncFail.function_execution_id">function_execution_id</a></code></li>
<li><code><a title="slack_bolt.context.fail.async_fail.AsyncFail.has_been_called" href="#slack_bolt.context.fail.async_fail.AsyncFail.has_been_called">has_been_called</a></code></li>
</ul>
</li>
</ul>
Expand Down
Loading
Loading