Skip to content

Commit a938c2b

Browse files
authored
Merge pull request #76 from livechat/API-10525-refactor-python-sdk-finish
API-10525: finish lc-sdk-py refactor
2 parents c3e0b94 + 2dd2980 commit a938c2b

Some content is hidden

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

50 files changed

+48017
-7034
lines changed

changelog.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# Change Log
22
All notable changes to this project will be documented in this file.
33

4-
## [0.2.2] - TBA
4+
## [0.3.0] - 2022-05-10
5+
6+
### Added
7+
- New methods in configuration-api v3.5 for tags management: `create_tag`, `list_tags`, `update_tag`, `delete_tag`.
8+
- New method in reports-api v3.5 for getting tags usage statistics in chats: `tags_chat_usage`.
59

610
### Changed
11+
- Major refactoring: classes with API methods for each version are now held in separate modules
12+
This is possibly breaking change, please make sure if your imports point to `livechat.<service>.<transport>.base`).
13+
When in doubt, please compare with the updated `examples` directory.
714
- Added new param `owner_client_id` in Configuration API `create_bot` for Interface and v3.5 classes.
815
- Added new methods related to product information (`list_channels`, `check_product_limits`) in Configuration API v3.5.
916

docs/agent_rtm/api/index.html

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.10.0" />
7+
<title>rtm.api API documentation</title>
8+
<meta name="description" content="" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Namespace <code>rtm.api</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
</section>
26+
<section>
27+
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
28+
<dl>
29+
<dt><code class="name"><a title="rtm.api.v33" href="v33.html">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>
33+
<dt><code class="name"><a title="rtm.api.v34" href="v34.html">rtm.api.v34</a></code></dt>
34+
<dd>
35+
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.4.</p></div>
36+
</dd>
37+
<dt><code class="name"><a title="rtm.api.v35" href="v35.html">rtm.api.v35</a></code></dt>
38+
<dd>
39+
<div class="desc"><p>Module containing Agent RTM API client implementation for v3.5.</p></div>
40+
</dd>
41+
</dl>
42+
</section>
43+
<section>
44+
</section>
45+
<section>
46+
</section>
47+
<section>
48+
</section>
49+
</article>
50+
<nav id="sidebar">
51+
<h1>Index</h1>
52+
<div class="toc">
53+
<ul></ul>
54+
</div>
55+
<ul id="index">
56+
<li><h3>Super-module</h3>
57+
<ul>
58+
<li><code><a title="rtm" href="../index.html">rtm</a></code></li>
59+
</ul>
60+
</li>
61+
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
62+
<ul>
63+
<li><code><a title="rtm.api.v33" href="v33.html">rtm.api.v33</a></code></li>
64+
<li><code><a title="rtm.api.v34" href="v34.html">rtm.api.v34</a></code></li>
65+
<li><code><a title="rtm.api.v35" href="v35.html">rtm.api.v35</a></code></li>
66+
</ul>
67+
</li>
68+
</ul>
69+
</nav>
70+
</main>
71+
<footer id="footer">
72+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
73+
</footer>
74+
</body>
75+
</html>

0 commit comments

Comments
 (0)