sendbee-api 1.6.4__tar.gz → 1.7.2__tar.gz

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/PKG-INFO

@@ -1,14 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sendbee_api
-Version: 1.6.4
+Version: 1.7.2
 Summary: Python client SDK for Sendbee Public API
-Home-page: https://github.com/sendbee/sendbee-python-client
-Author: Sendbee ltd
-Author-email: info@sendbee.io
+Author-email: Sendbee ltd <info@sendbee.io>
 License: MIT
+Project-URL: Homepage, https://github.com/sendbee/sendbee-python-client
 Project-URL: Source, https://github.com/sendbee/sendbee-python-client
-Keywords: sendbee api python
-Platform: UNKNOWN
+Keywords: sendbee,api,python
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: License :: OSI Approved :: MIT License
@@ -16,30 +14,28 @@ Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-
-# Sendbee Python API Client  
-
-```
-
-                .' '.            __
-       .        .   .           (__\_
-        .         .         . -{{_(|8)
-          ' .  . ' ' .  . '     (__/
-
-```  
+Requires-Dist: click>=7.0
+Requires-Dist: requests>=2.20.0
+Requires-Dist: dumpit>=0.5.0
+Requires-Dist: aenum>=2.1.2
+Requires-Dist: ujson<6,>=5.7.0
+Requires-Dist: cryptography>=3.2
+Requires-Dist: curlify>=2.2.1
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: responses>=0.23; extra == "dev"
+Dynamic: license-file
+
+# AI Number Python API Client  
 
 [![PyPI version](https://badge.fury.io/py/sendbee-api.svg)](https://badge.fury.io/py/sendbee-api)
-[![Build Status](https://travis-ci.org/sendbee/sendbee-python-api-client.svg?branch=master)](https://travis-ci.org/sendbee/sendbee-python-api-client)
-
-![GitHub issues](https://img.shields.io/github/issues/sendbee/sendbee-python-api-client.svg)
-![GitHub closed issues](https://img.shields.io/github/issues-closed/sendbee/sendbee-python-api-client.svg)
-![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/sendbee/sendbee-python-api-client.svg)
-
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sendbee-api.svg)
-![GitHub](https://img.shields.io/github/license/sendbee/sendbee-python-api-client.svg?color=blue)
-![GitHub last commit](https://img.shields.io/github/last-commit/sendbee/sendbee-python-api-client.svg?color=blue)
 
 ## Table of contents  
 
@@ -87,6 +83,7 @@ License-File: LICENSE
 #### Mics  
 
 -   [Pagination](#pagination)
+-   [API Rate Limit](#api-rate-limit)
 -   [Raw response](#raw-response)
 -   [Exception handling](#exception-handling)  
 -   [Authenticate webhook request](#authenticate-webhook-request)  
@@ -594,7 +591,25 @@ while True:
     messages = api.messages(
         conversation_id='...', page=messages.next_page()
     )
-```     
+```  
+
+### <a href='#api-rate-limit'>API Rate Limit</a>  
+
+A rate limit is the number of API calls a business number can make 
+within a given time period. If this limit is exceeded, 
+API requests are throttled, and will fail with 429 error response.  
+
+No matter how many API keys you make in your Sendbee account, 
+rate limit will always be counted within a business number.  
+
+```python
+from sendbee_api import SendbeeRequestApiException
+
+try:
+    api.rate_limit_request_test()
+except SendbeeRequestApiException as ex:
+    retry_after = ex.response.headers.get('Retry-After')
+```
 
 ### <a href='#raw-response'>Raw response</a>
 
@@ -673,5 +688,3 @@ api = SendbeeApi(
 Once you enabled the internal debug tool, every request to API will output various request and response data in standard output:  
 
 ![Debugging](docs/images/debugging.png)   
-
-

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/README.md

@@ -1,24 +1,6 @@
-# Sendbee Python API Client  
-
-```
-
-                .' '.            __
-       .        .   .           (__\_
-        .         .         . -{{_(|8)
-          ' .  . ' ' .  . '     (__/
-
-```  
+# AI Number Python API Client  
 
 [![PyPI version](https://badge.fury.io/py/sendbee-api.svg)](https://badge.fury.io/py/sendbee-api)
-[![Build Status](https://travis-ci.org/sendbee/sendbee-python-api-client.svg?branch=master)](https://travis-ci.org/sendbee/sendbee-python-api-client)
-
-![GitHub issues](https://img.shields.io/github/issues/sendbee/sendbee-python-api-client.svg)
-![GitHub closed issues](https://img.shields.io/github/issues-closed/sendbee/sendbee-python-api-client.svg)
-![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/sendbee/sendbee-python-api-client.svg)
-
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sendbee-api.svg)
-![GitHub](https://img.shields.io/github/license/sendbee/sendbee-python-api-client.svg?color=blue)
-![GitHub last commit](https://img.shields.io/github/last-commit/sendbee/sendbee-python-api-client.svg?color=blue)
 
 ## Table of contents  
 
@@ -66,6 +48,7 @@
 #### Mics  
 
 -   [Pagination](#pagination)
+-   [API Rate Limit](#api-rate-limit)
 -   [Raw response](#raw-response)
 -   [Exception handling](#exception-handling)  
 -   [Authenticate webhook request](#authenticate-webhook-request)  
@@ -573,7 +556,25 @@ while True:
     messages = api.messages(
         conversation_id='...', page=messages.next_page()
     )
-```     
+```  
+
+### <a href='#api-rate-limit'>API Rate Limit</a>  
+
+A rate limit is the number of API calls a business number can make 
+within a given time period. If this limit is exceeded, 
+API requests are throttled, and will fail with 429 error response.  
+
+No matter how many API keys you make in your Sendbee account, 
+rate limit will always be counted within a business number.  
+
+```python
+from sendbee_api import SendbeeRequestApiException
+
+try:
+    api.rate_limit_request_test()
+except SendbeeRequestApiException as ex:
+    retry_after = ex.response.headers.get('Retry-After')
+```
 
 ### <a href='#raw-response'>Raw response</a>
 

sendbee_api-1.7.2/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sendbee_api"
+version = "1.7.2"
+description = "Python client SDK for Sendbee Public API"
+readme = "README.md"
+requires-python = ">=3.6"
+license = { text = "MIT" }
+authors = [{ name = "Sendbee ltd", email = "info@sendbee.io" }]
+keywords = ["sendbee", "api", "python"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "click>=7.0",
+    "requests>=2.20.0",
+    "dumpit>=0.5.0",
+    "aenum>=2.1.2",
+    "ujson>=5.7.0,<6",
+    "cryptography>=3.2",
+    "curlify>=2.2.1",
+]
+
+[project.optional-dependencies]
+dev = ["pytest", "responses>=0.23"]
+
+[project.urls]
+Homepage = "https://github.com/sendbee/sendbee-python-client"
+Source = "https://github.com/sendbee/sendbee-python-client"
+
+[tool.setuptools.packages.find]
+include = ["sendbee_api*"]
+exclude = ["tests*"]

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/automation/models.py

@@ -1,6 +1,7 @@
 from sendbee_api.models import Model
 from sendbee_api.fields import TextField, BooleanField
 
+
 class ChatbotActivityStatus(Model):
     """Data model for chatbot status"""
 

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/automation/query_params.py

@@ -7,6 +7,7 @@ class ChatbotActivity(QueryParams):
     conversation_id = 'conversation_id', 'Conversation UUID'
     active = 'active', 'Chatbot activity'
 
+
 class ChatbotActivityStatus(QueryParams):
     """Parameters for getting chatbot status for a conversation"""
 

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/bind.py

@@ -23,6 +23,9 @@ def bind_request(**request_data):
         model = request_data.get(constants.ClientConst.MODEL)
         api_path = request_data.get(constants.RequestConst.API_PATH)
         formatter = request_data.get(constants.ClientConst.FORMATTER)
+        ignore_error = request_data.get(
+            constants.ClientConst.IGNORE_ERROR, False
+        )
         method = request_data.get(
             constants.RequestConst.METHOD, constants.RequestConst.GET
         )
@@ -187,8 +190,12 @@ def bind_request(**request_data):
                     self.parameters[constants.RequestConst.QUERY]
                 )
                 self.debug.ok(constants.ResponseConst.RESPONSE_OBJECT, response)
+                self.debug.set_curl(
+                    constants.DebugConst.CURL,
+                    response.request
+                )
 
-                return response.status_code, response.text
+                return response.status_code, response.headers, response.text
 
             elif self.method in [
                 constants.RequestConst.POST,
@@ -210,14 +217,20 @@ def bind_request(**request_data):
                 self.debug.ok('payload', self.parameters[
                     constants.RequestConst.QUERY
                 ])
-                self.debug.ok(constants.ResponseConst.RESPONSE_OBJECT, response)
+                self.debug.ok(
+                    constants.ResponseConst.RESPONSE_OBJECT, response
+                )
+                self.debug.set_curl(
+                    constants.DebugConst.CURL,
+                    response.request
+                )
 
-                return response.status_code, response.text
+                return response.status_code, response.headers, response.text
 
             else:
                 return constants.ResponseCode.NOT_FOUND, {}
 
-        def _process_response(self, status_code, response):
+        def _process_response(self, status_code, response, headers):
             """
             Process response using models
             :status_code: Response status code
@@ -230,10 +243,11 @@ def bind_request(**request_data):
                 formatter = FormatterFactory(constants.FormatterConst.JSON)\
                     .get_formatter()
 
-            response = Response(response, status_code, formatter, self)
+            response = Response(response, headers, status_code, formatter, self)
             formatted_data = response.formatted_data
 
-            if status_code >= constants.ResponseCode.BAD_REQUEST:
+            if status_code >= constants.ResponseCode.BAD_REQUEST and \
+                    self.ignore_error is False:
 
                 if status_code == constants.ResponseCode.NOT_FOUND:
                     error_msg = \
@@ -242,12 +256,18 @@ def bind_request(**request_data):
                     error_msg = \
                         constants.ResponseConst.DEFAULT_ERROR_MESSAGE
                 else:
-                    error_msg = formatted_data.get(
-                        constants.ErrorConst.ERROR, {}
-                    ).get(
-                        constants.ErrorConst.DETAIL,
-                        constants.ErrorConst.UNRECOGNIZED_ERROR
-                    )
+                    try:
+                        error_msg = formatted_data.get(
+                            constants.ErrorConst.ERROR, {}
+                        ).get(
+                            constants.ErrorConst.DETAIL,
+                            constants.ErrorConst.UNRECOGNIZED_ERROR
+                        )
+                    except AttributeError:
+                        error_msg = formatted_data.get(
+                            constants.ErrorConst.DETAIL,
+                            constants.ErrorConst.UNRECOGNIZED_ERROR
+                        )
 
                 self.debug.error(
                     constants.ResponseConst.STATUS_CODE, status_code
@@ -255,7 +275,7 @@ def bind_request(**request_data):
                 self.debug.error(
                     constants.ResponseConst.RESPONSE, response.formatted_data
                 )
-                raise SendbeeRequestApiException(error_msg)
+                raise SendbeeRequestApiException(error_msg, response=response)
             else:
                 self.debug.ok(constants.ResponseConst.STATUS_CODE, status_code)
                 self.debug.ok(constants.ResponseConst.RESPONSE, response.raw_data)
@@ -287,8 +307,8 @@ def bind_request(**request_data):
             """
 
             self.url = self._prepare_url()
-            status_code, response = self._do_request(self.url)
-            return self._process_response(status_code, response)
+            status_code, headers, response = self._do_request(self.url)
+            return self._process_response(status_code, response, headers)
 
     def call(client, *path_params, **query_params):
         """

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/client.py

@@ -3,12 +3,13 @@ import click
 from sendbee_api.auth import SendbeeAuth
 from sendbee_api.teams.client import Teams
 from sendbee_api.contacts.client import Contacts
+from sendbee_api.rate_limit.client import RateLimit
 from sendbee_api.automation.client import Automation
 from sendbee_api.conversations.client import Messages
 from sendbee_api.exceptions import SendbeeRequestApiException
 
 
-class Client(Contacts, Messages, Automation, Teams):
+class Client(Contacts, Messages, Automation, Teams, RateLimit):
     """Main API class. Sets all API calls."""
 
     base_url = 'api-v2.sendbee.io'

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/constants.py

@@ -1,3 +1,4 @@
+from abc import ABCMeta
 from collections import namedtuple
 
 
@@ -38,9 +39,11 @@ ResponseConst = namedtuple(
 
 ClientConst = namedtuple(
     'ClientConst', [
-        'META', 'MODEL', 'MODELS', 'FORMATTER', 'DESCRIPTION', 'FORCE_SINGLE_MODEL_RESPONSE'
+        'META', 'MODEL', 'MODELS', 'FORMATTER', 'DESCRIPTION',
+        'FORCE_SINGLE_MODEL_RESPONSE', 'IGNORE_ERROR', 'HEADERS'
     ]
-)('meta', 'model', 'models', 'formatter', 'description', 'force_single_model_response')
+)('meta', 'model', 'models', 'formatter', 'description',
+  'force_single_model_response', 'ignore_error', 'headers')
 
 FormatterConst = namedtuple(
     'FormatterConst', ['JSON', 'FORMATTED']
@@ -61,3 +64,24 @@ MiscConst = namedtuple(
 ResponseDataConst = namedtuple(
     'ResponseDataConst', ['DATA', 'META']
 )('data', 'meta')
+
+
+class ConstMeta(ABCMeta):
+    def __setattr__(self, name, value):
+        pass
+
+
+class Const(metaclass=ConstMeta):
+    """Helper class """
+    __slots__ = ()
+
+
+class DebugConst(Const):
+    PARAMETERS = 'parameters'
+    RESPONSE = 'response'
+    STATUS_CODE = 'status code'
+    FINAL_URL = 'final url'
+    HEADERS = 'headers'
+    METHOD = 'method'
+    QUERY_PARAMETERS = 'query parameters'
+    CURL = 'curl'

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/conversations/models.py

@@ -41,6 +41,8 @@ class SentMessage(Model):
 
     _conversation_id = TextField(index='id', desc='Conversation UUID')
     _message_id = TextField(index='message_id', desc='Message UUID')
+    _message_reference_id = TextField(index='message_reference_id',
+                                      desc='Message Reference UUID')
     _status = TextField(index='status', desc='Message status')
 
 

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/conversations/query_params.py

@@ -21,6 +21,7 @@ class SendTemplateMessage(QueryParams):
     prevent_bot_off = 'prevent_bot_off', 'Prevent turning-off chatbot'
     agent_id = 'agent_id', 'Assigned agent for the conversation'
     attachment = 'attachment', 'Attachment URL for media templates'
+    live_inbox = 'live_inbox', 'Trigger real-time events after sending'
 
 
 class SendMessage(QueryParams):
@@ -31,6 +32,7 @@ class SendMessage(QueryParams):
     media_url = 'media_url', 'Media URL for media message'
     prevent_bot_off = 'prevent_bot_off', 'Prevent turning-off chatbot'
     agent_id = 'agent_id', 'Assigned agent for the conversation'
+    live_inbox = 'live_inbox', 'Trigger real-time events after sending'
 
 
 class ListConversations(QueryParams):

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/debug.py

@@ -1,5 +1,5 @@
 import click
-import pprint
+import curlify
 
 
 STATUS_OK = 'ok'
@@ -25,6 +25,13 @@ class Debug:
     def error(self, key, value):
         self.record(key, value, STATUS_ERROR)
 
+    def set_curl(self, key, request):
+        if self.client.debug:
+            try:
+                self.ok(key, curlify.to_curl(request, compressed=False))
+            except UnicodeDecodeError:
+                self.ok(key, '__unable_to_decode__')
+
     def record(self, key, value, status):
         if self.client.debug:
             self.recorded_data[key] = {'value': value, 'status': status}

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/exceptions.py

@@ -1,6 +1,9 @@
 class SendbeeException(Exception):
 	"""Handle All Sendbee Exceptions"""
 
+	def __init__(self, *args, **kwargs):
+		self.response = kwargs.get('response')
+
 
 class SendbeeRequestApiException(SendbeeException):
 	"""Handle Request Exceptions"""

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/formatter.py

@@ -29,6 +29,12 @@ class Formatter(metaclass=ABCMeta):
 
         return data
 
+    @abstractmethod
+    def _format_headers(self, data):
+        """Format method in formatter classes."""
+
+        return data
+
     def format_data(self, data):
         """Main format method."""
 
@@ -44,6 +50,11 @@ class Formatter(metaclass=ABCMeta):
 
         return self._format_warning(data)
 
+    def format_headers(self, data):
+        """Main format method."""
+
+        return self._format_headers(data)
+
     @staticmethod
     def _default_meta_data(total_results):
         """Create default data set if there aren't one from the response."""
@@ -106,6 +117,11 @@ class Json(Formatter):
         if isinstance(formatted_data, dict):
             return formatted_data.get(constants.WarningConst.WARNING)
 
+    def _format_headers(self, data):
+        """Transform raw data from server into python native type."""
+
+        return data
+
 
 class FormatterFactory:
     """Formatter factory class."""

sendbee_api-1.7.2/sendbee_api/rate_limit/client.py

@@ -0,0 +1,26 @@
+from sendbee_api import constants
+from sendbee_api.bind import bind_request
+from sendbee_api.rate_limit import query_params
+from sendbee_api.rate_limit.models import RateLimitError
+
+
+class RateLimit:
+    """Api client for rete limit testing"""
+
+    rate_limit_error_test = bind_request(
+        api_path='/rate-limit/error-test',
+        model=RateLimitError,
+        query_parameters=query_params.RateLimitParams,
+        method=constants.RequestConst.GET,
+        # ignore_error=True,
+        description='Rate limit error test'
+    )
+
+    rate_limit_request_test = bind_request(
+        api_path='/rate-limit/request-test',
+        model=RateLimitError,
+        query_parameters=query_params.RateLimitParams,
+        method=constants.RequestConst.GET,
+        # ignore_error=True,
+        description='Rate limit request test'
+    )

sendbee_api-1.7.2/sendbee_api/rate_limit/models.py

@@ -0,0 +1,10 @@
+from sendbee_api.models import Model
+from sendbee_api.fields import TextField, BooleanField
+
+
+class RateLimitError(Model):
+    """Data model for rate limit error"""
+
+    _detail = TextField(index='detail', desc='Message detail')
+    _error = BooleanField(index='error', desc='Error or not')
+    _type = TextField(index='type', desc='Message type')

sendbee_api-1.7.2/sendbee_api/rate_limit/query_params.py

@@ -0,0 +1,5 @@
+from sendbee_api.query_params import QueryParams
+
+
+class RateLimitParams(QueryParams):
+    """Parameters for rate limit testing"""

{sendbee_api-1.6.4 → sendbee_api-1.7.2}/sendbee_api/response.py

@@ -4,8 +4,9 @@ from sendbee_api import constants
 class Response:
     """Response object returned from API call."""
 
-    def __init__(self, data, status_code, formatter, api_request):
+    def __init__(self, data, headers, status_code, formatter, api_request):
         self._data = data
+        self._headers = headers
         self._model = api_request.model
 
         self.api_reguest = api_request
@@ -16,7 +17,8 @@ class Response:
             constants.FormatterConst.FORMATTED: None,
             constants.ClientConst.MODELS: None,
             constants.ClientConst.META: None,
-            constants.WarningConst.WARNING: None
+            constants.WarningConst.WARNING: None,
+            constants.ClientConst.HEADERS: None,
         }
 
     def __iter__(self):
@@ -63,6 +65,16 @@ class Response:
 
         return self._response_data[constants.ClientConst.META]
 
+    @property
+    def headers(self):
+        """Response headers."""
+
+        if not self._response_data[constants.ClientConst.HEADERS]:
+            self._response_data[constants.ClientConst.HEADERS] = \
+                self.formatter.format_headers(self._headers)
+
+        return self._response_data[constants.ClientConst.HEADERS]
+
     @property
     def warning(self):
         """Format warning data using selected formatter."""