version 3.27.0

slackapi · Feb 13, 2024 · 60b02d6 · 60b02d6
1 parent 74febaf
commit 60b02d6
Show file tree

Hide file tree

Showing 10 changed files with 1,149 additions and 82 deletions.
diff --git a/docs/api-docs/slack_sdk/audit_logs/v1/logs.html b/docs/api-docs/slack_sdk/audit_logs/v1/logs.html
diff --git a/docs/api-docs/slack_sdk/models/basic_objects.html b/docs/api-docs/slack_sdk/models/basic_objects.html
@@ -292,6 +292,7 @@ <h3>Subclasses</h3>
 <li><a title="slack_sdk.models.blocks.basic_components.DispatchActionConfig" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.DispatchActionConfig">DispatchActionConfig</a></li>
 <li><a title="slack_sdk.models.blocks.basic_components.Option" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.Option">Option</a></li>
 <li><a title="slack_sdk.models.blocks.basic_components.OptionGroup" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.OptionGroup">OptionGroup</a></li>
+<li><a title="slack_sdk.models.blocks.basic_components.SlackFile" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.SlackFile">SlackFile</a></li>
 <li><a title="slack_sdk.models.blocks.basic_components.TextObject" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a></li>
 <li><a title="slack_sdk.models.blocks.basic_components.Workflow" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.Workflow">Workflow</a></li>
 <li><a title="slack_sdk.models.blocks.basic_components.WorkflowTrigger" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.WorkflowTrigger">WorkflowTrigger</a></li>

diff --git a/docs/api-docs/slack_sdk/models/blocks/basic_components.html b/docs/api-docs/slack_sdk/models/blocks/basic_components.html
@@ -586,6 +586,35 @@ <h1 class="title">Module <code>slack_sdk.models.blocks.basic_components</code></
             json[&#34;trigger&#34;] = self._trigger.to_dict()
         else:
             json[&#34;trigger&#34;] = self._trigger
+        return json
+
+
+class SlackFile(JsonObject):
+    attributes = {&#34;id&#34;, &#34;url&#34;}
+
+    def __init__(
+        self,
+        *,
+        id: Optional[str] = None,
+        url: Optional[str] = None,
+    ):
+        &#34;&#34;&#34;An object containing Slack file information to be used in an image block or image element.
+        https://api.slack.com/reference/block-kit/composition-objects#slack_file
+
+        Args:
+            id: Slack ID of the file.
+            url: This URL can be the url_private or the permalink of the Slack file.
+        &#34;&#34;&#34;
+        self._id = id
+        self._url = url
+
+    def to_dict(self) -&gt; Dict[str, Any]:  # skipcq: PYL-W0221
+        self.validate_json()
+        json = {}
+        if self._id is not None:
+            json[&#34;id&#34;] = self._id
+        if self._url is not None:
+            json[&#34;url&#34;] = self._url
         return json</code></pre>
 </details>
 </section>
@@ -1706,6 +1735,70 @@ <h3>Inherited members</h3>
 </li>
 </ul>
 </dd>
+<dt id="slack_sdk.models.blocks.basic_components.SlackFile"><code class="flex name class">
+<span>class <span class="ident">SlackFile</span></span>
+<span>(</span><span>*, id: Optional[str] = None, url: Optional[str] = None)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>The base class for JSON serializable class objects</p>
+<p>An object containing Slack file information to be used in an image block or image element.
+<a href="https://api.slack.com/reference/block-kit/composition-objects#slack_file">https://api.slack.com/reference/block-kit/composition-objects#slack_file</a></p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>id</code></strong></dt>
+<dd>Slack ID of the file.</dd>
+<dt><strong><code>url</code></strong></dt>
+<dd>This URL can be the url_private or the permalink of the Slack file.</dd>
+</dl></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class SlackFile(JsonObject):
+    attributes = {&#34;id&#34;, &#34;url&#34;}
+
+    def __init__(
+        self,
+        *,
+        id: Optional[str] = None,
+        url: Optional[str] = None,
+    ):
+        &#34;&#34;&#34;An object containing Slack file information to be used in an image block or image element.
+        https://api.slack.com/reference/block-kit/composition-objects#slack_file
+
+        Args:
+            id: Slack ID of the file.
+            url: This URL can be the url_private or the permalink of the Slack file.
+        &#34;&#34;&#34;
+        self._id = id
+        self._url = url
+
+    def to_dict(self) -&gt; Dict[str, Any]:  # skipcq: PYL-W0221
+        self.validate_json()
+        json = {}
+        if self._id is not None:
+            json[&#34;id&#34;] = self._id
+        if self._url is not None:
+            json[&#34;url&#34;] = self._url
+        return json</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li><a title="slack_sdk.models.basic_objects.JsonObject" href="../basic_objects.html#slack_sdk.models.basic_objects.JsonObject">JsonObject</a></li>
+<li><a title="slack_sdk.models.basic_objects.BaseObject" href="../basic_objects.html#slack_sdk.models.basic_objects.BaseObject">BaseObject</a></li>
+</ul>
+<h3>Inherited members</h3>
+<ul class="hlist">
+<li><code><b><a title="slack_sdk.models.basic_objects.JsonObject" href="../basic_objects.html#slack_sdk.models.basic_objects.JsonObject">JsonObject</a></b></code>:
+<ul class="hlist">
+<li><code><a title="slack_sdk.models.basic_objects.JsonObject.attributes" href="../basic_objects.html#slack_sdk.models.basic_objects.JsonObject.attributes">attributes</a></code></li>
+<li><code><a title="slack_sdk.models.basic_objects.JsonObject.get_non_null_attributes" href="../basic_objects.html#slack_sdk.models.basic_objects.JsonObject.get_non_null_attributes">get_non_null_attributes</a></code></li>
+<li><code><a title="slack_sdk.models.basic_objects.JsonObject.to_dict" href="../basic_objects.html#slack_sdk.models.basic_objects.JsonObject.to_dict">to_dict</a></code></li>
+<li><code><a title="slack_sdk.models.basic_objects.JsonObject.validate_json" href="../basic_objects.html#slack_sdk.models.basic_objects.JsonObject.validate_json">validate_json</a></code></li>
+</ul>
+</li>
+</ul>
+</dd>
 <dt id="slack_sdk.models.blocks.basic_components.TextObject"><code class="flex name class">
 <span>class <span class="ident">TextObject</span></span>
 <span>(</span><span>text: str, type: Optional[str] = None, subtype: Optional[str] = None, emoji: Optional[bool] = None, **kwargs)</span>
@@ -2022,6 +2115,9 @@ <h4><code><a title="slack_sdk.models.blocks.basic_components.PlainTextObject" hr
 </ul>
 </li>
 <li>
+<h4><code><a title="slack_sdk.models.blocks.basic_components.SlackFile" href="#slack_sdk.models.blocks.basic_components.SlackFile">SlackFile</a></code></h4>
+</li>
+<li>
 <h4><code><a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a></code></h4>
 <ul class="">
 <li><code><a title="slack_sdk.models.blocks.basic_components.TextObject.logger" href="#slack_sdk.models.blocks.basic_components.TextObject.logger">logger</a></code></li>

diff --git a/docs/api-docs/slack_sdk/models/blocks/block_elements.html b/docs/api-docs/slack_sdk/models/blocks/block_elements.html
@@ -39,7 +39,7 @@ <h1 class="title">Module <code>slack_sdk.models.blocks.block_elements</code></h1
     JsonValidator,
     EnumValidator,
 )
-from .basic_components import ButtonStyles, Workflow
+from .basic_components import ButtonStyles, Workflow, SlackFile
 from .basic_components import ConfirmObject
 from .basic_components import DispatchActionConfig
 from .basic_components import MarkdownTextObject
@@ -579,13 +579,14 @@ <h1 class="title">Module <code>slack_sdk.models.blocks.block_elements</code></h1
 
     @property
     def attributes(self) -&gt; Set[str]:
-        return super().attributes.union({&#34;alt_text&#34;, &#34;image_url&#34;})
+        return super().attributes.union({&#34;alt_text&#34;, &#34;image_url&#34;, &#34;slack_file&#34;})
 
     def __init__(
         self,
         *,
-        image_url: Optional[str] = None,
         alt_text: Optional[str] = None,
+        image_url: Optional[str] = None,
+        slack_file: Optional[Union[Dict[str, Any], SlackFile]] = None,
         **others: dict,
     ):
         &#34;&#34;&#34;An element to insert an image - this element can be used in section and
@@ -594,18 +595,20 @@ <h1 class="title">Module <code>slack_sdk.models.blocks.block_elements</code></h1
         https://api.slack.com/reference/block-kit/block-elements#image
 
         Args:
-            image_url (required): The URL of the image to be displayed.
             alt_text (required): A plain-text summary of the image. This should not contain any markup.
+            image_url: The URL of the image to be displayed.
+            slack_file: A Slack image file object that defines the source of the image.
         &#34;&#34;&#34;
         super().__init__(type=self.type)
         show_unknown_key_warning(self, others)
 
         self.image_url = image_url
         self.alt_text = alt_text
+        self.slack_file = slack_file if slack_file is None or isinstance(slack_file, SlackFile) else SlackFile(**slack_file)
 
     @JsonValidator(f&#34;image_url attribute cannot exceed {image_url_max_length} characters&#34;)
     def _validate_image_url_length(self) -&gt; bool:
-        return len(self.image_url) &lt;= self.image_url_max_length
+        return self.image_url is None or len(self.image_url) &lt;= self.image_url_max_length
 
     @JsonValidator(f&#34;alt_text attribute cannot exceed {alt_text_max_length} characters&#34;)
     def _validate_alt_text_length(self) -&gt; bool:
@@ -3974,7 +3977,7 @@ <h3>Inherited members</h3>
 </dd>
 <dt id="slack_sdk.models.blocks.block_elements.ImageElement"><code class="flex name class">
 <span>class <span class="ident">ImageElement</span></span>
-<span>(</span><span>*, image_url: Optional[str] = None, alt_text: Optional[str] = None, **others: dict)</span>
+<span>(</span><span>*, alt_text: Optional[str] = None, image_url: Optional[str] = None, slack_file: Union[Dict[str, Any], <a title="slack_sdk.models.blocks.basic_components.SlackFile" href="basic_components.html#slack_sdk.models.blocks.basic_components.SlackFile">SlackFile</a>, ForwardRef(None)] = None, **others: dict)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Block Elements are things that exists inside of your Blocks.
@@ -3985,10 +3988,12 @@ <h3>Inherited members</h3>
 <a href="https://api.slack.com/reference/block-kit/block-elements#image">https://api.slack.com/reference/block-kit/block-elements#image</a></p>
 <h2 id="args">Args</h2>
 <dl>
-<dt><strong><code>image_url</code></strong> :&ensp;<code>required</code></dt>
-<dd>The URL of the image to be displayed.</dd>
 <dt><strong><code>alt_text</code></strong> :&ensp;<code>required</code></dt>
 <dd>A plain-text summary of the image. This should not contain any markup.</dd>
+<dt><strong><code>image_url</code></strong></dt>
+<dd>The URL of the image to be displayed.</dd>
+<dt><strong><code>slack_file</code></strong></dt>
+<dd>A Slack image file object that defines the source of the image.</dd>
 </dl></div>
 <details class="source">
 <summary>
@@ -4001,13 +4006,14 @@ <h2 id="args">Args</h2>
 
     @property
     def attributes(self) -&gt; Set[str]:
-        return super().attributes.union({&#34;alt_text&#34;, &#34;image_url&#34;})
+        return super().attributes.union({&#34;alt_text&#34;, &#34;image_url&#34;, &#34;slack_file&#34;})
 
     def __init__(
         self,
         *,
-        image_url: Optional[str] = None,
         alt_text: Optional[str] = None,
+        image_url: Optional[str] = None,
+        slack_file: Optional[Union[Dict[str, Any], SlackFile]] = None,
         **others: dict,
     ):
         &#34;&#34;&#34;An element to insert an image - this element can be used in section and
@@ -4016,18 +4022,20 @@ <h2 id="args">Args</h2>
         https://api.slack.com/reference/block-kit/block-elements#image
 
         Args:
-            image_url (required): The URL of the image to be displayed.
             alt_text (required): A plain-text summary of the image. This should not contain any markup.
+            image_url: The URL of the image to be displayed.
+            slack_file: A Slack image file object that defines the source of the image.
         &#34;&#34;&#34;
         super().__init__(type=self.type)
         show_unknown_key_warning(self, others)
 
         self.image_url = image_url
         self.alt_text = alt_text
+        self.slack_file = slack_file if slack_file is None or isinstance(slack_file, SlackFile) else SlackFile(**slack_file)
 
     @JsonValidator(f&#34;image_url attribute cannot exceed {image_url_max_length} characters&#34;)
     def _validate_image_url_length(self) -&gt; bool:
-        return len(self.image_url) &lt;= self.image_url_max_length
+        return self.image_url is None or len(self.image_url) &lt;= self.image_url_max_length
 
     @JsonValidator(f&#34;alt_text attribute cannot exceed {alt_text_max_length} characters&#34;)
     def _validate_alt_text_length(self) -&gt; bool:
@@ -4067,7 +4075,7 @@ <h3>Instance variables</h3>
 </summary>
 <pre><code class="python">@property
 def attributes(self) -&gt; Set[str]:
-    return super().attributes.union({&#34;alt_text&#34;, &#34;image_url&#34;})</code></pre>
+    return super().attributes.union({&#34;alt_text&#34;, &#34;image_url&#34;, &#34;slack_file&#34;})</code></pre>
 </details>
 </dd>
 </dl>