jaxl-python 0.0.38__tar.gz → 0.0.40__tar.gz

{jaxl_python-0.0.38 → jaxl_python-0.0.40}/.gitignore

@@ -34,4 +34,6 @@ schema.yaml
 jaxl-api-credentials*.json
 docs
 jaxlapi.sh
-*.py.orig
+*.py.orig
+CLAUDE.md
+CURRENT.md

{jaxl_python-0.0.38 → jaxl_python-0.0.40}/.pylintrc

@@ -56,7 +56,7 @@ py-version=3.9
 
 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
+; suggestion-mode=yes
 
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.

{jaxl_python-0.0.38 → jaxl_python-0.0.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jaxl-python
-Version: 0.0.38
+Version: 0.0.40
 Summary: Official Python SDK and CLI for interfacing with the Jaxl API. Manage calls, messages, IVRs, devices, teams, payments, campaigns, streaming transcriptions and AI Agents. Built on OpenAPI, it offers both generated API clients and Pythonic wrappers for ease of use.
 Home-page: https://github.com/jaxl-innovations-private-limited/jaxl-python
 Download-URL: https://github.com/jaxl-innovations-private-limited/jaxl-python/archive/main.zip

{jaxl_python-0.0.38 → jaxl_python-0.0.40}/examples/__init__.py

@@ -16,6 +16,7 @@ from .streaming_aiagent import JaxlAppStreamingAIAgent
 from .streaming_audio_chunks import JaxlAppStreamingAudioChunk
 from .streaming_speech_segments import JaxlAppStreamingSpeechSegment
 from .streaming_transcriptions import JaxlAppStreamingTranscription
+from .streaming_wav_file import JaxlAppStreamingWavFile
 
 
 __all__ = [
@@ -26,4 +27,5 @@ __all__ = [
     "JaxlAppStreamingSpeechSegment",
     "JaxlAppStreamingTranscription",
     "JaxlAppStreamingAIAgent",
+    "JaxlAppStreamingWavFile",
 ]

jaxl_python-0.0.40/examples/streaming_wav_file.py

@@ -0,0 +1,95 @@
+"""
+Copyright (c) 2010-present by Jaxl Innovations Private Limited.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms,
+with or without modification, is strictly prohibited.
+"""
+
+import asyncio
+# pylint: disable=deprecated-module
+import audioop
+import os
+import wave
+from pathlib import Path
+from typing import Dict
+
+from jaxl.api.base import (
+    HANDLER_RESPONSE,
+    BaseJaxlApp,
+    JaxlWebhookRequest,
+    JaxlWebhookResponse,
+)
+
+
+SAMPLE_RATE = 8000
+SAMPLE_WIDTH = 2
+CHANNELS = 1
+FRAME_MS = 20
+FRAME_BYTES = SAMPLE_RATE * SAMPLE_WIDTH * FRAME_MS // 1000
+SEND_INTERVAL_S = 0.010  # Send faster than real-time to avoid SIP jitter.
+
+
+def load_wav_as_slin16_8k_mono(path: str) -> bytes:
+    with wave.open(path, "rb") as wav:
+        audio = wav.readframes(wav.getnframes())
+        sample_width = wav.getsampwidth()
+        channels = wav.getnchannels()
+        sample_rate = wav.getframerate()
+
+    if channels != CHANNELS:
+        audio = audioop.tomono(audio, sample_width, 0.5, 0.5)
+        channels = CHANNELS
+    if sample_width != SAMPLE_WIDTH:
+        audio = audioop.lin2lin(audio, sample_width, SAMPLE_WIDTH)
+        sample_width = SAMPLE_WIDTH
+    if sample_rate != SAMPLE_RATE:
+        audio, _ = audioop.ratecv(
+            audio,
+            sample_width,
+            channels,
+            sample_rate,
+            SAMPLE_RATE,
+            None,
+        )
+    return audio
+
+
+class JaxlAppStreamingWavFile(BaseJaxlApp):
+    """Minimal incoming-call app that streams one WAV file over the live stream."""
+
+    def __init__(self) -> None:
+        self._playback_tasks: Dict[int, asyncio.Task[None]] = {}
+        self._wav_path = os.environ.get("JAXL_STREAMING_WAV_PATH", "example.wav")
+        self._audio = load_wav_as_slin16_8k_mono(self._wav_path)
+
+    async def handle_setup(self, req: JaxlWebhookRequest) -> HANDLER_RESPONSE:
+        return JaxlWebhookResponse(prompt=[], num_characters=-1)
+
+    async def handle_teardown(self, req: JaxlWebhookRequest) -> HANDLER_RESPONSE:
+        assert req.state is not None
+        self._cancel_playback(req.state.call_id)
+        return None
+
+    async def on_stream_connect(self, call_id: int) -> None:
+        self._cancel_playback(call_id)
+        self._playback_tasks[call_id] = asyncio.create_task(self._stream_wav(call_id))
+
+    async def on_stream_disconnect(self, call_id: int) -> None:
+        self._cancel_playback(call_id)
+
+    def _cancel_playback(self, call_id: int) -> None:
+        task = self._playback_tasks.pop(call_id, None)
+        if task is not None:
+            task.cancel()
+
+    async def _stream_wav(self, call_id: int) -> None:
+        print(f"Streaming {Path(self._wav_path)} to call {call_id}")
+        for offset in range(0, len(self._audio), FRAME_BYTES):
+            chunk = self._audio[offset : offset + FRAME_BYTES]
+            if len(chunk) < FRAME_BYTES:
+                chunk += b"\x00" * (FRAME_BYTES - len(chunk))
+            if not await self.send_audio(call_id, chunk):
+                break
+            await asyncio.sleep(SEND_INTERVAL_S)

{jaxl_python-0.0.38 → jaxl_python-0.0.40}/jaxl/api/base.py

@@ -308,7 +308,12 @@ class BaseJaxlApp:
         return None
 
     async def add_tag(
-        self, call_id: int, tag: str
+        self, call_id: int, tag: str, rationale: Optional[str] = None
     ) -> Optional[Response[CallTagResponse]]:
-        """Add tag to a call by ID."""
+        """Add tag to a call by ID.
+
+        `rationale` (optional) carries the caller's explanation for
+        the tag (e.g. an AI agent's reasoning) and is persisted
+        alongside the tag by the backend.
+        """
         return None

{jaxl_python-0.0.38 → jaxl_python-0.0.40}/jaxl/api/client/_scm_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.38'
-__version_tuple__ = version_tuple = (0, 0, 38)
+__version__ = version = '0.0.40'
+__version_tuple__ = version_tuple = (0, 0, 40)

{jaxl_python-0.0.38 → jaxl_python-0.0.40}/jaxl/api/client/api/v1/v1_calls_list.py

@@ -7,6 +7,7 @@ Redistribution and use in source and binary forms,
 with or without modification, is strictly prohibited.
 """
 
+import datetime
 from http import HTTPStatus
 from typing import Any, Dict, List, Optional, Union
 
@@ -24,9 +25,12 @@ def _get_kwargs(
     client: AuthenticatedClient,
     aid: Union[Unset, None, List[int]] = UNSET,
     bot: Union[Unset, None, bool] = UNSET,
+    campaign: Union[Unset, None, bool] = UNSET,
+    campaign_id: Union[Unset, None, int] = UNSET,
     currency: int,
     direction: Union[Unset, None, V1CallsListDirection] = UNSET,
     duration: Union[Unset, None, int] = UNSET,
+    end_time: Union[Unset, None, datetime.datetime] = UNSET,
     from_number: Union[Unset, None, str] = UNSET,
     ivr: Union[Unset, None, bool] = UNSET,
     limit: Union[Unset, None, int] = UNSET,
@@ -35,6 +39,8 @@ def _get_kwargs(
     other_numbers: Union[Unset, None, str] = UNSET,
     our_numbers: Union[Unset, None, str] = UNSET,
     recording: Union[Unset, None, bool] = UNSET,
+    start_time: Union[Unset, None, datetime.datetime] = UNSET,
+    tag: Union[Unset, None, str] = UNSET,
     tag_operator: Union[Unset, None, bool] = UNSET,
     tid: Union[Unset, None, List[int]] = UNSET,
     to_number: Union[Unset, None, str] = UNSET,
@@ -57,6 +63,10 @@ def _get_kwargs(
 
     params["bot"] = bot
 
+    params["campaign"] = campaign
+
+    params["campaign_id"] = campaign_id
+
     params["currency"] = currency
 
     json_direction: Union[Unset, None, int] = UNSET
@@ -67,6 +77,12 @@ def _get_kwargs(
 
     params["duration"] = duration
 
+    json_end_time: Union[Unset, None, str] = UNSET
+    if not isinstance(end_time, Unset):
+        json_end_time = end_time.isoformat() if end_time else None
+
+    params["end_time"] = json_end_time
+
     params["from_number"] = from_number
 
     params["ivr"] = ivr
@@ -83,6 +99,14 @@ def _get_kwargs(
 
     params["recording"] = recording
 
+    json_start_time: Union[Unset, None, str] = UNSET
+    if not isinstance(start_time, Unset):
+        json_start_time = start_time.isoformat() if start_time else None
+
+    params["start_time"] = json_start_time
+
+    params["tag"] = tag
+
     params["tag_operator"] = tag_operator
 
     json_tid: Union[Unset, None, List[int]] = UNSET
@@ -139,9 +163,12 @@ def sync_detailed(
     client: AuthenticatedClient,
     aid: Union[Unset, None, List[int]] = UNSET,
     bot: Union[Unset, None, bool] = UNSET,
+    campaign: Union[Unset, None, bool] = UNSET,
+    campaign_id: Union[Unset, None, int] = UNSET,
     currency: int,
     direction: Union[Unset, None, V1CallsListDirection] = UNSET,
     duration: Union[Unset, None, int] = UNSET,
+    end_time: Union[Unset, None, datetime.datetime] = UNSET,
     from_number: Union[Unset, None, str] = UNSET,
     ivr: Union[Unset, None, bool] = UNSET,
     limit: Union[Unset, None, int] = UNSET,
@@ -150,6 +177,8 @@ def sync_detailed(
     other_numbers: Union[Unset, None, str] = UNSET,
     our_numbers: Union[Unset, None, str] = UNSET,
     recording: Union[Unset, None, bool] = UNSET,
+    start_time: Union[Unset, None, datetime.datetime] = UNSET,
+    tag: Union[Unset, None, str] = UNSET,
     tag_operator: Union[Unset, None, bool] = UNSET,
     tid: Union[Unset, None, List[int]] = UNSET,
     to_number: Union[Unset, None, str] = UNSET,
@@ -160,9 +189,12 @@ def sync_detailed(
     Args:
         aid (Union[Unset, None, List[int]]):
         bot (Union[Unset, None, bool]):
+        campaign (Union[Unset, None, bool]):
+        campaign_id (Union[Unset, None, int]):
         currency (int):
         direction (Union[Unset, None, V1CallsListDirection]):
         duration (Union[Unset, None, int]):
+        end_time (Union[Unset, None, datetime.datetime]):
         from_number (Union[Unset, None, str]):
         ivr (Union[Unset, None, bool]):
         limit (Union[Unset, None, int]):
@@ -171,6 +203,8 @@ def sync_detailed(
         other_numbers (Union[Unset, None, str]):
         our_numbers (Union[Unset, None, str]):
         recording (Union[Unset, None, bool]):
+        start_time (Union[Unset, None, datetime.datetime]):
+        tag (Union[Unset, None, str]):
         tag_operator (Union[Unset, None, bool]):
         tid (Union[Unset, None, List[int]]):
         to_number (Union[Unset, None, str]):
@@ -188,9 +222,12 @@ def sync_detailed(
         client=client,
         aid=aid,
         bot=bot,
+        campaign=campaign,
+        campaign_id=campaign_id,
         currency=currency,
         direction=direction,
         duration=duration,
+        end_time=end_time,
         from_number=from_number,
         ivr=ivr,
         limit=limit,
@@ -199,6 +236,8 @@ def sync_detailed(
         other_numbers=other_numbers,
         our_numbers=our_numbers,
         recording=recording,
+        start_time=start_time,
+        tag=tag,
         tag_operator=tag_operator,
         tid=tid,
         to_number=to_number,
@@ -218,9 +257,12 @@ def sync(
     client: AuthenticatedClient,
     aid: Union[Unset, None, List[int]] = UNSET,
     bot: Union[Unset, None, bool] = UNSET,
+    campaign: Union[Unset, None, bool] = UNSET,
+    campaign_id: Union[Unset, None, int] = UNSET,
     currency: int,
     direction: Union[Unset, None, V1CallsListDirection] = UNSET,
     duration: Union[Unset, None, int] = UNSET,
+    end_time: Union[Unset, None, datetime.datetime] = UNSET,
     from_number: Union[Unset, None, str] = UNSET,
     ivr: Union[Unset, None, bool] = UNSET,
     limit: Union[Unset, None, int] = UNSET,
@@ -229,6 +271,8 @@ def sync(
     other_numbers: Union[Unset, None, str] = UNSET,
     our_numbers: Union[Unset, None, str] = UNSET,
     recording: Union[Unset, None, bool] = UNSET,
+    start_time: Union[Unset, None, datetime.datetime] = UNSET,
+    tag: Union[Unset, None, str] = UNSET,
     tag_operator: Union[Unset, None, bool] = UNSET,
     tid: Union[Unset, None, List[int]] = UNSET,
     to_number: Union[Unset, None, str] = UNSET,
@@ -239,9 +283,12 @@ def sync(
     Args:
         aid (Union[Unset, None, List[int]]):
         bot (Union[Unset, None, bool]):
+        campaign (Union[Unset, None, bool]):
+        campaign_id (Union[Unset, None, int]):
         currency (int):
         direction (Union[Unset, None, V1CallsListDirection]):
         duration (Union[Unset, None, int]):
+        end_time (Union[Unset, None, datetime.datetime]):
         from_number (Union[Unset, None, str]):
         ivr (Union[Unset, None, bool]):
         limit (Union[Unset, None, int]):
@@ -250,6 +297,8 @@ def sync(
         other_numbers (Union[Unset, None, str]):
         our_numbers (Union[Unset, None, str]):
         recording (Union[Unset, None, bool]):
+        start_time (Union[Unset, None, datetime.datetime]):
+        tag (Union[Unset, None, str]):
         tag_operator (Union[Unset, None, bool]):
         tid (Union[Unset, None, List[int]]):
         to_number (Union[Unset, None, str]):
@@ -267,9 +316,12 @@ def sync(
         client=client,
         aid=aid,
         bot=bot,
+        campaign=campaign,
+        campaign_id=campaign_id,
         currency=currency,
         direction=direction,
         duration=duration,
+        end_time=end_time,
         from_number=from_number,
         ivr=ivr,
         limit=limit,
@@ -278,6 +330,8 @@ def sync(
         other_numbers=other_numbers,
         our_numbers=our_numbers,
         recording=recording,
+        start_time=start_time,
+        tag=tag,
         tag_operator=tag_operator,
         tid=tid,
         to_number=to_number,
@@ -290,9 +344,12 @@ async def asyncio_detailed(
     client: AuthenticatedClient,
     aid: Union[Unset, None, List[int]] = UNSET,
     bot: Union[Unset, None, bool] = UNSET,
+    campaign: Union[Unset, None, bool] = UNSET,
+    campaign_id: Union[Unset, None, int] = UNSET,
     currency: int,
     direction: Union[Unset, None, V1CallsListDirection] = UNSET,
     duration: Union[Unset, None, int] = UNSET,
+    end_time: Union[Unset, None, datetime.datetime] = UNSET,
     from_number: Union[Unset, None, str] = UNSET,
     ivr: Union[Unset, None, bool] = UNSET,
     limit: Union[Unset, None, int] = UNSET,
@@ -301,6 +358,8 @@ async def asyncio_detailed(
     other_numbers: Union[Unset, None, str] = UNSET,
     our_numbers: Union[Unset, None, str] = UNSET,
     recording: Union[Unset, None, bool] = UNSET,
+    start_time: Union[Unset, None, datetime.datetime] = UNSET,
+    tag: Union[Unset, None, str] = UNSET,
     tag_operator: Union[Unset, None, bool] = UNSET,
     tid: Union[Unset, None, List[int]] = UNSET,
     to_number: Union[Unset, None, str] = UNSET,
@@ -311,9 +370,12 @@ async def asyncio_detailed(
     Args:
         aid (Union[Unset, None, List[int]]):
         bot (Union[Unset, None, bool]):
+        campaign (Union[Unset, None, bool]):
+        campaign_id (Union[Unset, None, int]):
         currency (int):
         direction (Union[Unset, None, V1CallsListDirection]):
         duration (Union[Unset, None, int]):
+        end_time (Union[Unset, None, datetime.datetime]):
         from_number (Union[Unset, None, str]):
         ivr (Union[Unset, None, bool]):
         limit (Union[Unset, None, int]):
@@ -322,6 +384,8 @@ async def asyncio_detailed(
         other_numbers (Union[Unset, None, str]):
         our_numbers (Union[Unset, None, str]):
         recording (Union[Unset, None, bool]):
+        start_time (Union[Unset, None, datetime.datetime]):
+        tag (Union[Unset, None, str]):
         tag_operator (Union[Unset, None, bool]):
         tid (Union[Unset, None, List[int]]):
         to_number (Union[Unset, None, str]):
@@ -339,9 +403,12 @@ async def asyncio_detailed(
         client=client,
         aid=aid,
         bot=bot,
+        campaign=campaign,
+        campaign_id=campaign_id,
         currency=currency,
         direction=direction,
         duration=duration,
+        end_time=end_time,
         from_number=from_number,
         ivr=ivr,
         limit=limit,
@@ -350,6 +417,8 @@ async def asyncio_detailed(
         other_numbers=other_numbers,
         our_numbers=our_numbers,
         recording=recording,
+        start_time=start_time,
+        tag=tag,
         tag_operator=tag_operator,
         tid=tid,
         to_number=to_number,
@@ -367,9 +436,12 @@ async def asyncio(
     client: AuthenticatedClient,
     aid: Union[Unset, None, List[int]] = UNSET,
     bot: Union[Unset, None, bool] = UNSET,
+    campaign: Union[Unset, None, bool] = UNSET,
+    campaign_id: Union[Unset, None, int] = UNSET,
     currency: int,
     direction: Union[Unset, None, V1CallsListDirection] = UNSET,
     duration: Union[Unset, None, int] = UNSET,
+    end_time: Union[Unset, None, datetime.datetime] = UNSET,
     from_number: Union[Unset, None, str] = UNSET,
     ivr: Union[Unset, None, bool] = UNSET,
     limit: Union[Unset, None, int] = UNSET,
@@ -378,6 +450,8 @@ async def asyncio(
     other_numbers: Union[Unset, None, str] = UNSET,
     our_numbers: Union[Unset, None, str] = UNSET,
     recording: Union[Unset, None, bool] = UNSET,
+    start_time: Union[Unset, None, datetime.datetime] = UNSET,
+    tag: Union[Unset, None, str] = UNSET,
     tag_operator: Union[Unset, None, bool] = UNSET,
     tid: Union[Unset, None, List[int]] = UNSET,
     to_number: Union[Unset, None, str] = UNSET,
@@ -388,9 +462,12 @@ async def asyncio(
     Args:
         aid (Union[Unset, None, List[int]]):
         bot (Union[Unset, None, bool]):
+        campaign (Union[Unset, None, bool]):
+        campaign_id (Union[Unset, None, int]):
         currency (int):
         direction (Union[Unset, None, V1CallsListDirection]):
         duration (Union[Unset, None, int]):
+        end_time (Union[Unset, None, datetime.datetime]):
         from_number (Union[Unset, None, str]):
         ivr (Union[Unset, None, bool]):
         limit (Union[Unset, None, int]):
@@ -399,6 +476,8 @@ async def asyncio(
         other_numbers (Union[Unset, None, str]):
         our_numbers (Union[Unset, None, str]):
         recording (Union[Unset, None, bool]):
+        start_time (Union[Unset, None, datetime.datetime]):
+        tag (Union[Unset, None, str]):
         tag_operator (Union[Unset, None, bool]):
         tid (Union[Unset, None, List[int]]):
         to_number (Union[Unset, None, str]):
@@ -417,9 +496,12 @@ async def asyncio(
             client=client,
             aid=aid,
             bot=bot,
+            campaign=campaign,
+            campaign_id=campaign_id,
             currency=currency,
             direction=direction,
             duration=duration,
+            end_time=end_time,
             from_number=from_number,
             ivr=ivr,
             limit=limit,
@@ -428,6 +510,8 @@ async def asyncio(
             other_numbers=other_numbers,
             our_numbers=our_numbers,
             recording=recording,
+            start_time=start_time,
+            tag=tag,
             tag_operator=tag_operator,
             tid=tid,
             to_number=to_number,