Module livechat.configuration.api.v36
Configuration API module with client class in version 3.6.
Expand source code
''' Configuration API module with client class in version 3.6. '''
from typing import List, Union
import httpx
from livechat.utils.helpers import prepare_payload
from livechat.utils.http_client import HttpClient
from livechat.utils.structures import AccessToken
# pylint: disable=unused-argument,too-many-arguments,redefined-builtin,invalid-name
class ConfigurationApiV36(HttpClient):
''' Configuration API client class in version 3.6. '''
def __init__(self,
token: Union[AccessToken, str],
base_url: str,
http2: bool,
proxies=None,
verify: bool = True,
disable_logging: bool = False,
timeout: float = httpx.Timeout(15)):
super().__init__(token, base_url, http2, proxies, verify,
disable_logging, timeout)
self.api_url = f'https://{base_url}/v3.6/configuration/action'
# Agents
def create_agent(self,
id: str = None,
name: str = None,
role: str = None,
avatar_path: str = None,
job_title: str = None,
mobile: str = None,
max_chats_count: int = None,
awaiting_approval: bool = None,
groups: list = None,
notifications: list = None,
email_subscriptions: list = None,
work_scheduler: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Creates a new Agent with specified parameters within a license.
Args:
id (str): Agent's ID.
name (str): Agent's name.
role (str): Agent role, should be one of the following:
`viceowner`, `administrator`, `normal` (default).
avatar_path (str): URL path of the Agent's avatar.
job_title (str): Agent's job title.
mobile (str): Agent's mobile number.
max_chats_count (int): Agent's maximum number of concurrent chats.
awaiting_approval (bool): Determines if the Agent will be awaiting
approval after creation.
groups (list): Groups an Agent belongs to.
notifications (list): Represents which Agent notifications are turned on.
email_subscriptions (list): Represents which subscriptions will be send to
the Agent via email.
work_scheduler (dict): Work scheduler options to set for the new Agent.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/create_agent',
json=payload,
headers=headers)
def get_agent(self,
id: str = None,
fields: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns the info about an Agent specified by `id`.
Args:
id (str): Agent's ID.
fields (list): Additional fields to include.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/get_agent',
json=payload,
headers=headers)
def list_agents(self,
filters: dict = None,
fields: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns all Agents within a license.
Args:
filters (dict): Possible request filters.
fields (list): Additional fields to include.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_agents',
json=payload,
headers=headers)
def update_agent(self,
id: str = None,
name: str = None,
role: str = None,
avatar_path: str = None,
job_title: str = None,
mobile: str = None,
max_chats_count: int = None,
groups: list = None,
notifications: list = None,
email_subscriptions: list = None,
work_scheduler: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates the properties of an Agent specified by `id`.
Args:
id (str): Agent's ID.
name (str): Agent's name.
role (str): Agent role, should be one of the following:
`viceowner`, `administrator`, `normal` (default).
avatar_path (str): URL path of the Agent's avatar.
job_title (str): Agent's job title.
mobile (str): Agent's mobile number.
max_chats_count (int): Agent's maximum number of concurrent chats.
groups (list): Groups an Agent belongs to.
notifications (list): Represents which Agent notifications are turned on.
email_subscriptions (list): Represents which subscriptions will be send to
the Agent via email.
work_scheduler (dict): Work scheduler options to set for the new Agent.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_agent',
json=payload,
headers=headers)
def delete_agent(self,
id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes an Agent specified by `id`.
Args:
id (str): Agent's ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_agent',
json=payload,
headers=headers)
def suspend_agent(self,
id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Suspends an Agent specified by `id`.
Args:
id (str): Agent's ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/suspend_agent',
json=payload,
headers=headers)
def unsuspend_agent(self,
id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Unsuspends an Agent specified by `id`.
Args:
id (str): Agent's ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/unsuspend_agent',
json=payload,
headers=headers)
def request_agent_unsuspension(self,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' A suspended Agent can send emails to license owners and vice owners
with an unsuspension request.
Args:
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/request_agent_unsuspension',
json=payload,
headers=headers)
def approve_agent(self,
id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Approves an Agent thus allowing the Agent to use the application.
Args:
id (str): Agent's ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/approve_agent',
json=payload,
headers=headers)
# Auto access
def add_auto_access(self,
access: dict = None,
conditions: dict = None,
description: str = None,
next_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Creates an auto access data structure, which is a set of conditions
for the tracking URL and geolocation of a customer.
Args:
access (dict): Destination access.
conditions (dict): Conditions to check.
description (str): Description of the auto access.
next_id (str): ID of an existing auto access.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/add_auto_access',
json=payload,
headers=headers)
def list_auto_accesses(self,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns all existing auto access data structures.
Args:
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_auto_accesses',
json=payload,
headers=headers)
def delete_auto_access(self,
id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes an existing auto access data structure specified by its ID.
Args:
id (str): Auto access ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_auto_access',
json=payload,
headers=headers)
def update_auto_access(self,
id: str = None,
next_id: str = None,
access: dict = None,
conditions: dict = None,
description: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Moves an existing auto access data structure, specified by id,
before another one, specified by next_id.
Args:
id (str): ID of the auto access to move.
next_id (str): ID of the auto access that should follow the moved auto access.
access (dict): Destination access.
conditions (dict): Conditions to check.
description (str): Description of the auto access.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_auto_access',
json=payload,
headers=headers)
# Bots
def create_bot(self,
name: str = None,
avatar: str = None,
max_chats_count: int = None,
default_group_priority: str = None,
job_title: str = None,
groups: list = None,
work_scheduler: dict = None,
timezone: str = None,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Creates a new bot.
Args:
name (str): Display name.
avatar (str): Avatar URL.
max_chats_count (int): Max. number of incoming chats that can be routed to the Bot; default: 6.
default_group_priority (str): The default routing priority for a group without defined priority.
job_title (str): Bot's job title.
groups (list): Groups the Bot belongs to.
work_scheduler (dict): Work scheduler options to set for the new Bot.
timezone (str): The time zone in which the Bot's work scheduler should operate.
owner_client_id (str): ID of the client bot will be assigned to.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/create_bot',
json=payload,
headers=headers)
def create_bot_template(self,
name: str = None,
avatar: str = None,
max_chats_count: int = None,
default_group_priority: str = None,
job_title: str = None,
owner_client_id: str = None,
affect_existing_installations: bool = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Creates a new bot template for the Client ID (application) provided in the request.
One Client ID can register up to five bot templates.
Bots based on the template will be automatically created on the license when the application is installed.
The bots will have the same ID as the bot template. If the application is already installed on the license,
the bots will be created only if `affect_existing_installations` is set to `true`.
Args:
name (str): Display name.
avatar (str): Avatar URL.
max_chats_count (int): Max. number of incoming chats that can be routed to the Bot; default: 6.
default_group_priority (str): The default routing priority for a group without defined priority.
job_title (str): Bot's job title.
owner_client_id (str): Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the `client_id` associated with the Bearer Token
will be ignored, and provided `owner_client_id` will be used instead.
affect_existing_installations (bool): based on this template will be created on all licenses that have given
application installed. Otherwise only new installations will trigger bot
creation.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/create_bot_template',
json=payload,
headers=headers)
def delete_bot(self,
id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes a Bot.
Args:
id (str): Bot's ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_bot',
json=payload,
headers=headers)
def delete_bot_template(self,
id: str = None,
owner_client_id: str = None,
affect_existing_installations: bool = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes a bot template specified by `id`. The bots associated with the template will
be deleted only if `affect_existing_installations` is set to `true`.
Args:
id (str): Bot Template ID.
owner_client_id (str): Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the `client_id` associated with the Bearer Token
will be ignored, and provided `owner_client_id` will be used instead.
affect_existing_installations (bool): based on this template will be created on all licenses that have given
application installed. Otherwise only new installations will trigger bot
creation.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_bot_template',
json=payload,
headers=headers)
def update_bot(self,
id: str = None,
name: str = None,
avatar: str = None,
max_chats_count: int = None,
groups: list = None,
default_group_priority: str = None,
work_scheduler: dict = None,
timezone: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates an existing Bot.
Args:
id (str): Bot's ID.
name (str): Display name.
avatar (str): Avatar URL.
max_chats_count (int): Max. number of incoming chats that can be routed to the Bot.
groups (list): Groups the Bot belongs to.
default_group_priority (str): The default routing priority for a group without defined priority.
work_scheduler (dict): Work scheduler options to set for the new Bot.
timezone (str): The time zone in which the Bot's work scheduler should operate.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_bot',
json=payload,
headers=headers)
def update_bot_template(self,
id: str = None,
name: str = None,
avatar: str = None,
max_chats_count: int = None,
default_group_priority: str = None,
owner_client_id: str = None,
affect_existing_installations: bool = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates an existing Bot Template.
Args:
id (str): Bot Template ID.
name (str): Display name.
avatar (str): Avatar URL.
max_chats_count (int): Max. number of incoming chats that can be routed to the Bot.
default_group_priority (str): The default routing priority for a group without defined priority.
owner_client_id (str): Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the `client_id` associated with the Bearer Token
will be ignored, and provided `owner_client_id` will be used instead.
affect_existing_installations (bool): based on this template will be created on all licenses that have given
application installed. Otherwise only new installations will trigger bot
creation.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_bot_template',
json=payload,
headers=headers)
def list_bots(self,
all: bool = None,
fields: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns the list of Bots created within a license.
Args:
all (bool): `True` gets all Bots within a license. `False` (default) returns only the requester's Bots.
fields (list): Additional Bot fields to include.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_bots',
json=payload,
headers=headers)
def list_bot_templates(self,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns the list of Bot Templates created for the Client ID (application).
Args:
owner_client_id (str): Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the `client_id` associated with the Bearer Token
will be ignored, and provided `owner_client_id` will be used instead.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_bot_templates',
json=payload,
headers=headers)
def get_bot(self,
id: str = None,
fields: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Gets a Bot specified by `id`.
Args:
id (str): Bot's ID.
fields (list): Additional Bot fields to include.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/get_bot',
json=payload,
headers=headers)
def issue_bot_token(self,
bot_id: str = None,
bot_secret: str = None,
organization_id: str = None,
client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Issues a new token for the Bot. The token is valid for 24 hours. The token cannot be revoked.
Args:
bot_id (str): Bot's ID.
bot_secret (str): Bot's secret.
organization_id (str): Organization's ID.
client_id (str): Client's ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/issue_bot_token',
json=payload,
headers=headers)
def reset_bot_secret(self,
id: str = None,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Resets secret for given bot.
Args:
id (str): Bot's ID.
owner_client_id (str): Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the `client_id` associated with the Bearer Token
will be ignored, and provided `owner_client_id` will be used instead.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/reset_bot_secret',
json=payload,
headers=headers)
def reset_bot_template_secret(self,
id: str = None,
owner_client_id: str = None,
affect_existing_installations: bool = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Resets secret for given bot template.
Args:
id (str): Bot Template ID.
owner_client_id (str): Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the `client_id` associated with the Bearer Token
will be ignored, and provided `owner_client_id` will be used instead.
affect_existing_installations (bool): based on this template will be created on all licenses that have given
application installed. Otherwise only new installations will trigger bot
creation.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/reset_bot_template_secret',
json=payload,
headers=headers)
# Groups
def create_group(self,
name: str = None,
language_code: str = None,
agent_priorities: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Creates a new group.
Args:
name (str): Group name (up to 180 chars).
language_code (str): The code of the group languange.
agent_priorities (dict): Agents' priorities in a group as a map in the "<id>": "<priority>" format.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/create_group',
json=payload,
headers=headers)
def update_group(self,
id: int = None,
name: str = None,
language_code: str = None,
agent_priorities: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates an existing group.
Args:
id (int): Groups' ID.
name (str): Group name (up to 180 chars).
language_code (str): The code of the group languange.
agent_priorities (dict): Agents' priorities in a group as a map in the "<id>": "<priority>" format.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_group',
json=payload,
headers=headers)
def delete_group(self,
id: int = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes an existing group.
Args:
id (int): Groups' ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_group',
json=payload,
headers=headers)
def list_groups(self,
fields: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Lists all the exisiting groups.
Args:
fields (list): Additional fields to include.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_groups',
json=payload,
headers=headers)
def get_group(self,
id: int = None,
fields: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns details about a group specified by its id.
Args:
id (int): Groups' ID.
fields (list): Additional fields to include.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/get_group',
json=payload,
headers=headers)
# Properties
def register_property(self,
name: str = None,
owner_client_id: str = None,
type: str = None,
access: dict = None,
description: str = None,
domain: list = None,
range: dict = None,
default_value: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Registers a new private property for a given Client ID.
Args:
name (str): Property name.
owner_client_id (str): Client ID that will own the property; must be owned by your organization.
type (str): Possible values: `int`, `string`, `bool`, and `tokenized_string`.
access (dict): Destination access.
description (str): Property description.
domain (list): Array of values that properties can be set to.
range (dict): Range of values that properties can be set to.
default_value (str): Default value of property; validated by domain or range, if one exists.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/register_property',
json=payload,
headers=headers)
def unregister_property(self,
name: str = None,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Unregisters a private property.
Args:
name (str): Property name.
owner_client_id (str): Client ID that will own the property; must be owned by your organization.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/unregister_property',
json=payload,
headers=headers)
def publish_property(self,
name: str = None,
owner_client_id: str = None,
access_type: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Publishes a private property.
Args:
name (str): Property name.
owner_client_id (str): Client ID that will own the property; must be owned by your organization.
access_type (list): Possible values: `read`, `write`.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/publish_property',
json=payload,
headers=headers)
def list_properties(self,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Lists private and public properties owned by a given Client ID.
Args:
owner_client_id (str): Client ID that will own the property; must be owned by your organization.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_properties',
json=payload,
headers=headers)
def update_license_properties(self,
properties: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates a property value within a license. This operation doesn't
overwrite the existing values.
Args:
properties (dict): An object with namespaces as keys and properties (grouped in objects) as values.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_license_properties',
json=payload,
headers=headers)
def list_license_properties(self,
namespace: str = None,
name_prefix: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns the properties set within a license.
Args:
namespace (str): Properties namespace.
name_prefix (str): Properties name prefix.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_license_properties',
json=payload,
headers=headers)
def delete_license_properties(self,
properties: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes the properties set within a license.
Args:
properties (dict): An object with namespaces as keys and property_names (in an array) as values.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_license_properties',
json=payload,
headers=headers)
def update_group_properties(self,
group_id: int = None,
properties: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates a property value within a group as the property location.
This operation doesn't overwrite the existing values.
Args:
group_id (int): ID of the group you set the properties for.
properties (dict): An object with namespaces as keys and properties (grouped in objects) as values.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_group_properties',
json=payload,
headers=headers)
def list_groups_properties(self,
namespace: str = None,
name_prefix: str = None,
group_ids: List[int] = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Returns the properties set within multiple groups.
Args:
namespace (str): Properties namespace.
name_prefix (str): Properties name prefix.
group_ids (List[int]): IDs of the groups to filter the properties by.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_groups_properties',
json=payload,
headers=headers)
def delete_group_properties(self,
id: int = None,
properties: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes the properties set within a group.
Args:
id (int): ID of the group you delete properties from.
properties (dict): An object with namespaces as keys and property_names (in an array) as values.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_group_properties',
json=payload,
headers=headers)
# Tags
def create_tag(self,
name: str = None,
group_ids: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Creates a new tag.
Args:
name (str): Name of the new tag. Matching the name of an existing tag is case-insensitive.
group_ids (list): List of groups' IDs for the tag. Can be empty.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/create_tag',
json=payload,
headers=headers)
def delete_tag(self,
name: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Deletes an existing tag.
Args:
name (str): Name of the tag to delete. Matching the name of an existing tag is case-insensitive.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/delete_tag',
json=payload,
headers=headers)
def list_tags(self,
filters: dict = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Lists the exisiting tags.
Args:
filters (dict): Possible request filters.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_tags',
json=payload,
headers=headers)
def update_tag(self,
name: str = None,
group_ids: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates an existing tag.
Args:
name (str): Name of the tag to update. Matching the name of an existing tag is case-insensitive.
group_ids (list): List of groups' IDs for the tag. Can be empty.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_tag',
json=payload,
headers=headers)
# Webhooks
def register_webhook(self,
action: str = None,
secret_key: str = None,
url: str = None,
additional_data: list = None,
description: str = None,
filters: dict = None,
owner_client_id: str = None,
type: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Registers a webhook for the Client ID (application) provided in the request.
Args:
action (str): The action that triggers sending a webhook.
secret_key (str): The secret key sent in webhooks to verify the source of a webhook.
url (str): Destination URL for the webhook.
additional_data (list): Additional data arriving with the webhook.
description (str): Webhook description.
filters (dict): Filters to check if a webhook should be triggered.
owner_client_id (str): The Client ID for which the webhook will be registered.
type (str): `bot` or `license`.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/register_webhook',
json=payload,
headers=headers)
def list_webhooks(self,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Lists all webhooks registered for the given Client ID.
Args:
owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered).
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_webhooks',
json=payload,
headers=headers)
def unregister_webhook(self,
id: str = None,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Unregisters a webhook previously registered for a Client ID (application).
Args:
id (str): Webhook's ID.
owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered).
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/unregister_webhook',
json=payload,
headers=headers)
def list_webhook_names(self,
version: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Lists all webhooks that are supported in a given API version. This method requires no authorization.
Args:
version (str): API's version. Defaults to the current stable API version.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_webhook_names',
json=payload,
headers=headers)
def enable_license_webhooks(self,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Enables the webhooks registered for a given Client ID (application)
for the license associated with the access token used in the request.
Args:
owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered).
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/enable_license_webhooks',
json=payload,
headers=headers)
def disable_license_webhooks(self,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Disables the enabled webhooks.
Args:
owner_client_id (str): Required when authorizing via PATs; ignored otherwise.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/disable_license_webhooks',
json=payload,
headers=headers)
def get_license_webhooks_state(self,
owner_client_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Gets the state of the webhooks registered for a given Client ID (application)
on the license associated with the access token used in the request.
Args:
owner_client_id (str): Required when authorizing via PATs; ignored otherwise.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/get_license_webhooks_state',
json=payload,
headers=headers)
# Other
def list_channels(self,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' List all license activity per communication channel.
Args:
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_channels',
json=payload,
headers=headers)
def check_product_limits_for_plan(self,
plan: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Checks product limits for plans.
Args:
plan (str): License plan to check limit for.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(
f'{self.api_url}/check_product_limits_for_plan',
json=payload,
headers=headers)
def get_product_source(self,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Retrieves the source parameters that were passed when activating the LiveChat product.
Args:
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/get_product_source',
json=payload,
headers=headers)
def reactivate_email(self,
agent_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Reactivates email if it has been bounced.
Args:
agent_id (str): Agent ID.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/reactivate_email',
json=payload,
headers=headers)
def update_company_details(self,
enrich: bool = None,
audience: str = None,
chat_purpose: str = None,
city: str = None,
company: str = None,
company_size: str = None,
country: str = None,
invoice_email: str = None,
invoice_name: str = None,
nip: str = None,
postal_code: str = None,
state: str = None,
street: str = None,
phone: str = None,
province: str = None,
url: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Updates company details of the license.
Args:
enrich (bool): Whether the system should attempt to automatically
fill empty fields by searching for company's domain.
audience (str): Audience
chat_purpose (str): Chat purpose
city (str): City
company (str): Company
company_size (str): Company size
country (str): Country
invoice_email (str): Invoice email
invoice_name (str): Invoice name
nip (str): Employer Identification Number
postal_code (str): Postal code
state (str): State
street (str): Street
phone (str): Phone
province (str): Province
url (str): URL
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/update_company_details',
json=payload,
headers=headers)
def get_company_details(self,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Gets company details of the license.
Args:
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/get_company_details',
json=payload,
headers=headers)
def list_customer_bans(self,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Lists banned customers.
Args:
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/list_customer_bans',
json=payload,
headers=headers)
def unban_customer(self,
ip: str = None,
customer_id: str = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Unbans customer with provided IP or ID.
Args:
ip (str): IP address of the customer to be unbanned.
customer_id (str): ID of the customer to be unbanned.
payload (dict): Custom payload to be used as request's data.
It overrides all other parameters provided for the method.
headers (dict): Custom headers to be used with session headers.
They will be merged with session-level values that are set,
however, these method-level parameters will not be persisted across requests.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/unban_customer',
json=payload,
headers=headers)
# Batch requests
def batch_create_agents(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `create_agent`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_create_agents',
json=payload,
headers=headers)
def batch_delete_agents(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `delete_agent`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_delete_agents',
json=payload,
headers=headers)
def batch_update_agents(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `update_agent`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_update_agents',
json=payload,
headers=headers)
def batch_approve_agents(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `approve_agent`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_approve_agents',
json=payload,
headers=headers)
def batch_suspend_agents(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `suspend_agent`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_suspend_agents',
json=payload,
headers=headers)
def batch_unsuspend_agents(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `unsuspend_agent`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_unsuspend_agents',
json=payload,
headers=headers)
def batch_create_bots(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `create_bot`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_create_bots',
json=payload,
headers=headers)
def batch_delete_bots(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `delete_bot`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_delete_bots',
json=payload,
headers=headers)
def batch_update_bots(self,
requests: list = None,
payload: dict = None,
headers: dict = None) -> httpx.Response:
''' Batch method for `update_bot`.
Args:
requests (list): Array of Request objects of corresponding non-batch method.
Returns:
httpx.Response: The Response object from `httpx` library,
which contains a server's response to an HTTP request.
'''
if payload is None:
payload = prepare_payload(locals())
return self.session.post(f'{self.api_url}/batch_update_bots',
json=payload,
headers=headers)Classes
class ConfigurationApiV36 (token: Union[livechat.utils.structures.AccessToken, str], base_url: str, http2: bool, proxies=None, verify: bool = True, disable_logging: bool = False, timeout: float = Timeout(timeout=15))-
Configuration API client class in version 3.6.
Expand source code
class ConfigurationApiV36(HttpClient): ''' Configuration API client class in version 3.6. ''' def __init__(self, token: Union[AccessToken, str], base_url: str, http2: bool, proxies=None, verify: bool = True, disable_logging: bool = False, timeout: float = httpx.Timeout(15)): super().__init__(token, base_url, http2, proxies, verify, disable_logging, timeout) self.api_url = f'https://{base_url}/v3.6/configuration/action' # Agents def create_agent(self, id: str = None, name: str = None, role: str = None, avatar_path: str = None, job_title: str = None, mobile: str = None, max_chats_count: int = None, awaiting_approval: bool = None, groups: list = None, notifications: list = None, email_subscriptions: list = None, work_scheduler: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new Agent with specified parameters within a license. Args: id (str): Agent's ID. name (str): Agent's name. role (str): Agent role, should be one of the following: `viceowner`, `administrator`, `normal` (default). avatar_path (str): URL path of the Agent's avatar. job_title (str): Agent's job title. mobile (str): Agent's mobile number. max_chats_count (int): Agent's maximum number of concurrent chats. awaiting_approval (bool): Determines if the Agent will be awaiting approval after creation. groups (list): Groups an Agent belongs to. notifications (list): Represents which Agent notifications are turned on. email_subscriptions (list): Represents which subscriptions will be send to the Agent via email. work_scheduler (dict): Work scheduler options to set for the new Agent. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_agent', json=payload, headers=headers) def get_agent(self, id: str = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the info about an Agent specified by `id`. Args: id (str): Agent's ID. fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_agent', json=payload, headers=headers) def list_agents(self, filters: dict = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns all Agents within a license. Args: filters (dict): Possible request filters. fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_agents', json=payload, headers=headers) def update_agent(self, id: str = None, name: str = None, role: str = None, avatar_path: str = None, job_title: str = None, mobile: str = None, max_chats_count: int = None, groups: list = None, notifications: list = None, email_subscriptions: list = None, work_scheduler: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates the properties of an Agent specified by `id`. Args: id (str): Agent's ID. name (str): Agent's name. role (str): Agent role, should be one of the following: `viceowner`, `administrator`, `normal` (default). avatar_path (str): URL path of the Agent's avatar. job_title (str): Agent's job title. mobile (str): Agent's mobile number. max_chats_count (int): Agent's maximum number of concurrent chats. groups (list): Groups an Agent belongs to. notifications (list): Represents which Agent notifications are turned on. email_subscriptions (list): Represents which subscriptions will be send to the Agent via email. work_scheduler (dict): Work scheduler options to set for the new Agent. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_agent', json=payload, headers=headers) def delete_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an Agent specified by `id`. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_agent', json=payload, headers=headers) def suspend_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Suspends an Agent specified by `id`. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/suspend_agent', json=payload, headers=headers) def unsuspend_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unsuspends an Agent specified by `id`. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unsuspend_agent', json=payload, headers=headers) def request_agent_unsuspension(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' A suspended Agent can send emails to license owners and vice owners with an unsuspension request. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/request_agent_unsuspension', json=payload, headers=headers) def approve_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Approves an Agent thus allowing the Agent to use the application. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/approve_agent', json=payload, headers=headers) # Auto access def add_auto_access(self, access: dict = None, conditions: dict = None, description: str = None, next_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates an auto access data structure, which is a set of conditions for the tracking URL and geolocation of a customer. Args: access (dict): Destination access. conditions (dict): Conditions to check. description (str): Description of the auto access. next_id (str): ID of an existing auto access. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/add_auto_access', json=payload, headers=headers) def list_auto_accesses(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns all existing auto access data structures. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_auto_accesses', json=payload, headers=headers) def delete_auto_access(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an existing auto access data structure specified by its ID. Args: id (str): Auto access ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_auto_access', json=payload, headers=headers) def update_auto_access(self, id: str = None, next_id: str = None, access: dict = None, conditions: dict = None, description: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Moves an existing auto access data structure, specified by id, before another one, specified by next_id. Args: id (str): ID of the auto access to move. next_id (str): ID of the auto access that should follow the moved auto access. access (dict): Destination access. conditions (dict): Conditions to check. description (str): Description of the auto access. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_auto_access', json=payload, headers=headers) # Bots def create_bot(self, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, job_title: str = None, groups: list = None, work_scheduler: dict = None, timezone: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new bot. Args: name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot; default: 6. default_group_priority (str): The default routing priority for a group without defined priority. job_title (str): Bot's job title. groups (list): Groups the Bot belongs to. work_scheduler (dict): Work scheduler options to set for the new Bot. timezone (str): The time zone in which the Bot's work scheduler should operate. owner_client_id (str): ID of the client bot will be assigned to. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_bot', json=payload, headers=headers) def create_bot_template(self, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, job_title: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new bot template for the Client ID (application) provided in the request. One Client ID can register up to five bot templates. Bots based on the template will be automatically created on the license when the application is installed. The bots will have the same ID as the bot template. If the application is already installed on the license, the bots will be created only if `affect_existing_installations` is set to `true`. Args: name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot; default: 6. default_group_priority (str): The default routing priority for a group without defined priority. job_title (str): Bot's job title. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_bot_template', json=payload, headers=headers) def delete_bot(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes a Bot. Args: id (str): Bot's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_bot', json=payload, headers=headers) def delete_bot_template(self, id: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes a bot template specified by `id`. The bots associated with the template will be deleted only if `affect_existing_installations` is set to `true`. Args: id (str): Bot Template ID. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_bot_template', json=payload, headers=headers) def update_bot(self, id: str = None, name: str = None, avatar: str = None, max_chats_count: int = None, groups: list = None, default_group_priority: str = None, work_scheduler: dict = None, timezone: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing Bot. Args: id (str): Bot's ID. name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot. groups (list): Groups the Bot belongs to. default_group_priority (str): The default routing priority for a group without defined priority. work_scheduler (dict): Work scheduler options to set for the new Bot. timezone (str): The time zone in which the Bot's work scheduler should operate. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_bot', json=payload, headers=headers) def update_bot_template(self, id: str = None, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing Bot Template. Args: id (str): Bot Template ID. name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot. default_group_priority (str): The default routing priority for a group without defined priority. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_bot_template', json=payload, headers=headers) def list_bots(self, all: bool = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the list of Bots created within a license. Args: all (bool): `True` gets all Bots within a license. `False` (default) returns only the requester's Bots. fields (list): Additional Bot fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_bots', json=payload, headers=headers) def list_bot_templates(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the list of Bot Templates created for the Client ID (application). Args: owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_bot_templates', json=payload, headers=headers) def get_bot(self, id: str = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Gets a Bot specified by `id`. Args: id (str): Bot's ID. fields (list): Additional Bot fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_bot', json=payload, headers=headers) def issue_bot_token(self, bot_id: str = None, bot_secret: str = None, organization_id: str = None, client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Issues a new token for the Bot. The token is valid for 24 hours. The token cannot be revoked. Args: bot_id (str): Bot's ID. bot_secret (str): Bot's secret. organization_id (str): Organization's ID. client_id (str): Client's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/issue_bot_token', json=payload, headers=headers) def reset_bot_secret(self, id: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Resets secret for given bot. Args: id (str): Bot's ID. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/reset_bot_secret', json=payload, headers=headers) def reset_bot_template_secret(self, id: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Resets secret for given bot template. Args: id (str): Bot Template ID. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/reset_bot_template_secret', json=payload, headers=headers) # Groups def create_group(self, name: str = None, language_code: str = None, agent_priorities: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new group. Args: name (str): Group name (up to 180 chars). language_code (str): The code of the group languange. agent_priorities (dict): Agents' priorities in a group as a map in the "<id>": "<priority>" format. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_group', json=payload, headers=headers) def update_group(self, id: int = None, name: str = None, language_code: str = None, agent_priorities: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing group. Args: id (int): Groups' ID. name (str): Group name (up to 180 chars). language_code (str): The code of the group languange. agent_priorities (dict): Agents' priorities in a group as a map in the "<id>": "<priority>" format. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_group', json=payload, headers=headers) def delete_group(self, id: int = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an existing group. Args: id (int): Groups' ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_group', json=payload, headers=headers) def list_groups(self, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists all the exisiting groups. Args: fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_groups', json=payload, headers=headers) def get_group(self, id: int = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns details about a group specified by its id. Args: id (int): Groups' ID. fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_group', json=payload, headers=headers) # Properties def register_property(self, name: str = None, owner_client_id: str = None, type: str = None, access: dict = None, description: str = None, domain: list = None, range: dict = None, default_value: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Registers a new private property for a given Client ID. Args: name (str): Property name. owner_client_id (str): Client ID that will own the property; must be owned by your organization. type (str): Possible values: `int`, `string`, `bool`, and `tokenized_string`. access (dict): Destination access. description (str): Property description. domain (list): Array of values that properties can be set to. range (dict): Range of values that properties can be set to. default_value (str): Default value of property; validated by domain or range, if one exists. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/register_property', json=payload, headers=headers) def unregister_property(self, name: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unregisters a private property. Args: name (str): Property name. owner_client_id (str): Client ID that will own the property; must be owned by your organization. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unregister_property', json=payload, headers=headers) def publish_property(self, name: str = None, owner_client_id: str = None, access_type: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Publishes a private property. Args: name (str): Property name. owner_client_id (str): Client ID that will own the property; must be owned by your organization. access_type (list): Possible values: `read`, `write`. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/publish_property', json=payload, headers=headers) def list_properties(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists private and public properties owned by a given Client ID. Args: owner_client_id (str): Client ID that will own the property; must be owned by your organization. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_properties', json=payload, headers=headers) def update_license_properties(self, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates a property value within a license. This operation doesn't overwrite the existing values. Args: properties (dict): An object with namespaces as keys and properties (grouped in objects) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_license_properties', json=payload, headers=headers) def list_license_properties(self, namespace: str = None, name_prefix: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the properties set within a license. Args: namespace (str): Properties namespace. name_prefix (str): Properties name prefix. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_license_properties', json=payload, headers=headers) def delete_license_properties(self, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes the properties set within a license. Args: properties (dict): An object with namespaces as keys and property_names (in an array) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_license_properties', json=payload, headers=headers) def update_group_properties(self, group_id: int = None, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates a property value within a group as the property location. This operation doesn't overwrite the existing values. Args: group_id (int): ID of the group you set the properties for. properties (dict): An object with namespaces as keys and properties (grouped in objects) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_group_properties', json=payload, headers=headers) def list_groups_properties(self, namespace: str = None, name_prefix: str = None, group_ids: List[int] = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the properties set within multiple groups. Args: namespace (str): Properties namespace. name_prefix (str): Properties name prefix. group_ids (List[int]): IDs of the groups to filter the properties by. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_groups_properties', json=payload, headers=headers) def delete_group_properties(self, id: int = None, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes the properties set within a group. Args: id (int): ID of the group you delete properties from. properties (dict): An object with namespaces as keys and property_names (in an array) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_group_properties', json=payload, headers=headers) # Tags def create_tag(self, name: str = None, group_ids: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new tag. Args: name (str): Name of the new tag. Matching the name of an existing tag is case-insensitive. group_ids (list): List of groups' IDs for the tag. Can be empty. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_tag', json=payload, headers=headers) def delete_tag(self, name: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an existing tag. Args: name (str): Name of the tag to delete. Matching the name of an existing tag is case-insensitive. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_tag', json=payload, headers=headers) def list_tags(self, filters: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists the exisiting tags. Args: filters (dict): Possible request filters. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_tags', json=payload, headers=headers) def update_tag(self, name: str = None, group_ids: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing tag. Args: name (str): Name of the tag to update. Matching the name of an existing tag is case-insensitive. group_ids (list): List of groups' IDs for the tag. Can be empty. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_tag', json=payload, headers=headers) # Webhooks def register_webhook(self, action: str = None, secret_key: str = None, url: str = None, additional_data: list = None, description: str = None, filters: dict = None, owner_client_id: str = None, type: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Registers a webhook for the Client ID (application) provided in the request. Args: action (str): The action that triggers sending a webhook. secret_key (str): The secret key sent in webhooks to verify the source of a webhook. url (str): Destination URL for the webhook. additional_data (list): Additional data arriving with the webhook. description (str): Webhook description. filters (dict): Filters to check if a webhook should be triggered. owner_client_id (str): The Client ID for which the webhook will be registered. type (str): `bot` or `license`. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/register_webhook', json=payload, headers=headers) def list_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists all webhooks registered for the given Client ID. Args: owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered). payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_webhooks', json=payload, headers=headers) def unregister_webhook(self, id: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unregisters a webhook previously registered for a Client ID (application). Args: id (str): Webhook's ID. owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered). payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unregister_webhook', json=payload, headers=headers) def list_webhook_names(self, version: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists all webhooks that are supported in a given API version. This method requires no authorization. Args: version (str): API's version. Defaults to the current stable API version. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_webhook_names', json=payload, headers=headers) def enable_license_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Enables the webhooks registered for a given Client ID (application) for the license associated with the access token used in the request. Args: owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered). payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/enable_license_webhooks', json=payload, headers=headers) def disable_license_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Disables the enabled webhooks. Args: owner_client_id (str): Required when authorizing via PATs; ignored otherwise. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/disable_license_webhooks', json=payload, headers=headers) def get_license_webhooks_state(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Gets the state of the webhooks registered for a given Client ID (application) on the license associated with the access token used in the request. Args: owner_client_id (str): Required when authorizing via PATs; ignored otherwise. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_license_webhooks_state', json=payload, headers=headers) # Other def list_channels(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' List all license activity per communication channel. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_channels', json=payload, headers=headers) def check_product_limits_for_plan(self, plan: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Checks product limits for plans. Args: plan (str): License plan to check limit for. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post( f'{self.api_url}/check_product_limits_for_plan', json=payload, headers=headers) def get_product_source(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Retrieves the source parameters that were passed when activating the LiveChat product. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_product_source', json=payload, headers=headers) def reactivate_email(self, agent_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Reactivates email if it has been bounced. Args: agent_id (str): Agent ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/reactivate_email', json=payload, headers=headers) def update_company_details(self, enrich: bool = None, audience: str = None, chat_purpose: str = None, city: str = None, company: str = None, company_size: str = None, country: str = None, invoice_email: str = None, invoice_name: str = None, nip: str = None, postal_code: str = None, state: str = None, street: str = None, phone: str = None, province: str = None, url: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates company details of the license. Args: enrich (bool): Whether the system should attempt to automatically fill empty fields by searching for company's domain. audience (str): Audience chat_purpose (str): Chat purpose city (str): City company (str): Company company_size (str): Company size country (str): Country invoice_email (str): Invoice email invoice_name (str): Invoice name nip (str): Employer Identification Number postal_code (str): Postal code state (str): State street (str): Street phone (str): Phone province (str): Province url (str): URL payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_company_details', json=payload, headers=headers) def get_company_details(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Gets company details of the license. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_company_details', json=payload, headers=headers) def list_customer_bans(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists banned customers. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_customer_bans', json=payload, headers=headers) def unban_customer(self, ip: str = None, customer_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unbans customer with provided IP or ID. Args: ip (str): IP address of the customer to be unbanned. customer_id (str): ID of the customer to be unbanned. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unban_customer', json=payload, headers=headers) # Batch requests def batch_create_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `create_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_create_agents', json=payload, headers=headers) def batch_delete_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `delete_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_delete_agents', json=payload, headers=headers) def batch_update_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `update_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_update_agents', json=payload, headers=headers) def batch_approve_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `approve_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_approve_agents', json=payload, headers=headers) def batch_suspend_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `suspend_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_suspend_agents', json=payload, headers=headers) def batch_unsuspend_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `unsuspend_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_unsuspend_agents', json=payload, headers=headers) def batch_create_bots(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `create_bot`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_create_bots', json=payload, headers=headers) def batch_delete_bots(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `delete_bot`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_delete_bots', json=payload, headers=headers) def batch_update_bots(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `update_bot`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_update_bots', json=payload, headers=headers)Ancestors
- livechat.utils.http_client.HttpClient
Methods
def add_auto_access(self, access: dict = None, conditions: dict = None, description: str = None, next_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Creates an auto access data structure, which is a set of conditions for the tracking URL and geolocation of a customer.
Args
access:dict- Destination access.
conditions:dict- Conditions to check.
description:str- Description of the auto access.
next_id:str- ID of an existing auto access.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def add_auto_access(self, access: dict = None, conditions: dict = None, description: str = None, next_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates an auto access data structure, which is a set of conditions for the tracking URL and geolocation of a customer. Args: access (dict): Destination access. conditions (dict): Conditions to check. description (str): Description of the auto access. next_id (str): ID of an existing auto access. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/add_auto_access', json=payload, headers=headers) def approve_agent(self, id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Approves an Agent thus allowing the Agent to use the application.
Args
id:str- Agent's ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def approve_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Approves an Agent thus allowing the Agent to use the application. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/approve_agent', json=payload, headers=headers) def batch_approve_agents(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
approve_agent.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_approve_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `approve_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_approve_agents', json=payload, headers=headers) def batch_create_agents(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
create_agent.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_create_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `create_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_create_agents', json=payload, headers=headers) def batch_create_bots(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
create_bot.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_create_bots(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `create_bot`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_create_bots', json=payload, headers=headers) def batch_delete_agents(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
delete_agent.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_delete_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `delete_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_delete_agents', json=payload, headers=headers) def batch_delete_bots(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
delete_bot.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_delete_bots(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `delete_bot`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_delete_bots', json=payload, headers=headers) def batch_suspend_agents(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
suspend_agent.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_suspend_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `suspend_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_suspend_agents', json=payload, headers=headers) def batch_unsuspend_agents(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
unsuspend_agent.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_unsuspend_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `unsuspend_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_unsuspend_agents', json=payload, headers=headers) def batch_update_agents(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
update_agent.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_update_agents(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `update_agent`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_update_agents', json=payload, headers=headers) def batch_update_bots(self, requests: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Batch method for
update_bot.Args
requests:list- Array of Request objects of corresponding non-batch method.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def batch_update_bots(self, requests: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Batch method for `update_bot`. Args: requests (list): Array of Request objects of corresponding non-batch method. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/batch_update_bots', json=payload, headers=headers) def check_product_limits_for_plan(self, plan: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Checks product limits for plans.
Args
plan:str- License plan to check limit for.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def check_product_limits_for_plan(self, plan: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Checks product limits for plans. Args: plan (str): License plan to check limit for. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post( f'{self.api_url}/check_product_limits_for_plan', json=payload, headers=headers) def create_agent(self, id: str = None, name: str = None, role: str = None, avatar_path: str = None, job_title: str = None, mobile: str = None, max_chats_count: int = None, awaiting_approval: bool = None, groups: list = None, notifications: list = None, email_subscriptions: list = None, work_scheduler: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Creates a new Agent with specified parameters within a license.
Args
id:str- Agent's ID.
name:str- Agent's name.
role:str- Agent role, should be one of the following:
viceowner,administrator,normal(default). avatar_path:str- URL path of the Agent's avatar.
job_title:str- Agent's job title.
mobile:str- Agent's mobile number.
max_chats_count:int- Agent's maximum number of concurrent chats.
awaiting_approval:bool- Determines if the Agent will be awaiting approval after creation.
groups:list- Groups an Agent belongs to.
notifications:list- Represents which Agent notifications are turned on.
email_subscriptions:list- Represents which subscriptions will be send to the Agent via email.
work_scheduler:dict- Work scheduler options to set for the new Agent.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def create_agent(self, id: str = None, name: str = None, role: str = None, avatar_path: str = None, job_title: str = None, mobile: str = None, max_chats_count: int = None, awaiting_approval: bool = None, groups: list = None, notifications: list = None, email_subscriptions: list = None, work_scheduler: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new Agent with specified parameters within a license. Args: id (str): Agent's ID. name (str): Agent's name. role (str): Agent role, should be one of the following: `viceowner`, `administrator`, `normal` (default). avatar_path (str): URL path of the Agent's avatar. job_title (str): Agent's job title. mobile (str): Agent's mobile number. max_chats_count (int): Agent's maximum number of concurrent chats. awaiting_approval (bool): Determines if the Agent will be awaiting approval after creation. groups (list): Groups an Agent belongs to. notifications (list): Represents which Agent notifications are turned on. email_subscriptions (list): Represents which subscriptions will be send to the Agent via email. work_scheduler (dict): Work scheduler options to set for the new Agent. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_agent', json=payload, headers=headers) def create_bot(self, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, job_title: str = None, groups: list = None, work_scheduler: dict = None, timezone: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Creates a new bot.
Args
name:str- Display name.
avatar:str- Avatar URL.
max_chats_count:int- Max. number of incoming chats that can be routed to the Bot; default: 6.
default_group_priority:str- The default routing priority for a group without defined priority.
job_title:str- Bot's job title.
groups:list- Groups the Bot belongs to.
work_scheduler:dict- Work scheduler options to set for the new Bot.
timezone:str- The time zone in which the Bot's work scheduler should operate.
owner_client_id:str- ID of the client bot will be assigned to.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def create_bot(self, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, job_title: str = None, groups: list = None, work_scheduler: dict = None, timezone: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new bot. Args: name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot; default: 6. default_group_priority (str): The default routing priority for a group without defined priority. job_title (str): Bot's job title. groups (list): Groups the Bot belongs to. work_scheduler (dict): Work scheduler options to set for the new Bot. timezone (str): The time zone in which the Bot's work scheduler should operate. owner_client_id (str): ID of the client bot will be assigned to. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_bot', json=payload, headers=headers) def create_bot_template(self, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, job_title: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Creates a new bot template for the Client ID (application) provided in the request. One Client ID can register up to five bot templates. Bots based on the template will be automatically created on the license when the application is installed. The bots will have the same ID as the bot template. If the application is already installed on the license, the bots will be created only if
affect_existing_installationsis set totrue.Args
name:str- Display name.
avatar:str- Avatar URL.
max_chats_count:int- Max. number of incoming chats that can be routed to the Bot; default: 6.
default_group_priority:str- The default routing priority for a group without defined priority.
job_title:str- Bot's job title.
owner_client_id:str- Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the
client_idassociated with the Bearer Token will be ignored, and providedowner_client_idwill be used instead. affect_existing_installations:bool- based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def create_bot_template(self, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, job_title: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new bot template for the Client ID (application) provided in the request. One Client ID can register up to five bot templates. Bots based on the template will be automatically created on the license when the application is installed. The bots will have the same ID as the bot template. If the application is already installed on the license, the bots will be created only if `affect_existing_installations` is set to `true`. Args: name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot; default: 6. default_group_priority (str): The default routing priority for a group without defined priority. job_title (str): Bot's job title. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_bot_template', json=payload, headers=headers) def create_group(self, name: str = None, language_code: str = None, agent_priorities: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Creates a new group.
Args
name:str- Group name (up to 180 chars).
language_code:str- The code of the group languange.
agent_priorities:dict- Agents' priorities in a group as a map in the "
": " " format. payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def create_group(self, name: str = None, language_code: str = None, agent_priorities: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new group. Args: name (str): Group name (up to 180 chars). language_code (str): The code of the group languange. agent_priorities (dict): Agents' priorities in a group as a map in the "<id>": "<priority>" format. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_group', json=payload, headers=headers) def create_tag(self, name: str = None, group_ids: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Creates a new tag.
Args
name:str- Name of the new tag. Matching the name of an existing tag is case-insensitive.
group_ids:list- List of groups' IDs for the tag. Can be empty.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def create_tag(self, name: str = None, group_ids: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Creates a new tag. Args: name (str): Name of the new tag. Matching the name of an existing tag is case-insensitive. group_ids (list): List of groups' IDs for the tag. Can be empty. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/create_tag', json=payload, headers=headers) def delete_agent(self, id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes an Agent specified by
id.Args
id:str- Agent's ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an Agent specified by `id`. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_agent', json=payload, headers=headers) def delete_auto_access(self, id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes an existing auto access data structure specified by its ID.
Args
id:str- Auto access ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_auto_access(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an existing auto access data structure specified by its ID. Args: id (str): Auto access ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_auto_access', json=payload, headers=headers) def delete_bot(self, id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes a Bot.
Args
id:str- Bot's ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_bot(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes a Bot. Args: id (str): Bot's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_bot', json=payload, headers=headers) def delete_bot_template(self, id: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes a bot template specified by
id. The bots associated with the template will be deleted only ifaffect_existing_installationsis set totrue.Args
id:str- Bot Template ID.
owner_client_id:str- Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the
client_idassociated with the Bearer Token will be ignored, and providedowner_client_idwill be used instead. affect_existing_installations:bool- based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_bot_template(self, id: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes a bot template specified by `id`. The bots associated with the template will be deleted only if `affect_existing_installations` is set to `true`. Args: id (str): Bot Template ID. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_bot_template', json=payload, headers=headers) def delete_group(self, id: int = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes an existing group.
Args
id:int- Groups' ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_group(self, id: int = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an existing group. Args: id (int): Groups' ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_group', json=payload, headers=headers) def delete_group_properties(self, id: int = None, properties: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes the properties set within a group.
Args
id:int- ID of the group you delete properties from.
properties:dict- An object with namespaces as keys and property_names (in an array) as values.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_group_properties(self, id: int = None, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes the properties set within a group. Args: id (int): ID of the group you delete properties from. properties (dict): An object with namespaces as keys and property_names (in an array) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_group_properties', json=payload, headers=headers) def delete_license_properties(self, properties: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes the properties set within a license.
Args
properties:dict- An object with namespaces as keys and property_names (in an array) as values.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_license_properties(self, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes the properties set within a license. Args: properties (dict): An object with namespaces as keys and property_names (in an array) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_license_properties', json=payload, headers=headers) def delete_tag(self, name: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Deletes an existing tag.
Args
name:str- Name of the tag to delete. Matching the name of an existing tag is case-insensitive.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def delete_tag(self, name: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Deletes an existing tag. Args: name (str): Name of the tag to delete. Matching the name of an existing tag is case-insensitive. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/delete_tag', json=payload, headers=headers) def disable_license_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Disables the enabled webhooks.
Args
owner_client_id:str- Required when authorizing via PATs; ignored otherwise.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def disable_license_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Disables the enabled webhooks. Args: owner_client_id (str): Required when authorizing via PATs; ignored otherwise. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/disable_license_webhooks', json=payload, headers=headers) def enable_license_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Enables the webhooks registered for a given Client ID (application) for the license associated with the access token used in the request.
Args
owner_client_id:str- The webhook owner (the Client ID for which the webhook is registered).
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def enable_license_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Enables the webhooks registered for a given Client ID (application) for the license associated with the access token used in the request. Args: owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered). payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/enable_license_webhooks', json=payload, headers=headers) def get_agent(self, id: str = None, fields: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns the info about an Agent specified by
id.Args
id:str- Agent's ID.
fields:list- Additional fields to include.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def get_agent(self, id: str = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the info about an Agent specified by `id`. Args: id (str): Agent's ID. fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_agent', json=payload, headers=headers) def get_bot(self, id: str = None, fields: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Gets a Bot specified by
id.Args
id:str- Bot's ID.
fields:list- Additional Bot fields to include.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def get_bot(self, id: str = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Gets a Bot specified by `id`. Args: id (str): Bot's ID. fields (list): Additional Bot fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_bot', json=payload, headers=headers) def get_company_details(self, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Gets company details of the license.
Args
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def get_company_details(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Gets company details of the license. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_company_details', json=payload, headers=headers) def get_group(self, id: int = None, fields: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns details about a group specified by its id.
Args
id:int- Groups' ID.
fields:list- Additional fields to include.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def get_group(self, id: int = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns details about a group specified by its id. Args: id (int): Groups' ID. fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_group', json=payload, headers=headers) def get_license_webhooks_state(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Gets the state of the webhooks registered for a given Client ID (application) on the license associated with the access token used in the request.
Args
owner_client_id:str- Required when authorizing via PATs; ignored otherwise.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def get_license_webhooks_state(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Gets the state of the webhooks registered for a given Client ID (application) on the license associated with the access token used in the request. Args: owner_client_id (str): Required when authorizing via PATs; ignored otherwise. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_license_webhooks_state', json=payload, headers=headers) def get_product_source(self, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Retrieves the source parameters that were passed when activating the LiveChat product.
Args
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def get_product_source(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Retrieves the source parameters that were passed when activating the LiveChat product. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/get_product_source', json=payload, headers=headers) def issue_bot_token(self, bot_id: str = None, bot_secret: str = None, organization_id: str = None, client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Issues a new token for the Bot. The token is valid for 24 hours. The token cannot be revoked.
Args
bot_id:str- Bot's ID.
bot_secret:str- Bot's secret.
organization_id:str- Organization's ID.
client_id:str- Client's ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def issue_bot_token(self, bot_id: str = None, bot_secret: str = None, organization_id: str = None, client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Issues a new token for the Bot. The token is valid for 24 hours. The token cannot be revoked. Args: bot_id (str): Bot's ID. bot_secret (str): Bot's secret. organization_id (str): Organization's ID. client_id (str): Client's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/issue_bot_token', json=payload, headers=headers) def list_agents(self, filters: dict = None, fields: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns all Agents within a license.
Args
filters:dict- Possible request filters.
fields:list- Additional fields to include.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_agents(self, filters: dict = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns all Agents within a license. Args: filters (dict): Possible request filters. fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_agents', json=payload, headers=headers) def list_auto_accesses(self, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns all existing auto access data structures.
Args
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns: httpx.Response: The Response object from
httpxlibrary, which contains a server's response to an HTTP request.Expand source code
def list_auto_accesses(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns all existing auto access data structures. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_auto_accesses', json=payload, headers=headers) def list_bot_templates(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns the list of Bot Templates created for the Client ID (application).
Args
owner_client_id:str- Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the
client_idassociated with the Bearer Token will be ignored, and providedowner_client_idwill be used instead. payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_bot_templates(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the list of Bot Templates created for the Client ID (application). Args: owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_bot_templates', json=payload, headers=headers) def list_bots(self, all: bool = None, fields: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns the list of Bots created within a license.
Args
all:boolTruegets all Bots within a license.False(default) returns only the requester's Bots.fields:list- Additional Bot fields to include.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_bots(self, all: bool = None, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the list of Bots created within a license. Args: all (bool): `True` gets all Bots within a license. `False` (default) returns only the requester's Bots. fields (list): Additional Bot fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_bots', json=payload, headers=headers) def list_channels(self, payload: dict = None, headers: dict = None) ‑> httpx.Response-
List all license activity per communication channel.
Args
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns: httpx.Response: The Response object from
httpxlibrary, which contains a server's response to an HTTP request.Expand source code
def list_channels(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' List all license activity per communication channel. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_channels', json=payload, headers=headers) def list_customer_bans(self, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Lists banned customers.
Args
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_customer_bans(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists banned customers. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_customer_bans', json=payload, headers=headers) def list_groups(self, fields: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Lists all the exisiting groups.
Args
fields:list- Additional fields to include.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_groups(self, fields: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists all the exisiting groups. Args: fields (list): Additional fields to include. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_groups', json=payload, headers=headers) def list_groups_properties(self, namespace: str = None, name_prefix: str = None, group_ids: List[int] = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns the properties set within multiple groups.
Args
namespace:str- Properties namespace.
name_prefix:str- Properties name prefix.
group_ids:List[int]- IDs of the groups to filter the properties by.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_groups_properties(self, namespace: str = None, name_prefix: str = None, group_ids: List[int] = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the properties set within multiple groups. Args: namespace (str): Properties namespace. name_prefix (str): Properties name prefix. group_ids (List[int]): IDs of the groups to filter the properties by. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_groups_properties', json=payload, headers=headers) def list_license_properties(self, namespace: str = None, name_prefix: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Returns the properties set within a license.
Args
namespace:str- Properties namespace.
name_prefix:str- Properties name prefix.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_license_properties(self, namespace: str = None, name_prefix: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Returns the properties set within a license. Args: namespace (str): Properties namespace. name_prefix (str): Properties name prefix. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_license_properties', json=payload, headers=headers) def list_properties(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Lists private and public properties owned by a given Client ID.
Args
owner_client_id:str- Client ID that will own the property; must be owned by your organization.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_properties(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists private and public properties owned by a given Client ID. Args: owner_client_id (str): Client ID that will own the property; must be owned by your organization. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_properties', json=payload, headers=headers) -
Lists the exisiting tags.
Args
filters:dict- Possible request filters.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_tags(self, filters: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists the exisiting tags. Args: filters (dict): Possible request filters. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_tags', json=payload, headers=headers) def list_webhook_names(self, version: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Lists all webhooks that are supported in a given API version. This method requires no authorization.
Args
version:str- API's version. Defaults to the current stable API version.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_webhook_names(self, version: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists all webhooks that are supported in a given API version. This method requires no authorization. Args: version (str): API's version. Defaults to the current stable API version. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_webhook_names', json=payload, headers=headers) def list_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Lists all webhooks registered for the given Client ID.
Args
owner_client_id:str- The webhook owner (the Client ID for which the webhook is registered).
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def list_webhooks(self, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Lists all webhooks registered for the given Client ID. Args: owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered). payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_webhooks', json=payload, headers=headers) def publish_property(self, name: str = None, owner_client_id: str = None, access_type: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Publishes a private property.
Args
name:str- Property name.
owner_client_id:str- Client ID that will own the property; must be owned by your organization.
access_type:list- Possible values:
read,write. payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def publish_property(self, name: str = None, owner_client_id: str = None, access_type: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Publishes a private property. Args: name (str): Property name. owner_client_id (str): Client ID that will own the property; must be owned by your organization. access_type (list): Possible values: `read`, `write`. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/publish_property', json=payload, headers=headers) def reactivate_email(self, agent_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Reactivates email if it has been bounced.
Args
agent_id:str- Agent ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def reactivate_email(self, agent_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Reactivates email if it has been bounced. Args: agent_id (str): Agent ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/reactivate_email', json=payload, headers=headers) def register_property(self, name: str = None, owner_client_id: str = None, type: str = None, access: dict = None, description: str = None, domain: list = None, range: dict = None, default_value: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Registers a new private property for a given Client ID.
Args
name:str- Property name.
owner_client_id:str- Client ID that will own the property; must be owned by your organization.
type:str- Possible values:
int,string,bool, andtokenized_string. access:dict- Destination access.
description:str- Property description.
domain:list- Array of values that properties can be set to.
range:dict- Range of values that properties can be set to.
default_value:str- Default value of property; validated by domain or range, if one exists.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def register_property(self, name: str = None, owner_client_id: str = None, type: str = None, access: dict = None, description: str = None, domain: list = None, range: dict = None, default_value: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Registers a new private property for a given Client ID. Args: name (str): Property name. owner_client_id (str): Client ID that will own the property; must be owned by your organization. type (str): Possible values: `int`, `string`, `bool`, and `tokenized_string`. access (dict): Destination access. description (str): Property description. domain (list): Array of values that properties can be set to. range (dict): Range of values that properties can be set to. default_value (str): Default value of property; validated by domain or range, if one exists. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/register_property', json=payload, headers=headers) def register_webhook(self, action: str = None, secret_key: str = None, url: str = None, additional_data: list = None, description: str = None, filters: dict = None, owner_client_id: str = None, type: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Registers a webhook for the Client ID (application) provided in the request.
Args
action:str- The action that triggers sending a webhook.
secret_key:str- The secret key sent in webhooks to verify the source of a webhook.
url:str- Destination URL for the webhook.
additional_data:list- Additional data arriving with the webhook.
description:str-
Webhook description.
filters:dict- Filters to check if a webhook should be triggered.
owner_client_id:str- The Client ID for which the webhook will be registered.
type:strbotorlicense.payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def register_webhook(self, action: str = None, secret_key: str = None, url: str = None, additional_data: list = None, description: str = None, filters: dict = None, owner_client_id: str = None, type: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Registers a webhook for the Client ID (application) provided in the request. Args: action (str): The action that triggers sending a webhook. secret_key (str): The secret key sent in webhooks to verify the source of a webhook. url (str): Destination URL for the webhook. additional_data (list): Additional data arriving with the webhook. description (str): Webhook description. filters (dict): Filters to check if a webhook should be triggered. owner_client_id (str): The Client ID for which the webhook will be registered. type (str): `bot` or `license`. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/register_webhook', json=payload, headers=headers) def request_agent_unsuspension(self, payload: dict = None, headers: dict = None) ‑> httpx.Response-
A suspended Agent can send emails to license owners and vice owners with an unsuspension request.
Args
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def request_agent_unsuspension(self, payload: dict = None, headers: dict = None) -> httpx.Response: ''' A suspended Agent can send emails to license owners and vice owners with an unsuspension request. Args: payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/request_agent_unsuspension', json=payload, headers=headers) def reset_bot_secret(self, id: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Resets secret for given bot.
Args
id:str- Bot's ID.
owner_client_id:str- Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the
client_idassociated with the Bearer Token will be ignored, and providedowner_client_idwill be used instead. payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def reset_bot_secret(self, id: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Resets secret for given bot. Args: id (str): Bot's ID. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/reset_bot_secret', json=payload, headers=headers) def reset_bot_template_secret(self, id: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Resets secret for given bot template.
Args
id:str- Bot Template ID.
owner_client_id:str- Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the
client_idassociated with the Bearer Token will be ignored, and providedowner_client_idwill be used instead. affect_existing_installations:bool- based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def reset_bot_template_secret(self, id: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Resets secret for given bot template. Args: id (str): Bot Template ID. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/reset_bot_template_secret', json=payload, headers=headers) def suspend_agent(self, id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Suspends an Agent specified by
id.Args
id:str- Agent's ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def suspend_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Suspends an Agent specified by `id`. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/suspend_agent', json=payload, headers=headers) def unban_customer(self, ip: str = None, customer_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Unbans customer with provided IP or ID.
Args
ip:str- IP address of the customer to be unbanned.
customer_id:str- ID of the customer to be unbanned.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def unban_customer(self, ip: str = None, customer_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unbans customer with provided IP or ID. Args: ip (str): IP address of the customer to be unbanned. customer_id (str): ID of the customer to be unbanned. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unban_customer', json=payload, headers=headers) def unregister_property(self, name: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Unregisters a private property.
Args
name:str- Property name.
owner_client_id:str- Client ID that will own the property; must be owned by your organization.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def unregister_property(self, name: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unregisters a private property. Args: name (str): Property name. owner_client_id (str): Client ID that will own the property; must be owned by your organization. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unregister_property', json=payload, headers=headers) def unregister_webhook(self, id: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Unregisters a webhook previously registered for a Client ID (application).
Args
id:str- Webhook's ID.
owner_client_id:str- The webhook owner (the Client ID for which the webhook is registered).
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def unregister_webhook(self, id: str = None, owner_client_id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unregisters a webhook previously registered for a Client ID (application). Args: id (str): Webhook's ID. owner_client_id (str): The webhook owner (the Client ID for which the webhook is registered). payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unregister_webhook', json=payload, headers=headers) def unsuspend_agent(self, id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Unsuspends an Agent specified by
id.Args
id:str- Agent's ID.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def unsuspend_agent(self, id: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Unsuspends an Agent specified by `id`. Args: id (str): Agent's ID. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/unsuspend_agent', json=payload, headers=headers) def update_agent(self, id: str = None, name: str = None, role: str = None, avatar_path: str = None, job_title: str = None, mobile: str = None, max_chats_count: int = None, groups: list = None, notifications: list = None, email_subscriptions: list = None, work_scheduler: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates the properties of an Agent specified by
id.Args
id:str- Agent's ID.
name:str- Agent's name.
role:str- Agent role, should be one of the following:
viceowner,administrator,normal(default). avatar_path:str- URL path of the Agent's avatar.
job_title:str- Agent's job title.
mobile:str- Agent's mobile number.
max_chats_count:int- Agent's maximum number of concurrent chats.
groups:list- Groups an Agent belongs to.
notifications:list- Represents which Agent notifications are turned on.
email_subscriptions:list- Represents which subscriptions will be send to the Agent via email.
work_scheduler:dict- Work scheduler options to set for the new Agent.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_agent(self, id: str = None, name: str = None, role: str = None, avatar_path: str = None, job_title: str = None, mobile: str = None, max_chats_count: int = None, groups: list = None, notifications: list = None, email_subscriptions: list = None, work_scheduler: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates the properties of an Agent specified by `id`. Args: id (str): Agent's ID. name (str): Agent's name. role (str): Agent role, should be one of the following: `viceowner`, `administrator`, `normal` (default). avatar_path (str): URL path of the Agent's avatar. job_title (str): Agent's job title. mobile (str): Agent's mobile number. max_chats_count (int): Agent's maximum number of concurrent chats. groups (list): Groups an Agent belongs to. notifications (list): Represents which Agent notifications are turned on. email_subscriptions (list): Represents which subscriptions will be send to the Agent via email. work_scheduler (dict): Work scheduler options to set for the new Agent. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_agent', json=payload, headers=headers) def update_auto_access(self, id: str = None, next_id: str = None, access: dict = None, conditions: dict = None, description: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Moves an existing auto access data structure, specified by id, before another one, specified by next_id.
Args
id:str- ID of the auto access to move.
next_id:str- ID of the auto access that should follow the moved auto access.
access:dict- Destination access.
conditions:dict- Conditions to check.
description:str- Description of the auto access.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_auto_access(self, id: str = None, next_id: str = None, access: dict = None, conditions: dict = None, description: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Moves an existing auto access data structure, specified by id, before another one, specified by next_id. Args: id (str): ID of the auto access to move. next_id (str): ID of the auto access that should follow the moved auto access. access (dict): Destination access. conditions (dict): Conditions to check. description (str): Description of the auto access. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_auto_access', json=payload, headers=headers) def update_bot(self, id: str = None, name: str = None, avatar: str = None, max_chats_count: int = None, groups: list = None, default_group_priority: str = None, work_scheduler: dict = None, timezone: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates an existing Bot.
Args
id:str- Bot's ID.
name:str- Display name.
avatar:str- Avatar URL.
max_chats_count:int- Max. number of incoming chats that can be routed to the Bot.
groups:list- Groups the Bot belongs to.
default_group_priority:str- The default routing priority for a group without defined priority.
work_scheduler:dict- Work scheduler options to set for the new Bot.
timezone:str- The time zone in which the Bot's work scheduler should operate.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_bot(self, id: str = None, name: str = None, avatar: str = None, max_chats_count: int = None, groups: list = None, default_group_priority: str = None, work_scheduler: dict = None, timezone: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing Bot. Args: id (str): Bot's ID. name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot. groups (list): Groups the Bot belongs to. default_group_priority (str): The default routing priority for a group without defined priority. work_scheduler (dict): Work scheduler options to set for the new Bot. timezone (str): The time zone in which the Bot's work scheduler should operate. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_bot', json=payload, headers=headers) def update_bot_template(self, id: str = None, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates an existing Bot Template.
Args
id:str- Bot Template ID.
name:str- Display name.
avatar:str- Avatar URL.
max_chats_count:int- Max. number of incoming chats that can be routed to the Bot.
default_group_priority:str- The default routing priority for a group without defined priority.
owner_client_id:str- Required only when authorizing via PAT. When you provide this param while
authorizing with a Bearer Token, the
client_idassociated with the Bearer Token will be ignored, and providedowner_client_idwill be used instead. affect_existing_installations:bool- based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_bot_template(self, id: str = None, name: str = None, avatar: str = None, max_chats_count: int = None, default_group_priority: str = None, owner_client_id: str = None, affect_existing_installations: bool = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing Bot Template. Args: id (str): Bot Template ID. name (str): Display name. avatar (str): Avatar URL. max_chats_count (int): Max. number of incoming chats that can be routed to the Bot. default_group_priority (str): The default routing priority for a group without defined priority. owner_client_id (str): Required only when authorizing via PAT. When you provide this param while authorizing with a Bearer Token, the `client_id` associated with the Bearer Token will be ignored, and provided `owner_client_id` will be used instead. affect_existing_installations (bool): based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_bot_template', json=payload, headers=headers) def update_company_details(self, enrich: bool = None, audience: str = None, chat_purpose: str = None, city: str = None, company: str = None, company_size: str = None, country: str = None, invoice_email: str = None, invoice_name: str = None, nip: str = None, postal_code: str = None, state: str = None, street: str = None, phone: str = None, province: str = None, url: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates company details of the license.
Args
enrich:bool- Whether the system should attempt to automatically fill empty fields by searching for company's domain.
audience:str- Audience
chat_purpose:str- Chat purpose
city:str- City
company:str- Company
company_size:str- Company size
country:str- Country
invoice_email:str- Invoice email
invoice_name:str- Invoice name
nip:str- Employer Identification Number
postal_code:str- Postal code
state:str- State
street:str- Street
phone:str- Phone
province:str- Province
url:str- URL
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_company_details(self, enrich: bool = None, audience: str = None, chat_purpose: str = None, city: str = None, company: str = None, company_size: str = None, country: str = None, invoice_email: str = None, invoice_name: str = None, nip: str = None, postal_code: str = None, state: str = None, street: str = None, phone: str = None, province: str = None, url: str = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates company details of the license. Args: enrich (bool): Whether the system should attempt to automatically fill empty fields by searching for company's domain. audience (str): Audience chat_purpose (str): Chat purpose city (str): City company (str): Company company_size (str): Company size country (str): Country invoice_email (str): Invoice email invoice_name (str): Invoice name nip (str): Employer Identification Number postal_code (str): Postal code state (str): State street (str): Street phone (str): Phone province (str): Province url (str): URL payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_company_details', json=payload, headers=headers) def update_group(self, id: int = None, name: str = None, language_code: str = None, agent_priorities: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates an existing group.
Args
id:int- Groups' ID.
name:str- Group name (up to 180 chars).
language_code:str- The code of the group languange.
agent_priorities:dict- Agents' priorities in a group as a map in the "
": " " format. payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_group(self, id: int = None, name: str = None, language_code: str = None, agent_priorities: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing group. Args: id (int): Groups' ID. name (str): Group name (up to 180 chars). language_code (str): The code of the group languange. agent_priorities (dict): Agents' priorities in a group as a map in the "<id>": "<priority>" format. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_group', json=payload, headers=headers) def update_group_properties(self, group_id: int = None, properties: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates a property value within a group as the property location. This operation doesn't overwrite the existing values.
Args
group_id:int- ID of the group you set the properties for.
properties:dict- An object with namespaces as keys and properties (grouped in objects) as values.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_group_properties(self, group_id: int = None, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates a property value within a group as the property location. This operation doesn't overwrite the existing values. Args: group_id (int): ID of the group you set the properties for. properties (dict): An object with namespaces as keys and properties (grouped in objects) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_group_properties', json=payload, headers=headers) def update_license_properties(self, properties: dict = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates a property value within a license. This operation doesn't overwrite the existing values.
Args
properties:dict- An object with namespaces as keys and properties (grouped in objects) as values.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_license_properties(self, properties: dict = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates a property value within a license. This operation doesn't overwrite the existing values. Args: properties (dict): An object with namespaces as keys and properties (grouped in objects) as values. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_license_properties', json=payload, headers=headers) def update_tag(self, name: str = None, group_ids: list = None, payload: dict = None, headers: dict = None) ‑> httpx.Response-
Updates an existing tag.
Args
name:str- Name of the tag to update. Matching the name of an existing tag is case-insensitive.
group_ids:list- List of groups' IDs for the tag. Can be empty.
payload:dict- Custom payload to be used as request's data. It overrides all other parameters provided for the method.
headers:dict- Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests.
Returns
httpx.Response- The Response object from
httpxlibrary, which contains a server's response to an HTTP request.
Expand source code
def update_tag(self, name: str = None, group_ids: list = None, payload: dict = None, headers: dict = None) -> httpx.Response: ''' Updates an existing tag. Args: name (str): Name of the tag to update. Matching the name of an existing tag is case-insensitive. group_ids (list): List of groups' IDs for the tag. Can be empty. payload (dict): Custom payload to be used as request's data. It overrides all other parameters provided for the method. headers (dict): Custom headers to be used with session headers. They will be merged with session-level values that are set, however, these method-level parameters will not be persisted across requests. Returns: httpx.Response: The Response object from `httpx` library, which contains a server's response to an HTTP request. ''' if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/update_tag', json=payload, headers=headers)