Skip to content

Commit e8c20d1

Browse files
authored
Merge branch 'ai-apps' into docs-ai-apps
2 parents 0b4beb2 + 1a1b2b3 commit e8c20d1

34 files changed

+5696
-440
lines changed

docs/reference/index.html

Lines changed: 408 additions & 40 deletions
Large diffs are not rendered by default.

docs/reference/models/basic_objects.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ <h3>Subclasses</h3>
194194
<li><a title="slack_sdk.models.attachments.AttachmentField" href="attachments/index.html#slack_sdk.models.attachments.AttachmentField">AttachmentField</a></li>
195195
<li><a title="slack_sdk.models.blocks.basic_components.ConfirmObject" href="blocks/basic_components.html#slack_sdk.models.blocks.basic_components.ConfirmObject">ConfirmObject</a></li>
196196
<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>
197+
<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>
197198
<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>
198199
<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>
199200
<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>

docs/reference/models/blocks/basic_components.html

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,157 @@ <h3>Inherited members</h3>
341341
</li>
342342
</ul>
343343
</dd>
344+
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject"><code class="flex name class">
345+
<span>class <span class="ident">FeedbackButtonObject</span></span>
346+
<span>(</span><span>*,<br>text: str | Dict[str, Any] | <a title="slack_sdk.models.blocks.basic_components.PlainTextObject" href="#slack_sdk.models.blocks.basic_components.PlainTextObject">PlainTextObject</a>,<br>accessibility_label: str | None = None,<br>value: str,<br>**others: Dict[str, Any])</span>
347+
</code></dt>
348+
<dd>
349+
<details class="source">
350+
<summary>
351+
<span>Expand source code</span>
352+
</summary>
353+
<pre><code class="python">class FeedbackButtonObject(JsonObject):
354+
attributes: Set[str] = set()
355+
356+
text_max_length = 75
357+
value_max_length = 2000
358+
359+
@classmethod
360+
def parse(cls, feedback_button: Union[&#34;FeedbackButtonObject&#34;, Dict[str, Any]]):
361+
if feedback_button:
362+
if isinstance(feedback_button, FeedbackButtonObject):
363+
return feedback_button
364+
elif isinstance(feedback_button, dict):
365+
return FeedbackButtonObject(**feedback_button)
366+
else:
367+
# Not yet implemented: show some warning here
368+
return None
369+
return None
370+
371+
def __init__(
372+
self,
373+
*,
374+
text: Union[str, Dict[str, Any], PlainTextObject],
375+
accessibility_label: Optional[str] = None,
376+
value: str,
377+
**others: Dict[str, Any],
378+
):
379+
&#34;&#34;&#34;
380+
A feedback button element object for either positive or negative feedback.
381+
382+
Args:
383+
text (required): An object containing some text. Maximum length for this field is 75 characters.
384+
accessibility_label: A label for longer descriptive text about a button element. This label will be read out by
385+
screen readers instead of the button `text` object.
386+
value (required): The button value. Maximum length for this field is 2000 characters.
387+
&#34;&#34;&#34;
388+
self._text: Optional[TextObject] = PlainTextObject.parse(text, default_type=PlainTextObject.type)
389+
self._accessibility_label: Optional[str] = accessibility_label
390+
self._value: Optional[str] = value
391+
show_unknown_key_warning(self, others)
392+
393+
@JsonValidator(f&#34;text attribute cannot exceed {text_max_length} characters&#34;)
394+
def text_length(self) -&gt; bool:
395+
return self._text is None or len(self._text.text) &lt;= self.text_max_length
396+
397+
@JsonValidator(f&#34;value attribute cannot exceed {value_max_length} characters&#34;)
398+
def value_length(self) -&gt; bool:
399+
return self._value is None or len(self._value) &lt;= self.value_max_length
400+
401+
def to_dict(self) -&gt; Dict[str, Any]:
402+
self.validate_json()
403+
json: Dict[str, Union[str, dict]] = {}
404+
if self._text:
405+
json[&#34;text&#34;] = self._text.to_dict()
406+
if self._accessibility_label:
407+
json[&#34;accessibility_label&#34;] = self._accessibility_label
408+
if self._value:
409+
json[&#34;value&#34;] = self._value
410+
return json</code></pre>
411+
</details>
412+
<div class="desc"><p>The base class for JSON serializable class objects</p>
413+
<p>A feedback button element object for either positive or negative feedback.</p>
414+
<h2 id="args">Args</h2>
415+
<dl>
416+
<dt><strong><code>text</code></strong> :&ensp;<code>required</code></dt>
417+
<dd>An object containing some text. Maximum length for this field is 75 characters.</dd>
418+
<dt><strong><code>accessibility_label</code></strong></dt>
419+
<dd>A label for longer descriptive text about a button element. This label will be read out by
420+
screen readers instead of the button <code>text</code> object.</dd>
421+
<dt><strong><code>value</code></strong> :&ensp;<code>required</code></dt>
422+
<dd>The button value. Maximum length for this field is 2000 characters.</dd>
423+
</dl></div>
424+
<h3>Ancestors</h3>
425+
<ul class="hlist">
426+
<li><a title="slack_sdk.models.basic_objects.JsonObject" href="../basic_objects.html#slack_sdk.models.basic_objects.JsonObject">JsonObject</a></li>
427+
<li><a title="slack_sdk.models.basic_objects.BaseObject" href="../basic_objects.html#slack_sdk.models.basic_objects.BaseObject">BaseObject</a></li>
428+
</ul>
429+
<h3>Class variables</h3>
430+
<dl>
431+
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.attributes"><code class="name">var <span class="ident">attributes</span> : Set[str]</code></dt>
432+
<dd>
433+
<div class="desc"><p>The type of the None singleton.</p></div>
434+
</dd>
435+
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.text_max_length"><code class="name">var <span class="ident">text_max_length</span></code></dt>
436+
<dd>
437+
<div class="desc"><p>The type of the None singleton.</p></div>
438+
</dd>
439+
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.value_max_length"><code class="name">var <span class="ident">value_max_length</span></code></dt>
440+
<dd>
441+
<div class="desc"><p>The type of the None singleton.</p></div>
442+
</dd>
443+
</dl>
444+
<h3>Static methods</h3>
445+
<dl>
446+
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.parse"><code class="name flex">
447+
<span>def <span class="ident">parse</span></span>(<span>feedback_button: ForwardRef('<a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</a>') | Dict[str, Any])</span>
448+
</code></dt>
449+
<dd>
450+
<div class="desc"></div>
451+
</dd>
452+
</dl>
453+
<h3>Methods</h3>
454+
<dl>
455+
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.text_length"><code class="name flex">
456+
<span>def <span class="ident">text_length</span></span>(<span>self) ‑> bool</span>
457+
</code></dt>
458+
<dd>
459+
<details class="source">
460+
<summary>
461+
<span>Expand source code</span>
462+
</summary>
463+
<pre><code class="python">@JsonValidator(f&#34;text attribute cannot exceed {text_max_length} characters&#34;)
464+
def text_length(self) -&gt; bool:
465+
return self._text is None or len(self._text.text) &lt;= self.text_max_length</code></pre>
466+
</details>
467+
<div class="desc"></div>
468+
</dd>
469+
<dt id="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.value_length"><code class="name flex">
470+
<span>def <span class="ident">value_length</span></span>(<span>self) ‑> bool</span>
471+
</code></dt>
472+
<dd>
473+
<details class="source">
474+
<summary>
475+
<span>Expand source code</span>
476+
</summary>
477+
<pre><code class="python">@JsonValidator(f&#34;value attribute cannot exceed {value_max_length} characters&#34;)
478+
def value_length(self) -&gt; bool:
479+
return self._value is None or len(self._value) &lt;= self.value_max_length</code></pre>
480+
</details>
481+
<div class="desc"></div>
482+
</dd>
483+
</dl>
484+
<h3>Inherited members</h3>
485+
<ul class="hlist">
486+
<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>:
487+
<ul class="hlist">
488+
<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>
489+
<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>
490+
<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>
491+
</ul>
492+
</li>
493+
</ul>
494+
</dd>
344495
<dt id="slack_sdk.models.blocks.basic_components.MarkdownTextObject"><code class="flex name class">
345496
<span>class <span class="ident">MarkdownTextObject</span></span>
346497
<span>(</span><span>*, text: str, verbatim: bool | None = None)</span>
@@ -1427,6 +1578,17 @@ <h4><code><a title="slack_sdk.models.blocks.basic_components.DispatchActionConfi
14271578
</ul>
14281579
</li>
14291580
<li>
1581+
<h4><code><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject">FeedbackButtonObject</a></code></h4>
1582+
<ul class="two-column">
1583+
<li><code><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.attributes" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject.attributes">attributes</a></code></li>
1584+
<li><code><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.parse" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject.parse">parse</a></code></li>
1585+
<li><code><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.text_length" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject.text_length">text_length</a></code></li>
1586+
<li><code><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.text_max_length" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject.text_max_length">text_max_length</a></code></li>
1587+
<li><code><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.value_length" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject.value_length">value_length</a></code></li>
1588+
<li><code><a title="slack_sdk.models.blocks.basic_components.FeedbackButtonObject.value_max_length" href="#slack_sdk.models.blocks.basic_components.FeedbackButtonObject.value_max_length">value_max_length</a></code></li>
1589+
</ul>
1590+
</li>
1591+
<li>
14301592
<h4><code><a title="slack_sdk.models.blocks.basic_components.MarkdownTextObject" href="#slack_sdk.models.blocks.basic_components.MarkdownTextObject">MarkdownTextObject</a></code></h4>
14311593
<ul class="two-column">
14321594
<li><code><a title="slack_sdk.models.blocks.basic_components.MarkdownTextObject.attributes" href="#slack_sdk.models.blocks.basic_components.MarkdownTextObject.attributes">attributes</a></code></li>

0 commit comments

Comments
 (0)