Skip to content

Support for create_customer method removed in agent-api v3.6 and later #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcindebski merged 1 commit into from
Aug 12, 2025
Merged

Support for create_customer method removed in agent-api v3.6 and later #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file.

### Removed
- Removed support for billing-api.
- Support for `create_customer` method removed in agent-api v3.6 and later.

## [0.4.1] - 2025-04-23

Expand Down
107 changes: 0 additions & 107 deletions docs/agent/rtm/api/v36.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,31 +651,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v36</code></h1>
payload = prepare_payload(locals())
return self.ws.send({&#39;action&#39;: &#39;get_customer&#39;, &#39;payload&#39;: payload})

def create_customer(self,
name: str = None,
email: str = None,
avatar: str = None,
session_fields: list = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Creates a new Customer user type.

Args:
name (str): Customer&#39;s name.
email (str): Customer&#39;s email.
avatar (str): URL of the Customer&#39;s avatar.
session_fields (list): An array of custom object-enclosed key:value pairs.
Respects the order of items.
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;create_customer&#39;, &#39;payload&#39;: payload})

def update_customer(self,
id: str = None,
name: str = None,
Expand Down Expand Up @@ -1709,31 +1684,6 @@ <h2 class="section-title" id="header-classes">Classes</h2>
payload = prepare_payload(locals())
return self.ws.send({&#39;action&#39;: &#39;get_customer&#39;, &#39;payload&#39;: payload})

def create_customer(self,
name: str = None,
email: str = None,
avatar: str = None,
session_fields: list = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Creates a new Customer user type.

Args:
name (str): Customer&#39;s name.
email (str): Customer&#39;s email.
avatar (str): URL of the Customer&#39;s avatar.
session_fields (list): An array of custom object-enclosed key:value pairs.
Respects the order of items.
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;create_customer&#39;, &#39;payload&#39;: payload})

def update_customer(self,
id: str = None,
name: str = None,
Expand Down Expand Up @@ -2317,62 +2267,6 @@ <h2 id="returns">Returns</h2>
self.ws.close()</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.create_customer"><code class="name flex">
<span>def <span class="ident">create_customer</span></span>(<span>self, name: str = None, email: str = None, avatar: str = None, session_fields: list = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
<dd>
<div class="desc"><p>Creates a new Customer user type.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>name</code></strong> :&ensp;<code>str</code></dt>
<dd>Customer's name.</dd>
<dt><strong><code>email</code></strong> :&ensp;<code>str</code></dt>
<dd>Customer's email.</dd>
<dt><strong><code>avatar</code></strong> :&ensp;<code>str</code></dt>
<dd>URL of the Customer's avatar.</dd>
<dt><strong><code>session_fields</code></strong> :&ensp;<code>list</code></dt>
<dd>An array of custom object-enclosed key:value pairs.
Respects the order of items.</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 create_customer(self,
name: str = None,
email: str = None,
avatar: str = None,
session_fields: list = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Creates a new Customer user type.

Args:
name (str): Customer&#39;s name.
email (str): Customer&#39;s email.
avatar (str): URL of the Customer&#39;s avatar.
session_fields (list): An array of custom object-enclosed key:value pairs.
Respects the order of items.
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;create_customer&#39;, &#39;payload&#39;: payload})</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v36.AgentRtmV36.deactivate_chat"><code class="name flex">
<span>def <span class="ident">deactivate_chat</span></span>(<span>self, id: str = None, ignore_requester_presence: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
Expand Down Expand Up @@ -4373,7 +4267,6 @@ <h4><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36" href="#livechat.agen
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.ban_customer" href="#livechat.agent.rtm.api.v36.AgentRtmV36.ban_customer">ban_customer</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.change_push_notifications" href="#livechat.agent.rtm.api.v36.AgentRtmV36.change_push_notifications">change_push_notifications</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.close_connection" href="#livechat.agent.rtm.api.v36.AgentRtmV36.close_connection">close_connection</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.create_customer" href="#livechat.agent.rtm.api.v36.AgentRtmV36.create_customer">create_customer</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.deactivate_chat" href="#livechat.agent.rtm.api.v36.AgentRtmV36.deactivate_chat">deactivate_chat</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.delete_chat_properties" href="#livechat.agent.rtm.api.v36.AgentRtmV36.delete_chat_properties">delete_chat_properties</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v36.AgentRtmV36.delete_event_properties" href="#livechat.agent.rtm.api.v36.AgentRtmV36.delete_event_properties">delete_event_properties</a></code></li>
Expand Down
107 changes: 0 additions & 107 deletions docs/agent/rtm/api/v37.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,31 +651,6 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v37</code></h1>
payload = prepare_payload(locals())
return self.ws.send({&#39;action&#39;: &#39;get_customer&#39;, &#39;payload&#39;: payload})

def create_customer(self,
name: str = None,
email: str = None,
avatar: str = None,
session_fields: list = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Creates a new Customer user type.

Args:
name (str): Customer&#39;s name.
email (str): Customer&#39;s email.
avatar (str): URL of the Customer&#39;s avatar.
session_fields (list): An array of custom object-enclosed key:value pairs.
Respects the order of items.
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;create_customer&#39;, &#39;payload&#39;: payload})

def update_customer(self,
id: str = None,
name: str = None,
Expand Down Expand Up @@ -1709,31 +1684,6 @@ <h2 class="section-title" id="header-classes">Classes</h2>
payload = prepare_payload(locals())
return self.ws.send({&#39;action&#39;: &#39;get_customer&#39;, &#39;payload&#39;: payload})

def create_customer(self,
name: str = None,
email: str = None,
avatar: str = None,
session_fields: list = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Creates a new Customer user type.

Args:
name (str): Customer&#39;s name.
email (str): Customer&#39;s email.
avatar (str): URL of the Customer&#39;s avatar.
session_fields (list): An array of custom object-enclosed key:value pairs.
Respects the order of items.
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;create_customer&#39;, &#39;payload&#39;: payload})

def update_customer(self,
id: str = None,
name: str = None,
Expand Down Expand Up @@ -2317,62 +2267,6 @@ <h2 id="returns">Returns</h2>
self.ws.close()</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v37.AgentRtmV37.create_customer"><code class="name flex">
<span>def <span class="ident">create_customer</span></span>(<span>self, name: str = None, email: str = None, avatar: str = None, session_fields: list = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
<dd>
<div class="desc"><p>Creates a new Customer user type.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>name</code></strong> :&ensp;<code>str</code></dt>
<dd>Customer's name.</dd>
<dt><strong><code>email</code></strong> :&ensp;<code>str</code></dt>
<dd>Customer's email.</dd>
<dt><strong><code>avatar</code></strong> :&ensp;<code>str</code></dt>
<dd>URL of the Customer's avatar.</dd>
<dt><strong><code>session_fields</code></strong> :&ensp;<code>list</code></dt>
<dd>An array of custom object-enclosed key:value pairs.
Respects the order of items.</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 create_customer(self,
name: str = None,
email: str = None,
avatar: str = None,
session_fields: list = None,
payload: dict = None) -&gt; RtmResponse:
&#39;&#39;&#39; Creates a new Customer user type.

Args:
name (str): Customer&#39;s name.
email (str): Customer&#39;s email.
avatar (str): URL of the Customer&#39;s avatar.
session_fields (list): An array of custom object-enclosed key:value pairs.
Respects the order of items.
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;create_customer&#39;, &#39;payload&#39;: payload})</code></pre>
</details>
</dd>
<dt id="livechat.agent.rtm.api.v37.AgentRtmV37.deactivate_chat"><code class="name flex">
<span>def <span class="ident">deactivate_chat</span></span>(<span>self, id: str = None, ignore_requester_presence: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
</code></dt>
Expand Down Expand Up @@ -4373,7 +4267,6 @@ <h4><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37" href="#livechat.agen
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.ban_customer" href="#livechat.agent.rtm.api.v37.AgentRtmV37.ban_customer">ban_customer</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.change_push_notifications" href="#livechat.agent.rtm.api.v37.AgentRtmV37.change_push_notifications">change_push_notifications</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.close_connection" href="#livechat.agent.rtm.api.v37.AgentRtmV37.close_connection">close_connection</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.create_customer" href="#livechat.agent.rtm.api.v37.AgentRtmV37.create_customer">create_customer</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.deactivate_chat" href="#livechat.agent.rtm.api.v37.AgentRtmV37.deactivate_chat">deactivate_chat</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.delete_chat_properties" href="#livechat.agent.rtm.api.v37.AgentRtmV37.delete_chat_properties">delete_chat_properties</a></code></li>
<li><code><a title="livechat.agent.rtm.api.v37.AgentRtmV37.delete_event_properties" href="#livechat.agent.rtm.api.v37.AgentRtmV37.delete_event_properties">delete_event_properties</a></code></li>
Expand Down
Loading