serwersmsv2api 0.0.1__tar.gz

serwersmsv2api-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

serwersmsv2api-0.0.1/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: serwersmsv2api
+Version: 0.0.1
+Summary: Python client for remote communication with SerwerSMS.pl API v2
+Home-page: https://serwersms.pl
+Author: SerwerSMS
+Author-email: dev@serwersms.pl
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# SerwerSMS.pl Python Client API
+Python client for remote communication with SerwerSMS.pl API v2
+
+Attention. The current version works based on the API token.
+
+In order to authorize via an API Token, it must be generated on the Customer Panel side in the Interface Settings → HTTPS API → API Tokens menu. The authorization header format follows the Bearer token format.
+
+#### Example usage
+```python
+import sys
+import json
+
+from serwersms import SerwerSMS
+
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'test': 'true',
+        'details': 'true'
+    }
+
+    response = api.message.send_sms('500600700', 'Test message', 'INFORMACJA', params)
+
+    result = json.loads(response)
+
+    if 'items' not in result:
+        raise Exception('Empty items')
+
+    for item in result['items']:
+        print(item['id'] + ' - ' + item['phone'] + ' - ' + item['status'])
+        
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Sending SMS
+```python
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'details': 'true'
+    }
+
+    response = api.message.send_sms('500600700', 'Test message', 'INFORMACJA', params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Sending personalized SMS
+```python
+api = SerwerSMS('token')
+
+try:
+
+    messages = []
+
+    message1 = {
+        'phone': '500600700',
+        'text': 'First message'
+    }
+    
+    messages.append(message1)
+
+    message2 = {
+        'phone': '600700800',
+        'text': 'Second  message'
+    }
+    
+    messages.append(message2)
+
+    params = {
+        'details': 'true'
+    }
+
+    response = api.message.send_personalized(messages, 'INFORMACJA', params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Downloading delivery reports
+```python
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'id': 'aca3944055'
+    }
+    
+    response = api.message.reports(params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Downloading incoming messages
+```python
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'phone': '500600700'
+    }
+    response = api.message.recived('ndi',params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+## Requirements
+Python 3.5.*
+
+## Documentation
+http://dev.serwersms.pl
+
+## API Console
+http://apiconsole.serwersms.pl

serwersmsv2api-0.0.1/README.md

@@ -0,0 +1,137 @@
+# SerwerSMS.pl Python Client API
+Python client for remote communication with SerwerSMS.pl API v2
+
+Attention. The current version works based on the API token.
+
+In order to authorize via an API Token, it must be generated on the Customer Panel side in the Interface Settings → HTTPS API → API Tokens menu. The authorization header format follows the Bearer token format.
+
+#### Example usage
+```python
+import sys
+import json
+
+from serwersms import SerwerSMS
+
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'test': 'true',
+        'details': 'true'
+    }
+
+    response = api.message.send_sms('500600700', 'Test message', 'INFORMACJA', params)
+
+    result = json.loads(response)
+
+    if 'items' not in result:
+        raise Exception('Empty items')
+
+    for item in result['items']:
+        print(item['id'] + ' - ' + item['phone'] + ' - ' + item['status'])
+        
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Sending SMS
+```python
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'details': 'true'
+    }
+
+    response = api.message.send_sms('500600700', 'Test message', 'INFORMACJA', params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Sending personalized SMS
+```python
+api = SerwerSMS('token')
+
+try:
+
+    messages = []
+
+    message1 = {
+        'phone': '500600700',
+        'text': 'First message'
+    }
+    
+    messages.append(message1)
+
+    message2 = {
+        'phone': '600700800',
+        'text': 'Second  message'
+    }
+    
+    messages.append(message2)
+
+    params = {
+        'details': 'true'
+    }
+
+    response = api.message.send_personalized(messages, 'INFORMACJA', params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Downloading delivery reports
+```python
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'id': 'aca3944055'
+    }
+    
+    response = api.message.reports(params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+#### Downloading incoming messages
+```python
+api = SerwerSMS('token')
+
+try:
+
+    params = {
+        'phone': '500600700'
+    }
+    response = api.message.recived('ndi',params)
+    
+    print(response)
+    
+except Exception:
+
+    print('ERROR: ', sys.exc_info()[1])
+```
+
+## Requirements
+Python 3.5.*
+
+## Documentation
+http://dev.serwersms.pl
+
+## API Console
+http://apiconsole.serwersms.pl

serwersmsv2api-0.0.1/pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+requires = [
+	"requests",
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

serwersmsv2api-0.0.1/setup.cfg

@@ -0,0 +1,28 @@
+[metadata]
+name = serwersmsv2api
+version = 0.0.1
+author = SerwerSMS
+author_email = dev@serwersms.pl
+description = Python client for remote communication with SerwerSMS.pl API v2
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://serwersms.pl
+project_urls = 
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.9
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

serwersmsv2api-0.0.1/src/serwersms/__init__.py

@@ -0,0 +1 @@
+from .serwersms import SerwerSMS

serwersmsv2api-0.0.1/src/serwersms/account.py

@@ -0,0 +1,65 @@
+class Account:
+    
+    def __init__(self, param):
+        
+        self.master = param
+    
+    '''
+    * Register new account
+    *
+    * param array params
+    *      option string "phone"
+    *      option string "email"
+    *      option string "first_name"
+    *      option string "last_name"
+    *      option string "company"
+    * return array
+    *      option bool "success"
+    '''
+    def add(self, options):
+
+        return self.master.call('account/add', options)
+
+    '''
+    * Return limits SMS
+    * param array params
+    *      option bool "show_type"
+    * return array
+    *      option array "items"
+    *          option string "type" Type of message
+    *          option string "chars_limit" The maximum length of message
+    *          option string "value" Limit messages
+    *
+    '''
+    def limits(self, options):
+
+        return self.master.call('account/limits', options)
+
+    '''
+    * Return contact details
+    *
+    * return array
+    *      option string "telephone"
+    *      option string "email"
+    *      option string "form"
+    *      option string "faq"
+    *      option array "account_maintainer"
+    *          option string "name"
+    *          option string "email"
+    *          option string "telephone"
+    *          option string "photo"
+    '''
+    def help(self):
+
+        return self.master.call('account/help', {})
+
+    '''
+    * Return messages from the administrator
+    *
+    * return array
+    *      option bool "new" Marking unread message
+    *      option string "message"
+    '''
+    def messages(self):
+
+        return self.master.call('account/messages', {})

serwersmsv2api-0.0.1/src/serwersms/blacklist.py

@@ -0,0 +1,77 @@
+class Blacklist:
+
+    def __init__(self, param):
+
+        self.master = param
+
+    '''
+    * Add phone to the blacklist
+    *
+    * param string phone
+    * return array
+    *      option bool "success"
+    *      option int "id"
+    '''
+    def add(self, phone):
+
+        options = {
+            'phone': phone
+        }
+
+        return self.master.call('blacklist/add', options)
+
+    '''
+    * List of blacklist phones
+    *
+    * param string phone
+    * param array params
+    *      option int "page" The number of the displayed page
+    *      option int "limit" Limit items are displayed on the single page
+    * return array
+    *      option array "paging"
+    *          option int "page" The number of current page
+    *          option int "count" The number of all pages
+    *      option array "items"
+    *          option string "phone"
+    *          option string "added" Date of adding phone
+    '''
+    def index(self, phone, params):
+
+        default = {
+            'phone': phone
+        }
+
+        options = params.copy()
+        options.update(default)
+
+        return self.master.call('blacklist/index', options)
+
+    '''
+    * Checking if phone is blacklisted
+    *
+    * param string phone
+    * return array
+    *      option bool "exists"
+    '''
+    def check(self, phone):
+
+        options = {
+            'phone': phone
+        }
+
+        return self.master.call('blacklist/check', options)
+
+    '''
+    * Deleting phone from the blacklist
+    *
+    * param string phone
+    * return array
+    *      option bool "success"
+    '''
+    def delete(self, phone):
+
+        options = {
+            'phone': phone
+        }
+
+        return self.master.call('blacklist/delete', options)

serwersmsv2api-0.0.1/src/serwersms/contact.py

@@ -0,0 +1,173 @@
+class Contact:
+
+    def __init__(self, param):
+
+        self.master = param
+
+    '''
+    * Add new contact
+    *
+    * param string group_id
+    * param string phone
+    * param array params
+    *      option string "email"
+    *      option string "first_name"
+    *      option string "last_name"
+    *      option string "company"
+    *      option string "tax_id"
+    *      option string "address"
+    *      option string "city"
+    *      option string "description"
+    * return array
+    *      option bool "success"
+    *      option int "id"
+    '''
+    def add(self, group_id, phone, params):
+
+        default = {
+            'group_id': group_id,
+            'phone': phone
+        }
+
+        options = params.copy()
+        options.update(default)
+
+        return self.master.call('contacts/add', options)
+
+    '''
+    * List of contacts
+    *
+    * param int group_id
+    * param string search
+    * param array params
+    *      option int "page" The number of the displayed page
+    *      option int "limit" Limit items are displayed on the single page
+    *      option string "sort" Values: first_name|last_name|phone|company|tax_id|email|address|city|description
+    *      option string "order" Values: asc|desc
+    * return array
+    *      option array "paging"
+    *          option int "page" The number of current page
+    *          option int "count" The number of all pages
+    *      options array "items"
+    *          option int "id"
+    *          option string "phone"
+    *          option string "email"
+    *          option string "company"
+    *          option string "first_name"
+    *          option string "last_name"
+    *          option string "tax_id"
+    *          option string "address"
+    *          option string "city"
+    *          option string "description"
+    *          option bool "blacklist"
+    *          option int "group_id"
+    *          option string "group_name"
+    '''
+    def index(self, group_id, search, params):
+
+        default = {
+            'group_id': group_id,
+            'search': search
+        }
+
+        options = params.copy()
+        options.update(default)
+
+        return self.master.call('contacts/index', options)
+
+    '''
+    * View single contact
+    *
+    * param int id
+    * return array
+    *      option integer "id"
+    *      option string "phone"
+    *      option string "email"
+    *      option string "company"
+    *      option string "first_name"
+    *      option string "last_name"
+    *      option string "tax_id"
+    *      option string "address"
+    *      option string "city"
+    *      option string "description"
+    *      option bool "blacklist"
+    '''
+    def view(self, id):
+
+        options = {
+            'id': id
+        }
+
+        return self.master.call('contacts/view', options)
+
+    '''
+    * Editing a contact
+    *
+    * param int id
+    * param string group_id
+    * param string phone
+    * param array params
+    *      option string "email"
+    *      option string "first_name"
+    *      option string "last_name"
+    *      option string "company"
+    *      option string "tax_id"
+    *      option string "address"
+    *      option string "city"
+    *      option string "description"
+    * return array
+    *      option bool "success"
+    *      option int "id"
+    '''
+    def edit(self, id, group_id, phone, params):
+
+        default = {
+            'id': id,
+            'group_id': group_id,
+            'phone': phone
+        }
+
+        options = params.copy()
+        options.update(default)
+
+        return self.master.call('contacts/edit', options)
+
+    '''
+    * Deleting a phone from contacts
+    *
+    * param int id
+    * return array
+    *      option bool "success"
+    '''
+    def delete(self, id):
+
+        options = {
+            'id': id
+        }
+
+        return self.master.call('contacts/delete', options)
+
+    '''
+    * Import contact list
+    *
+    * param string group_name
+    * param array contact[]
+    *      option string "phone"
+    *      option string "email"
+    *      option string "first_name"
+    *      option string "last_name"
+    *      option string "company"
+    * return array
+    *      option bool "success"
+    *      option int "id"
+    *      option int "correct" Number of contacts imported correctly
+    *      option int "failed" Number of errors
+    '''
+    def imports(self, group_name, contacts):
+
+        options = {
+            'group_name': group_name,
+            'contact': contacts
+        }
+
+        return self.master.call('contacts/import', options)

serwersmsv2api-0.0.1/src/serwersms/error.py

@@ -0,0 +1,18 @@
+class Error:
+    
+    def __init__(self, param):
+        
+        self.master = param
+    
+    '''
+    * Preview error
+    *
+    * param int code
+    * return array
+    *      option int "code"
+    *      option string "type"
+    *      option string "message"
+    '''
+    def view(self, code):
+
+        return self.master.call('error/' + str(code), {})