bestsms 3.0.0.0__py3-none-any.whl

bestsms/__init__.py

@@ -0,0 +1,76 @@
+class BestSMS():
+
+    def __init__(self, **kwargs):
+        self.AuthToken = kwargs.get("AuthToken")
+        self.BaseURL = kwargs.get("BaseURL")
+
+        self._messaging = None
+        self._reports = None
+        self._actions = None
+        self._addressbook = None
+        self._optout = None
+
+    @property
+    def Messaging(self):
+
+        """ bestsms.api.v300.messaging - Messaging() """
+
+        if self._messaging == None:
+            from bestsms.core.auth import BestSMSApiUser
+            from bestsms.api.v300.messaging import Messaging
+
+            self._messaging = Messaging(BestSMSApiUser(AuthToken=self.AuthToken, BaseURL=self.BaseURL))
+
+        return self._messaging
+
+    @property
+    def Reports(self):
+
+        """ bestsms.api.v300.reports - Reports() """
+
+        if self._reports == None:
+            from bestsms.core.auth import BestSMSApiUser
+            from bestsms.api.v300.reports import Reports
+
+            self._reports = Reports(BestSMSApiUser(AuthToken=self.AuthToken, BaseURL=self.BaseURL))
+
+        return self._reports
+
+    @property
+    def Actions(self):
+
+        """ bestsms.api.v300.actions - Actions() """
+
+        if self._actions == None:
+            from bestsms.core.auth import BestSMSApiUser
+            from bestsms.api.v300.actions import Actions
+
+            self._actions = Actions(BestSMSApiUser(AuthToken=self.AuthToken, BaseURL=self.BaseURL))
+
+        return self._actions
+
+    @property
+    def Addressbook(self):
+
+        """ bestsms.api.v300.addressbook - Addressbook() """
+
+        if self._addressbook == None:
+            from bestsms.core.auth import BestSMSApiUser
+            from bestsms.api.v300.addressbook import Addressbook
+
+            self._addressbook = Addressbook(BestSMSApiUser(AuthToken=self.AuthToken, BaseURL=self.BaseURL))
+
+        return self._addressbook
+
+    @property
+    def OptOut(self):
+
+        """ bestsms.api.v300.optout.builders.optout - OptOut() """
+
+        if self._optout == None:
+            from bestsms.core.auth import BestSMSApiUser
+            from bestsms.api.v300.optout.builders.optout import OptOut
+
+            self._optout = OptOut(BestSMSApiUser(AuthToken=self.AuthToken, BaseURL=self.BaseURL))
+
+        return self._optout

bestsms/_config.py

@@ -0,0 +1,7 @@
+# Backward-compatibility shim: the legacy config now lives in bestsms/api/v204/_config.py.
+# Alias the same module object (not a re-export) so writes through either path stay in sync.
+import sys
+
+from bestsms.api.v204 import _config as _v204_config
+
+sys.modules[__name__] = _v204_config

bestsms/api/v204/_config.py

@@ -0,0 +1,11 @@
+# Legacy-client-only config (read by bestsms/api/v204 and bestsms/legacy). The v3.00 facades use bestsms/core/auth.py instead.
+__AuthToken__   = ""
+__Sender__      = ""
+__APIKey__      = ""
+__APIVersion__  = "3.00"
+__APIURL__      = "https://api.bestsms.com.au/api/v"+__APIVersion__;
+__APIHeaders__  = {
+    "Content-Type": "application/json",
+    "Accept": "application/json",
+    "encoding": "utf-8"
+}

bestsms/api/v204/actions/__init__.py

@@ -0,0 +1,68 @@
+from bestsms.api.v204 import _config
+
+class BestSMS():
+
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+
+            if key == "AuthToken":
+                self.AuthToken = _config.__AuthToken__ = value
+                _config.__APIHeaders__["Authorization"] = f"Basic {self.AuthToken}"
+
+            if key == "Sender":
+                self.Sender = _config.__Sender__ = value
+
+            if key == "APIKey":
+                self.APIKey = _config.__APIKey__ = value
+
+        self._messaging = None
+        self._reports = None
+        self._actions = None
+        self._addressbook = None
+
+    #
+    # Renamed since v2.3.0.0
+    #
+
+    @property
+    def Messaging(self, **kwargs):
+        
+        """ bestsms.messaging.__init__.py - Messaging() """
+
+        if self._messaging == None:
+            from bestsms.api.v204.messaging.requests import Messaging
+
+            self._messaging = Messaging(**kwargs)
+
+        return self._messaging
+    
+    @property
+    def Reports(self, **kwargs):
+    
+        """ bestsms.reports._reference.py - Reference() """
+        
+        if self._reports == None:
+            from bestsms.api.v204.reports.requests import Reports
+            self._reports = Reports(**kwargs)
+    
+        return self._reports
+    
+    @property
+    def Actions(self, **kwargs):
+
+        """ bestsms.actions._reference.py - Reference() """
+
+        if self._actions == None:
+            from bestsms.api.v204.actions.requests import Actions
+            self._actions = Actions(**kwargs)
+    
+        return self._actions
+    
+    @property
+    def Addressbook(self, **kwargs):
+        
+        if self._addressbook == None:
+            from bestsms.api.v204.addressbook import Addressbook
+            self._addressbook = Addressbook(**kwargs)
+
+        return self._addressbook

bestsms/api/v204/actions/dtos/action_api_result_dto.py

@@ -0,0 +1,16 @@
+from dataclasses import dataclass, field
+
+from bestsms.helpers.functions import Functions
+
+@dataclass
+class ActionApiResultDTO:
+    Result: str = None
+    MessageID: str = None
+    JobNum: str = None
+    Status: str = None
+    Action: str = None
+    ErrorMessage: list[str] = field(default_factory=list)
+
+    def __repr__(self):
+        return Functions.__pretty_class__(self, self)
+

bestsms/api/v204/actions/requests/__init__.py

@@ -0,0 +1,55 @@
+class Actions(object):
+
+    def __init__(self):
+        self._abort = None
+        self._pacing = None
+        self._reschedule = None
+        self._resubmit = None
+
+    @property
+    def Abort(self,**kwargs):
+
+        from bestsms.api.v204.actions.requests.abort import Abort
+
+        if self._abort != None:
+            del(self._abort)
+            
+        self._abort = Abort(kwargs)
+
+        return self._abort
+    
+    @property
+    def Pacing(self,**kwargs):
+
+        from bestsms.api.v204.actions.requests.pacing import Pacing
+
+        if self._pacing != None:
+            del(self._pacing)
+            
+        self._pacing = Pacing(kwargs)
+
+        return self._pacing
+
+    @property
+    def Reschedule(self,**kwargs):
+
+        from bestsms.api.v204.actions.requests.reschedule import Reschedule
+
+        if self._reschedule != None:
+            del(self._reschedule)
+
+        self._reschedule = Reschedule(kwargs)
+        
+        return self._reschedule
+
+    @property
+    def Resubmit(self,**kwargs):
+
+        from bestsms.api.v204.actions.requests.resubmit import Resubmit
+
+        if self._resubmit != None:
+            del(self._resubmit)
+            
+        self._resubmit = Resubmit(kwargs)
+
+        return self._resubmit

bestsms/api/v204/actions/requests/_common.py

@@ -0,0 +1,63 @@
+from bestsms.api.v204 import _config
+from bestsms.helpers.functions import Functions
+
+class Common:
+
+    AuthToken       = _config.__AuthToken__
+    Sender          = _config.__Sender__
+    APIKey          = _config.__APIKey__
+    APIVersion      = _config.__APIVersion__
+    APIURL          = _config.__APIURL__
+    APIHeaders      = _config.__APIHeaders__
+
+    MessageID       = ""
+
+    """ Constructor """
+    def __init__(self,kwargs):
+
+        self.AuthToken       = _config.__AuthToken__
+        self.Sender          = _config.__Sender__
+        self.APIKey          = _config.__APIKey__
+        self.APIVersion      = _config.__APIVersion__
+        self.APIURL          = _config.__APIURL__
+        self.APIHeaders      = _config.__APIHeaders__
+
+        self.MessageID      = ""
+
+        self.SetArgsCommon(kwargs)
+
+    """ Destructor """
+    def __del__(self):
+        self.AuthToken      = ""
+        self.Sender         = ""
+        self.APIKey         = ""
+        self.APIVersion     = ""
+        self.APIURL         = ""
+        self.APIHeaders     = ""
+
+        self.MessageID      = ""
+
+    """ Set Args """
+    def SetArgsCommon(self, kwargs):
+
+        #
+        # AuthToken / Send / APIKey can be overriden in the BestSMS.Set.xxx() functions
+        # Default initialization happens in /__init__.py
+        #
+
+        if "AuthToken" in kwargs:
+            self.AuthToken = _config.__AuthToken__ = kwargs.pop("AuthToken")
+            self.APIHeaders["Authorization"] = _config.__APIHeaders__["Authorization"] = f"Basic {self.AuthToken}"
+
+        if "Sender" in kwargs:
+            self.Sender = _config.__Sender__ = kwargs.pop("Sender")
+
+        if "APIKey" in kwargs:
+            self.APIKey = _config.__APIKey__ = kwargs.pop("APIKey")
+        
+        if "MessageID" in kwargs:
+            self.MessageID = kwargs.pop("MessageID")
+    
+    def __pretty__(self,obj):
+        
+        return Functions.__pretty__(self,obj)

bestsms/api/v204/actions/requests/abort.py

@@ -0,0 +1,119 @@
+import requests
+import json
+import asyncio
+
+from bestsms.api.v204.actions.requests._common import Common
+from bestsms.api.v204.actions.responses import ActionApiResult
+
+
+class Abort(Common):
+
+    """ Constructor """
+    def __init__(self, kwargs):
+
+        super().__init__(kwargs)
+
+        #self.SetArgs(kwargs)
+
+    """ Update Data """
+    #def SetArgs(self, kwargs):
+
+        #super().SetArgs(kwargs)
+
+    """ API Data """
+    @property
+    def APIDataWithSender(self):
+        return {
+            "Sender": self.Sender,
+            "APIKey": self.APIKey,
+            "MessageID" : self.MessageID
+        }
+
+    @property
+    def APIDataWithAuthToken(self):
+        return {}
+
+    @property
+    def APIData(self):
+        if self.AuthToken :
+            return self.APIDataWithAuthToken
+        return self.APIDataWithSender
+
+    @property
+    def BuildAPIURL(self):
+
+        url = self.APIURL+"/set/abort"
+
+        if self.AuthToken :
+            url = f"{url}/{self.MessageID}"
+
+        return url
+
+    """ Private function to POST message to BestSMS REST API """
+    def __PostMessage(self):
+
+        try:
+            if self.AuthToken :
+                r = requests.patch(self.BuildAPIURL, data=json.dumps(self.APIData), headers=self.APIHeaders)
+            else :
+                r = requests.post(self.BuildAPIURL, data=json.dumps(self.APIData), headers=self.APIHeaders)
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            return ActionApiResult(response=r)
+        except requests.exceptions.RequestException as e:  # This is the correct syntax
+            return ActionApiResult(error=str(e))
+        
+        return ActionApiResult(response=r)
+
+    """ Private async function to POST message to BestSMS REST API """
+    async def __PostMessageAsync(self):
+
+        return self.__PostMessage()
+
+    """ Function to send message """
+    def SendRequest(self, **kwargs):
+
+        if kwargs != None and len(kwargs) > 0:
+            self.__init__(kwargs)
+
+        if not self.AuthToken :
+
+            if not self.Sender :
+                return ActionApiResult(error="Missing AuthToken")
+            
+            if not self.APIKey :
+                return ActionApiResult(error="Missing AuthToken")
+        
+        if not self.MessageID:
+            return ActionApiResult(error="Missing MessageID")
+        
+        return self.__PostMessage()
+
+    """ Async Function to send message """
+    async def SendRequestAsync(self, **kwargs):
+
+        if kwargs != None and len(kwargs) > 0:
+            self.__init__(kwargs)
+
+        if not self.AuthToken :
+
+            if not self.Sender :
+                return ActionApiResult(error="Missing AuthToken")
+            
+            if not self.APIKey :
+                return ActionApiResult(error="Missing AuthToken")
+        
+        if not self.MessageID:
+            return ActionApiResult(error="Missing MessageID")
+        
+        return await asyncio.create_task(self.__PostMessageAsync())
+
+    def __repr__(self):
+        return self.__pretty__(self.APIData)
+
+    def __str__(self):
+
+        if self.AuthToken :
+            return 'Abort(AuthToken='+self.AuthToken+ ')'
+
+        return 'Abort(Sender='+self.Sender+', APIKey='+str(self.APIKey)+ ')'

bestsms/api/v204/actions/requests/reschedule.py

@@ -0,0 +1,137 @@
+from datetime import datetime
+import requests
+import json
+import asyncio
+
+from bestsms.api.v204.actions.requests._common import Common
+from bestsms.api.v204.actions.responses import ActionApiResult
+
+class Reschedule(Common):
+
+    SendTime    = datetime.now()
+
+    """ Constructor """
+    def __init__(self, kwargs):
+
+        super().__init__(kwargs)
+
+        self.SetArgsChild(kwargs)
+
+    """ Destructor """
+    def __del__(self):
+        self.SendTime = ""
+
+    """ Update Data """
+    def SetArgsChild(self, kwargs):
+
+        #super().SetArgs(kwargs)
+
+        for key, value in kwargs.items():
+
+            if key == "SendTime":
+                self.SendTime = datetime.fromisoformat(value)
+
+    """ API Data """
+    @property
+    def APIDataWithSender(self):
+        return {
+            "Sender": self.Sender,
+            "APIKey": self.APIKey,
+            "MessageID" : self.MessageID,
+            "SendTime": self.SendTime.strftime("%Y-%m-%dT%H:%M:%S")
+        }
+
+    @property
+    def APIDataWithAuthToken(self):
+        return {
+            "SendTime": self.SendTime.strftime("%Y-%m-%dT%H:%M:%S")
+        }
+
+    @property
+    def APIData(self):
+        if self.AuthToken :
+            return self.APIDataWithAuthToken
+        return self.APIDataWithSender
+
+    @property
+    def BuildAPIURL(self):
+
+        url = self.APIURL+"/set/reschedule"
+
+        if self.AuthToken :
+            url = f"{url}/{self.MessageID}"
+
+        return url
+
+    """ Private function to POST message to BestSMS REST API """
+    def __PostMessage(self):
+
+        try:
+            if self.AuthToken :
+                r = requests.patch(self.BuildAPIURL, data=json.dumps(self.APIData), headers=self.APIHeaders)
+            else :
+                r = requests.post(self.BuildAPIURL, data=json.dumps(self.APIData), headers=self.APIHeaders)
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            return ActionApiResult(response=r)
+        except requests.exceptions.RequestException as e:  # This is the correct syntax
+            return ActionApiResult(error=str(e))
+
+        return ActionApiResult(response=r)
+
+    """ Private async function to POST message to BestSMS REST API """
+    async def __PostMessageAsync(self):
+
+        return self.__PostMessage()
+
+    """ Function to send message """
+    def SendRequest(self, **kwargs):
+
+        if kwargs != None and len(kwargs) > 0:
+            self.__init__(kwargs)
+
+        if not self.AuthToken :
+            if not self.Sender :
+                return ActionApiResult(error="Missing AuthToken")
+            
+            if not self.APIKey :
+                return ActionApiResult(error="Missing AuthToken")
+        
+        if not self.MessageID:
+            return ActionApiResult(error="Missing MessageID")
+
+        if not self.SendTime:
+            return ActionApiResult(error="Missing SendTime")
+        
+        return self.__PostMessage()
+
+    """ Async Function to send message """
+    async def SendRequestAsync(self, **kwargs):
+
+        if kwargs != None and len(kwargs) > 0:
+            self.__init__(kwargs)
+
+        if not self.AuthToken :
+            if not self.Sender :
+                return ActionApiResult(error="Missing AuthToken")
+            
+            if not self.APIKey :
+                return ActionApiResult(error="Missing AuthToken")
+        
+        if not self.MessageID:
+            return ActionApiResult(error="Missing MessageID")
+
+        if not self.SendTime:
+            return ActionApiResult(error="Missing SendTime")
+        
+        return await asyncio.create_task(self.__PostMessageAsync())
+
+    def __repr__(self):
+        return self.__pretty__(self.APIData)
+
+    def __str__(self):
+
+        if self.AuthToken :
+            return 'Reschedule(AuthToken='+self.AuthToken+ ')'
+
+        return 'Reschedule(Sender='+self.Sender+', APIKey='+str(self.APIKey)+ ')'

bestsms/api/v204/actions/requests/resubmit.py

@@ -0,0 +1,128 @@
+import requests
+import json
+import asyncio
+from datetime import datetime
+
+from bestsms.api.v204.actions.requests._common import Common
+from bestsms.api.v204.actions.responses import ActionApiResult
+
+class Resubmit(Common):
+
+    SendTime = datetime.now()
+
+    """ Constructor """
+    def __init__(self, kwargs):
+
+        super().__init__(kwargs)
+
+        self.SetArgsChild(kwargs)
+
+    """ Update Data """
+    def SetArgsChild(self, kwargs):
+
+        #super().SetArgs(kwargs)
+
+        for key, value in kwargs.items():
+            if key == "SendTime":
+                self.SendTime = datetime.fromisoformat(value)
+
+    """ API Data """
+    @property
+    def APIDataWithSender(self):
+        return {
+            "Sender": self.Sender,
+            "APIKey": self.APIKey,
+            "MessageID" : self.MessageID,
+            "SendTime": self.SendTime.strftime("%Y-%m-%dT%H:%M:%S")
+        }
+
+    @property
+    def APIDataWithAuthToken(self):
+        return {
+            "SendTime": self.SendTime.strftime("%Y-%m-%dT%H:%M:%S")
+        }
+
+    @property
+    def APIData(self):
+        if self.AuthToken :
+            return self.APIDataWithAuthToken
+        return self.APIDataWithSender
+
+    @property
+    def BuildAPIURL(self):
+
+        url = self.APIURL+"/set/resubmit"
+
+        if self.AuthToken :
+            url = f"{url}/{self.MessageID}"
+
+        return url
+
+    """ Private function to POST message to BestSMS REST API """
+    def __PostMessage(self):
+        
+        try:
+            if self.AuthToken :
+                r = requests.patch(self.BuildAPIURL, data=json.dumps(self.APIData), headers=self.APIHeaders)
+            else :
+                r = requests.post(self.BuildAPIURL, data=json.dumps(self.APIData), headers=self.APIHeaders)
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            return ActionApiResult(response=r)
+        except requests.exceptions.RequestException as e:  # This is the correct syntax
+            return ActionApiResult(error=str(e))
+
+        return ActionApiResult(response=r)
+
+    """ Private async function to POST message to BestSMS REST API """
+    async def __PostMessageAsync(self):
+        
+        return self.__PostMessage()
+
+    """ Function to send message """
+    def SendRequest(self, **kwargs):
+
+        if kwargs != None and len(kwargs) > 0:
+            self.__init__(kwargs)
+
+        if not self.AuthToken :
+
+            if not self.Sender :
+                return ActionApiResult(error="Missing AuthToken")
+            
+            if not self.APIKey :
+                return ActionApiResult(error="Missing AuthToken")
+        
+        if not self.MessageID:
+            return ActionApiResult(error="Missing MessageID")
+        
+        return self.__PostMessage()
+
+    """ Async Function to send message """
+    async def SendRequestAsync(self, **kwargs):
+
+        if kwargs != None and len(kwargs) > 0:
+            self.__init__(kwargs)
+
+        if not self.AuthToken :
+
+            if not self.Sender :
+                return ActionApiResult(error="Missing AuthToken")
+            
+            if not self.APIKey :
+                return ActionApiResult(error="Missing AuthToken")
+        
+        if not self.MessageID:
+            return ActionApiResult(error="Missing MessageID")
+        
+        return await asyncio.create_task(self.__PostMessageAsync())
+
+    def __repr__(self):
+        return self.__pretty__(self.APIData)
+
+    def __str__(self):
+
+        if self.AuthToken :
+            return 'Resubmit(AuthToken='+self.AuthToken+')'
+
+        return 'Resubmit(Sender='+self.Sender+', APIKey='+str(self.APIKey)+ ')'