lynkora-sdk-python 0.1.0__py3-none-any.whl

lynkora_sdk/__init__.py

@@ -0,0 +1,4 @@
+from .client import LynkoraClient
+from .errors import LynkoraApiError
+
+__all__ = ["LynkoraClient", "LynkoraApiError"]

lynkora_sdk/client.py

@@ -0,0 +1,78 @@
+import json
+from urllib.error import HTTPError
+from urllib.request import Request, urlopen
+
+from .errors import LynkoraApiError
+
+
+class LynkoraClient:
+    def __init__(self, api_key: str, base_url: str) -> None:
+        self._api_key = api_key
+        self._base_url = base_url
+
+    def register_subscriber(
+        self,
+        suite_id: str,
+        name: str,
+        email: str,
+        document: str | None = None,
+        metadata: dict | None = None,
+    ) -> dict:
+        body = {"name": name, "email": email}
+        if document is not None:
+            body["document"] = document
+        if metadata is not None:
+            body["metadata"] = metadata
+        return self._request(
+            "POST", f"/v1/suites/{suite_id}/subscribers/register", body
+        )
+
+    def consume_action(
+        self,
+        subscriber_id: str,
+        action_slug: str,
+        quantity: int | None = None,
+        metadata: dict | None = None,
+    ) -> dict:
+        body = {"subscriberId": subscriber_id, "actionSlug": action_slug}
+        if quantity is not None:
+            body["quantity"] = quantity
+        if metadata is not None:
+            body["metadata"] = metadata
+        return self._request("POST", "/v1/actions/consume", body)
+
+    def confirm_consumption(self, reservation_id: str) -> dict:
+        return self._request("POST", f"/v1/actions/confirm/{reservation_id}")
+
+    def cancel_consumption(self, reservation_id: str) -> None:
+        return self._request("POST", f"/v1/actions/cancel/{reservation_id}")
+
+    def _request(self, method: str, path: str, body: dict | None = None) -> object:
+        data = json.dumps(body).encode("utf-8") if body is not None else None
+        req = Request(
+            f"{self._base_url}{path}",
+            data=data,
+            method=method,
+            headers={
+                "X-Api-Key": self._api_key,
+                "Content-Type": "application/json",
+            },
+        )
+
+        try:
+            with urlopen(req) as response:
+                if response.status == 204:
+                    return None
+                return json.loads(response.read())
+        except HTTPError as e:
+            raw = e.read()
+            try:
+                error_body = json.loads(raw) if raw else None
+            except ValueError:
+                error_body = None
+            message = (
+                error_body.get("message")
+                if isinstance(error_body, dict) and error_body.get("message")
+                else e.reason
+            )
+            raise LynkoraApiError(e.code, message, error_body) from e

lynkora_sdk/errors.py

@@ -0,0 +1,5 @@
+class LynkoraApiError(Exception):
+    def __init__(self, status_code: int, message: str, body: object) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.body = body

lynkora_sdk_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: lynkora-sdk-python
+Version: 0.1.0
+Summary: SDK Python para integração com a API de Actions/Subscribers do Lynkora Admin Service.
+License-Expression: MIT
+Project-URL: Homepage, https://docs.lynkora.dev/docs/para-desenvolvedores/sdks
+Project-URL: Repository, https://github.com/natanaeldeveloper/lynkora-api
+Project-URL: Issues, https://github.com/natanaeldeveloper/lynkora-api/issues
+Keywords: lynkora,billing,usage-based-billing,metering,sdk
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# lynkora-sdk-python
+
+SDK Python pra integrar com a API pública do Lynkora — registrar assinantes e
+controlar consumo (reservar, confirmar, cancelar). Zero dependências de
+runtime (usa `urllib.request` da biblioteca padrão), cliente síncrono.
+
+Documentação completa dos endpoints: [docs.lynkora.dev/docs/para-desenvolvedores/sdks](https://docs.lynkora.dev/docs/para-desenvolvedores/sdks).
+
+## Instalação
+
+```bash
+pip install lynkora-sdk-python
+```
+
+## Uso
+
+```python
+import os
+from lynkora_sdk import LynkoraClient
+
+lynkora = LynkoraClient(
+    api_key=os.environ["LYNKORA_API_KEY"],
+    base_url="https://api.lynkora.dev",
+)
+
+result = lynkora.consume_action(
+    subscriber_id="sub_123",
+    action_slug="generate-report",
+)
+
+lynkora.confirm_consumption(result["reservationId"])
+```
+
+Erros da API chegam como `LynkoraApiError`, com `status_code`, a mensagem (via
+`str(err)`) e o corpo original da resposta em `body`:
+
+```python
+from lynkora_sdk import LynkoraApiError
+
+try:
+    lynkora.consume_action(subscriber_id="sub_123", action_slug="generate-report")
+except LynkoraApiError as err:
+    print(err.status_code, str(err), err.body)
+```
+
+## Escopo
+
+Só os 4 endpoints autenticados por `X-Api-Key`: `consume_action`,
+`confirm_consumption`, `cancel_consumption` e `register_subscriber`. Nada de
+painel administrativo nem cobrança — isso é feito direto pela API.
+
+## Licença
+
+MIT

lynkora_sdk_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+lynkora_sdk/__init__.py,sha256=l3OB5aTQnhnIVUxCo90glO-75fe3RiipxPUZ2Ys8qHI,118
+lynkora_sdk/client.py,sha256=N97Yea13LvD35DXucLYX1rYAlfrmRntOz4g-CKpTlUw,2592
+lynkora_sdk/errors.py,sha256=2Etnrp0dykVeXP8bc1caD0-41xVj2w1a-RO_jvFZKR4,210
+lynkora_sdk_python-0.1.0.dist-info/licenses/LICENSE,sha256=F6L4fbhXv8SquSXEKIOJ6vjHuFi-ftTeH9HDyYKkIGw,1064
+lynkora_sdk_python-0.1.0.dist-info/METADATA,sha256=_pgG8VwZC5a3LDbr_EvpxLjeQ0qz1c_w_DZTwrrhE0Y,2122
+lynkora_sdk_python-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+lynkora_sdk_python-0.1.0.dist-info/top_level.txt,sha256=QN5jLv9Y37lVO_GCfayaHC1TdcEZ9Q6SnWepbU2507s,12
+lynkora_sdk_python-0.1.0.dist-info/RECORD,,

lynkora_sdk_python-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

lynkora_sdk_python-0.1.0.dist-info/licenses/LICENSE

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

lynkora_sdk_python-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+lynkora_sdk