PySyriatel 2.1.1__tar.gz

pysyriatel-2.1.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Syriatel Cash API
+
+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.
+

pysyriatel-2.1.1/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: PySyriatel
+Version: 2.1.1
+Summary: Python client for Syriatel API
+Author-email: melchersman <melchersman@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/melchersman/PySyriatel
+Project-URL: Documentation, https://api.melchersman.com/syr-cash/api-docs
+Project-URL: Repository, https://github.com/melchersman/PySyriatel
+Project-URL: Issues, https://github.com/melchersman/PySyriatel/issues
+Keywords: syriatel,cash,api,syria,payment,mobile,money
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: requests>=2.28.0
+Dynamic: license-file
+
+# PySyriatel
+
+Python client for Syriatel API.
+
+## Installation
+
+```bash
+pip install PySyriatel
+```
+
+## Usage
+
+### Async
+
+```python
+from syriatel import SyriatelAPI
+
+async with SyriatelAPI(api_token="your_token") as api:
+    # Get registered numbers
+    numbers = await api.get_numbers()
+    codes = await api.get_codes()
+    numbers_codes = await api.get_numbers_codes()
+    
+    # Syriatel Cash - accepts phone number or secret code (auto-detected)
+    balance = await api.syrcash.balance("0991234567")  # Phone number
+    balance = await api.syrcash.balance("65656565")    # Secret code as string
+    balance = await api.syrcash.balance(65656565)      # Secret code as int
+    
+    # Get transaction history (only successful transactions by default)
+    incoming = await api.syrcash.get_incoming_history("0991234567")
+    
+    # Get all transactions including failed ones
+    all_tx = await api.syrcash.get_incoming_history("0991234567", status="all")
+    
+    # Get only failed transactions
+    failed = await api.syrcash.get_incoming_history("0991234567", status="failed")
+    
+    # Date filtering
+    incoming = await api.syrcash.get_incoming_history(
+        "0991234567",
+        start_at="2024-01-01",
+        end_at="2024-12-31"
+    )
+    
+    outgoing = await api.syrcash.get_outgoing_history("0991234567")
+    
+    tx = await api.syrcash.find_incoming_transaction(
+        "6036565056",
+        query="0991234567"
+    )
+```
+
+### Sync
+
+```python
+from syriatel import SyriatelAPISync
+
+with SyriatelAPISync(api_token="your_token") as api:
+    numbers = api.get_numbers()
+    balance = api.syrcash.balance("0991234567")
+    balance = api.syrcash.balance(65656565)  # Secret code as int works too
+    incoming = api.syrcash.get_incoming_history("0991234567")
+```
+
+## API
+
+### SyriatelAPI / SyriatelAPISync
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `get_numbers()` | `List[str]` | Active phone numbers |
+| `get_codes()` | `List[str]` | Secret codes |
+| `get_numbers_codes()` | `List[Tuple[str, str]]` | Number and code pairs |
+
+### api.syrcash
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `balance(query)` | `float` | Balance in SYP. Accepts phone number or secret code (auto-detected) |
+| `get_incoming_history(query, page, status, start_at, end_at)` | `List[Transaction]` | Incoming transfers |
+| `get_outgoing_history(query, page, status, start_at, end_at)` | `List[Transaction]` | Outgoing transfers |
+| `find_incoming_transaction(transaction_no, query)` | `Transaction` | Find by transaction number |
+
+**Notes:**
+- `query` parameter auto-detects: if 10 digits starting with `09`, it's a phone number, otherwise it's a secret code
+- `status` parameter: `"success"` (default), `"failed"`, or `"all"`
+- Phone numbers and secret codes can be passed as strings or integers
+
+### Transaction
+
+```python
+@dataclass
+class Transaction:
+    transaction_no: str
+    date: str
+    from_gsm: str
+    to_gsm: str
+    amount: float
+    fee: float
+    net: float
+    channel: str
+    status: str
+```
+
+## Error Handling
+
+```python
+from syriatel import (
+    SyriatelAPIError,
+    InvalidTokenError,
+    SubscriptionExpiredError,
+    FetchFailedError,
+    NetworkError,
+)
+
+try:
+    balance = await api.syrcash.balance("0991234567")
+except SubscriptionExpiredError:
+    print("Subscription expired")
+except InvalidTokenError:
+    print("Invalid token")
+except NetworkError as e:
+    print(f"Network error: {e}")
+```
+
+## Rate Limits
+
+- Balance: 5 requests per minute per number
+- History: 5 requests per minute per number
+
+## License
+
+MIT

pysyriatel-2.1.1/PySyriatel.egg-info/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: PySyriatel
+Version: 2.1.1
+Summary: Python client for Syriatel API
+Author-email: melchersman <melchersman@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/melchersman/PySyriatel
+Project-URL: Documentation, https://api.melchersman.com/syr-cash/api-docs
+Project-URL: Repository, https://github.com/melchersman/PySyriatel
+Project-URL: Issues, https://github.com/melchersman/PySyriatel/issues
+Keywords: syriatel,cash,api,syria,payment,mobile,money
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: requests>=2.28.0
+Dynamic: license-file
+
+# PySyriatel
+
+Python client for Syriatel API.
+
+## Installation
+
+```bash
+pip install PySyriatel
+```
+
+## Usage
+
+### Async
+
+```python
+from syriatel import SyriatelAPI
+
+async with SyriatelAPI(api_token="your_token") as api:
+    # Get registered numbers
+    numbers = await api.get_numbers()
+    codes = await api.get_codes()
+    numbers_codes = await api.get_numbers_codes()
+    
+    # Syriatel Cash - accepts phone number or secret code (auto-detected)
+    balance = await api.syrcash.balance("0991234567")  # Phone number
+    balance = await api.syrcash.balance("65656565")    # Secret code as string
+    balance = await api.syrcash.balance(65656565)      # Secret code as int
+    
+    # Get transaction history (only successful transactions by default)
+    incoming = await api.syrcash.get_incoming_history("0991234567")
+    
+    # Get all transactions including failed ones
+    all_tx = await api.syrcash.get_incoming_history("0991234567", status="all")
+    
+    # Get only failed transactions
+    failed = await api.syrcash.get_incoming_history("0991234567", status="failed")
+    
+    # Date filtering
+    incoming = await api.syrcash.get_incoming_history(
+        "0991234567",
+        start_at="2024-01-01",
+        end_at="2024-12-31"
+    )
+    
+    outgoing = await api.syrcash.get_outgoing_history("0991234567")
+    
+    tx = await api.syrcash.find_incoming_transaction(
+        "6036565056",
+        query="0991234567"
+    )
+```
+
+### Sync
+
+```python
+from syriatel import SyriatelAPISync
+
+with SyriatelAPISync(api_token="your_token") as api:
+    numbers = api.get_numbers()
+    balance = api.syrcash.balance("0991234567")
+    balance = api.syrcash.balance(65656565)  # Secret code as int works too
+    incoming = api.syrcash.get_incoming_history("0991234567")
+```
+
+## API
+
+### SyriatelAPI / SyriatelAPISync
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `get_numbers()` | `List[str]` | Active phone numbers |
+| `get_codes()` | `List[str]` | Secret codes |
+| `get_numbers_codes()` | `List[Tuple[str, str]]` | Number and code pairs |
+
+### api.syrcash
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `balance(query)` | `float` | Balance in SYP. Accepts phone number or secret code (auto-detected) |
+| `get_incoming_history(query, page, status, start_at, end_at)` | `List[Transaction]` | Incoming transfers |
+| `get_outgoing_history(query, page, status, start_at, end_at)` | `List[Transaction]` | Outgoing transfers |
+| `find_incoming_transaction(transaction_no, query)` | `Transaction` | Find by transaction number |
+
+**Notes:**
+- `query` parameter auto-detects: if 10 digits starting with `09`, it's a phone number, otherwise it's a secret code
+- `status` parameter: `"success"` (default), `"failed"`, or `"all"`
+- Phone numbers and secret codes can be passed as strings or integers
+
+### Transaction
+
+```python
+@dataclass
+class Transaction:
+    transaction_no: str
+    date: str
+    from_gsm: str
+    to_gsm: str
+    amount: float
+    fee: float
+    net: float
+    channel: str
+    status: str
+```
+
+## Error Handling
+
+```python
+from syriatel import (
+    SyriatelAPIError,
+    InvalidTokenError,
+    SubscriptionExpiredError,
+    FetchFailedError,
+    NetworkError,
+)
+
+try:
+    balance = await api.syrcash.balance("0991234567")
+except SubscriptionExpiredError:
+    print("Subscription expired")
+except InvalidTokenError:
+    print("Invalid token")
+except NetworkError as e:
+    print(f"Network error: {e}")
+```
+
+## Rate Limits
+
+- Balance: 5 requests per minute per number
+- History: 5 requests per minute per number
+
+## License
+
+MIT

pysyriatel-2.1.1/PySyriatel.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+PySyriatel.egg-info/PKG-INFO
+PySyriatel.egg-info/SOURCES.txt
+PySyriatel.egg-info/dependency_links.txt
+PySyriatel.egg-info/requires.txt
+PySyriatel.egg-info/top_level.txt
+syriatel/__init__.py
+syriatel/client.py
+syriatel/exceptions.py
+syriatel/models.py

pysyriatel-2.1.1/PySyriatel.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pysyriatel-2.1.1/PySyriatel.egg-info/requires.txt

@@ -0,0 +1,2 @@
+aiohttp>=3.8.0
+requests>=2.28.0

pysyriatel-2.1.1/PySyriatel.egg-info/top_level.txt

@@ -0,0 +1 @@
+syriatel

pysyriatel-2.1.1/README.md

@@ -0,0 +1,133 @@
+# PySyriatel
+
+Python client for Syriatel API.
+
+## Installation
+
+```bash
+pip install PySyriatel
+```
+
+## Usage
+
+### Async
+
+```python
+from syriatel import SyriatelAPI
+
+async with SyriatelAPI(api_token="your_token") as api:
+    # Get registered numbers
+    numbers = await api.get_numbers()
+    codes = await api.get_codes()
+    numbers_codes = await api.get_numbers_codes()
+    
+    # Syriatel Cash - accepts phone number or secret code (auto-detected)
+    balance = await api.syrcash.balance("0991234567")  # Phone number
+    balance = await api.syrcash.balance("65656565")    # Secret code as string
+    balance = await api.syrcash.balance(65656565)      # Secret code as int
+    
+    # Get transaction history (only successful transactions by default)
+    incoming = await api.syrcash.get_incoming_history("0991234567")
+    
+    # Get all transactions including failed ones
+    all_tx = await api.syrcash.get_incoming_history("0991234567", status="all")
+    
+    # Get only failed transactions
+    failed = await api.syrcash.get_incoming_history("0991234567", status="failed")
+    
+    # Date filtering
+    incoming = await api.syrcash.get_incoming_history(
+        "0991234567",
+        start_at="2024-01-01",
+        end_at="2024-12-31"
+    )
+    
+    outgoing = await api.syrcash.get_outgoing_history("0991234567")
+    
+    tx = await api.syrcash.find_incoming_transaction(
+        "6036565056",
+        query="0991234567"
+    )
+```
+
+### Sync
+
+```python
+from syriatel import SyriatelAPISync
+
+with SyriatelAPISync(api_token="your_token") as api:
+    numbers = api.get_numbers()
+    balance = api.syrcash.balance("0991234567")
+    balance = api.syrcash.balance(65656565)  # Secret code as int works too
+    incoming = api.syrcash.get_incoming_history("0991234567")
+```
+
+## API
+
+### SyriatelAPI / SyriatelAPISync
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `get_numbers()` | `List[str]` | Active phone numbers |
+| `get_codes()` | `List[str]` | Secret codes |
+| `get_numbers_codes()` | `List[Tuple[str, str]]` | Number and code pairs |
+
+### api.syrcash
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `balance(query)` | `float` | Balance in SYP. Accepts phone number or secret code (auto-detected) |
+| `get_incoming_history(query, page, status, start_at, end_at)` | `List[Transaction]` | Incoming transfers |
+| `get_outgoing_history(query, page, status, start_at, end_at)` | `List[Transaction]` | Outgoing transfers |
+| `find_incoming_transaction(transaction_no, query)` | `Transaction` | Find by transaction number |
+
+**Notes:**
+- `query` parameter auto-detects: if 10 digits starting with `09`, it's a phone number, otherwise it's a secret code
+- `status` parameter: `"success"` (default), `"failed"`, or `"all"`
+- Phone numbers and secret codes can be passed as strings or integers
+
+### Transaction
+
+```python
+@dataclass
+class Transaction:
+    transaction_no: str
+    date: str
+    from_gsm: str
+    to_gsm: str
+    amount: float
+    fee: float
+    net: float
+    channel: str
+    status: str
+```
+
+## Error Handling
+
+```python
+from syriatel import (
+    SyriatelAPIError,
+    InvalidTokenError,
+    SubscriptionExpiredError,
+    FetchFailedError,
+    NetworkError,
+)
+
+try:
+    balance = await api.syrcash.balance("0991234567")
+except SubscriptionExpiredError:
+    print("Subscription expired")
+except InvalidTokenError:
+    print("Invalid token")
+except NetworkError as e:
+    print(f"Network error: {e}")
+```
+
+## Rate Limits
+
+- Balance: 5 requests per minute per number
+- History: 5 requests per minute per number
+
+## License
+
+MIT

pysyriatel-2.1.1/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "PySyriatel"
+version = "2.1.1"
+description = "Python client for Syriatel API"
+readme = "README.md"
+authors = [
+    { name = "melchersman", email = "melchersman@gmail.com" },
+]
+license = { text = "MIT" }
+requires-python = ">=3.7"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "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",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+keywords = ["syriatel", "cash", "api", "syria", "payment", "mobile", "money"]
+dependencies = [
+    "aiohttp>=3.8.0",
+    "requests>=2.28.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/melchersman/PySyriatel"
+Documentation = "https://api.melchersman.com/syr-cash/api-docs"
+Repository = "https://github.com/melchersman/PySyriatel"
+Issues = "https://github.com/melchersman/PySyriatel/issues"
+
+[tool.setuptools]
+packages = ["syriatel"]
+
+[tool.setuptools.package-data]
+syriatel = ["py.typed"]
+

pysyriatel-2.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pysyriatel-2.1.1/syriatel/__init__.py

@@ -0,0 +1,43 @@
+"""
+Syriatel API Python Library
+
+A professional Python library for interacting with the Syriatel API.
+Supports both async and sync operations.
+"""
+
+from .client import SyriatelAPI, SyriatelAPISync, SyriatelCash
+from .models import Transaction
+from .exceptions import (
+    SyriatelAPIError,
+    InvalidTokenError,
+    SubscriptionExpiredError,
+    FetchFailedError,
+    NotAuthorizedError,
+    ServerMaintenanceError,
+    NetworkError,
+    GSMNotFoundError,
+    VerificationRequiredError,
+    VerificationFailedError,
+    PINInvalidError,
+    LoginFailedError,
+)
+
+__version__ = "2.0.3"
+__all__ = [
+    "SyriatelAPI",
+    "SyriatelAPISync",
+    "SyriatelCash",
+    "Transaction",
+    "SyriatelAPIError",
+    "InvalidTokenError",
+    "SubscriptionExpiredError",
+    "FetchFailedError",
+    "NotAuthorizedError",
+    "ServerMaintenanceError",
+    "NetworkError",
+    "GSMNotFoundError",
+    "VerificationRequiredError",
+    "VerificationFailedError",
+    "PINInvalidError",
+    "LoginFailedError",
+]