Skip to content

Commit 36e1b39

Browse files
zuczkowszuczkows
committed
ME-620: Generate docs
1 parent 67392de commit 36e1b39

File tree

29 files changed

+28320
-1993
lines changed

29 files changed

+28320
-1993
lines changed

‎docs/agent/rtm/api/index.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
4242
<dd>
4343
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.6.</p></div>
4444
</dd>
45+
<dt><code class="name"><a title="livechat.agent.rtm.api.v37" href="v37.html">livechat.agent.rtm.api.v37</a></code></dt>
46+
<dd>
47+
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.7.</p></div>
48+
</dd>
4549
</dl>
4650
</section>
4751
<section>
@@ -68,6 +72,7 @@ <h1>Index</h1>
6872
<li><code><a title="livechat.agent.rtm.api.v34" href="v34.html">livechat.agent.rtm.api.v34</a></code></li>
6973
<li><code><a title="livechat.agent.rtm.api.v35" href="v35.html">livechat.agent.rtm.api.v35</a></code></li>
7074
<li><code><a title="livechat.agent.rtm.api.v36" href="v36.html">livechat.agent.rtm.api.v36</a></code></li>
75+
<li><code><a title="livechat.agent.rtm.api.v37" href="v37.html">livechat.agent.rtm.api.v37</a></code></li>
7176
</ul>
7277
</li>
7378
</ul>

‎docs/agent/rtm/api/v36.html

Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -981,6 +981,58 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v36</code></h1>
981981
&#39;payload&#39;: payload
982982
})
983983

984+
def send_thinking_indicator(self,
985+
chat_id: str = None,
986+
visibility: str = None,
987+
title: str = None,
988+
description: str = None,
989+
custom_id: str = None,
990+
payload: dict = None) -&gt; RtmResponse:
991+
&#39;&#39;&#39; Sends a thinking indicator.
992+
993+
Args:
994+
chat_id (str): ID of the chat you want to send the thinking indicator to.
995+
visibility (str): Possible values: `all`, `agents`.
996+
title (str): Title of the thinking indicator.
997+
description (str): Description of the thinking indicator.
998+
custom_id (str): Custom ID for the thinking indicator.
999+
payload (dict): Custom payload to be used as request&#39;s data.
1000+
It overrides all other parameters provided for the method.
1001+
1002+
Returns:
1003+
RtmResponse: RTM response structure (`request_id`, `action`,
1004+
`type`, `success` and `payload` properties)
1005+
&#39;&#39;&#39;
1006+
if payload is None:
1007+
payload = prepare_payload(locals())
1008+
return self.ws.send({
1009+
&#39;action&#39;: &#39;send_thinking_indicator&#39;,
1010+
&#39;payload&#39;: payload
1011+
})
1012+
1013+
def send_event_preview(self,
1014+
chat_id: str = None,
1015+
event: dict = None,
1016+
payload: dict = None) -&gt; RtmResponse:
1017+
&#39;&#39;&#39; Sends an event preview.
1018+
1019+
Args:
1020+
chat_id (str): ID of the chat to send event preview to.
1021+
event (dict): Event object containing the event data.
1022+
payload (dict): Custom payload to be used as request&#39;s data.
1023+
It overrides all other parameters provided for the method.
1024+
1025+
Returns:
1026+
RtmResponse: RTM response structure (`request_id`, `action`,
1027+
`type`, `success` and `payload` properties)
1028+
&#39;&#39;&#39;
1029+
if payload is None:
1030+
payload = prepare_payload(locals())
1031+
return self.ws.send({
1032+
&#39;action&#39;: &#39;send_event_preview&#39;,
1033+
&#39;payload&#39;: payload
1034+
})
1035+
9841036
def multicast(self,
9851037
recipients: dict = None,
9861038
content: Any = None,
@@ -1987,6 +2039,58 @@ <h2 class="section-title" id="header-classes">Classes</h2>
19872039
&#39;payload&#39;: payload
19882040
})
19892041

2042+
def send_thinking_indicator(self,
2043+
chat_id: str = None,
2044+
visibility: str = None,
2045+
title: str = None,
2046+
description: str = None,
2047+
custom_id: str = None,
2048+
payload: dict = None) -&gt; RtmResponse:
2049+
&#39;&#39;&#39; Sends a thinking indicator.
2050+
2051+
Args:
2052+
chat_id (str): ID of the chat you want to send the thinking indicator to.
2053+
visibility (str): Possible values: `all`, `agents`.
2054+
title (str): Title of the thinking indicator.
2055+
description (str): Description of the thinking indicator.
2056+
custom_id (str): Custom ID for the thinking indicator.
2057+
payload (dict): Custom payload to be used as request&#39;s data.
2058+
It overrides all other parameters provided for the method.
2059+
2060+
Returns:
2061+
RtmResponse: RTM response structure (`request_id`, `action`,
2062+
`type`, `success` and `payload` properties)
2063+
&#39;&#39;&#39;
2064+
if payload is None:
2065+
payload = prepare_payload(locals())
2066+
return self.ws.send({
2067+
&#39;action&#39;: &#39;send_thinking_indicator&#39;,
2068+
&#39;payload&#39;: payload
2069+
})
2070+
2071+
def send_event_preview(self,
2072+
chat_id: str = None,
2073+
event: dict = None,
2074+
payload: dict = None) -&gt; RtmResponse:
2075+
&#39;&#39;&#39; Sends an event preview.
2076+
2077+
Args:
2078+
chat_id (str): ID of the chat to send event preview to.
2079+
event (dict): Event object containing the event data.
2080+
payload (dict): Custom payload to be used as request&#39;s data.
2081+
It overrides all other parameters provided for the method.
2082+
2083+
Returns:
2084+
RtmResponse: RTM response structure (`request_id`, `action`,
2085+
`type`, `success` and `payload` properties)
2086+
&#39;&#39;&#39;
2087+
if payload is None:
2088+
payload = prepare_payload(locals())
2089+
return self.ws.send({
2090+
&#39;action&#39;: &#39;send_event_preview&#39;,
2091+
&#39;payload&#39;: payload
2092+
})
2093+
19902094
def multicast(self,
19912095
recipients: dict = None,
19922096
content: Any = None,
@@ -3371,6 +3475,55 @@ <h2 id="returns">Returns</h2>
33713475
})</code></pre>
33723476
</details>
33733477
</dd>
3478+
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.send_event_preview"><code class="name flex">
3479+
<span>def <span class="ident">send_event_preview</span></span>(<span>self, chat_id: str = None, event: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
3480+
</code></dt>
3481+
<dd>
3482+
<div class="desc"><p>Sends an event preview.</p>
3483+
<h2 id="args">Args</h2>
3484+
<dl>
3485+
<dt><strong><code>chat_id</code></strong> :&ensp;<code>str</code></dt>
3486+
<dd>ID of the chat to send event preview to.</dd>
3487+
<dt><strong><code>event</code></strong> :&ensp;<code>dict</code></dt>
3488+
<dd>Event object containing the event data.</dd>
3489+
<dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
3490+
<dd>Custom payload to be used as request's data.
3491+
It overrides all other parameters provided for the method.</dd>
3492+
</dl>
3493+
<h2 id="returns">Returns</h2>
3494+
<dl>
3495+
<dt><code>RtmResponse</code></dt>
3496+
<dd>RTM response structure (<code>request_id</code>, <code>action</code>,
3497+
<code>type</code>, <code>success</code> and <code>payload</code> properties)</dd>
3498+
</dl></div>
3499+
<details class="source">
3500+
<summary>
3501+
<span>Expand source code</span>
3502+
</summary>
3503+
<pre><code class="python">def send_event_preview(self,
3504+
chat_id: str = None,
3505+
event: dict = None,
3506+
payload: dict = None) -&gt; RtmResponse:
3507+
&#39;&#39;&#39; Sends an event preview.
3508+
3509+
Args:
3510+
chat_id (str): ID of the chat to send event preview to.
3511+
event (dict): Event object containing the event data.
3512+
payload (dict): Custom payload to be used as request&#39;s data.
3513+
It overrides all other parameters provided for the method.
3514+
3515+
Returns:
3516+
RtmResponse: RTM response structure (`request_id`, `action`,
3517+
`type`, `success` and `payload` properties)
3518+
&#39;&#39;&#39;
3519+
if payload is None:
3520+
payload = prepare_payload(locals())
3521+
return self.ws.send({
3522+
&#39;action&#39;: &#39;send_event_preview&#39;,
3523+
&#39;payload&#39;: payload
3524+
})</code></pre>
3525+
</details>
3526+
</dd>
33743527
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.send_rich_message_postback"><code class="name flex">
33753528
<span>def <span class="ident">send_rich_message_postback</span></span>(<span>self, chat_id: str = None, thread_id: str = None, event_id: str = None, postback: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
33763529
</code></dt>
@@ -3428,6 +3581,67 @@ <h2 id="returns">Returns</h2>
34283581
})</code></pre>
34293582
</details>
34303583
</dd>
3584+
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.send_thinking_indicator"><code class="name flex">
3585+
<span>def <span class="ident">send_thinking_indicator</span></span>(<span>self, chat_id: str = None, visibility: str = None, title: str = None, description: str = None, custom_id: str = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
3586+
</code></dt>
3587+
<dd>
3588+
<div class="desc"><p>Sends a thinking indicator.</p>
3589+
<h2 id="args">Args</h2>
3590+
<dl>
3591+
<dt><strong><code>chat_id</code></strong> :&ensp;<code>str</code></dt>
3592+
<dd>ID of the chat you want to send the thinking indicator to.</dd>
3593+
<dt><strong><code>visibility</code></strong> :&ensp;<code>str</code></dt>
3594+
<dd>Possible values: <code>all</code>, <code>agents</code>.</dd>
3595+
<dt><strong><code>title</code></strong> :&ensp;<code>str</code></dt>
3596+
<dd>Title of the thinking indicator.</dd>
3597+
<dt><strong><code>description</code></strong> :&ensp;<code>str</code></dt>
3598+
<dd>Description of the thinking indicator.</dd>
3599+
<dt><strong><code>custom_id</code></strong> :&ensp;<code>str</code></dt>
3600+
<dd>Custom ID for the thinking indicator.</dd>
3601+
<dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
3602+
<dd>Custom payload to be used as request's data.
3603+
It overrides all other parameters provided for the method.</dd>
3604+
</dl>
3605+
<h2 id="returns">Returns</h2>
3606+
<dl>
3607+
<dt><code>RtmResponse</code></dt>
3608+
<dd>RTM response structure (<code>request_id</code>, <code>action</code>,
3609+
<code>type</code>, <code>success</code> and <code>payload</code> properties)</dd>
3610+
</dl></div>
3611+
<details class="source">
3612+
<summary>
3613+
<span>Expand source code</span>
3614+
</summary>
3615+
<pre><code class="python">def send_thinking_indicator(self,
3616+
chat_id: str = None,
3617+
visibility: str = None,
3618+
title: str = None,
3619+
description: str = None,
3620+
custom_id: str = None,
3621+
payload: dict = None) -&gt; RtmResponse:
3622+
&#39;&#39;&#39; Sends a thinking indicator.
3623+
3624+
Args:
3625+
chat_id (str): ID of the chat you want to send the thinking indicator to.
3626+
visibility (str): Possible values: `all`, `agents`.
3627+
title (str): Title of the thinking indicator.
3628+
description (str): Description of the thinking indicator.
3629+
custom_id (str): Custom ID for the thinking indicator.
3630+
payload (dict): Custom payload to be used as request&#39;s data.
3631+
It overrides all other parameters provided for the method.
3632+
3633+
Returns:
3634+
RtmResponse: RTM response structure (`request_id`, `action`,
3635+
`type`, `success` and `payload` properties)
3636+
&#39;&#39;&#39;
3637+
if payload is None:
3638+
payload = prepare_payload(locals())
3639+
return self.ws.send({
3640+
&#39;action&#39;: &#39;send_thinking_indicator&#39;,
3641+
&#39;payload&#39;: payload
3642+
})</code></pre>
3643+
</details>
3644+
</dd>
34313645
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.send_typing_indicator"><code class="name flex">
34323646
<span>def <span class="ident">send_typing_indicator</span></span>(<span>self, chat_id: str = None, visibility: str = None, is_typing: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
34333647
</code></dt>
@@ -4181,7 +4395,9 @@ <h4><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36" href="#livechat.agen
41814395
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.remove_user_from_chat" href="#livechat.agent.rtm.api.v36.AgentRtmV36.remove_user_from_chat">remove_user_from_chat</a></code></li>
41824396
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.resume_chat" href="#livechat.agent.rtm.api.v36.AgentRtmV36.resume_chat">resume_chat</a></code></li>
41834397
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.send_event" href="#livechat.agent.rtm.api.v36.AgentRtmV36.send_event">send_event</a></code></li>
4398+
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.send_event_preview" href="#livechat.agent.rtm.api.v36.AgentRtmV36.send_event_preview">send_event_preview</a></code></li>
41844399
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.send_rich_message_postback" href="#livechat.agent.rtm.api.v36.AgentRtmV36.send_rich_message_postback">send_rich_message_postback</a></code></li>
4400+
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.send_thinking_indicator" href="#livechat.agent.rtm.api.v36.AgentRtmV36.send_thinking_indicator">send_thinking_indicator</a></code></li>
41854401
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.send_typing_indicator" href="#livechat.agent.rtm.api.v36.AgentRtmV36.send_typing_indicator">send_typing_indicator</a></code></li>
41864402
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.set_away_status" href="#livechat.agent.rtm.api.v36.AgentRtmV36.set_away_status">set_away_status</a></code></li>
41874403
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.set_routing_status" href="#livechat.agent.rtm.api.v36.AgentRtmV36.set_routing_status">set_routing_status</a></code></li>

0 commit comments

Comments
 (0)