farazsms 1.0.1__tar.gz

farazsms-1.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FarazSMS
+
+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.

farazsms-1.0.1/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: farazsms
+Version: 1.0.1
+Summary: Official client for FarazSMS · IranPayamak (فراز اس ام اس · ایران پیامک) — https://farazsms.com. Send pattern/OTP, bulk SMS, reports, phonebook, and all 63 endpoints.
+Author: FarazSMS (فراز اس ام اس)
+License: MIT
+Project-URL: Homepage, https://farazsms.com
+Project-URL: IranPayamak, https://iranpayamak.com
+Project-URL: Documentation, https://farazsms.com
+Project-URL: Source, https://gitlab.faraz.club/common-service-centres/api-docs
+Keywords: farazsms,iranpayamak,sms,otp,pattern,iran,پیامک
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Dynamic: license-file
+
+# farazsms
+
+**FarazSMS · IranPayamak** — فراز اس ام اس · ایران پیامک
+🌐 [farazsms.com](https://farazsms.com) · [iranpayamak.com](https://iranpayamak.com)
+
+Official Python client for the **FarazSMS / IranPayamak** web services — send pattern/OTP, simple & bulk SMS, pull reports, manage your phonebook, and reach **all 63 endpoints** through a low-level `request()`.
+
+Python 3.7+ · depends only on `requests` · raises on API errors.
+
+## Install
+
+```bash
+pip install farazsms
+```
+
+## Quick start
+
+```python
+from farazsms import FarazSMS, FarazError
+
+sms = FarazSMS("YOUR_API_KEY")  # key from the panel → Web Service / API Key
+
+print(sms.balance())                                              # verify the key — free
+sms.send_pattern("SJ3FgPrE0C", "09120000000", {"code": "1234"})   # OTP (instant)
+sms.send_simple("Hello!", ["09120000000", "09130000000"])         # bulk
+print(sms.inbox(page=1, limit=20))                                # inbound replies
+
+try:
+    sms.send_pattern("BAD", "09120000000", {"code": "1"})
+except FarazError as e:
+    print(e.status, e.body)
+```
+
+> Recipients use the local format `09120000000` (no `+98`). Default sender line `90008361`.
+
+## Bundled helpers
+
+| Area | Methods |
+|------|---------|
+| Account | `balance()` · `profile()` · `lines()` |
+| Send | `send_pattern()` · `send_simple()` · `send_variable()` |
+| Patterns | `create_pattern()` · `patterns()` |
+| Reports | `inbox()` · `send_requests()` · `send_request_items()` |
+| Phonebook | `phonebooks()` · `add_contact()` |
+| Reference | `provinces()` · `number_banks()` |
+
+**Anything else** (tickets, orders, voice, LBS, …) via `request(method, path, body)`.
+
+## License
+
+MIT

farazsms-1.0.1/README.md

@@ -0,0 +1,51 @@
+# farazsms
+
+**FarazSMS · IranPayamak** — فراز اس ام اس · ایران پیامک
+🌐 [farazsms.com](https://farazsms.com) · [iranpayamak.com](https://iranpayamak.com)
+
+Official Python client for the **FarazSMS / IranPayamak** web services — send pattern/OTP, simple & bulk SMS, pull reports, manage your phonebook, and reach **all 63 endpoints** through a low-level `request()`.
+
+Python 3.7+ · depends only on `requests` · raises on API errors.
+
+## Install
+
+```bash
+pip install farazsms
+```
+
+## Quick start
+
+```python
+from farazsms import FarazSMS, FarazError
+
+sms = FarazSMS("YOUR_API_KEY")  # key from the panel → Web Service / API Key
+
+print(sms.balance())                                              # verify the key — free
+sms.send_pattern("SJ3FgPrE0C", "09120000000", {"code": "1234"})   # OTP (instant)
+sms.send_simple("Hello!", ["09120000000", "09130000000"])         # bulk
+print(sms.inbox(page=1, limit=20))                                # inbound replies
+
+try:
+    sms.send_pattern("BAD", "09120000000", {"code": "1"})
+except FarazError as e:
+    print(e.status, e.body)
+```
+
+> Recipients use the local format `09120000000` (no `+98`). Default sender line `90008361`.
+
+## Bundled helpers
+
+| Area | Methods |
+|------|---------|
+| Account | `balance()` · `profile()` · `lines()` |
+| Send | `send_pattern()` · `send_simple()` · `send_variable()` |
+| Patterns | `create_pattern()` · `patterns()` |
+| Reports | `inbox()` · `send_requests()` · `send_request_items()` |
+| Phonebook | `phonebooks()` · `add_contact()` |
+| Reference | `provinces()` · `number_banks()` |
+
+**Anything else** (tickets, orders, voice, LBS, …) via `request(method, path, body)`.
+
+## License
+
+MIT

farazsms-1.0.1/farazsms/__init__.py

@@ -0,0 +1,98 @@
+# FarazSMS · IranPayamak (فراز اس ام اس · ایران پیامک)
+# Official client — https://farazsms.com · https://iranpayamak.com
+"""Lightweight official client for the FarazSMS / IranPayamak web services."""
+
+import requests
+
+__version__ = "1.0.1"
+BASE = "https://api.iranpayamak.com"
+
+__all__ = ["FarazSMS", "FarazError"]
+
+
+class FarazError(Exception):
+    """Raised when the API returns an envelope with ``status == "error"``."""
+
+    def __init__(self, status, body):
+        super().__init__("[%s] %s" % (status, body))
+        self.status = status
+        self.body = body
+
+
+class FarazSMS:
+    """Official client for the FarazSMS / IranPayamak web services.
+
+    See https://farazsms.com
+    """
+
+    def __init__(self, api_key, base_url=BASE):
+        if not api_key:
+            raise ValueError("FarazSMS: api_key is required")
+        self.base = base_url.rstrip("/")
+        self.s = requests.Session()
+        self.s.headers.update({"Api-Key": api_key, "Accept": "application/json"})
+
+    # low-level — reaches every one of the 63 endpoints
+    def request(self, method, path, body=None, params=None):
+        r = self.s.request(method, self.base + path, json=body, params=params, timeout=30)
+        data = r.json() if r.content else {}
+        if isinstance(data, dict) and data.get("status") == "error":
+            raise FarazError(r.status_code, data.get("message") or data)
+        return data
+
+    # account
+    def balance(self):
+        return self.request("GET", "/ws/v1/account/balance")
+
+    def profile(self):
+        return self.request("GET", "/ws/v1/account/profile")
+
+    def lines(self):
+        return self.request("GET", "/ws/v1/lines/accessible")
+
+    # send
+    def send_pattern(self, code, recipient, attributes, line_number="90008361"):
+        return self.request("POST", "/ws/v1/sms/pattern", {
+            "code": code, "recipient": recipient, "attributes": attributes,
+            "line_number": line_number, "number_format": "english"})
+
+    def send_simple(self, text, recipients, line_number="90008361"):
+        return self.request("POST", "/ws/v1/sms/simple", {
+            "text": text, "recipients": recipients,
+            "line_number": line_number, "number_format": "english"})
+
+    def send_variable(self, text, recipients, line_number="90008361"):
+        return self.request("POST", "/ws/v1/sms/keywords", {
+            "text": text, "recipients": recipients,
+            "line_number": line_number, "number_format": "english"})
+
+    # patterns
+    def create_pattern(self, payload):
+        return self.request("POST", "/ws/v1/patterns", payload)
+
+    def patterns(self, **params):
+        return self.request("GET", "/ws/v1/patterns", params=params)
+
+    # reports
+    def inbox(self, page=1, limit=20):
+        return self.request("GET", "/ws/v1/inbox", params={"page": page, "limit": limit})
+
+    def send_requests(self, **params):
+        return self.request("GET", "/ws/v1/send_request", params=params)
+
+    def send_request_items(self, send_request_id, **params):
+        return self.request("GET", "/ws/v1/send_request/%s/items" % send_request_id, params=params)
+
+    # phonebook
+    def phonebooks(self):
+        return self.request("GET", "/ws/v1/phone_book")
+
+    def add_contact(self, payload):
+        return self.request("POST", "/ws/v1/phone_book_data", payload)
+
+    # reference
+    def provinces(self, **params):
+        return self.request("GET", "/provinces", params=params)
+
+    def number_banks(self, **params):
+        return self.request("GET", "/ws/v1/number_bank", params=params)

farazsms-1.0.1/farazsms.egg-info/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: farazsms
+Version: 1.0.1
+Summary: Official client for FarazSMS · IranPayamak (فراز اس ام اس · ایران پیامک) — https://farazsms.com. Send pattern/OTP, bulk SMS, reports, phonebook, and all 63 endpoints.
+Author: FarazSMS (فراز اس ام اس)
+License: MIT
+Project-URL: Homepage, https://farazsms.com
+Project-URL: IranPayamak, https://iranpayamak.com
+Project-URL: Documentation, https://farazsms.com
+Project-URL: Source, https://gitlab.faraz.club/common-service-centres/api-docs
+Keywords: farazsms,iranpayamak,sms,otp,pattern,iran,پیامک
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Dynamic: license-file
+
+# farazsms
+
+**FarazSMS · IranPayamak** — فراز اس ام اس · ایران پیامک
+🌐 [farazsms.com](https://farazsms.com) · [iranpayamak.com](https://iranpayamak.com)
+
+Official Python client for the **FarazSMS / IranPayamak** web services — send pattern/OTP, simple & bulk SMS, pull reports, manage your phonebook, and reach **all 63 endpoints** through a low-level `request()`.
+
+Python 3.7+ · depends only on `requests` · raises on API errors.
+
+## Install
+
+```bash
+pip install farazsms
+```
+
+## Quick start
+
+```python
+from farazsms import FarazSMS, FarazError
+
+sms = FarazSMS("YOUR_API_KEY")  # key from the panel → Web Service / API Key
+
+print(sms.balance())                                              # verify the key — free
+sms.send_pattern("SJ3FgPrE0C", "09120000000", {"code": "1234"})   # OTP (instant)
+sms.send_simple("Hello!", ["09120000000", "09130000000"])         # bulk
+print(sms.inbox(page=1, limit=20))                                # inbound replies
+
+try:
+    sms.send_pattern("BAD", "09120000000", {"code": "1"})
+except FarazError as e:
+    print(e.status, e.body)
+```
+
+> Recipients use the local format `09120000000` (no `+98`). Default sender line `90008361`.
+
+## Bundled helpers
+
+| Area | Methods |
+|------|---------|
+| Account | `balance()` · `profile()` · `lines()` |
+| Send | `send_pattern()` · `send_simple()` · `send_variable()` |
+| Patterns | `create_pattern()` · `patterns()` |
+| Reports | `inbox()` · `send_requests()` · `send_request_items()` |
+| Phonebook | `phonebooks()` · `add_contact()` |
+| Reference | `provinces()` · `number_banks()` |
+
+**Anything else** (tickets, orders, voice, LBS, …) via `request(method, path, body)`.
+
+## License
+
+MIT

farazsms-1.0.1/farazsms.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+LICENSE
+README.md
+pyproject.toml
+farazsms/__init__.py
+farazsms.egg-info/PKG-INFO
+farazsms.egg-info/SOURCES.txt
+farazsms.egg-info/dependency_links.txt
+farazsms.egg-info/requires.txt
+farazsms.egg-info/top_level.txt

farazsms-1.0.1/farazsms.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

farazsms-1.0.1/farazsms.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.20

farazsms-1.0.1/farazsms.egg-info/top_level.txt

@@ -0,0 +1 @@
+farazsms

farazsms-1.0.1/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "farazsms"
+version = "1.0.1"
+description = "Official client for FarazSMS · IranPayamak (فراز اس ام اس · ایران پیامک) — https://farazsms.com. Send pattern/OTP, bulk SMS, reports, phonebook, and all 63 endpoints."
+readme = "README.md"
+requires-python = ">=3.7"
+license = { text = "MIT" }
+authors = [{ name = "FarazSMS (فراز اس ام اس)" }]
+keywords = ["farazsms", "iranpayamak", "sms", "otp", "pattern", "iran", "پیامک"]
+dependencies = ["requests>=2.20"]
+
+[project.urls]
+Homepage = "https://farazsms.com"
+IranPayamak = "https://iranpayamak.com"
+Documentation = "https://farazsms.com"
+Source = "https://gitlab.faraz.club/common-service-centres/api-docs"
+
+[tool.setuptools]
+packages = ["farazsms"]

farazsms-1.0.1/setup.cfg

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