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
754 changes: 746 additions & 8 deletions docs/reference/index.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/reference/models/basic_objects.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ <h3>Subclasses</h3>
<li><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</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.RawNumberObject" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.RawNumberObject">RawNumberObject</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.TableBlockColumnSettings" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.TableBlockColumnSettings">TableBlockColumnSettings</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>
Expand Down
79 changes: 79 additions & 0 deletions docs/reference/models/blocks/basic_components.html
Original file line number Diff line number Diff line change
Expand Up @@ -1238,6 +1238,77 @@ <h3>Inherited members</h3>
</li>
</ul>
</dd>
<dt id="slack_sdk.models.blocks.basic_components.RawNumberObject"><code class="flex name class">
<span>class <span class="ident">RawNumberObject</span></span>
<span>(</span><span>*, value: int | float, text: str)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class RawNumberObject(JsonObject):
&#34;&#34;&#34;raw_number typed object.&#34;&#34;&#34;

type = &#34;raw_number&#34;
attributes = {&#34;value&#34;, &#34;text&#34;, &#34;type&#34;}
logger = logging.getLogger(__name__)

def __init__(self, *, value: Union[int, float], text: str):
&#34;&#34;&#34;Defines an object containing a numeric value.

Args:
value (required): The numeric value.
text (required): The text used to display the value. The minimum length is 1 character.
&#34;&#34;&#34;
self.value = value
self.text = text

@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_number typed object.</p>
<p>Defines an object containing a numeric value.</p>
<dl>
<dt>Args</dt>
<dt>-----=</dt>
<dt><strong><code>value</code></strong> :&ensp;<code>required</code></dt>
<dd>The numeric value.</dd>
<dt><strong><code>text</code></strong> :&ensp;<code>required</code></dt>
<dd>The text used to display the value. The minimum length is 1 character.</dd>
</dl></div>
<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>Class variables</h3>
<dl>
<dt id="slack_sdk.models.blocks.basic_components.RawNumberObject.attributes"><code class="name">var <span class="ident">attributes</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.models.blocks.basic_components.RawNumberObject.logger"><code class="name">var <span class="ident">logger</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.models.blocks.basic_components.RawNumberObject.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>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.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.RawTextObject"><code class="flex name class">
<span>class <span class="ident">RawTextObject</span></span>
<span>(</span><span>*, text: str)</span>
Expand Down Expand Up @@ -1840,6 +1911,14 @@ <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.RawNumberObject" href="#slack_sdk.models.blocks.basic_components.RawNumberObject">RawNumberObject</a></code></h4>
<ul class="">
<li><code><a title="slack_sdk.models.blocks.basic_components.RawNumberObject.attributes" href="#slack_sdk.models.blocks.basic_components.RawNumberObject.attributes">attributes</a></code></li>
<li><code><a title="slack_sdk.models.blocks.basic_components.RawNumberObject.logger" href="#slack_sdk.models.blocks.basic_components.RawNumberObject.logger">logger</a></code></li>
<li><code><a title="slack_sdk.models.blocks.basic_components.RawNumberObject.type" href="#slack_sdk.models.blocks.basic_components.RawNumberObject.type">type</a></code></li>
</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>
Expand Down
50 changes: 47 additions & 3 deletions docs/reference/models/blocks/block_elements.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h3>Inherited members</h3>
</dd>
<dt id="slack_sdk.models.blocks.block_elements.ButtonElement"><code class="flex name class">
<span>class <span class="ident">ButtonElement</span></span>
<span>(</span><span>*,<br>text: str | dict | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>,<br>action_id: str | None = None,<br>url: str | None = None,<br>value: str | None = None,<br>style: str | None = None,<br>confirm: dict | <a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a> | None = None,<br>accessibility_label: str | None = None,<br>**others: dict)</span>
<span>(</span><span>*,<br>text: str | dict | <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>,<br>action_id: str | None = None,<br>url: str | None = None,<br>value: str | None = None,<br>style: str | None = None,<br>confirm: dict | <a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a> | None = None,<br>accessibility_label: str | None = None,<br>agent_prompt: str | None = None,<br>agent_prompt_display: str | None = None,<br>visible_to_user_ids: List[str] | None = None,<br>**others: dict)</span>
</code></dt>
<dd>
<details class="source">
Expand All @@ -199,10 +199,23 @@ <h3>Inherited members</h3>
text_max_length = 75
url_max_length = 3000
value_max_length = 2000
agent_prompt_max_length = 4000

@property
def attributes(self) -&gt; Set[str]: # type: ignore[override]
return super().attributes.union({&#34;text&#34;, &#34;url&#34;, &#34;value&#34;, &#34;style&#34;, &#34;confirm&#34;, &#34;accessibility_label&#34;})
return super().attributes.union(
{
&#34;text&#34;,
&#34;url&#34;,
&#34;value&#34;,
&#34;style&#34;,
&#34;confirm&#34;,
&#34;accessibility_label&#34;,
&#34;agent_prompt&#34;,
&#34;agent_prompt_display&#34;,
&#34;visible_to_user_ids&#34;,
}
)

def __init__(
self,
Expand All @@ -214,6 +227,9 @@ <h3>Inherited members</h3>
style: Optional[str] = None, # primary, danger
confirm: Optional[Union[dict, ConfirmObject]] = None,
accessibility_label: Optional[str] = None,
agent_prompt: Optional[str] = None,
agent_prompt_display: Optional[str] = None,
visible_to_user_ids: Optional[List[str]] = None,
**others: dict,
):
&#34;&#34;&#34;An interactive element that inserts a button.
Expand Down Expand Up @@ -245,6 +261,12 @@ <h3>Inherited members</h3>
accessibility_label: A label for longer descriptive text about a button element.
This label will be read out by screen readers instead of the button text object.
Maximum length for this field is 75 characters.
agent_prompt: A prompt sent to Slackbot when the button is clicked, if Slackbot AI is available to the user.
Maximum length for this field is 4000 characters.
agent_prompt_display: Short text shown instead of the full agent_prompt in the user&#39;s Slackbot message.
Only takes effect alongside agent_prompt and defaults to the button&#39;s text.
visible_to_user_ids: User IDs for which the button appears.
If not provided, the button is visible to all users.
&#34;&#34;&#34;
super().__init__(action_id=action_id, type=self.type)
show_unknown_key_warning(self, others)
Expand All @@ -256,6 +278,9 @@ <h3>Inherited members</h3>
self.style = style
self.confirm = ConfirmObject.parse(confirm) # type: ignore[arg-type]
self.accessibility_label = accessibility_label
self.agent_prompt = agent_prompt
self.agent_prompt_display = agent_prompt_display
self.visible_to_user_ids = visible_to_user_ids

@JsonValidator(f&#34;text attribute cannot exceed {text_max_length} characters&#34;)
def _validate_text_length(self) -&gt; bool:
Expand All @@ -275,7 +300,11 @@ <h3>Inherited members</h3>

@JsonValidator(f&#34;accessibility_label attribute cannot exceed {text_max_length} characters&#34;)
def _validate_accessibility_label_length(self) -&gt; bool:
return self.accessibility_label is None or len(self.accessibility_label) &lt;= self.text_max_length</code></pre>
return self.accessibility_label is None or len(self.accessibility_label) &lt;= self.text_max_length

@JsonValidator(f&#34;agent_prompt attribute cannot exceed {agent_prompt_max_length} characters&#34;)
def _validate_agent_prompt_length(self) -&gt; bool:
return self.agent_prompt is None or len(self.agent_prompt) &lt;= self.agent_prompt_max_length</code></pre>
</details>
<div class="desc"><p>Block Elements are things that exists inside of your Blocks.</p>
<p><a href="https://docs.slack.dev/reference/block-kit/block-elements/">https://docs.slack.dev/reference/block-kit/block-elements/</a></p>
Expand Down Expand Up @@ -315,6 +344,15 @@ <h3>Inherited members</h3>
<dd>A label for longer descriptive text about a button element.
This label will be read out by screen readers instead of the button text object.
Maximum length for this field is 75 characters.</dd>
<dt><strong><code>agent_prompt</code></strong></dt>
<dd>A prompt sent to Slackbot when the button is clicked, if Slackbot AI is available to the user.
Maximum length for this field is 4000 characters.</dd>
<dt><strong><code>agent_prompt_display</code></strong></dt>
<dd>Short text shown instead of the full agent_prompt in the user's Slackbot message.
Only takes effect alongside agent_prompt and defaults to the button's text.</dd>
<dt><strong><code>visible_to_user_ids</code></strong></dt>
<dd>User IDs for which the button appears.
If not provided, the button is visible to all users.</dd>
</dl></div>
<h3>Ancestors</h3>
<ul class="hlist">
Expand All @@ -329,6 +367,10 @@ <h3>Subclasses</h3>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_sdk.models.blocks.block_elements.ButtonElement.agent_prompt_max_length"><code class="name">var <span class="ident">agent_prompt_max_length</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
</dd>
<dt id="slack_sdk.models.blocks.block_elements.ButtonElement.text_max_length"><code class="name">var <span class="ident">text_max_length</span></code></dt>
<dd>
<div class="desc"><p>The type of the None singleton.</p></div>
Expand Down Expand Up @@ -2611,6 +2653,7 @@ <h3>Inherited members</h3>
<li><code><b><a title="slack_sdk.models.blocks.block_elements.ButtonElement" href="#slack_sdk.models.blocks.block_elements.ButtonElement">ButtonElement</a></b></code>:
<ul class="hlist">
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.action_id_max_length" href="#slack_sdk.models.blocks.block_elements.InteractiveElement.action_id_max_length">action_id_max_length</a></code></li>
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.agent_prompt_max_length" href="#slack_sdk.models.blocks.block_elements.ButtonElement.agent_prompt_max_length">agent_prompt_max_length</a></code></li>
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.attributes" href="#slack_sdk.models.blocks.block_elements.InteractiveElement.attributes">attributes</a></code></li>
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.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.block_elements.ButtonElement.logger" href="#slack_sdk.models.blocks.block_elements.BlockElement.logger">logger</a></code></li>
Expand Down Expand Up @@ -5211,6 +5254,7 @@ <h4><code><a title="slack_sdk.models.blocks.block_elements.BlockElement" href="#
<li>
<h4><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement" href="#slack_sdk.models.blocks.block_elements.ButtonElement">ButtonElement</a></code></h4>
<ul class="">
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.agent_prompt_max_length" href="#slack_sdk.models.blocks.block_elements.ButtonElement.agent_prompt_max_length">agent_prompt_max_length</a></code></li>
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.text_max_length" href="#slack_sdk.models.blocks.block_elements.ButtonElement.text_max_length">text_max_length</a></code></li>
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.type" href="#slack_sdk.models.blocks.block_elements.ButtonElement.type">type</a></code></li>
<li><code><a title="slack_sdk.models.blocks.block_elements.ButtonElement.url_max_length" href="#slack_sdk.models.blocks.block_elements.ButtonElement.url_max_length">url_max_length</a></code></li>
Expand Down
Loading
Loading