livekit-api 0.4.4__tar.gz → 0.5.1__tar.gz

{livekit-api-0.4.4 → livekit_api-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: livekit-api
-Version: 0.4.4
+Version: 0.5.1
 Summary: Python Server API for LiveKit
 Home-page: https://github.com/livekit/python-sdks
 License: Apache-2.0
@@ -19,13 +19,13 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.8.0
+Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 Requires-Dist: pyjwt>=2.0.0
 Requires-Dist: aiohttp>=3.9.0
 Requires-Dist: protobuf>=3
 Requires-Dist: types-protobuf<5,>=4
-Requires-Dist: livekit-protocol<1,>=0.3.0
+Requires-Dist: livekit-protocol<2,>=0.5.1
 
 # LiveKit Server APIs
 

{livekit-api-0.4.4 → livekit_api-0.5.1}/livekit/api/__init__.py

@@ -21,9 +21,10 @@ from livekit.protocol.ingress import *
 from livekit.protocol.models import *
 from livekit.protocol.room import *
 from livekit.protocol.webhook import *
+from livekit.protocol.sip import *
 
 from .twirp_client import TwirpError, TwirpErrorCode
 from .livekit_api import LiveKitAPI
-from .access_token import VideoGrants, AccessToken, TokenVerifier
+from .access_token import VideoGrants, SIPGrants, AccessToken, TokenVerifier
 from .webhook import WebhookReceiver
 from .version import __version__

{livekit-api-0.4.4 → livekit_api-0.5.1}/livekit/api/_service.py

@@ -1,8 +1,10 @@
+from __future__ import annotations
+
 from typing import Dict
 import aiohttp
 from abc import ABC
 from .twirp_client import TwirpClient
-from .access_token import AccessToken, VideoGrants
+from .access_token import AccessToken, VideoGrants, SIPGrants
 
 AUTHORIZATION = "authorization"
 
@@ -15,8 +17,14 @@ class Service(ABC):
         self.api_key = api_key
         self.api_secret = api_secret
 
-    def _auth_header(self, grants: VideoGrants) -> Dict[str, str]:
-        token = AccessToken(self.api_key, self.api_secret).with_grants(grants).to_jwt()
+    def _auth_header(
+        self, grants: VideoGrants, sip: SIPGrants | None = None
+    ) -> Dict[str, str]:
+        tok = AccessToken(self.api_key, self.api_secret).with_grants(grants)
+        if sip is not None:
+            tok = tok.with_sip_grants(sip)
+
+        token = tok.to_jwt()
 
         headers = {}
         headers[AUTHORIZATION] = "Bearer {}".format(token)

{livekit-api-0.4.4 → livekit_api-0.5.1}/livekit/api/access_token.py

@@ -63,11 +63,20 @@ class VideoGrants:
     agent: bool = False
 
 
+@dataclasses.dataclass
+class SIPGrants:
+    # manage sip resources
+    admin: bool = False
+    # make outbound calls
+    call: bool = False
+
+
 @dataclasses.dataclass
 class Claims:
     identity: str = ""
     name: str = ""
     video: VideoGrants = dataclasses.field(default_factory=VideoGrants)
+    sip: SIPGrants = dataclasses.field(default_factory=SIPGrants)
     metadata: str = ""
     sha256: str = ""
 
@@ -100,6 +109,10 @@ class AccessToken:
         self.claims.video = grants
         return self
 
+    def with_sip_grants(self, grants: SIPGrants) -> "AccessToken":
+        self.claims.sip = grants
+        return self
+
     def with_identity(self, identity: str) -> "AccessToken":
         self.identity = identity
         return self
@@ -173,10 +186,18 @@ class TokenVerifier:
         }
         video = VideoGrants(**video_dict)
 
+        sip_dict = claims.get("sip", dict())
+        sip_dict = {camel_to_snake(k): v for k, v in sip_dict.items()}
+        sip_dict = {
+            k: v for k, v in sip_dict.items() if k in SIPGrants.__dataclass_fields__
+        }
+        sip = SIPGrants(**sip_dict)
+
         return Claims(
             identity=claims.get("sub", ""),
             name=claims.get("name", ""),
             video=video,
+            sip=sip,
             metadata=claims.get("metadata", ""),
             sha256=claims.get("sha256", ""),
         )

{livekit-api-0.4.4 → livekit_api-0.5.1}/livekit/api/livekit_api.py

@@ -3,6 +3,7 @@ import os
 from .room_service import RoomService
 from .egress_service import EgressService
 from .ingress_service import IngressService
+from .sip_service import SipService
 from typing import Optional
 
 
@@ -29,6 +30,7 @@ class LiveKitAPI:
         self._room = RoomService(self._session, url, api_key, api_secret)
         self._ingress = IngressService(self._session, url, api_key, api_secret)
         self._egress = EgressService(self._session, url, api_key, api_secret)
+        self._sip = SipService(self._session, url, api_key, api_secret)
 
     @property
     def room(self):
@@ -42,5 +44,9 @@ class LiveKitAPI:
     def egress(self):
         return self._egress
 
+    @property
+    def sip(self):
+        return self._sip
+
     async def aclose(self):
         await self._session.close()

livekit_api-0.5.1/livekit/api/sip_service.py

@@ -0,0 +1,134 @@
+import aiohttp
+from livekit.protocol import sip as proto_sip
+from ._service import Service
+from .access_token import VideoGrants, SIPGrants
+
+SVC = "SIP"
+
+
+class SipService(Service):
+    def __init__(
+        self, session: aiohttp.ClientSession, url: str, api_key: str, api_secret: str
+    ):
+        super().__init__(session, url, api_key, api_secret)
+
+    async def create_sip_trunk(
+        self, create: proto_sip.CreateSIPTrunkRequest
+    ) -> proto_sip.SIPTrunkInfo:
+        return await self._client.request(
+            SVC,
+            "CreateSIPTrunk",
+            create,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.SIPTrunkInfo,
+        )
+
+    async def create_sip_inbound_trunk(
+        self, create: proto_sip.CreateSIPInboundTrunkRequest
+    ) -> proto_sip.SIPInboundTrunkInfo:
+        return await self._client.request(
+            SVC,
+            "CreateSIPInboundTrunk",
+            create,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.SIPInboundTrunkInfo,
+        )
+
+    async def create_sip_outbound_trunk(
+        self, create: proto_sip.CreateSIPOutboundTrunkRequest
+    ) -> proto_sip.SIPOutboundTrunkInfo:
+        return await self._client.request(
+            SVC,
+            "CreateSIPOutboundTrunk",
+            create,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.SIPOutboundTrunkInfo,
+        )
+
+    async def list_sip_trunk(
+        self, list: proto_sip.ListSIPTrunkRequest
+    ) -> proto_sip.ListSIPTrunkResponse:
+        return await self._client.request(
+            SVC,
+            "ListSIPTrunk",
+            list,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.ListSIPTrunkResponse,
+        )
+
+    async def list_sip_inbound_trunk(
+        self, list: proto_sip.ListSIPInboundTrunkRequest
+    ) -> proto_sip.ListSIPInboundTrunkResponse:
+        return await self._client.request(
+            SVC,
+            "ListSIPInboundTrunk",
+            list,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.ListSIPInboundTrunkResponse,
+        )
+
+    async def list_sip_outbound_trunk(
+        self, list: proto_sip.ListSIPOutboundTrunkRequest
+    ) -> proto_sip.ListSIPOutboundTrunkResponse:
+        return await self._client.request(
+            SVC,
+            "ListSIPOutboundTrunk",
+            list,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.ListSIPOutboundTrunkResponse,
+        )
+
+    async def delete_sip_trunk(
+        self, delete: proto_sip.DeleteSIPTrunkRequest
+    ) -> proto_sip.SIPTrunkInfo:
+        return await self._client.request(
+            SVC,
+            "DeleteSIPTrunk",
+            delete,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.SIPTrunkInfo,
+        )
+
+    async def create_sip_dispatch_rule(
+        self, create: proto_sip.CreateSIPDispatchRuleRequest
+    ) -> proto_sip.SIPDispatchRuleInfo:
+        return await self._client.request(
+            SVC,
+            "CreateSIPDispatchRule",
+            create,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.SIPDispatchRuleInfo,
+        )
+
+    async def list_sip_dispatch_rule(
+        self, list: proto_sip.ListSIPDispatchRuleRequest
+    ) -> proto_sip.ListSIPDispatchRuleResponse:
+        return await self._client.request(
+            SVC,
+            "ListSIPDispatchRule",
+            list,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.ListSIPDispatchRuleResponse,
+        )
+
+    async def delete_sip_dispatch_rule(
+        self, delete: proto_sip.DeleteSIPDispatchRuleRequest
+    ) -> proto_sip.SIPDispatchRuleInfo:
+        return await self._client.request(
+            SVC,
+            "DeleteSIPDispatchRule",
+            delete,
+            self._auth_header(VideoGrants(), sip=SIPGrants(admin=True)),
+            proto_sip.SIPDispatchRuleInfo,
+        )
+
+    async def create_sip_participant(
+        self, create: proto_sip.CreateSIPParticipantRequest
+    ) -> proto_sip.SIPParticipantInfo:
+        return await self._client.request(
+            SVC,
+            "CreateSIPParticipant",
+            create,
+            self._auth_header(VideoGrants(), sip=SIPGrants(call=True)),
+            proto_sip.SIPParticipantInfo,
+        )

livekit_api-0.5.1/livekit/api/version.py

@@ -0,0 +1 @@
+__version__ = "0.5.1"

{livekit-api-0.4.4 → livekit_api-0.5.1}/livekit_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: livekit-api
-Version: 0.4.4
+Version: 0.5.1
 Summary: Python Server API for LiveKit
 Home-page: https://github.com/livekit/python-sdks
 License: Apache-2.0
@@ -19,13 +19,13 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.8.0
+Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 Requires-Dist: pyjwt>=2.0.0
 Requires-Dist: aiohttp>=3.9.0
 Requires-Dist: protobuf>=3
 Requires-Dist: types-protobuf<5,>=4
-Requires-Dist: livekit-protocol<1,>=0.3.0
+Requires-Dist: livekit-protocol<2,>=0.5.1
 
 # LiveKit Server APIs
 

{livekit-api-0.4.4 → livekit_api-0.5.1}/livekit_api.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ livekit/api/ingress_service.py
 livekit/api/livekit_api.py
 livekit/api/py.typed
 livekit/api/room_service.py
+livekit/api/sip_service.py
 livekit/api/twirp_client.py
 livekit/api/version.py
 livekit/api/webhook.py

{livekit-api-0.4.4 → livekit_api-0.5.1}/livekit_api.egg-info/requires.txt

@@ -2,4 +2,4 @@ pyjwt>=2.0.0
 aiohttp>=3.9.0
 protobuf>=3
 types-protobuf<5,>=4
-livekit-protocol<1,>=0.3.0
+livekit-protocol<2,>=0.5.1

{livekit-api-0.4.4 → livekit_api-0.5.1}/setup.py

@@ -47,13 +47,13 @@ setuptools.setup(
     keywords=["webrtc", "realtime", "audio", "video", "livekit"],
     license="Apache-2.0",
     packages=setuptools.find_namespace_packages(include=["livekit.*"]),
-    python_requires=">=3.8.0",
+    python_requires=">=3.9.0",
     install_requires=[
         "pyjwt>=2.0.0",
         "aiohttp>=3.9.0",
         "protobuf>=3",
         "types-protobuf>=4,<5",
-        "livekit-protocol>=0.3.0,<1",
+        "livekit-protocol>=0.5.1,<2",
     ],
     package_data={
         "livekit.api": ["py.typed", "*.pyi", "**/*.pyi"],

{livekit-api-0.4.4 → livekit_api-0.5.1}/tests/test_access_token.py

@@ -1,7 +1,7 @@
 import datetime
 
 import pytest  # type: ignore
-from livekit.api import AccessToken, TokenVerifier, VideoGrants
+from livekit.api import AccessToken, TokenVerifier, VideoGrants, SIPGrants
 
 TEST_API_KEY = "myapikey"
 TEST_API_SECRET = "thiskeyistotallyunsafe"
@@ -9,12 +9,14 @@ TEST_API_SECRET = "thiskeyistotallyunsafe"
 
 def test_verify_token():
     grants = VideoGrants(room_join=True, room="test_room")
+    sip = SIPGrants(admin=True)
 
     token = (
         AccessToken(TEST_API_KEY, TEST_API_SECRET)
         .with_identity("test_identity")
         .with_metadata("test_metadata")
         .with_grants(grants)
+        .with_sip_grants(sip)
         .to_jwt()
     )
 
@@ -24,6 +26,7 @@ def test_verify_token():
     assert claims.identity == "test_identity"
     assert claims.metadata == "test_metadata"
     assert claims.video == grants
+    assert claims.sip == sip
 
 
 def test_verify_token_invalid():

livekit-api-0.4.4/livekit/api/version.py

@@ -1 +0,0 @@
-__version__ = "0.4.4"