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
2 changes: 1 addition & 1 deletion docs/reference/http_retry/async_handler.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ <h3>Static methods</h3>
</dd>
<dt id="slack_sdk.http_retry.async_handler.HttpResponse"><code class="flex name class">
<span>class <span class="ident">HttpResponse</span></span>
<span>(</span><span>*,<br>status_code: str | int,<br>headers: Dict[str, str | List[str]],<br>body: Dict[str, Any] | None = None,<br>data: bytes | None = None)</span>
<span>(</span><span>*,<br>status_code: int | str,<br>headers: Dict[str, str | List[str]],<br>body: Dict[str, Any] | None = None,<br>data: bytes | None = None)</span>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/http_retry/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ <h3>Static methods</h3>
</dd>
<dt id="slack_sdk.http_retry.HttpResponse"><code class="flex name class">
<span>class <span class="ident">HttpResponse</span></span>
<span>(</span><span>*,<br>status_code: str | int,<br>headers: Dict[str, str | List[str]],<br>body: Dict[str, Any] | None = None,<br>data: bytes | None = None)</span>
<span>(</span><span>*,<br>status_code: int | str,<br>headers: Dict[str, str | List[str]],<br>body: Dict[str, Any] | None = None,<br>data: bytes | None = None)</span>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/http_retry/response.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_sdk.http_retry.response.HttpResponse"><code class="flex name class">
<span>class <span class="ident">HttpResponse</span></span>
<span>(</span><span>*,<br>status_code: str | int,<br>headers: Dict[str, str | List[str]],<br>body: Dict[str, Any] | None = None,<br>data: bytes | None = None)</span>
<span>(</span><span>*,<br>status_code: int | str,<br>headers: Dict[str, str | List[str]],<br>body: Dict[str, Any] | None = None,<br>data: bytes | None = None)</span>
</code></dt>
<dd>
<details class="source">
Expand Down
702 changes: 698 additions & 4 deletions docs/reference/index.html

Large diffs are not rendered by default.

62 changes: 58 additions & 4 deletions docs/reference/models/basic_objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ <h3>Ancestors</h3>
if callable(method) and hasattr(method, &#34;validator&#34;):
method()

def get_object_attribute(self, key: str):
return getattr(self, key, None)

def get_non_null_attributes(self) -&gt; dict:
&#34;&#34;&#34;
Construct a dictionary out of non-null keys (from attributes property)
Expand All @@ -136,7 +139,7 @@ <h3>Ancestors</h3>
return value

def is_not_empty(self, key: str) -&gt; bool:
value = getattr(self, key, None)
value = self.get_object_attribute(key)
if value is None:
return False

Expand All @@ -154,7 +157,9 @@ <h3>Ancestors</h3>
return value is not None

return {
key: to_dict_compatible(getattr(self, key, None)) for key in sorted(self.attributes) if is_not_empty(self, key)
key: to_dict_compatible(value=self.get_object_attribute(key))
for key in sorted(self.attributes)
if is_not_empty(self, key)
}

def to_dict(self, *args) -&gt; dict:
Expand Down Expand Up @@ -208,7 +213,40 @@ <h3>Subclasses</h3>
<li><a title="slack_sdk.models.dialogs.DialogBuilder" href="dialogs/index.html#slack_sdk.models.dialogs.DialogBuilder">DialogBuilder</a></li>
<li><a title="slack_sdk.models.dialogs.DialogTextComponent" href="dialogs/index.html#slack_sdk.models.dialogs.DialogTextComponent">DialogTextComponent</a></li>
<li><a title="slack_sdk.models.messages.message.Message" href="messages/message.html#slack_sdk.models.messages.message.Message">Message</a></li>
<li><a title="slack_sdk.models.metadata.ContentItemEntityFields" href="metadata/index.html#slack_sdk.models.metadata.ContentItemEntityFields">ContentItemEntityFields</a></li>
<li><a title="slack_sdk.models.metadata.EntityActionButton" href="metadata/index.html#slack_sdk.models.metadata.EntityActionButton">EntityActionButton</a></li>
<li><a title="slack_sdk.models.metadata.EntityActionProcessingState" href="metadata/index.html#slack_sdk.models.metadata.EntityActionProcessingState">EntityActionProcessingState</a></li>
<li><a title="slack_sdk.models.metadata.EntityActions" href="metadata/index.html#slack_sdk.models.metadata.EntityActions">EntityActions</a></li>
<li><a title="slack_sdk.models.metadata.EntityArrayItemField" href="metadata/index.html#slack_sdk.models.metadata.EntityArrayItemField">EntityArrayItemField</a></li>
<li><a title="slack_sdk.models.metadata.EntityAttributes" href="metadata/index.html#slack_sdk.models.metadata.EntityAttributes">EntityAttributes</a></li>
<li><a title="slack_sdk.models.metadata.EntityBooleanCheckboxField" href="metadata/index.html#slack_sdk.models.metadata.EntityBooleanCheckboxField">EntityBooleanCheckboxField</a></li>
<li><a title="slack_sdk.models.metadata.EntityBooleanTextField" href="metadata/index.html#slack_sdk.models.metadata.EntityBooleanTextField">EntityBooleanTextField</a></li>
<li><a title="slack_sdk.models.metadata.EntityCustomField" href="metadata/index.html#slack_sdk.models.metadata.EntityCustomField">EntityCustomField</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditNumberConfig" href="metadata/index.html#slack_sdk.models.metadata.EntityEditNumberConfig">EntityEditNumberConfig</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditSelectConfig" href="metadata/index.html#slack_sdk.models.metadata.EntityEditSelectConfig">EntityEditSelectConfig</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditSupport" href="metadata/index.html#slack_sdk.models.metadata.EntityEditSupport">EntityEditSupport</a></li>
<li><a title="slack_sdk.models.metadata.EntityEditTextConfig" href="metadata/index.html#slack_sdk.models.metadata.EntityEditTextConfig">EntityEditTextConfig</a></li>
<li><a title="slack_sdk.models.metadata.EntityFullSizePreview" href="metadata/index.html#slack_sdk.models.metadata.EntityFullSizePreview">EntityFullSizePreview</a></li>
<li><a title="slack_sdk.models.metadata.EntityFullSizePreviewError" href="metadata/index.html#slack_sdk.models.metadata.EntityFullSizePreviewError">EntityFullSizePreviewError</a></li>
<li><a title="slack_sdk.models.metadata.EntityIconField" href="metadata/index.html#slack_sdk.models.metadata.EntityIconField">EntityIconField</a></li>
<li><a title="slack_sdk.models.metadata.EntityIconSlackFile" href="metadata/index.html#slack_sdk.models.metadata.EntityIconSlackFile">EntityIconSlackFile</a></li>
<li><a title="slack_sdk.models.metadata.EntityImageField" href="metadata/index.html#slack_sdk.models.metadata.EntityImageField">EntityImageField</a></li>
<li><a title="slack_sdk.models.metadata.EntityMetadata" href="metadata/index.html#slack_sdk.models.metadata.EntityMetadata">EntityMetadata</a></li>
<li><a title="slack_sdk.models.metadata.EntityPayload" href="metadata/index.html#slack_sdk.models.metadata.EntityPayload">EntityPayload</a></li>
<li><a title="slack_sdk.models.metadata.EntityRefField" href="metadata/index.html#slack_sdk.models.metadata.EntityRefField">EntityRefField</a></li>
<li><a title="slack_sdk.models.metadata.EntityStringField" href="metadata/index.html#slack_sdk.models.metadata.EntityStringField">EntityStringField</a></li>
<li><a title="slack_sdk.models.metadata.EntityTimestampField" href="metadata/index.html#slack_sdk.models.metadata.EntityTimestampField">EntityTimestampField</a></li>
<li><a title="slack_sdk.models.metadata.EntityTitle" href="metadata/index.html#slack_sdk.models.metadata.EntityTitle">EntityTitle</a></li>
<li><a title="slack_sdk.models.metadata.EntityTypedField" href="metadata/index.html#slack_sdk.models.metadata.EntityTypedField">EntityTypedField</a></li>
<li><a title="slack_sdk.models.metadata.EntityUserField" href="metadata/index.html#slack_sdk.models.metadata.EntityUserField">EntityUserField</a></li>
<li><a title="slack_sdk.models.metadata.EntityUserIDField" href="metadata/index.html#slack_sdk.models.metadata.EntityUserIDField">EntityUserIDField</a></li>
<li><a title="slack_sdk.models.metadata.EventAndEntityMetadata" href="metadata/index.html#slack_sdk.models.metadata.EventAndEntityMetadata">EventAndEntityMetadata</a></li>
<li><a title="slack_sdk.models.metadata.ExternalRef" href="metadata/index.html#slack_sdk.models.metadata.ExternalRef">ExternalRef</a></li>
<li><a title="slack_sdk.models.metadata.FileEntityFields" href="metadata/index.html#slack_sdk.models.metadata.FileEntityFields">FileEntityFields</a></li>
<li><a title="slack_sdk.models.metadata.FileEntitySlackFile" href="metadata/index.html#slack_sdk.models.metadata.FileEntitySlackFile">FileEntitySlackFile</a></li>
<li><a title="slack_sdk.models.metadata.IncidentEntityFields" href="metadata/index.html#slack_sdk.models.metadata.IncidentEntityFields">IncidentEntityFields</a></li>
<li><a title="slack_sdk.models.metadata.Metadata" href="metadata/index.html#slack_sdk.models.metadata.Metadata">Metadata</a></li>
<li><a title="slack_sdk.models.metadata.TaskEntityFields" href="metadata/index.html#slack_sdk.models.metadata.TaskEntityFields">TaskEntityFields</a></li>
<li><a title="slack_sdk.models.views.View" href="views/index.html#slack_sdk.models.views.View">View</a></li>
<li><a title="slack_sdk.models.views.ViewState" href="views/index.html#slack_sdk.models.views.ViewState">ViewState</a></li>
<li><a title="slack_sdk.models.views.ViewStateValue" href="views/index.html#slack_sdk.models.views.ViewStateValue">ViewStateValue</a></li>
Expand Down Expand Up @@ -257,7 +295,7 @@ <h3>Methods</h3>
return value

def is_not_empty(self, key: str) -&gt; bool:
value = getattr(self, key, None)
value = self.get_object_attribute(key)
if value is None:
return False

Expand All @@ -275,12 +313,27 @@ <h3>Methods</h3>
return value is not None

return {
key: to_dict_compatible(getattr(self, key, None)) for key in sorted(self.attributes) if is_not_empty(self, key)
key: to_dict_compatible(value=self.get_object_attribute(key))
for key in sorted(self.attributes)
if is_not_empty(self, key)
}</code></pre>
</details>
<div class="desc"><p>Construct a dictionary out of non-null keys (from attributes property)
present on this object</p></div>
</dd>
<dt id="slack_sdk.models.basic_objects.JsonObject.get_object_attribute"><code class="name flex">
<span>def <span class="ident">get_object_attribute</span></span>(<span>self, key: str)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_object_attribute(self, key: str):
return getattr(self, key, None)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_sdk.models.basic_objects.JsonObject.to_dict"><code class="name flex">
<span>def <span class="ident">to_dict</span></span>(<span>self, *args) ‑> dict</span>
</code></dt>
Expand Down Expand Up @@ -401,6 +454,7 @@ <h4><code><a title="slack_sdk.models.basic_objects.JsonObject" href="#slack_sdk.
<ul class="">
<li><code><a title="slack_sdk.models.basic_objects.JsonObject.attributes" href="#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="#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.get_object_attribute" href="#slack_sdk.models.basic_objects.JsonObject.get_object_attribute">get_object_attribute</a></code></li>
<li><code><a title="slack_sdk.models.basic_objects.JsonObject.to_dict" href="#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="#slack_sdk.models.basic_objects.JsonObject.validate_json">validate_json</a></code></li>
</ul>
Expand Down
134 changes: 134 additions & 0 deletions docs/reference/models/blocks/basic_components.html
Original file line number Diff line number Diff line change
Expand Up @@ -1248,6 +1248,130 @@ <h3>Inherited members</h3>
</li>
</ul>
</dd>
<dt id="slack_sdk.models.blocks.basic_components.RawTextObject"><code class="flex name class">
<span>class <span class="ident">RawTextObject</span></span>
<span>(</span><span>*, text: str)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class RawTextObject(TextObject):
&#34;&#34;&#34;raw_text typed text object&#34;&#34;&#34;

type = &#34;raw_text&#34;

@property
def attributes(self) -&gt; Set[str]: # type: ignore[override]
return {&#34;text&#34;, &#34;type&#34;}

def __init__(self, *, text: str):
&#34;&#34;&#34;A raw text object used in table block cells.
https://docs.slack.dev/reference/block-kit/composition-objects/text-object/
https://docs.slack.dev/reference/block-kit/blocks/table-block

Args:
text (required): The text content for the table block cell.
&#34;&#34;&#34;
super().__init__(text=text, type=self.type)

@staticmethod
def from_str(text: str) -&gt; &#34;RawTextObject&#34;:
&#34;&#34;&#34;Transforms a string into a RawTextObject&#34;&#34;&#34;
return RawTextObject(text=text)

@staticmethod
def direct_from_string(text: str) -&gt; Dict[str, Any]:
&#34;&#34;&#34;Transforms a string into the required object shape to act as a RawTextObject&#34;&#34;&#34;
return RawTextObject.from_str(text).to_dict()

@JsonValidator(&#34;text attribute must have at least 1 character&#34;)
def _validate_text_min_length(self):
return len(self.text) &gt;= 1</code></pre>
</details>
<div class="desc"><p>raw_text typed text object</p>
<p>A raw text object used in table block cells.
<a href="https://docs.slack.dev/reference/block-kit/composition-objects/text-object/">https://docs.slack.dev/reference/block-kit/composition-objects/text-object/</a>
<a href="https://docs.slack.dev/reference/block-kit/blocks/table-block">https://docs.slack.dev/reference/block-kit/blocks/table-block</a></p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>text</code></strong> :&ensp;<code>required</code></dt>
<dd>The text content for the table block cell.</dd>
</dl></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a></li>
<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>Class variables</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.RawTextObject.type"><code class="name">var <span class="ident">type</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
</dl>
<h3>Static methods</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.RawTextObject.direct_from_string"><code class="name flex">
<span>def <span class="ident">direct_from_string</span></span>(<span>text: str) ‑> Dict[str, Any]</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def direct_from_string(text: str) -&gt; Dict[str, Any]:
&#34;&#34;&#34;Transforms a string into the required object shape to act as a RawTextObject&#34;&#34;&#34;
return RawTextObject.from_str(text).to_dict()</code></pre>
</details>
<div class="desc"><p>Transforms a string into the required object shape to act as a RawTextObject</p></div>
</dd>
<dt id="slack_sdk.models.blocks.basic_components.RawTextObject.from_str"><code class="name flex">
<span>def <span class="ident">from_str</span></span>(<span>text: str) ‑> <a title="slack_sdk.models.blocks.basic_components.RawTextObject" href="#slack_sdk.models.blocks.basic_components.RawTextObject">RawTextObject</a></span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def from_str(text: str) -&gt; &#34;RawTextObject&#34;:
&#34;&#34;&#34;Transforms a string into a RawTextObject&#34;&#34;&#34;
return RawTextObject(text=text)</code></pre>
</details>
<div class="desc"><p>Transforms a string into a RawTextObject</p></div>
</dd>
</dl>
<h3>Instance variables</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.RawTextObject.attributes"><code class="name">prop <span class="ident">attributes</span> : Set[str]</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def attributes(self) -&gt; Set[str]: # type: ignore[override]
return {&#34;text&#34;, &#34;type&#34;}</code></pre>
</details>
<div class="desc"><p>Build an unordered collection of unique elements.</p></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_sdk.models.blocks.basic_components.TextObject" href="#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a></b></code>:
<ul class="hlist">
<li><code><a title="slack_sdk.models.blocks.basic_components.TextObject.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.blocks.basic_components.TextObject.logger" href="#slack_sdk.models.blocks.basic_components.TextObject.logger">logger</a></code></li>
<li><code><a title="slack_sdk.models.blocks.basic_components.TextObject.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.blocks.basic_components.TextObject.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.SlackFile"><code class="flex name class">
<span>class <span class="ident">SlackFile</span></span>
<span>(</span><span>*, id: str | None = None, url: str | None = None)</span>
Expand Down Expand Up @@ -1396,6 +1520,7 @@ <h3>Subclasses</h3>
<ul class="hlist">
<li><a title="slack_sdk.models.blocks.basic_components.MarkdownTextObject" href="#slack_sdk.models.blocks.basic_components.MarkdownTextObject">MarkdownTextObject</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.PlainTextObject" href="#slack_sdk.models.blocks.basic_components.PlainTextObject">PlainTextObject</a></li>
<li><a title="slack_sdk.models.blocks.basic_components.RawTextObject" href="#slack_sdk.models.blocks.basic_components.RawTextObject">RawTextObject</a></li>
</ul>
<h3>Class variables</h3>
<dl>
Expand Down Expand Up @@ -1633,6 +1758,15 @@ <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.RawTextObject" href="#slack_sdk.models.blocks.basic_components.RawTextObject">RawTextObject</a></code></h4>
<ul class="">
<li><code><a title="slack_sdk.models.blocks.basic_components.RawTextObject.attributes" href="#slack_sdk.models.blocks.basic_components.RawTextObject.attributes">attributes</a></code></li>
<li><code><a title="slack_sdk.models.blocks.basic_components.RawTextObject.direct_from_string" href="#slack_sdk.models.blocks.basic_components.RawTextObject.direct_from_string">direct_from_string</a></code></li>
<li><code><a title="slack_sdk.models.blocks.basic_components.RawTextObject.from_str" href="#slack_sdk.models.blocks.basic_components.RawTextObject.from_str">from_str</a></code></li>
<li><code><a title="slack_sdk.models.blocks.basic_components.RawTextObject.type" href="#slack_sdk.models.blocks.basic_components.RawTextObject.type">type</a></code></li>
</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>
<ul class="">
<li><code><a title="slack_sdk.models.blocks.basic_components.SlackFile.attributes" href="#slack_sdk.models.blocks.basic_components.SlackFile.attributes">attributes</a></code></li>
Expand Down
Loading