identifyorg 0.1.0__tar.gz

identifyorg-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: identifyorg
+Version: 0.1.0
+Summary: IdentifyOrg server-side SDK — identity verification, prepaid billing, and realtime call/chat token issuance.
+License: MIT
+Keywords: identifyorg,kyc,bvn,nin,identity-verification,livekit
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+
+# identifyorg (Python server SDK)
+
+```bash
+pip install identifyorg
+```
+
+```python
+import os
+from identifyorg import IdentifyOrgClient, IdentifyOrgApiError
+
+identifyorg = IdentifyOrgClient(api_key=os.environ["IDENTIFYORG_SECRET_KEY"])
+
+# Identity verification
+result = identifyorg.verify_bvn("22212345678", first_name="Ada", last_name="Okafor",
+                              idempotency_key="order-123")
+
+# Top up credit
+topup = identifyorg.topup(amount=5000)
+print(topup["checkout_url"])
+
+# Mint a realtime token for YOUR user, then hand it to the browser/mobile
+# client (IdentifyOrg JS/React Native/Flutter/Kotlin SDK) — never send your
+# secret key to a client.
+call = identifyorg.streaming_token("video", identity=user.id, display_name=user.name)
+return {"token": call["token"], "url": call["url"], "room_name": call["room_name"]}
+
+chat = identifyorg.chat_token(visitor_id=visitor.id, visitor_name=visitor.name)
+```
+
+Errors raise `IdentifyOrgApiError` with `.status` and `.code` attributes.
+
+## Django / Flask example: minting a call token endpoint
+
+```python
+@app.post("/api/call-token")
+def call_token():
+    return identifyorg.streaming_token("video", identity=current_user.id, display_name=current_user.name)
+```
+
+Your frontend calls this endpoint (never IdentifyOrg directly with a secret
+key), then passes the returned `token`/`url` straight into the IdentifyOrg JS
+SDK's `joinCall()`.

identifyorg-0.1.0/README.md

@@ -0,0 +1,42 @@
+# identifyorg (Python server SDK)
+
+```bash
+pip install identifyorg
+```
+
+```python
+import os
+from identifyorg import IdentifyOrgClient, IdentifyOrgApiError
+
+identifyorg = IdentifyOrgClient(api_key=os.environ["IDENTIFYORG_SECRET_KEY"])
+
+# Identity verification
+result = identifyorg.verify_bvn("22212345678", first_name="Ada", last_name="Okafor",
+                              idempotency_key="order-123")
+
+# Top up credit
+topup = identifyorg.topup(amount=5000)
+print(topup["checkout_url"])
+
+# Mint a realtime token for YOUR user, then hand it to the browser/mobile
+# client (IdentifyOrg JS/React Native/Flutter/Kotlin SDK) — never send your
+# secret key to a client.
+call = identifyorg.streaming_token("video", identity=user.id, display_name=user.name)
+return {"token": call["token"], "url": call["url"], "room_name": call["room_name"]}
+
+chat = identifyorg.chat_token(visitor_id=visitor.id, visitor_name=visitor.name)
+```
+
+Errors raise `IdentifyOrgApiError` with `.status` and `.code` attributes.
+
+## Django / Flask example: minting a call token endpoint
+
+```python
+@app.post("/api/call-token")
+def call_token():
+    return identifyorg.streaming_token("video", identity=current_user.id, display_name=current_user.name)
+```
+
+Your frontend calls this endpoint (never IdentifyOrg directly with a secret
+key), then passes the returned `token`/`url` straight into the IdentifyOrg JS
+SDK's `joinCall()`.

identifyorg-0.1.0/identifyorg/__init__.py

@@ -0,0 +1,12 @@
+"""IdentifyOrg — Python server SDK.
+
+Server-side only: use your SECRET key here (vl_test_sk_.../vl_live_sk_...).
+For browser/mobile clients, mint a realtime token with `client.streaming_token(...)`
+or `client.chat_token(...)` on your backend and hand the result to the
+IdentifyOrg JS/React Native/Flutter/Kotlin SDK — never ship this key to a client.
+"""
+
+from .client import IdentifyOrgClient, IdentifyOrgApiError
+
+__all__ = ["IdentifyOrgClient", "IdentifyOrgApiError"]
+__version__ = "0.1.0"

identifyorg-0.1.0/identifyorg/client.py

@@ -0,0 +1,222 @@
+from __future__ import annotations
+
+from typing import Any
+from urllib.parse import urlencode
+
+import requests
+
+DEFAULT_BASE_URL = "https://api.identifyorg.com"
+
+
+class IdentifyOrgApiError(Exception):
+    def __init__(self, status: int, code: str | None, message: str):
+        self.status = status
+        self.code = code
+        super().__init__(f"IdentifyOrg API error ({code or status}): {message}")
+
+
+class IdentifyOrgClient:
+    """Server-side client. `api_key` must be a SECRET key
+    (vl_test_sk_.../vl_live_sk_...) — never expose it in client-side code.
+    """
+
+    def __init__(self, api_key: str, base_url: str = DEFAULT_BASE_URL):
+        if not api_key:
+            raise ValueError("IdentifyOrg: api_key is required")
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self._session = requests.Session()
+
+    # --- verification ---
+
+    def verify_bvn(self, bvn: str, first_name: str | None = None,
+                    last_name: str | None = None, idempotency_key: str | None = None) -> dict:
+        return self._post(
+            "/v1/verify/bvn",
+            {"bvn": bvn, "first_name": first_name, "last_name": last_name},
+            idempotency_key,
+        )
+
+    def verify_nin(self, nin: str, first_name: str | None = None,
+                    last_name: str | None = None, idempotency_key: str | None = None) -> dict:
+        return self._post(
+            "/v1/verify/nin",
+            {"nin": nin, "first_name": first_name, "last_name": last_name},
+            idempotency_key,
+        )
+
+    def verify_frsc(self, licence_number: str, first_name: str | None = None,
+                     last_name: str | None = None, idempotency_key: str | None = None) -> dict:
+        return self._post(
+            "/v1/verify/frsc",
+            {"licence_number": licence_number, "first_name": first_name, "last_name": last_name},
+            idempotency_key,
+        )
+
+    def verify_credit_score(self, bvn: str, first_name: str | None = None,
+                             last_name: str | None = None, idempotency_key: str | None = None) -> dict:
+        return self._post(
+            "/v1/verify/credit-score",
+            {"bvn": bvn, "first_name": first_name, "last_name": last_name},
+            idempotency_key,
+        )
+
+    def verify_cac(self, rc_number: str, first_name: str | None = None,
+                    last_name: str | None = None, idempotency_key: str | None = None) -> dict:
+        return self._post(
+            "/v1/verify/cac",
+            {"rc_number": rc_number, "first_name": first_name, "last_name": last_name},
+            idempotency_key,
+        )
+
+    # --- realtime: calls, streaming, chat ---
+
+    def streaming_token(self, session_type: str, identity: str,
+                         display_name: str | None = None, room_name: str | None = None,
+                         role: str = "publisher") -> dict:
+        """session_type: 'video' | 'voice' | 'stream'. Mint this server-side,
+        then hand the result to a client SDK (JS/React Native/Flutter/Kotlin)."""
+        return self._post(
+            f"/v1/streaming/{session_type}/token",
+            {
+                "identity": identity,
+                "display_name": display_name,
+                "room_name": room_name,
+                "role": role,
+            },
+        )
+
+    def streaming_sessions(self, limit: int = 50) -> list[dict]:
+        return self._get("/v1/streaming/sessions", {"limit": limit})
+
+    # --- host moderation — call from your backend in response to your own
+    # host UI (mute/kick/end buttons), never directly from a client ---
+
+    def list_participants(self, session_id: str) -> list[dict]:
+        return self._get(f"/v1/streaming/sessions/{session_id}/participants")
+
+    def mute_participant(self, session_id: str, identity: str) -> dict:
+        return self._post(f"/v1/streaming/sessions/{session_id}/participants/{identity}/mute", {})
+
+    def unmute_participant(self, session_id: str, identity: str) -> dict:
+        return self._post(f"/v1/streaming/sessions/{session_id}/participants/{identity}/unmute", {})
+
+    def camera_off_participant(self, session_id: str, identity: str) -> dict:
+        return self._post(
+            f"/v1/streaming/sessions/{session_id}/participants/{identity}/camera-off", {}
+        )
+
+    def camera_on_participant(self, session_id: str, identity: str) -> dict:
+        return self._post(
+            f"/v1/streaming/sessions/{session_id}/participants/{identity}/camera-on", {}
+        )
+
+    def kick_participant(self, session_id: str, identity: str) -> dict:
+        return self._post(f"/v1/streaming/sessions/{session_id}/participants/{identity}/kick", {})
+
+    def end_session(self, session_id: str) -> dict:
+        return self._post(f"/v1/streaming/sessions/{session_id}/end", {})
+
+    # --- the gifting economy ---
+
+    def create_gift(self, name: str, price_coins: int, emoji: str = "🎁") -> dict:
+        return self._post(
+            "/v1/streaming/gifts", {"name": name, "emoji": emoji, "price_coins": price_coins}
+        )
+
+    def list_gifts(self, include_inactive: bool = False) -> list[dict]:
+        return self._get("/v1/streaming/gifts", {"include_inactive": include_inactive})
+
+    def update_gift(self, gift_id: str, **fields: Any) -> dict:
+        return self._patch(f"/v1/streaming/gifts/{gift_id}", fields)
+
+    def delete_gift(self, gift_id: str) -> None:
+        self._delete(f"/v1/streaming/gifts/{gift_id}")
+
+    def credit_coins(self, external_id: str, amount: int, display_name: str | None = None) -> dict:
+        return self._post(
+            f"/v1/streaming/viewers/{external_id}/coins/credit",
+            {"amount": amount, "display_name": display_name},
+        )
+
+    def get_viewer(self, external_id: str) -> dict:
+        return self._get(f"/v1/streaming/viewers/{external_id}")
+
+    def send_gift(self, from_external_id: str, to_identity: str, gift_id: str, room_name: str) -> dict:
+        return self._post(
+            "/v1/streaming/gifts/send",
+            {
+                "from_external_id": from_external_id,
+                "to_identity": to_identity,
+                "gift_id": gift_id,
+                "room_name": room_name,
+            },
+        )
+
+    def chat_token(self, visitor_id: str, visitor_name: str | None = None,
+                    channel_id: str | None = None) -> dict:
+        return self._post(
+            "/v1/chat/token",
+            {"visitor_id": visitor_id, "visitor_name": visitor_name, "channel_id": channel_id},
+        )
+
+    # --- billing ---
+
+    def topup(self, amount: float) -> dict:
+        return self._post("/v1/payments/topup", {"amount": amount})
+
+    def payments(self, limit: int = 50) -> list[dict]:
+        return self._get("/v1/payments", {"limit": limit})
+
+    def balance(self) -> dict:
+        return self._get("/v1/balance")
+
+    def transactions(self, limit: int = 50, offset: int = 0) -> dict:
+        return self._get("/v1/transactions", {"limit": limit, "offset": offset})
+
+    def usage(self, **filters: Any) -> dict:
+        return self._get("/v1/usage", filters)
+
+    def pricing(self) -> list[dict]:
+        return self._get("/v1/pricing")
+
+    # --- internals ---
+
+    def _headers(self, idempotency_key: str | None = None) -> dict:
+        headers = {"X-IdentifyOrg-Key": self.api_key}
+        if idempotency_key:
+            headers["Idempotency-Key"] = idempotency_key
+        return headers
+
+    def _post(self, path: str, body: dict, idempotency_key: str | None = None) -> dict:
+        body = {k: v for k, v in body.items() if v is not None}
+        resp = self._session.post(
+            self.base_url + path, json=body, headers=self._headers(idempotency_key)
+        )
+        return self._parse(resp)
+
+    def _patch(self, path: str, body: dict) -> dict:
+        body = {k: v for k, v in body.items() if v is not None}
+        resp = self._session.patch(self.base_url + path, json=body, headers=self._headers())
+        return self._parse(resp)
+
+    def _delete(self, path: str) -> None:
+        resp = self._session.delete(self.base_url + path, headers=self._headers())
+        self._parse(resp)
+
+    def _get(self, path: str, params: dict | None = None) -> Any:
+        params = {k: v for k, v in (params or {}).items() if v is not None}
+        query = f"?{urlencode(params)}" if params else ""
+        resp = self._session.get(self.base_url + path + query, headers=self._headers())
+        return self._parse(resp)
+
+    @staticmethod
+    def _parse(resp: requests.Response) -> Any:
+        try:
+            data = resp.json()
+        except ValueError:
+            data = {}
+        if not resp.ok:
+            err = data.get("error", {}) if isinstance(data, dict) else {}
+            raise IdentifyOrgApiError(resp.status_code, err.get("code"), err.get("message", resp.reason))
+        return data

identifyorg-0.1.0/identifyorg.egg-info/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: identifyorg
+Version: 0.1.0
+Summary: IdentifyOrg server-side SDK — identity verification, prepaid billing, and realtime call/chat token issuance.
+License: MIT
+Keywords: identifyorg,kyc,bvn,nin,identity-verification,livekit
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+
+# identifyorg (Python server SDK)
+
+```bash
+pip install identifyorg
+```
+
+```python
+import os
+from identifyorg import IdentifyOrgClient, IdentifyOrgApiError
+
+identifyorg = IdentifyOrgClient(api_key=os.environ["IDENTIFYORG_SECRET_KEY"])
+
+# Identity verification
+result = identifyorg.verify_bvn("22212345678", first_name="Ada", last_name="Okafor",
+                              idempotency_key="order-123")
+
+# Top up credit
+topup = identifyorg.topup(amount=5000)
+print(topup["checkout_url"])
+
+# Mint a realtime token for YOUR user, then hand it to the browser/mobile
+# client (IdentifyOrg JS/React Native/Flutter/Kotlin SDK) — never send your
+# secret key to a client.
+call = identifyorg.streaming_token("video", identity=user.id, display_name=user.name)
+return {"token": call["token"], "url": call["url"], "room_name": call["room_name"]}
+
+chat = identifyorg.chat_token(visitor_id=visitor.id, visitor_name=visitor.name)
+```
+
+Errors raise `IdentifyOrgApiError` with `.status` and `.code` attributes.
+
+## Django / Flask example: minting a call token endpoint
+
+```python
+@app.post("/api/call-token")
+def call_token():
+    return identifyorg.streaming_token("video", identity=current_user.id, display_name=current_user.name)
+```
+
+Your frontend calls this endpoint (never IdentifyOrg directly with a secret
+key), then passes the returned `token`/`url` straight into the IdentifyOrg JS
+SDK's `joinCall()`.

identifyorg-0.1.0/identifyorg.egg-info/SOURCES.txt

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

identifyorg-0.1.0/identifyorg.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

identifyorg-0.1.0/identifyorg.egg-info/requires.txt

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

identifyorg-0.1.0/identifyorg.egg-info/top_level.txt

@@ -0,0 +1 @@
+identifyorg

identifyorg-0.1.0/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "identifyorg"
+version = "0.1.0"
+description = "IdentifyOrg server-side SDK — identity verification, prepaid billing, and realtime call/chat token issuance."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+dependencies = ["requests>=2.28"]
+keywords = ["identifyorg", "kyc", "bvn", "nin", "identity-verification", "livekit"]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["identifyorg*"]

identifyorg-0.1.0/setup.cfg

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