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
1 change: 1 addition & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ All notable changes to this project will be documented in this file.
- Fixed passing query params in customer-api WEB client for httpx v0.28.0 compatibility.

### Removed
- Support for version 3.3.
- Removed support for billing-api.
- Support for `create_customer` method removed in agent-api v3.6 and later.
- Support for `incoming_customer` webhook removed in v3.6 and later.
Expand Down
5 changes: 0 additions & 5 deletions docs/agent/rtm/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.api</code></h1>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="livechat.agent.rtm.api.v33" href="v33.html">livechat.agent.rtm.api.v33</a></code></dt>
<dd>
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.3.</p></div>
</dd>
<dt><code class="name"><a title="livechat.agent.rtm.api.v34" href="v34.html">livechat.agent.rtm.api.v34</a></code></dt>
<dd>
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.4.</p></div>
Expand Down Expand Up @@ -68,7 +64,6 @@ <h1>Index</h1>
</li>
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="livechat.agent.rtm.api.v33" href="v33.html">livechat.agent.rtm.api.v33</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v34" href="v34.html">livechat.agent.rtm.api.v34</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v35" href="v35.html">livechat.agent.rtm.api.v35</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36" href="v36.html">livechat.agent.rtm.api.v36</a></code></li>
Expand Down
4,378 changes: 0 additions & 4,378 deletions docs/agent/rtm/api/v33.html

This file was deleted.

96 changes: 96 additions & 0 deletions docs/agent/rtm/api/v36.html
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,29 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v36</code></h1>
&#39;payload&#39;: payload
})

def request_thread_summary(self,
chat_id: str = None,
thread_id: str = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Requests a thread summary.

Args:
chat_id (str): ID of the chat to request thread summary for.
thread_id (str): ID of the thread to request summary for.
payload (dict): Custom payload to be used as request&#39;s data.
It overrides all other parameters provided for the method.

Returns:
RtmResponse: RTM response structure (`request_id`, `action`,
`type`, `success` and `payload` properties)
&#39;&#39;&#39;
if payload is None:
payload = prepare_payload(locals())
return self.ws.send({
&#39;action&#39;: &#39;request_thread_summary&#39;,
&#39;payload&#39;: payload
})

# Properties

def update_chat_properties(self,
Expand Down Expand Up @@ -1466,6 +1489,29 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#39;payload&#39;: payload
})

def request_thread_summary(self,
chat_id: str = None,
thread_id: str = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Requests a thread summary.

Args:
chat_id (str): ID of the chat to request thread summary for.
thread_id (str): ID of the thread to request summary for.
payload (dict): Custom payload to be used as request&#39;s data.
It overrides all other parameters provided for the method.

Returns:
RtmResponse: RTM response structure (`request_id`, `action`,
`type`, `success` and `payload` properties)
&#39;&#39;&#39;
if payload is None:
payload = prepare_payload(locals())
return self.ws.send({
&#39;action&#39;: &#39;request_thread_summary&#39;,
&#39;payload&#39;: payload
})

# Properties

def update_chat_properties(self,
Expand Down Expand Up @@ -3256,6 +3302,55 @@ <h2 id="returns">Returns</h2>
})</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.request_thread_summary"><code class="name flex">
<span>def <span class="ident">request_thread_summary</span></span>(<span>self, chat_id: str = None, thread_id: str = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
<dd>
<div class="desc"><p>Requests a thread summary.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>chat_id</code></strong> :&ensp;<code>str</code></dt>
<dd>ID of the chat to request thread summary for.</dd>
<dt><strong><code>thread_id</code></strong> :&ensp;<code>str</code></dt>
<dd>ID of the thread to request summary for.</dd>
<dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
<dd>Custom payload to be used as request's data.
It overrides all other parameters provided for the method.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>RtmResponse</code></dt>
<dd>RTM response structure (<code>request_id</code>, <code>action</code>,
<code>type</code>, <code>success</code> and <code>payload</code> properties)</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def request_thread_summary(self,
chat_id: str = None,
thread_id: str = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Requests a thread summary.

Args:
chat_id (str): ID of the chat to request thread summary for.
thread_id (str): ID of the thread to request summary for.
payload (dict): Custom payload to be used as request&#39;s data.
It overrides all other parameters provided for the method.

Returns:
RtmResponse: RTM response structure (`request_id`, `action`,
`type`, `success` and `payload` properties)
&#39;&#39;&#39;
if payload is None:
payload = prepare_payload(locals())
return self.ws.send({
&#39;action&#39;: &#39;request_thread_summary&#39;,
&#39;payload&#39;: payload
})</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.resume_chat"><code class="name flex">
<span>def <span class="ident">resume_chat</span></span>(<span>self, chat: dict = None, active: bool = None, continuous: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
Expand Down Expand Up @@ -4286,6 +4381,7 @@ <h4><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36" href="#livechat.agen
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.multicast" href="#livechat.agent.rtm.api.v36.AgentRtmV36.multicast">multicast</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.open_connection" href="#livechat.agent.rtm.api.v36.AgentRtmV36.open_connection">open_connection</a></code></li>
<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>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.request_thread_summary" href="#livechat.agent.rtm.api.v36.AgentRtmV36.request_thread_summary">request_thread_summary</a></code></li>
<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>
<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>
<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>
Expand Down
96 changes: 96 additions & 0 deletions docs/agent/rtm/api/v37.html
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,29 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v37</code></h1>
&#39;payload&#39;: payload
})

def request_thread_summary(self,
chat_id: str = None,
thread_id: str = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Requests a thread summary.

Args:
chat_id (str): ID of the chat to request thread summary for.
thread_id (str): ID of the thread to request summary for.
payload (dict): Custom payload to be used as request&#39;s data.
It overrides all other parameters provided for the method.

Returns:
RtmResponse: RTM response structure (`request_id`, `action`,
`type`, `success` and `payload` properties)
&#39;&#39;&#39;
if payload is None:
payload = prepare_payload(locals())
return self.ws.send({
&#39;action&#39;: &#39;request_thread_summary&#39;,
&#39;payload&#39;: payload
})

# Properties

def update_chat_properties(self,
Expand Down Expand Up @@ -1466,6 +1489,29 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#39;payload&#39;: payload
})

def request_thread_summary(self,
chat_id: str = None,
thread_id: str = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Requests a thread summary.

Args:
chat_id (str): ID of the chat to request thread summary for.
thread_id (str): ID of the thread to request summary for.
payload (dict): Custom payload to be used as request&#39;s data.
It overrides all other parameters provided for the method.

Returns:
RtmResponse: RTM response structure (`request_id`, `action`,
`type`, `success` and `payload` properties)
&#39;&#39;&#39;
if payload is None:
payload = prepare_payload(locals())
return self.ws.send({
&#39;action&#39;: &#39;request_thread_summary&#39;,
&#39;payload&#39;: payload
})

# Properties

def update_chat_properties(self,
Expand Down Expand Up @@ -3256,6 +3302,55 @@ <h2 id="returns">Returns</h2>
})</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v37.AgentRtmV37.request_thread_summary"><code class="name flex">
<span>def <span class="ident">request_thread_summary</span></span>(<span>self, chat_id: str = None, thread_id: str = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
<dd>
<div class="desc"><p>Requests a thread summary.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>chat_id</code></strong> :&ensp;<code>str</code></dt>
<dd>ID of the chat to request thread summary for.</dd>
<dt><strong><code>thread_id</code></strong> :&ensp;<code>str</code></dt>
<dd>ID of the thread to request summary for.</dd>
<dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
<dd>Custom payload to be used as request's data.
It overrides all other parameters provided for the method.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>RtmResponse</code></dt>
<dd>RTM response structure (<code>request_id</code>, <code>action</code>,
<code>type</code>, <code>success</code> and <code>payload</code> properties)</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def request_thread_summary(self,
chat_id: str = None,
thread_id: str = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Requests a thread summary.

Args:
chat_id (str): ID of the chat to request thread summary for.
thread_id (str): ID of the thread to request summary for.
payload (dict): Custom payload to be used as request&#39;s data.
It overrides all other parameters provided for the method.

Returns:
RtmResponse: RTM response structure (`request_id`, `action`,
`type`, `success` and `payload` properties)
&#39;&#39;&#39;
if payload is None:
payload = prepare_payload(locals())
return self.ws.send({
&#39;action&#39;: &#39;request_thread_summary&#39;,
&#39;payload&#39;: payload
})</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v37.AgentRtmV37.resume_chat"><code class="name flex">
<span>def <span class="ident">resume_chat</span></span>(<span>self, chat: dict = None, active: bool = None, continuous: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
Expand Down Expand Up @@ -4286,6 +4381,7 @@ <h4><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37" href="#livechat.agen
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.multicast" href="#livechat.agent.rtm.api.v37.AgentRtmV37.multicast">multicast</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.open_connection" href="#livechat.agent.rtm.api.v37.AgentRtmV37.open_connection">open_connection</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.remove_user_from_chat" href="#livechat.agent.rtm.api.v37.AgentRtmV37.remove_user_from_chat">remove_user_from_chat</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.request_thread_summary" href="#livechat.agent.rtm.api.v37.AgentRtmV37.request_thread_summary">request_thread_summary</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.resume_chat" href="#livechat.agent.rtm.api.v37.AgentRtmV37.resume_chat">resume_chat</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.send_event" href="#livechat.agent.rtm.api.v37.AgentRtmV37.send_event">send_event</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.send_event_preview" href="#livechat.agent.rtm.api.v37.AgentRtmV37.send_event_preview">send_event_preview</a></code></li>
Expand Down
15 changes: 4 additions & 11 deletions docs/agent/rtm/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.base</code></h1>

from typing import Callable, Union

from livechat.agent.rtm.api.v33 import AgentRtmV33
from livechat.agent.rtm.api.v34 import AgentRtmV34
from livechat.agent.rtm.api.v35 import AgentRtmV35
from livechat.agent.rtm.api.v36 import AgentRtmV36
Expand All @@ -52,8 +51,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.base</code></h1>
version: str = stable_version,
base_url: str = api_url,
header: Union[list, dict, Callable, None] = None,
) -&gt; Union[AgentRtmV33, AgentRtmV34, AgentRtmV35, AgentRtmV36,
AgentRtmV37]:
) -&gt; Union[AgentRtmV34, AgentRtmV35, AgentRtmV36, AgentRtmV37]:
&#39;&#39;&#39; Returns client for specific Agent RTM version.

Args:
Expand All @@ -69,7 +67,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.base</code></h1>
ValueError: If the specified version does not exist.
&#39;&#39;&#39;
client = {
&#39;3.3&#39;: AgentRtmV33,
&#39;3.4&#39;: AgentRtmV34,
&#39;3.5&#39;: AgentRtmV35,
&#39;3.6&#39;: AgentRtmV36,
Expand Down Expand Up @@ -105,8 +102,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
version: str = stable_version,
base_url: str = api_url,
header: Union[list, dict, Callable, None] = None,
) -&gt; Union[AgentRtmV33, AgentRtmV34, AgentRtmV35, AgentRtmV36,
AgentRtmV37]:
) -&gt; Union[AgentRtmV34, AgentRtmV35, AgentRtmV36, AgentRtmV37]:
&#39;&#39;&#39; Returns client for specific Agent RTM version.

Args:
Expand All @@ -122,7 +118,6 @@ <h2 class="section-title" id="header-classes">Classes</h2>
ValueError: If the specified version does not exist.
&#39;&#39;&#39;
client = {
&#39;3.3&#39;: AgentRtmV33,
&#39;3.4&#39;: AgentRtmV34,
&#39;3.5&#39;: AgentRtmV35,
&#39;3.6&#39;: AgentRtmV36,
Expand All @@ -135,7 +130,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<h3>Static methods</h3>
<dl>
<dt id="livechat.agent.rtm.base.AgentRTM.get_client"><code class="name flex">
<span>def <span class="ident">get_client</span></span>(<span>version: str = '3.6', base_url: str = 'api.livechatinc.com', header: Union[list, dict, Callable, None] = None) ‑> Union[<a title="livechat.agent.rtm.api.v33.AgentRtmV33" href="api/v33.html#livechat.agent.rtm.api.v33.AgentRtmV33">AgentRtmV33</a>, <a title="livechat.agent.rtm.api.v34.AgentRtmV34" href="api/v34.html#livechat.agent.rtm.api.v34.AgentRtmV34">AgentRtmV34</a>, <a title="livechat.agent.rtm.api.v35.AgentRtmV35" href="api/v35.html#livechat.agent.rtm.api.v35.AgentRtmV35">AgentRtmV35</a>, <a title="livechat.agent.rtm.api.v36.AgentRtmV36" href="api/v36.html#livechat.agent.rtm.api.v36.AgentRtmV36">AgentRtmV36</a>, <a title="livechat.agent.rtm.api.v37.AgentRtmV37" href="api/v37.html#livechat.agent.rtm.api.v37.AgentRtmV37">AgentRtmV37</a>]</span>
<span>def <span class="ident">get_client</span></span>(<span>version: str = '3.6', base_url: str = 'api.livechatinc.com', header: Union[list, dict, Callable, None] = None) ‑> Union[<a title="livechat.agent.rtm.api.v34.AgentRtmV34" href="api/v34.html#livechat.agent.rtm.api.v34.AgentRtmV34">AgentRtmV34</a>, <a title="livechat.agent.rtm.api.v35.AgentRtmV35" href="api/v35.html#livechat.agent.rtm.api.v35.AgentRtmV35">AgentRtmV35</a>, <a title="livechat.agent.rtm.api.v36.AgentRtmV36" href="api/v36.html#livechat.agent.rtm.api.v36.AgentRtmV36">AgentRtmV36</a>, <a title="livechat.agent.rtm.api.v37.AgentRtmV37" href="api/v37.html#livechat.agent.rtm.api.v37.AgentRtmV37">AgentRtmV37</a>]</span>
</code></dt>
<dd>
<div class="desc"><p>Returns client for specific Agent RTM version.</p>
Expand Down Expand Up @@ -165,8 +160,7 @@ <h2 id="raises">Raises</h2>
version: str = stable_version,
base_url: str = api_url,
header: Union[list, dict, Callable, None] = None,
) -&gt; Union[AgentRtmV33, AgentRtmV34, AgentRtmV35, AgentRtmV36,
AgentRtmV37]:
) -&gt; Union[AgentRtmV34, AgentRtmV35, AgentRtmV36, AgentRtmV37]:
&#39;&#39;&#39; Returns client for specific Agent RTM version.

Args:
Expand All @@ -182,7 +176,6 @@ <h2 id="raises">Raises</h2>
ValueError: If the specified version does not exist.
&#39;&#39;&#39;
client = {
&#39;3.3&#39;: AgentRtmV33,
&#39;3.4&#39;: AgentRtmV34,
&#39;3.5&#39;: AgentRtmV35,
&#39;3.6&#39;: AgentRtmV36,
Expand Down
5 changes: 0 additions & 5 deletions docs/agent/web/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ <h1 class="title">Module <code>livechat.agent.web.api</code></h1>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="livechat.agent.web.api.v33" href="v33.html">livechat.agent.web.api.v33</a></code></dt>
<dd>
<div class="desc"><p>Agent Web client implementation for v3.3.</p></div>
</dd>
<dt><code class="name"><a title="livechat.agent.web.api.v34" href="v34.html">livechat.agent.web.api.v34</a></code></dt>
<dd>
<div class="desc"><p>Agent Web client implementation for v3.4.</p></div>
Expand Down Expand Up @@ -68,7 +64,6 @@ <h1>Index</h1>
</li>
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="livechat.agent.web.api.v33" href="v33.html">livechat.agent.web.api.v33</a></code></li>
<li><code><a title="livechat.agent.web.api.v34" href="v34.html">livechat.agent.web.api.v34</a></code></li>
<li><code><a title="livechat.agent.web.api.v35" href="v35.html">livechat.agent.web.api.v35</a></code></li>
<li><code><a title="livechat.agent.web.api.v36" href="v36.html">livechat.agent.web.api.v36</a></code></li>
Expand Down
Loading
Loading