diff --git a/changelog.md b/changelog.md index 897cb7b..db0d5ef 100644 --- a/changelog.md +++ b/changelog.md @@ -1,7 +1,7 @@ # Change Log All notable changes to this project will be documented in this file. -## [0.3.8] - TBA +## [0.3.8] - 2023-11-30 ### Added - Support for `logout` method in agent-api v3.6 web class. diff --git a/docs/agent/index.html b/docs/agent/index.html index eef8356..1bba542 100644 --- a/docs/agent/index.html +++ b/docs/agent/index.html @@ -75,4 +75,4 @@

Index

Generated by pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/rtm/api/index.html b/docs/agent/rtm/api/index.html index 026fc22..7d6ac0a 100644 --- a/docs/agent/rtm/api/index.html +++ b/docs/agent/rtm/api/index.html @@ -77,4 +77,4 @@

Index

Generated by pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/rtm/api/v33.html b/docs/agent/rtm/api/v33.html index e9e5aa9..8153ecb 100644 --- a/docs/agent/rtm/api/v33.html +++ b/docs/agent/rtm/api/v33.html @@ -29,7 +29,7 @@

Module livechat.agent.rtm.api.v33

''' Module containing Agent RTM API client implementation for v3.3. '''
 
-from typing import Any
+from typing import Any, Optional
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import RtmResponse
@@ -385,6 +385,7 @@ 
Module livechat.agent.rtm.api.v33

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -393,6 +394,7 @@ 
Module livechat.agent.rtm.api.v33

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -400,9 +402,12 @@ 
Module livechat.agent.rtm.api.v33

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -1394,6 +1399,7 @@ 
Classes

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -1402,6 +1408,7 @@ 
Classes

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -1409,9 +1416,12 @@ 
Classes

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -3411,7 +3421,7 @@ 
Returns

 
 
 

-def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
+def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, author_id: Optional[str] = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
 

 

 
Sends an Event object.

@@ -3424,6 +3434,8 @@ 
Args

 
attach_to_last_thread : bool

 
Flag which states if event object should be added to last thread.
 The flag is ignored for active chats.

+
author_id : optional str

+
Provide if the event should be sent on behalf of a bot.

 
payload : dict

 
Custom payload to be used as request's data.
 It overrides all other parameters provided for the method.

@@ -3442,6 +3454,7 @@ 
Returns

                chat_id: str = None,
                event: dict = None,
                attach_to_last_thread: bool = None,
+               author_id: Optional[str] = None,
                payload: dict = None) -> RtmResponse:
     ''' Sends an Event object.
 
@@ -3450,6 +3463,7 @@ 
Returns

             event (dict): Event object.
             attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                     The flag is ignored for active chats.
+            author_id (optional str): Provide if the event should be sent on behalf of a bot.
             payload (dict): Custom payload to be used as request's data.
                     It overrides all other parameters provided for the method.
 
@@ -3457,9 +3471,12 @@ 
Returns

             RtmResponse: RTM response structure (`request_id`, `action`,
                          `type`, `success` and `payload` properties)
     '''
+    opts = {}
+    if author_id:
+        opts['author_id'] = author_id
     if payload is None:
         payload = prepare_payload(locals())
-    return self.ws.send({'action': 'send_event', 'payload': payload})
+ return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
@@ -4252,4 +4269,4 @@

pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/rtm/api/v34.html b/docs/agent/rtm/api/v34.html index f383071..4f2538d 100644 --- a/docs/agent/rtm/api/v34.html +++ b/docs/agent/rtm/api/v34.html @@ -29,7 +29,7 @@

Module livechat.agent.rtm.api.v34

''' Module containing Agent RTM API client implementation for v3.4. '''
 
-from typing import Any
+from typing import Any, Optional
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import RtmResponse
@@ -351,6 +351,7 @@ 
Module livechat.agent.rtm.api.v34

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -359,6 +360,7 @@ 
Module livechat.agent.rtm.api.v34

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -366,9 +368,12 @@ 
Module livechat.agent.rtm.api.v34

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -1326,6 +1331,7 @@ 
Classes

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -1334,6 +1340,7 @@ 
Classes

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -1341,9 +1348,12 @@ 
Classes

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -3265,7 +3275,7 @@ 
Returns

 
 
 

-def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
+def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, author_id: Optional[str] = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
 

 

 
Sends an Event object.

@@ -3278,6 +3288,8 @@ 
Args

 
attach_to_last_thread : bool

 
Flag which states if event object should be added to last thread.
 The flag is ignored for active chats.

+
author_id : optional str

+
Provide if the event should be sent on behalf of a bot.

 
payload : dict

 
Custom payload to be used as request's data.
 It overrides all other parameters provided for the method.

@@ -3296,6 +3308,7 @@ 
Returns

                chat_id: str = None,
                event: dict = None,
                attach_to_last_thread: bool = None,
+               author_id: Optional[str] = None,
                payload: dict = None) -> RtmResponse:
     ''' Sends an Event object.
 
@@ -3304,6 +3317,7 @@ 
Returns

             event (dict): Event object.
             attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                     The flag is ignored for active chats.
+            author_id (optional str): Provide if the event should be sent on behalf of a bot.
             payload (dict): Custom payload to be used as request's data.
                     It overrides all other parameters provided for the method.
 
@@ -3311,9 +3325,12 @@ 
Returns

             RtmResponse: RTM response structure (`request_id`, `action`,
                          `type`, `success` and `payload` properties)
     '''
+    opts = {}
+    if author_id:
+        opts['author_id'] = author_id
     if payload is None:
         payload = prepare_payload(locals())
-    return self.ws.send({'action': 'send_event', 'payload': payload})
+ return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
@@ -4108,4 +4125,4 @@

pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/rtm/api/v35.html b/docs/agent/rtm/api/v35.html index 10d56c4..aea502c 100644 --- a/docs/agent/rtm/api/v35.html +++ b/docs/agent/rtm/api/v35.html @@ -29,7 +29,7 @@

Module livechat.agent.rtm.api.v35

''' Module containing Agent RTM API client implementation for v3.5. '''
 
-from typing import Any
+from typing import Any, Optional
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import RtmResponse
@@ -351,6 +351,7 @@ 
Module livechat.agent.rtm.api.v35

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -359,6 +360,7 @@ 
Module livechat.agent.rtm.api.v35

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -366,9 +368,12 @@ 
Module livechat.agent.rtm.api.v35

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -1326,6 +1331,7 @@ 
Classes

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -1334,6 +1340,7 @@ 
Classes

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -1341,9 +1348,12 @@ 
Classes

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -3265,7 +3275,7 @@ 
Returns

 
 
 

-def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
+def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, author_id: Optional[str] = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
 

 

 
Sends an Event object.

@@ -3278,6 +3288,8 @@ 
Args

 
attach_to_last_thread : bool

 
Flag which states if event object should be added to last thread.
 The flag is ignored for active chats.

+
author_id : optional str

+
Provide if the event should be sent on behalf of a bot.

 
payload : dict

 
Custom payload to be used as request's data.
 It overrides all other parameters provided for the method.

@@ -3296,6 +3308,7 @@ 
Returns

                chat_id: str = None,
                event: dict = None,
                attach_to_last_thread: bool = None,
+               author_id: Optional[str] = None,
                payload: dict = None) -> RtmResponse:
     ''' Sends an Event object.
 
@@ -3304,6 +3317,7 @@ 
Returns

             event (dict): Event object.
             attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                     The flag is ignored for active chats.
+            author_id (optional str): Provide if the event should be sent on behalf of a bot.
             payload (dict): Custom payload to be used as request's data.
                     It overrides all other parameters provided for the method.
 
@@ -3311,9 +3325,12 @@ 
Returns

             RtmResponse: RTM response structure (`request_id`, `action`,
                          `type`, `success` and `payload` properties)
     '''
+    opts = {}
+    if author_id:
+        opts['author_id'] = author_id
     if payload is None:
         payload = prepare_payload(locals())
-    return self.ws.send({'action': 'send_event', 'payload': payload})
+ return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
@@ -4108,4 +4125,4 @@

pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/rtm/api/v36.html b/docs/agent/rtm/api/v36.html index 61b87d5..bfb4469 100644 --- a/docs/agent/rtm/api/v36.html +++ b/docs/agent/rtm/api/v36.html @@ -29,7 +29,7 @@

Module livechat.agent.rtm.api.v36

''' Module containing Agent RTM API client implementation for v3.6. '''
 
-from typing import Any
+from typing import Any, Optional
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import RtmResponse
@@ -351,6 +351,7 @@ 
Module livechat.agent.rtm.api.v36

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -359,6 +360,7 @@ 
Module livechat.agent.rtm.api.v36

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -366,9 +368,16 @@ 
Module livechat.agent.rtm.api.v36

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({
+            'action': 'send_event',
+            'payload': payload,
+            **opts
+        })
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -834,10 +843,13 @@ 
Module livechat.agent.rtm.api.v36

             payload = prepare_payload(locals())
         return self.ws.send({'action': 'set_away_status', 'payload': payload})
 
-    def logout(self, payload: dict = None) -> RtmResponse:
-        ''' Logs out agent.
+    def logout(self,
+               agent_id: str = None,
+               payload: dict = None) -> RtmResponse:
+        ''' Logs the Agent out.
 
             Args:
+                agent_id (str): Login of the agent to logout.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -845,10 +857,9 @@ 
Module livechat.agent.rtm.api.v36

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
-        return self.ws.send({
-            'action': 'logout',
-            'payload': {} if payload is None else payload
-        })
+        if payload is None:
+            payload = prepare_payload(locals())
+        return self.ws.send({'action': 'logout', 'payload': payload})
 
     def list_routing_statuses(self,
                               filters: dict = None,
@@ -1298,6 +1309,7 @@ 
Classes

                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -> RtmResponse:
         ''' Sends an Event object.
 
@@ -1306,6 +1318,7 @@ 
Classes

                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -1313,9 +1326,16 @@ 
Classes

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
+        opts = {}
+        if author_id:
+            opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload})
+        return self.ws.send({
+            'action': 'send_event',
+            'payload': payload,
+            **opts
+        })
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -1781,10 +1801,13 @@ 
Classes

             payload = prepare_payload(locals())
         return self.ws.send({'action': 'set_away_status', 'payload': payload})
 
-    def logout(self, payload: dict = None) -> RtmResponse:
-        ''' Logs out agent.
+    def logout(self,
+               agent_id: str = None,
+               payload: dict = None) -> RtmResponse:
+        ''' Logs the Agent out.
 
             Args:
+                agent_id (str): Login of the agent to logout.
                 payload (dict): Custom payload to be used as request's data.
                         It overrides all other parameters provided for the method.
 
@@ -1792,10 +1815,9 @@ 
Classes

                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         '''
-        return self.ws.send({
-            'action': 'logout',
-            'payload': {} if payload is None else payload
-        })
+        if payload is None:
+            payload = prepare_payload(locals())
+        return self.ws.send({'action': 'logout', 'payload': payload})
 
     def list_routing_statuses(self,
                               filters: dict = None,
@@ -2887,12 +2909,14 @@ 
Returns

 
 
 

-def logout(self, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
+def logout(self, agent_id: str = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
 

 

-
Logs out agent.

+
Logs the Agent out.

 
Args

 

+
agent_id : str

+
Login of the agent to logout.

 
payload : dict

 
Custom payload to be used as request's data.
 It overrides all other parameters provided for the method.

@@ -2907,10 +2931,13 @@ 
Returns

 
 Expand source code
 
-
def logout(self, payload: dict = None) -> RtmResponse:
-    ''' Logs out agent.
+
def logout(self,
+           agent_id: str = None,
+           payload: dict = None) -> RtmResponse:
+    ''' Logs the Agent out.
 
         Args:
+            agent_id (str): Login of the agent to logout.
             payload (dict): Custom payload to be used as request's data.
                     It overrides all other parameters provided for the method.
 
@@ -2918,10 +2945,9 @@ 
Returns

             RtmResponse: RTM response structure (`request_id`, `action`,
                          `type`, `success` and `payload` properties)
     '''
-    return self.ws.send({
-        'action': 'logout',
-        'payload': {} if payload is None else payload
-    })

+    if payload is None:
+        payload = prepare_payload(locals())
+    return self.ws.send({'action': 'logout', 'payload': payload})

 
 

 

@@ -3147,7 +3173,7 @@ 
Returns

 
 
 

-def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
+def send_event(self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, author_id: Optional[str] = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse
 

 

 
Sends an Event object.

@@ -3160,6 +3186,8 @@ 
Args

 
attach_to_last_thread : bool

 
Flag which states if event object should be added to last thread.
 The flag is ignored for active chats.

+
author_id : optional str

+
Provide if the event should be sent on behalf of a bot.

 
payload : dict

 
Custom payload to be used as request's data.
 It overrides all other parameters provided for the method.

@@ -3178,6 +3206,7 @@ 
Returns

                chat_id: str = None,
                event: dict = None,
                attach_to_last_thread: bool = None,
+               author_id: Optional[str] = None,
                payload: dict = None) -> RtmResponse:
     ''' Sends an Event object.
 
@@ -3186,6 +3215,7 @@ 
Returns

             event (dict): Event object.
             attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                     The flag is ignored for active chats.
+            author_id (optional str): Provide if the event should be sent on behalf of a bot.
             payload (dict): Custom payload to be used as request's data.
                     It overrides all other parameters provided for the method.
 
@@ -3193,9 +3223,16 @@ 
Returns

             RtmResponse: RTM response structure (`request_id`, `action`,
                          `type`, `success` and `payload` properties)
     '''
+    opts = {}
+    if author_id:
+        opts['author_id'] = author_id
     if payload is None:
         payload = prepare_payload(locals())
-    return self.ws.send({'action': 'send_event', 'payload': payload})
+ return self.ws.send({ + 'action': 'send_event', + 'payload': payload, + **opts + })
@@ -3989,4 +4026,4 @@

pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/rtm/base.html b/docs/agent/rtm/base.html index 710cf29..3ab3ed3 100644 --- a/docs/agent/rtm/base.html +++ b/docs/agent/rtm/base.html @@ -207,4 +207,4 @@

pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/rtm/index.html b/docs/agent/rtm/index.html index 838bca8..0042e99 100644 --- a/docs/agent/rtm/index.html +++ b/docs/agent/rtm/index.html @@ -67,4 +67,4 @@

Index

Generated by pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/web/api/index.html b/docs/agent/web/api/index.html index fe5f169..c6a3877 100644 --- a/docs/agent/web/api/index.html +++ b/docs/agent/web/api/index.html @@ -77,4 +77,4 @@

Index

Generated by pdoc 0.10.0.

- \ No newline at end of file + diff --git a/docs/agent/web/api/v36.html b/docs/agent/web/api/v36.html index 273458e..c7145f2 100644 --- a/docs/agent/web/api/v36.html +++ b/docs/agent/web/api/v36.html @@ -1061,6 +1061,29 @@

Module livechat.agent.web.api.v36

if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_agents_for_transfer', + json=payload, + headers=headers) + + def logout(self, + agent_id: str = None, + payload: dict = None, + headers: dict = None) -> httpx.Response: + ''' Logs the Agent out. + + Args: + agent_id (str): Login of the agent to logout. + 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}/logout', json=payload, headers=headers) @@ -2103,6 +2126,29 @@

Classes

if payload is None: payload = prepare_payload(locals()) return self.session.post(f'{self.api_url}/list_agents_for_transfer', + json=payload, + headers=headers) + + def logout(self, + agent_id: str = None, + payload: dict = None, + headers: dict = None) -> httpx.Response: + ''' Logs the Agent out. + + Args: + agent_id (str): Login of the agent to logout. + 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}/logout', json=payload, headers=headers) @@ -3103,6 +3149,57 @@

Returns

headers=headers) +
+def logout(self, agent_id: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response +
+
+

Logs the Agent out.

+

Args

+
+
agent_id : str
+
Login of the agent to logout.
+
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.
+
+
+ +Expand source code + +
def logout(self,
+           agent_id: str = None,
+           payload: dict = None,
+           headers: dict = None) -> httpx.Response:
+    ''' Logs the Agent out.
+
+        Args:
+            agent_id (str): Login of the agent to logout.
+            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}/logout',
+                             json=payload,
+                             headers=headers)
+
+
def mark_events_as_seen(self, chat_id: str = None, seen_up_to: str = None, payload: dict = None, headers: dict = None) ‑> httpx.Response
@@ -4285,6 +4382,7 @@

list_chats
  • list_routing_statuses
  • list_threads
    • +
  • logout
  • mark_events_as_seen
  • multicast
  • remove_user_from_chat
    • diff --git a/docs/agent/web/index.html b/docs/agent/web/index.html index 16e7447..f3442be 100644 --- a/docs/agent/web/index.html +++ b/docs/agent/web/index.html @@ -67,4 +67,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/billing/api/index.html b/docs/billing/api/index.html index d8a201a..fa98fb4 100644 --- a/docs/billing/api/index.html +++ b/docs/billing/api/index.html @@ -69,4 +69,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/billing/index.html b/docs/billing/index.html index 49c3c0d..ed3a676 100644 --- a/docs/billing/index.html +++ b/docs/billing/index.html @@ -75,4 +75,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/configuration/api/index.html b/docs/configuration/api/index.html index b8875bc..62e3a3a 100644 --- a/docs/configuration/api/index.html +++ b/docs/configuration/api/index.html @@ -77,4 +77,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/configuration/index.html b/docs/configuration/index.html index 524e691..2dfbb00 100644 --- a/docs/configuration/index.html +++ b/docs/configuration/index.html @@ -75,4 +75,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/index.html b/docs/customer/index.html index f00cecb..c18d944 100644 --- a/docs/customer/index.html +++ b/docs/customer/index.html @@ -75,4 +75,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/rtm/api/index.html b/docs/customer/rtm/api/index.html index 6eba2d1..bcf6b9e 100644 --- a/docs/customer/rtm/api/index.html +++ b/docs/customer/rtm/api/index.html @@ -77,4 +77,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/rtm/api/v33.html b/docs/customer/rtm/api/v33.html index f598e7d..8ca5a9a 100644 --- a/docs/customer/rtm/api/v33.html +++ b/docs/customer/rtm/api/v33.html @@ -2731,4 +2731,4 @@

    pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/rtm/api/v34.html b/docs/customer/rtm/api/v34.html index 7991336..178c6f5 100644 --- a/docs/customer/rtm/api/v34.html +++ b/docs/customer/rtm/api/v34.html @@ -2731,4 +2731,4 @@

    pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/rtm/api/v35.html b/docs/customer/rtm/api/v35.html index 9233b58..3833b0d 100644 --- a/docs/customer/rtm/api/v35.html +++ b/docs/customer/rtm/api/v35.html @@ -2731,4 +2731,4 @@

    pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/rtm/api/v36.html b/docs/customer/rtm/api/v36.html index af24a59..09b74c5 100644 --- a/docs/customer/rtm/api/v36.html +++ b/docs/customer/rtm/api/v36.html @@ -2731,4 +2731,4 @@

    pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/rtm/base.html b/docs/customer/rtm/base.html index d652243..eb8074c 100644 --- a/docs/customer/rtm/base.html +++ b/docs/customer/rtm/base.html @@ -275,4 +275,4 @@

    pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/rtm/index.html b/docs/customer/rtm/index.html index 6e0a576..0261bd1 100644 --- a/docs/customer/rtm/index.html +++ b/docs/customer/rtm/index.html @@ -67,4 +67,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/web/api/index.html b/docs/customer/web/api/index.html index 48c9136..7543aed 100644 --- a/docs/customer/web/api/index.html +++ b/docs/customer/web/api/index.html @@ -77,4 +77,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/customer/web/index.html b/docs/customer/web/index.html index ef438b4..828fcad 100644 --- a/docs/customer/web/index.html +++ b/docs/customer/web/index.html @@ -67,4 +67,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/index.html b/docs/index.html index f4bf444..2bf411c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -87,4 +87,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/reports/api/index.html b/docs/reports/api/index.html index 322cb0c..17d7a9e 100644 --- a/docs/reports/api/index.html +++ b/docs/reports/api/index.html @@ -77,4 +77,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/docs/reports/index.html b/docs/reports/index.html index 6387dc6..ce90862 100644 --- a/docs/reports/index.html +++ b/docs/reports/index.html @@ -75,4 +75,4 @@

    Index

    Generated by pdoc 0.10.0.

    - \ No newline at end of file + diff --git a/setup.cfg b/setup.cfg index 272db4e..5148163 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = lc-sdk-python -version = 0.3.7 +version = 0.3.8 description = Package which lets to work with LiveChat API. long_description = file: README.md long_description_content_type = text/markdown