version 1.15.4

slackapi · Nov 17, 2022 · 48a793d · 48a793d
1 parent 157e7ea
commit 48a793d
Show file tree

Hide file tree

Showing 6 changed files with 144 additions and 10 deletions.
diff --git a/docs/api-docs/slack_bolt/logger/messages.html b/docs/api-docs/slack_bolt/logger/messages.html
@@ -38,7 +38,8 @@ <h1 class="title">Module <code>slack_bolt.logger.messages</code></h1>
     is_options,
     is_shortcut,
     is_slash_command,
-    is_view,
+    is_view_submission,
+    is_view_closed,
     is_workflow_step_edit,
     is_workflow_step_save,
     is_workflow_step_execute,
@@ -269,13 +270,24 @@ <h1 class="title">Module <code>slack_bolt.logger.messages</code></h1>
     logger.info(body)
 &#34;&#34;&#34;,
         )
-    if is_view(req.body):
+    if is_view_submission(req.body):
         # @app.view
         return _build_unhandled_request_suggestion(
             default_message,
             f&#34;&#34;&#34;
 @app.view(&#34;{req.body.get(&#39;view&#39;, {}).get(&#39;callback_id&#39;, &#39;modal-view-id&#39;)}&#34;)
-{&#39;async &#39; if is_async else &#39;&#39;}def handle_view_events(ack, body, logger):
+{&#39;async &#39; if is_async else &#39;&#39;}def handle_view_submission_events(ack, body, logger):
+    {&#39;await &#39; if is_async else &#39;&#39;}ack()
+    logger.info(body)
+&#34;&#34;&#34;,
+        )
+    if is_view_closed(req.body):
+        # @app.view
+        return _build_unhandled_request_suggestion(
+            default_message,
+            f&#34;&#34;&#34;
+@app.view_closed(&#34;{req.body.get(&#39;view&#39;, {}).get(&#39;callback_id&#39;, &#39;modal-view-id&#39;)}&#34;)
+{&#39;async &#39; if is_async else &#39;&#39;}def handle_view_closed_events(ack, body, logger):
     {&#39;await &#39; if is_async else &#39;&#39;}ack()
     logger.info(body)
 &#34;&#34;&#34;,
@@ -811,13 +823,24 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     logger.info(body)
 &#34;&#34;&#34;,
         )
-    if is_view(req.body):
+    if is_view_submission(req.body):
         # @app.view
         return _build_unhandled_request_suggestion(
             default_message,
             f&#34;&#34;&#34;
 @app.view(&#34;{req.body.get(&#39;view&#39;, {}).get(&#39;callback_id&#39;, &#39;modal-view-id&#39;)}&#34;)
-{&#39;async &#39; if is_async else &#39;&#39;}def handle_view_events(ack, body, logger):
+{&#39;async &#39; if is_async else &#39;&#39;}def handle_view_submission_events(ack, body, logger):
+    {&#39;await &#39; if is_async else &#39;&#39;}ack()
+    logger.info(body)
+&#34;&#34;&#34;,
+        )
+    if is_view_closed(req.body):
+        # @app.view
+        return _build_unhandled_request_suggestion(
+            default_message,
+            f&#34;&#34;&#34;
+@app.view_closed(&#34;{req.body.get(&#39;view&#39;, {}).get(&#39;callback_id&#39;, &#39;modal-view-id&#39;)}&#34;)
+{&#39;async &#39; if is_async else &#39;&#39;}def handle_view_closed_events(ack, body, logger):
     {&#39;await &#39; if is_async else &#39;&#39;}ack()
     logger.info(body)
 &#34;&#34;&#34;,

diff --git a/docs/api-docs/slack_bolt/version.html b/docs/api-docs/slack_bolt/version.html
@@ -28,7 +28,7 @@ <h1 class="title">Module <code>slack_bolt.version</code></h1>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;Check the latest version at https://pypi.org/project/slack-bolt/&#34;&#34;&#34;
-__version__ = &#34;1.15.2&#34;</code></pre>
+__version__ = &#34;1.15.4&#34;</code></pre>
 </details>
 </section>
 <section>

diff --git a/docs/api-docs/slack_bolt/workflows/step/async_step.html b/docs/api-docs/slack_bolt/workflows/step/async_step.html
@@ -336,6 +336,18 @@ <h1 class="title">Module <code>slack_bolt.workflows.step.async_step</code></h1>
         app_name: Optional[str] = None,
         base_logger: Optional[Logger] = None,
     ):
+        &#34;&#34;&#34;
+        Args:
+            callback_id: The callback_id for this workflow step
+            edit: Either a single function or a list of functions for opening a modal in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            save: Either a single function or a list of functions for handling modal interactions in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            execute: Either a single function or a list of functions for handling workflow step executions
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            app_name: The app name that can be mainly used for logging
+            base_logger: The logger instance that can be used as a template when creating this step&#39;s logger
+        &#34;&#34;&#34;
         self.callback_id = callback_id
         app_name = app_name or __name__
         self.edit = self.build_listener(
@@ -540,7 +552,24 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <span>(</span><span>*, callback_id: Union[str, Pattern], edit: Union[Callable[..., Awaitable[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.async_listener.AsyncListener" href="../../listener/async_listener.html#slack_bolt.listener.async_listener.AsyncListener">AsyncListener</a>, Sequence[Callable]], save: Union[Callable[..., Awaitable[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.async_listener.AsyncListener" href="../../listener/async_listener.html#slack_bolt.listener.async_listener.AsyncListener">AsyncListener</a>, Sequence[Callable]], execute: Union[Callable[..., Awaitable[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.async_listener.AsyncListener" href="../../listener/async_listener.html#slack_bolt.listener.async_listener.AsyncListener">AsyncListener</a>, Sequence[Callable]], app_name: Optional[str] = None, base_logger: Optional[logging.Logger] = None)</span>
 </code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>callback_id</code></strong></dt>
+<dd>The callback_id for this workflow step</dd>
+<dt><strong><code>edit</code></strong></dt>
+<dd>Either a single function or a list of functions for opening a modal in the builder UI
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>save</code></strong></dt>
+<dd>Either a single function or a list of functions for handling modal interactions in the builder UI
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>execute</code></strong></dt>
+<dd>Either a single function or a list of functions for handling workflow step executions
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>app_name</code></strong></dt>
+<dd>The app name that can be mainly used for logging</dd>
+<dt><strong><code>base_logger</code></strong></dt>
+<dd>The logger instance that can be used as a template when creating this step's logger</dd>
+</dl></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
@@ -565,6 +594,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         app_name: Optional[str] = None,
         base_logger: Optional[Logger] = None,
     ):
+        &#34;&#34;&#34;
+        Args:
+            callback_id: The callback_id for this workflow step
+            edit: Either a single function or a list of functions for opening a modal in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            save: Either a single function or a list of functions for handling modal interactions in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            execute: Either a single function or a list of functions for handling workflow step executions
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            app_name: The app name that can be mainly used for logging
+            base_logger: The logger instance that can be used as a template when creating this step&#39;s logger
+        &#34;&#34;&#34;
         self.callback_id = callback_id
         app_name = app_name or __name__
         self.edit = self.build_listener(

diff --git a/docs/api-docs/slack_bolt/workflows/step/index.html b/docs/api-docs/slack_bolt/workflows/step/index.html
@@ -390,7 +390,24 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <span>(</span><span>*, callback_id: Union[str, Pattern], edit: Union[Callable[..., Optional[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.listener.Listener" href="../../listener/listener.html#slack_bolt.listener.listener.Listener">Listener</a>, Sequence[Callable]], save: Union[Callable[..., Optional[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.listener.Listener" href="../../listener/listener.html#slack_bolt.listener.listener.Listener">Listener</a>, Sequence[Callable]], execute: Union[Callable[..., Optional[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.listener.Listener" href="../../listener/listener.html#slack_bolt.listener.listener.Listener">Listener</a>, Sequence[Callable]], app_name: Optional[str] = None, base_logger: Optional[logging.Logger] = None)</span>
 </code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>callback_id</code></strong></dt>
+<dd>The callback_id for this workflow step</dd>
+<dt><strong><code>edit</code></strong></dt>
+<dd>Either a single function or a list of functions for opening a modal in the builder UI
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>save</code></strong></dt>
+<dd>Either a single function or a list of functions for handling modal interactions in the builder UI
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>execute</code></strong></dt>
+<dd>Either a single function or a list of functions for handling workflow step executions
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>app_name</code></strong></dt>
+<dd>The app name that can be mainly used for logging</dd>
+<dt><strong><code>base_logger</code></strong></dt>
+<dd>The logger instance that can be used as a template when creating this step's logger</dd>
+</dl></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
@@ -415,6 +432,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         app_name: Optional[str] = None,
         base_logger: Optional[Logger] = None,
     ):
+        &#34;&#34;&#34;
+        Args:
+            callback_id: The callback_id for this workflow step
+            edit: Either a single function or a list of functions for opening a modal in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            save: Either a single function or a list of functions for handling modal interactions in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            execute: Either a single function or a list of functions for handling workflow step executions
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            app_name: The app name that can be mainly used for logging
+            base_logger: The logger instance that can be used as a template when creating this step&#39;s logger
+        &#34;&#34;&#34;
         self.callback_id = callback_id
         app_name = app_name or __name__
         self.edit = self.build_listener(

diff --git a/docs/api-docs/slack_bolt/workflows/step/step.html b/docs/api-docs/slack_bolt/workflows/step/step.html
@@ -347,6 +347,18 @@ <h1 class="title">Module <code>slack_bolt.workflows.step.step</code></h1>
         app_name: Optional[str] = None,
         base_logger: Optional[Logger] = None,
     ):
+        &#34;&#34;&#34;
+        Args:
+            callback_id: The callback_id for this workflow step
+            edit: Either a single function or a list of functions for opening a modal in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            save: Either a single function or a list of functions for handling modal interactions in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            execute: Either a single function or a list of functions for handling workflow step executions
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            app_name: The app name that can be mainly used for logging
+            base_logger: The logger instance that can be used as a template when creating this step&#39;s logger
+        &#34;&#34;&#34;
         self.callback_id = callback_id
         app_name = app_name or __name__
         self.edit = self.build_listener(
@@ -559,7 +571,24 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <span>(</span><span>*, callback_id: Union[str, Pattern], edit: Union[Callable[..., Optional[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.listener.Listener" href="../../listener/listener.html#slack_bolt.listener.listener.Listener">Listener</a>, Sequence[Callable]], save: Union[Callable[..., Optional[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.listener.Listener" href="../../listener/listener.html#slack_bolt.listener.listener.Listener">Listener</a>, Sequence[Callable]], execute: Union[Callable[..., Optional[<a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]], <a title="slack_bolt.listener.listener.Listener" href="../../listener/listener.html#slack_bolt.listener.listener.Listener">Listener</a>, Sequence[Callable]], app_name: Optional[str] = None, base_logger: Optional[logging.Logger] = None)</span>
 </code></dt>
 <dd>
-<div class="desc"></div>
+<div class="desc"><h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>callback_id</code></strong></dt>
+<dd>The callback_id for this workflow step</dd>
+<dt><strong><code>edit</code></strong></dt>
+<dd>Either a single function or a list of functions for opening a modal in the builder UI
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>save</code></strong></dt>
+<dd>Either a single function or a list of functions for handling modal interactions in the builder UI
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>execute</code></strong></dt>
+<dd>Either a single function or a list of functions for handling workflow step executions
+When it's a list, the first one is responsible for ack() while the rest are lazy listeners.</dd>
+<dt><strong><code>app_name</code></strong></dt>
+<dd>The app name that can be mainly used for logging</dd>
+<dt><strong><code>base_logger</code></strong></dt>
+<dd>The logger instance that can be used as a template when creating this step's logger</dd>
+</dl></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
@@ -584,6 +613,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         app_name: Optional[str] = None,
         base_logger: Optional[Logger] = None,
     ):
+        &#34;&#34;&#34;
+        Args:
+            callback_id: The callback_id for this workflow step
+            edit: Either a single function or a list of functions for opening a modal in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            save: Either a single function or a list of functions for handling modal interactions in the builder UI
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            execute: Either a single function or a list of functions for handling workflow step executions
+                When it&#39;s a list, the first one is responsible for ack() while the rest are lazy listeners.
+            app_name: The app name that can be mainly used for logging
+            base_logger: The logger instance that can be used as a template when creating this step&#39;s logger
+        &#34;&#34;&#34;
         self.callback_id = callback_id
         app_name = app_name or __name__
         self.edit = self.build_listener(

diff --git a/slack_bolt/version.py b/slack_bolt/version.py
@@ -1,2 +1,2 @@
 """Check the latest version at https://pypi.org/project/slack-bolt/"""
-__version__ = "1.15.3"
+__version__ = "1.15.4"