Skip to content

Commit 8a926db

Browse files
authored
Merge pull request #171 from livechat/ME-1295/remove-support-for-v33
Me 1295/remove support for v33
2 parents 470cc86 + 8c2076f commit 8a926db

File tree

43 files changed

+1090
-27212
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1090
-27212
lines changed

changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ All notable changes to this project will be documented in this file.
2020
- Fixed passing query params in customer-api WEB client for httpx v0.28.0 compatibility.
2121

2222
### Removed
23+
- Support for version 3.3.
2324
- Removed support for billing-api.
2425
- Support for `create_customer` method removed in agent-api v3.6 and later.
2526
- Support for `incoming_customer` webhook removed in v3.6 and later.

docs/agent/rtm/api/index.html

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.api</code></h1>
2626
<section>
2727
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
2828
<dl>
29-
<dt><code class="name"><a title="livechat.agent.rtm.api.v33" href="v33.html">livechat.agent.rtm.api.v33</a></code></dt>
30-
<dd>
31-
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.3.</p></div>
32-
</dd>
3329
<dt><code class="name"><a title="livechat.agent.rtm.api.v34" href="v34.html">livechat.agent.rtm.api.v34</a></code></dt>
3430
<dd>
3531
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.4.</p></div>
@@ -68,7 +64,6 @@ <h1>Index</h1>
6864
</li>
6965
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
7066
<ul>
71-
<li><code><a title="livechat.agent.rtm.api.v33" href="v33.html">livechat.agent.rtm.api.v33</a></code></li>
7267
<li><code><a title="livechat.agent.rtm.api.v34" href="v34.html">livechat.agent.rtm.api.v34</a></code></li>
7368
<li><code><a title="livechat.agent.rtm.api.v35" href="v35.html">livechat.agent.rtm.api.v35</a></code></li>
7469
<li><code><a title="livechat.agent.rtm.api.v36" href="v36.html">livechat.agent.rtm.api.v36</a></code></li>

docs/agent/rtm/api/v33.html

Lines changed: 0 additions & 4378 deletions
This file was deleted.

docs/agent/rtm/api/v36.html

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,29 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v36</code></h1>
433433
&#39;payload&#39;: payload
434434
})
435435

436+
def request_thread_summary(self,
437+
chat_id: str = None,
438+
thread_id: str = None,
439+
payload: dict = None) -&gt; RtmResponse:
440+
&#39;&#39;&#39; Requests a thread summary.
441+
442+
Args:
443+
chat_id (str): ID of the chat to request thread summary for.
444+
thread_id (str): ID of the thread to request summary for.
445+
payload (dict): Custom payload to be used as request&#39;s data.
446+
It overrides all other parameters provided for the method.
447+
448+
Returns:
449+
RtmResponse: RTM response structure (`request_id`, `action`,
450+
`type`, `success` and `payload` properties)
451+
&#39;&#39;&#39;
452+
if payload is None:
453+
payload = prepare_payload(locals())
454+
return self.ws.send({
455+
&#39;action&#39;: &#39;request_thread_summary&#39;,
456+
&#39;payload&#39;: payload
457+
})
458+
436459
# Properties
437460

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

1492+
def request_thread_summary(self,
1493+
chat_id: str = None,
1494+
thread_id: str = None,
1495+
payload: dict = None) -&gt; RtmResponse:
1496+
&#39;&#39;&#39; Requests a thread summary.
1497+
1498+
Args:
1499+
chat_id (str): ID of the chat to request thread summary for.
1500+
thread_id (str): ID of the thread to request summary for.
1501+
payload (dict): Custom payload to be used as request&#39;s data.
1502+
It overrides all other parameters provided for the method.
1503+
1504+
Returns:
1505+
RtmResponse: RTM response structure (`request_id`, `action`,
1506+
`type`, `success` and `payload` properties)
1507+
&#39;&#39;&#39;
1508+
if payload is None:
1509+
payload = prepare_payload(locals())
1510+
return self.ws.send({
1511+
&#39;action&#39;: &#39;request_thread_summary&#39;,
1512+
&#39;payload&#39;: payload
1513+
})
1514+
14691515
# Properties
14701516

14711517
def update_chat_properties(self,
@@ -3256,6 +3302,55 @@ <h2 id="returns">Returns</h2>
32563302
})</code></pre>
32573303
</details>
32583304
</dd>
3305+
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.request_thread_summary"><code class="name flex">
3306+
<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>
3307+
</code></dt>
3308+
<dd>
3309+
<div class="desc"><p>Requests a thread summary.</p>
3310+
<h2 id="args">Args</h2>
3311+
<dl>
3312+
<dt><strong><code>chat_id</code></strong> :&ensp;<code>str</code></dt>
3313+
<dd>ID of the chat to request thread summary for.</dd>
3314+
<dt><strong><code>thread_id</code></strong> :&ensp;<code>str</code></dt>
3315+
<dd>ID of the thread to request summary for.</dd>
3316+
<dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
3317+
<dd>Custom payload to be used as request's data.
3318+
It overrides all other parameters provided for the method.</dd>
3319+
</dl>
3320+
<h2 id="returns">Returns</h2>
3321+
<dl>
3322+
<dt><code>RtmResponse</code></dt>
3323+
<dd>RTM response structure (<code>request_id</code>, <code>action</code>,
3324+
<code>type</code>, <code>success</code> and <code>payload</code> properties)</dd>
3325+
</dl></div>
3326+
<details class="source">
3327+
<summary>
3328+
<span>Expand source code</span>
3329+
</summary>
3330+
<pre><code class="python">def request_thread_summary(self,
3331+
chat_id: str = None,
3332+
thread_id: str = None,
3333+
payload: dict = None) -&gt; RtmResponse:
3334+
&#39;&#39;&#39; Requests a thread summary.
3335+
3336+
Args:
3337+
chat_id (str): ID of the chat to request thread summary for.
3338+
thread_id (str): ID of the thread to request summary for.
3339+
payload (dict): Custom payload to be used as request&#39;s data.
3340+
It overrides all other parameters provided for the method.
3341+
3342+
Returns:
3343+
RtmResponse: RTM response structure (`request_id`, `action`,
3344+
`type`, `success` and `payload` properties)
3345+
&#39;&#39;&#39;
3346+
if payload is None:
3347+
payload = prepare_payload(locals())
3348+
return self.ws.send({
3349+
&#39;action&#39;: &#39;request_thread_summary&#39;,
3350+
&#39;payload&#39;: payload
3351+
})</code></pre>
3352+
</details>
3353+
</dd>
32593354
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.resume_chat"><code class="name flex">
32603355
<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>
32613356
</code></dt>
@@ -4286,6 +4381,7 @@ <h4><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36" href="#livechat.agen
42864381
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.multicast" href="#livechat.agent.rtm.api.v36.AgentRtmV36.multicast">multicast</a></code></li>
42874382
<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>
42884383
<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>
4384+
<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>
42894385
<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>
42904386
<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>
42914387
<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>

docs/agent/rtm/api/v37.html

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,29 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v37</code></h1>
433433
&#39;payload&#39;: payload
434434
})
435435

436+
def request_thread_summary(self,
437+
chat_id: str = None,
438+
thread_id: str = None,
439+
payload: dict = None) -&gt; RtmResponse:
440+
&#39;&#39;&#39; Requests a thread summary.
441+
442+
Args:
443+
chat_id (str): ID of the chat to request thread summary for.
444+
thread_id (str): ID of the thread to request summary for.
445+
payload (dict): Custom payload to be used as request&#39;s data.
446+
It overrides all other parameters provided for the method.
447+
448+
Returns:
449+
RtmResponse: RTM response structure (`request_id`, `action`,
450+
`type`, `success` and `payload` properties)
451+
&#39;&#39;&#39;
452+
if payload is None:
453+
payload = prepare_payload(locals())
454+
return self.ws.send({
455+
&#39;action&#39;: &#39;request_thread_summary&#39;,
456+
&#39;payload&#39;: payload
457+
})
458+
436459
# Properties
437460

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

1492+
def request_thread_summary(self,
1493+
chat_id: str = None,
1494+
thread_id: str = None,
1495+
payload: dict = None) -&gt; RtmResponse:
1496+
&#39;&#39;&#39; Requests a thread summary.
1497+
1498+
Args:
1499+
chat_id (str): ID of the chat to request thread summary for.
1500+
thread_id (str): ID of the thread to request summary for.
1501+
payload (dict): Custom payload to be used as request&#39;s data.
1502+
It overrides all other parameters provided for the method.
1503+
1504+
Returns:
1505+
RtmResponse: RTM response structure (`request_id`, `action`,
1506+
`type`, `success` and `payload` properties)
1507+
&#39;&#39;&#39;
1508+
if payload is None:
1509+
payload = prepare_payload(locals())
1510+
return self.ws.send({
1511+
&#39;action&#39;: &#39;request_thread_summary&#39;,
1512+
&#39;payload&#39;: payload
1513+
})
1514+
14691515
# Properties
14701516

14711517
def update_chat_properties(self,
@@ -3256,6 +3302,55 @@ <h2 id="returns">Returns</h2>
32563302
})</code></pre>
32573303
</details>
32583304
</dd>
3305+
<dt id="livechat.agent.rtm.api.v37.AgentRtmV37.request_thread_summary"><code class="name flex">
3306+
<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>
3307+
</code></dt>
3308+
<dd>
3309+
<div class="desc"><p>Requests a thread summary.</p>
3310+
<h2 id="args">Args</h2>
3311+
<dl>
3312+
<dt><strong><code>chat_id</code></strong> :&ensp;<code>str</code></dt>
3313+
<dd>ID of the chat to request thread summary for.</dd>
3314+
<dt><strong><code>thread_id</code></strong> :&ensp;<code>str</code></dt>
3315+
<dd>ID of the thread to request summary for.</dd>
3316+
<dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
3317+
<dd>Custom payload to be used as request's data.
3318+
It overrides all other parameters provided for the method.</dd>
3319+
</dl>
3320+
<h2 id="returns">Returns</h2>
3321+
<dl>
3322+
<dt><code>RtmResponse</code></dt>
3323+
<dd>RTM response structure (<code>request_id</code>, <code>action</code>,
3324+
<code>type</code>, <code>success</code> and <code>payload</code> properties)</dd>
3325+
</dl></div>
3326+
<details class="source">
3327+
<summary>
3328+
<span>Expand source code</span>
3329+
</summary>
3330+
<pre><code class="python">def request_thread_summary(self,
3331+
chat_id: str = None,
3332+
thread_id: str = None,
3333+
payload: dict = None) -&gt; RtmResponse:
3334+
&#39;&#39;&#39; Requests a thread summary.
3335+
3336+
Args:
3337+
chat_id (str): ID of the chat to request thread summary for.
3338+
thread_id (str): ID of the thread to request summary for.
3339+
payload (dict): Custom payload to be used as request&#39;s data.
3340+
It overrides all other parameters provided for the method.
3341+
3342+
Returns:
3343+
RtmResponse: RTM response structure (`request_id`, `action`,
3344+
`type`, `success` and `payload` properties)
3345+
&#39;&#39;&#39;
3346+
if payload is None:
3347+
payload = prepare_payload(locals())
3348+
return self.ws.send({
3349+
&#39;action&#39;: &#39;request_thread_summary&#39;,
3350+
&#39;payload&#39;: payload
3351+
})</code></pre>
3352+
</details>
3353+
</dd>
32593354
<dt id="livechat.agent.rtm.api.v37.AgentRtmV37.resume_chat"><code class="name flex">
32603355
<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>
32613356
</code></dt>
@@ -4286,6 +4381,7 @@ <h4><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37" href="#livechat.agen
42864381
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.multicast" href="#livechat.agent.rtm.api.v37.AgentRtmV37.multicast">multicast</a></code></li>
42874382
<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>
42884383
<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>
4384+
<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>
42894385
<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>
42904386
<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>
42914387
<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>

docs/agent/rtm/base.html

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.base</code></h1>
3434

3535
from typing import Callable, Union
3636

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

5957
Args:
@@ -69,7 +67,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.base</code></h1>
6967
ValueError: If the specified version does not exist.
7068
&#39;&#39;&#39;
7169
client = {
72-
&#39;3.3&#39;: AgentRtmV33,
7370
&#39;3.4&#39;: AgentRtmV34,
7471
&#39;3.5&#39;: AgentRtmV35,
7572
&#39;3.6&#39;: AgentRtmV36,
@@ -105,8 +102,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
105102
version: str = stable_version,
106103
base_url: str = api_url,
107104
header: Union[list, dict, Callable, None] = None,
108-
) -&gt; Union[AgentRtmV33, AgentRtmV34, AgentRtmV35, AgentRtmV36,
109-
AgentRtmV37]:
105+
) -&gt; Union[AgentRtmV34, AgentRtmV35, AgentRtmV36, AgentRtmV37]:
110106
&#39;&#39;&#39; Returns client for specific Agent RTM version.
111107

112108
Args:
@@ -122,7 +118,6 @@ <h2 class="section-title" id="header-classes">Classes</h2>
122118
ValueError: If the specified version does not exist.
123119
&#39;&#39;&#39;
124120
client = {
125-
&#39;3.3&#39;: AgentRtmV33,
126121
&#39;3.4&#39;: AgentRtmV34,
127122
&#39;3.5&#39;: AgentRtmV35,
128123
&#39;3.6&#39;: AgentRtmV36,
@@ -135,7 +130,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
135130
<h3>Static methods</h3>
136131
<dl>
137132
<dt id="livechat.agent.rtm.base.AgentRTM.get_client"><code class="name flex">
138-
<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>
133+
<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>
139134
</code></dt>
140135
<dd>
141136
<div class="desc"><p>Returns client for specific Agent RTM version.</p>
@@ -165,8 +160,7 @@ <h2 id="raises">Raises</h2>
165160
version: str = stable_version,
166161
base_url: str = api_url,
167162
header: Union[list, dict, Callable, None] = None,
168-
) -&gt; Union[AgentRtmV33, AgentRtmV34, AgentRtmV35, AgentRtmV36,
169-
AgentRtmV37]:
163+
) -&gt; Union[AgentRtmV34, AgentRtmV35, AgentRtmV36, AgentRtmV37]:
170164
&#39;&#39;&#39; Returns client for specific Agent RTM version.
171165

172166
Args:
@@ -182,7 +176,6 @@ <h2 id="raises">Raises</h2>
182176
ValueError: If the specified version does not exist.
183177
&#39;&#39;&#39;
184178
client = {
185-
&#39;3.3&#39;: AgentRtmV33,
186179
&#39;3.4&#39;: AgentRtmV34,
187180
&#39;3.5&#39;: AgentRtmV35,
188181
&#39;3.6&#39;: AgentRtmV36,

docs/agent/web/api/index.html

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@ <h1 class="title">Module <code>livechat.agent.web.api</code></h1>
2626
<section>
2727
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
2828
<dl>
29-
<dt><code class="name"><a title="livechat.agent.web.api.v33" href="v33.html">livechat.agent.web.api.v33</a></code></dt>
30-
<dd>
31-
<div class="desc"><p>Agent Web client implementation for v3.3.</p></div>
32-
</dd>
3329
<dt><code class="name"><a title="livechat.agent.web.api.v34" href="v34.html">livechat.agent.web.api.v34</a></code></dt>
3430
<dd>
3531
<div class="desc"><p>Agent Web client implementation for v3.4.</p></div>
@@ -68,7 +64,6 @@ <h1>Index</h1>
6864
</li>
6965
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
7066
<ul>
71-
<li><code><a title="livechat.agent.web.api.v33" href="v33.html">livechat.agent.web.api.v33</a></code></li>
7267
<li><code><a title="livechat.agent.web.api.v34" href="v34.html">livechat.agent.web.api.v34</a></code></li>
7368
<li><code><a title="livechat.agent.web.api.v35" href="v35.html">livechat.agent.web.api.v35</a></code></li>
7469
<li><code><a title="livechat.agent.web.api.v36" href="v36.html">livechat.agent.web.api.v36</a></code></li>

0 commit comments

Comments
 (0)