inttegro 1.0.0__tar.gz

inttegro-1.0.0/LICENSE

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

inttegro-1.0.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: inttegro
+Version: 1.0.0
+Summary: Official Python SDK for the Inttegro API
+License: MIT
+License-File: LICENSE
+Author: Inttegro Engineering
+Author-email: engineering@inttegro.com
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Project-URL: Documentation, https://studio.inttegro.com/api-reference
+Project-URL: Homepage, https://studio.inttegro.com
+Project-URL: Issues, https://github.com/zebodotdev/inttegro-sdk-python/issues
+Project-URL: Repository, https://github.com/zebodotdev/inttegro-sdk-python
+Description-Content-Type: text/markdown
+
+# Inttegro Python SDK
+
+The official Python client for building server-side Inttegro integrations.
+
+> **Fastest, most modern path:** connect an agent to [Inttegro MCP](https://studio.inttegro.com/inttegro-mcp) at `https://mcp.inttegro.com`, then ask it to run `design_integration`. It will produce an implementation and test plan for your application. Use this SDK when you are ready to connect that plan to your Python service.
+
+All official Inttegro SDKs expose the same API capabilities. This package adds Python-specific data access, transports, and test seams.
+
+## Install
+
+Requires Python 3.10 or newer.
+
+```bash
+pip install inttegro
+```
+
+Store your secret key in the server environment:
+
+```bash
+export INTTEGRO_API_KEY="your_secret_key"
+```
+
+Never put the key in browser code, a mobile app, or source control. The client uses `https://api.inttegro.com` by default.
+
+## Create a hosted checkout
+
+Create and finalize an order, then send the customer to its hosted invoice URL:
+
+```python
+import os
+
+from inttegro import APIError, InttegroClient, ProductType
+
+inttegro = InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
+
+try:
+    result = inttegro.orders.create({
+        "request_meta": {"idempotency_key": "checkout-cart-123"},
+        "customer_data": {
+            "name": "Akua Mensah",
+            "email_address": "akua@example.com",
+            "phone_number": "+233544998605",
+        },
+        "finalize": True,
+        "checkout_settings": {
+            "redirect_url": "https://example.com/orders/complete",
+            "cancel_url": "https://example.com/cart",
+        },
+        "line_items": [{
+            "type": "product",
+            "product": {
+                "type": ProductType.DIGITAL,
+                "name": "Monthly subscription",
+                "quantity": 1,
+                "price": {"currency": "ghs", "value": 5000},
+            },
+        }],
+    })
+
+    checkout_url = result.order.invoice.format.web.url
+    print(result.order.id, checkout_url)
+except APIError as error:
+    print(error.code, error.detail or str(error))
+    raise
+```
+
+Amounts use integer minor units: `5000` GHS is GHS 50.00. Reuse the same idempotency key when retrying the same logical write. If you omit one, the SDK generates a UUIDv7 key for mutating calls.
+
+## Work with the API
+
+The SDK covers orders and checkout, customers, products and prices, purchase intents, payment methods, balances, payouts and refunds, notifications, files, application settings, keys, and country specifications. Resources use snake-case attributes such as `purchase_intents` and `payment_methods`.
+
+Python-specific features:
+
+- Standard-library-only runtime with no third-party dependencies.
+- Native dictionary requests and responses that support both attribute and mapping access.
+- JSON-compatible string enums for public API values.
+- Configurable timeout, base URL, and injectable transport for tests or custom networking.
+- Structured authentication, rate-limit, network, timeout, and API exceptions.
+
+See the [API reference](https://studio.inttegro.com/api-reference) for request fields and lifecycle rules, [errors](https://studio.inttegro.com/errors) for recovery guidance, and [idempotency](https://studio.inttegro.com/idempotency) for safe retries.
+
+## Verify a release
+
+The GitHub release for each version is the canonical record. It contains the exact wheel and source distribution uploaded to PyPI, SHA-256 checksums, and a Sigstore attestation tied to the source commit and release workflow.
+
+```bash
+sha256sum --check SHA256SUMS
+gh attestation verify inttegro-1.0.0-py3-none-any.whl \
+  --repo zebodotdev/inttegro-sdk-python
+```
+
+## Develop
+
+```bash
+poetry install
+poetry run python -m unittest discover -s tests -p "test_*.py"
+```
+

inttegro-1.0.0/README.md

@@ -0,0 +1,98 @@
+# Inttegro Python SDK
+
+The official Python client for building server-side Inttegro integrations.
+
+> **Fastest, most modern path:** connect an agent to [Inttegro MCP](https://studio.inttegro.com/inttegro-mcp) at `https://mcp.inttegro.com`, then ask it to run `design_integration`. It will produce an implementation and test plan for your application. Use this SDK when you are ready to connect that plan to your Python service.
+
+All official Inttegro SDKs expose the same API capabilities. This package adds Python-specific data access, transports, and test seams.
+
+## Install
+
+Requires Python 3.10 or newer.
+
+```bash
+pip install inttegro
+```
+
+Store your secret key in the server environment:
+
+```bash
+export INTTEGRO_API_KEY="your_secret_key"
+```
+
+Never put the key in browser code, a mobile app, or source control. The client uses `https://api.inttegro.com` by default.
+
+## Create a hosted checkout
+
+Create and finalize an order, then send the customer to its hosted invoice URL:
+
+```python
+import os
+
+from inttegro import APIError, InttegroClient, ProductType
+
+inttegro = InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
+
+try:
+    result = inttegro.orders.create({
+        "request_meta": {"idempotency_key": "checkout-cart-123"},
+        "customer_data": {
+            "name": "Akua Mensah",
+            "email_address": "akua@example.com",
+            "phone_number": "+233544998605",
+        },
+        "finalize": True,
+        "checkout_settings": {
+            "redirect_url": "https://example.com/orders/complete",
+            "cancel_url": "https://example.com/cart",
+        },
+        "line_items": [{
+            "type": "product",
+            "product": {
+                "type": ProductType.DIGITAL,
+                "name": "Monthly subscription",
+                "quantity": 1,
+                "price": {"currency": "ghs", "value": 5000},
+            },
+        }],
+    })
+
+    checkout_url = result.order.invoice.format.web.url
+    print(result.order.id, checkout_url)
+except APIError as error:
+    print(error.code, error.detail or str(error))
+    raise
+```
+
+Amounts use integer minor units: `5000` GHS is GHS 50.00. Reuse the same idempotency key when retrying the same logical write. If you omit one, the SDK generates a UUIDv7 key for mutating calls.
+
+## Work with the API
+
+The SDK covers orders and checkout, customers, products and prices, purchase intents, payment methods, balances, payouts and refunds, notifications, files, application settings, keys, and country specifications. Resources use snake-case attributes such as `purchase_intents` and `payment_methods`.
+
+Python-specific features:
+
+- Standard-library-only runtime with no third-party dependencies.
+- Native dictionary requests and responses that support both attribute and mapping access.
+- JSON-compatible string enums for public API values.
+- Configurable timeout, base URL, and injectable transport for tests or custom networking.
+- Structured authentication, rate-limit, network, timeout, and API exceptions.
+
+See the [API reference](https://studio.inttegro.com/api-reference) for request fields and lifecycle rules, [errors](https://studio.inttegro.com/errors) for recovery guidance, and [idempotency](https://studio.inttegro.com/idempotency) for safe retries.
+
+## Verify a release
+
+The GitHub release for each version is the canonical record. It contains the exact wheel and source distribution uploaded to PyPI, SHA-256 checksums, and a Sigstore attestation tied to the source commit and release workflow.
+
+```bash
+sha256sum --check SHA256SUMS
+gh attestation verify inttegro-1.0.0-py3-none-any.whl \
+  --repo zebodotdev/inttegro-sdk-python
+```
+
+## Develop
+
+```bash
+poetry install
+poetry run python -m unittest discover -s tests -p "test_*.py"
+```

inttegro-1.0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[tool.poetry]
+name = "inttegro"
+version = "1.0.0"
+description = "Official Python SDK for the Inttegro API"
+authors = ["Inttegro Engineering <engineering@inttegro.com>"]
+license = "MIT"
+readme = "README.md"
+packages = [{ include = "inttegro", from = "src" }]
+
+[tool.poetry.urls]
+Homepage = "https://studio.inttegro.com"
+Repository = "https://github.com/zebodotdev/inttegro-sdk-python"
+Issues = "https://github.com/zebodotdev/inttegro-sdk-python/issues"
+Documentation = "https://studio.inttegro.com/api-reference"
+
+[tool.poetry.dependencies]
+python = ">=3.10"
+
+[tool.poetry.group.dev.dependencies]
+coverage = "^7.6.1"
+
+[build-system]
+requires = ["poetry-core==2.4.1"]
+build-backend = "poetry.core.masonry.api"

inttegro-1.0.0/src/inttegro/__init__.py

@@ -0,0 +1,21 @@
+from .client import InttegroClient
+from .errors import (
+    InttegroError,
+    NetworkError,
+    TimeoutError,
+    APIError,
+    AuthenticationError,
+    RateLimitError,
+)
+from .enums import *  # noqa: F401,F403
+from .enums import __all__ as _enum_exports
+
+__all__ = [
+    "InttegroClient",
+    "InttegroError",
+    "NetworkError",
+    "TimeoutError",
+    "APIError",
+    "AuthenticationError",
+    "RateLimitError",
+] + _enum_exports

inttegro-1.0.0/src/inttegro/client.py

@@ -0,0 +1,157 @@
+from __future__ import annotations
+
+from .http_client import HttpClient
+from .resources.balance_transactions import BalanceTransactions
+from .resources.chimes import Chimes
+from .resources.customers import Customers
+from .resources.schedules import Schedules
+from .resources.broadcasts import Broadcasts
+from .resources.message_templates import MessageTemplates
+from .resources.financial_accounts import FinancialAccounts
+from .resources.files import Files
+from .resources.file_links import FileLinks
+from .resources.file_references import FileReferences
+from .resources.keys import Keys
+from .resources.otp import Otp
+from .resources.orders import Orders
+from .resources.payment_methods import PaymentMethods
+from .resources.payouts import Payouts
+from .resources.products import Products
+from .resources.prices import Prices
+from .resources.purchase_intents import PurchaseIntents
+from .resources.refunds import Refunds
+from .resources.spec import Spec
+from .resources.balances import Balances
+from .resources.upload_requests import UploadRequests
+from .resources.apps import Apps
+
+
+class InttegroClient:
+    """
+    Main SDK client for the Inttegro API.
+
+    The Inttegro client provides access to all API resources including orders,
+    payment methods, payouts, financial accounts, and more. Initialize with
+    your API key from the Inttegro dashboard.
+
+    Attributes:
+        orders: Orders resource for creating and managing orders, processing payments
+        payment_methods: Payment methods resource for tokenizing and managing payment instruments
+        payouts: Payouts resource for scheduling and managing fund transfers
+        balance_transactions: Balance transactions resource for viewing account activity
+        financial_accounts: Financial accounts resource for connecting bank and mobile money accounts
+        customers: Customers resource for creating and managing customers
+        products: Products resource for managing catalog products
+        prices: Prices resource for managing catalog prices
+        refunds: Refunds resource for creating and managing refunds
+        chimes: Chimes resource for sending transactional notifications
+        schedules: Schedules resource for looking up and canceling scheduled chimes
+        broadcasts: Broadcasts resource for looking up and canceling broadcasts
+        otp: OTP resource for one-time password verification
+        apps: Apps resource for creating, looking up, and updating applications
+        spec: Spec resource for retrieving supported countries and currencies
+
+    Example:
+        ```python
+        import os
+        from inttegro import InttegroClient
+
+        # Initialize client with API key
+        client = InttegroClient(api_key=os.environ["INTTEGRO_API_KEY"])
+
+        # Create and process an order
+        result = client.orders.create({
+            "customer_data": {
+                "name": "Akua Asantewaa",
+                "phone_number": "+233541234567",
+                "email_address": "akua@example.com"
+            },
+            "line_items": [{
+                "type": "product",
+                "product": {
+                    "type": "digital",
+                    "name": "Premium Subscription",
+                    "quantity": 1,
+                    "price": {"currency": "ghs", "value": 5000}
+                }
+            }],
+            "billing_details": {
+                "name": "Akua Asantewaa",
+                "phone_number": "+233541234567"
+            },
+            "execute_payment": True
+        })
+        ```
+
+    Thread Safety:
+        The client is thread-safe after initialization and can be safely shared
+        across multiple threads.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = "https://api.inttegro.com",
+        timeout: float = 30.0,
+        transport=None,
+    ):
+        """
+        Initialize a new Inttegro client.
+
+        Args:
+            api_key: Your Inttegro API key (required). Get this from your dashboard
+                at https://studio.inttegro.com/settings/keys. Use test keys (sk_test_...)
+                for development and live keys (sk_live_...) for production.
+            base_url: API base URL. Defaults to production (https://api.inttegro.com).
+                Override for testing or staging environments.
+            timeout: Request timeout in seconds. Defaults to 30.0. Increase for
+                long-running operations or slow networks.
+            transport: Custom HTTP transport adapter. Pass a requests.Session or
+                custom transport for connection pooling, retries, or proxies.
+
+        Raises:
+            ValueError: If api_key is empty or invalid
+
+        Example:
+            ```python
+            # Production usage
+            client = InttegroClient(api_key="sk_live_...")
+
+            # Development with custom timeout
+            client = InttegroClient(
+                api_key="sk_test_...",
+                timeout=60.0
+            )
+
+            # Testing with mock server
+            client = InttegroClient(
+                api_key="sk_test_...",
+                base_url="http://localhost:8080"
+            )
+            ```
+        """
+        self.http = HttpClient(api_key=api_key, base_url=base_url, timeout=timeout, transport=transport)
+
+        self.orders = Orders(self.http)
+        self.payment_methods = PaymentMethods(self.http)
+        self.payouts = Payouts(self.http)
+        self.balance_transactions = BalanceTransactions(self.http)
+        self.financial_accounts = FinancialAccounts(self.http)
+        self.files = Files(self.http)
+        self.file_links = FileLinks(self.http)
+        self.file_references = FileReferences(self.http)
+        self.customers = Customers(self.http)
+        self.products = Products(self.http)
+        self.prices = Prices(self.http)
+        self.purchase_intents = PurchaseIntents(self.http)
+        self.refunds = Refunds(self.http)
+        self.chimes = Chimes(self.http)
+        self.schedules = Schedules(self.http)
+        self.broadcasts = Broadcasts(self.http)
+        self.message_templates = MessageTemplates(self.http)
+        self.otp = Otp(self.http)
+        self.apps = Apps(self.http)
+        self.keys = Keys(self.http)
+        self.spec = Spec(self.http)
+        self.balances = Balances(self.http)
+        self.upload_requests = UploadRequests(self.http)