jaxl-python 0.0.11__tar.gz → 0.0.13__tar.gz

{jaxl_python-0.0.11 → jaxl_python-0.0.13}/.github/workflows/sdk.yml

@@ -29,7 +29,7 @@ jobs:
           python -m venv .venv
           source .venv/bin/activate
           python -m pip install --upgrade pip
-          pip install -e .[dev,app,grout,silence,transcribe]
+          pip install -e .[dev,docs,types,app,grout,silence,transcribe,release]
       - name: Run mypy
         run: |
           source .venv/bin/activate

{jaxl_python-0.0.11 → jaxl_python-0.0.13}/.gitignore

@@ -28,6 +28,8 @@ _scm_version.py
 license.py
 schema.py
 schema.yaml
+*.patch
+/site
 
 jaxl-api-credentials*.json
 docs

{jaxl_python-0.0.11 → jaxl_python-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jaxl-python
-Version: 0.0.11
+Version: 0.0.13
 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
@@ -48,22 +48,23 @@ License-File: LICENSE.md
 Requires-Dist: httpx<0.24.0,>=0.15.0
 Requires-Dist: attrs>=21.3.0
 Requires-Dist: python-dateutil<3,>=2.8.0
-Requires-Dist: cryptography==39.0.1
+Requires-Dist: cryptography==46.0.2
 Requires-Dist: PyJWT==2.8.0
 Requires-Dist: requests==2.32.4
 Requires-Dist: pydantic==2.11.9
 Provides-Extra: dev
-Requires-Dist: types-python-dateutil; extra == "dev"
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: autoflake; extra == "dev"
 Requires-Dist: pylint==3.3.3; extra == "dev"
-Requires-Dist: types-requests==2.32.0.20240602; extra == "dev"
-Requires-Dist: pdoc3==0.11.6; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: types-PyYAML==6.0.12.20250915; extra == "dev"
-Requires-Dist: types-Pygments==2.19.0.20250809; extra == "dev"
-Requires-Dist: types-ujson==5.10.0.20250822; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: pdoc3==0.11.6; extra == "docs"
+Provides-Extra: types
+Requires-Dist: types-python-dateutil; extra == "types"
+Requires-Dist: types-PyYAML==6.0.12.20250915; extra == "types"
+Requires-Dist: types-Pygments==2.19.0.20250809; extra == "types"
+Requires-Dist: types-ujson==5.10.0.20250822; extra == "types"
+Requires-Dist: types-requests==2.32.0.20240602; extra == "types"
 Provides-Extra: app
 Requires-Dist: uvicorn[standard]==0.35.0; extra == "app"
 Requires-Dist: fastapi==0.116.1; extra == "app"
@@ -72,9 +73,14 @@ Requires-Dist: proxy.py==2.4.10; extra == "grout"
 Provides-Extra: silence
 Requires-Dist: webrtcvad==2.0.10; extra == "silence"
 Requires-Dist: setuptools==80.9.0; extra == "silence"
-Requires-Dist: numpy==1.26.4; extra == "silence"
 Provides-Extra: transcribe
 Requires-Dist: openai-whisper==20240930; extra == "transcribe"
+Requires-Dist: numpy==1.26.4; extra == "transcribe"
+Provides-Extra: openai
+Requires-Dist: openai==2.1.0; extra == "openai"
+Provides-Extra: release
+Requires-Dist: build; extra == "release"
+Requires-Dist: twine; extra == "release"
 Dynamic: download-url
 Dynamic: license-file
 
@@ -95,10 +101,9 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
    - [Assign a Phone Number to IVR by ID](#assign-a-phone-number-to-ivr-by-id)
    - [Place Outgoing Cellular Call with Existing IVR](#place-outgoing-cellular-call-with-existing-ivr)
    - [Place Outgoing Cellular Call with Ad-hoc IVR](#place-outgoing-cellular-call-with-ad-hoc-ivr)
-   - [Dial-out Multi-Party Conference between Cellular Numbers](#dial-out-multi-party-conference-between-cellular-numbers)
-   - [Dial-out Agent Team and Cellular Numbers](#dial-out-agent-team-and-cellular-numbers)
    - [Dial-out 2-Party Conference with Ad-hoc IVR](#dial-out-2-party-conference-with-ad-hoc-ivr)
    - [Add External Phone Number to an Active Call](#add-external-phone-number-to-an-active-call)
+   - [Add External Phone Number via Another Phone Number to an Active Call](#add-external-phone-number-via-another-phone-number-to-an-active-call)
    - [Add Agent to an Active Call](#add-agent-to-an-active-call)
    - [Remove External Phone Number from an Active Call](#remove-external-phone-number-from-an-active-call)
    - [Remove Agent from an Active Call](#remove-agent-from-an-active-call)
@@ -194,13 +199,13 @@ This IVR will speak the message and then hangup the call.
 
 ```bash
 jaxl ivrs create \
-  --message "Hello, we are calling via Jaxl IVR demo created from CLI" \
+  --message "Hello, we are calling via Jaxl IVR demo created from CLI.  Will hang up after speaking this message." \
   --hangup
 ```
 
 ### Configure IVR Options
 
-This IVR option uses `--next` to send user to another IVR.
+This IVR option uses `--next` to send user to another IVR or to the same IVR for a "repeat this menu" experience.
 
 ```bash
 jaxl ivrs options configure \
@@ -210,7 +215,7 @@ jaxl ivrs options configure \
   --next <NEXT IVR ID>
 ```
 
-> Use &lt;IVR ID TO CONFIGURE&gt; as the &lt;NEXT IVR ID&gt; to complete the "repeat this menu" experience.
+> Use same value for &lt;IVR ID TO CONFIGURE&gt; and &lt;NEXT IVR ID&gt; to complete the "repeat this menu" experience.
 
 One of the CTA key flag must be provided. Allowed CTA keys are:
 
@@ -235,7 +240,7 @@ jaxl phones list
 You can also search for a specific purchased number:
 
 ```bash
-jaxl phones list --e164 "+91<Purchased Jaxl Number>"
+jaxl phones list --e164 "+CC<Purchased Jaxl Number>"
 ```
 
 ### Assign a Phone Number to IVR by ID
@@ -244,7 +249,7 @@ All incoming calls to this number will send user to the assigned IVR.
 
 ```bash
 jaxl phones ivrs \
-  --e164 "+91<Purchased Jaxl Number>" \
+  --e164 "+CC<Purchased Jaxl Number>" \
   --ivr <IVR ID>
 ```
 
@@ -258,8 +263,8 @@ Below command will execute the following flow:
 
 ```bash
 jaxl calls create \
-  --to "+91<Callee Number>" \
-  --from "+91<Purchased Jaxl Number>" \
+  --to "+CC<Callee Number>" \
+  --from "+CC<Purchased Jaxl Number>" \
   --ivr <IVR ID>
 ```
 
@@ -274,46 +279,13 @@ Below command will execute the following flow:
 
 ```bash
 jaxl calls create \
-  --to "+91<Callee Number>" \
-  --from "+91<Purchased Jaxl Number>" \
+  --to "+CC<Callee Number>" \
+  --from "+CC<Purchased Jaxl Number>" \
   --message "Hello, we are calling you from MyCompany" \
   --option "1=Press 1 for sales:team=<Sales Team ID>" \
   --option "2=Press 2 for HR department:team=<HR Team ID>
 ```
 
-## Dial-out Multi-Party Conference between Cellular Numbers
-
-Below command will execute the following flow:
-
-- Dials out all `--to` participants in parallel
-- Connects them together as they answer the call
-- Ends the call when one but all others have hanged up the call
-
-```bash
-jaxl calls create \
-  --to "+91<Doctors Number>" \
-  --to "+91<Patient Number>" \
-  --to "+91<Supervisor Number>" \
-  --from "+91<Purchased Jaxl Number>"
-```
-
-### Dial-out Agent Team and Cellular Numbers
-
-Below command will execute the following flow:
-
-- Dials out multiple teams of doctors & patient in parallel
-- Connects the patient with first doctor to pick the call from the teams
-- Doctors are called on their cellular number first (if added on Jaxl app),
-  followed by an attempt to call on Jaxl app directly (VoIP).
-- Calling preference can be controlled per agent (doctor) or team to dictate
-  whether to use cellular or voip first to connect with a doctor.
-
-```bash
-jaxl calls create \
-  --to "teams=<Doctors Team ID1>,<Doctors Team ID2>" \
-  --to "+91<Patient Number>"
-```
-
 ### Dial-out 2-Party Conference with Ad-hoc IVR
 
 Below command will execute the following flow:
@@ -325,34 +297,40 @@ Below command will execute the following flow:
 
 ```bash
 jaxl calls create \
-  --to "+91<Doctors Number>" \
-  --from "+91<Purchased Jaxl Number>" \
+  --to "+CC<Doctors Number>" \
+  --from "+CC<Purchased Jaxl Number>" \
   --message "Hello Doctor, this is a call from MyCompany regarding your appointment with Mr. Patient Name. When ready please, " \
-  --option "1=Press 1 to connect with the patient:phone=+91<Patient Number>"
+  --option "1=Press 1 to connect with the patient:phone=+CC<Patient Number>"
 ```
 
 ### Add External Phone Number to an Active Call
 
 ```bash
-jaxl calls add --call-id 1234 --phone +91<Mobile Number>
+jaxl calls add --call-id 1234 --e164 +CC<Mobile Number>
+```
+
+### Add External Phone Number via Another Phone Number to an Active Call
+
+```bash
+jaxl calls add --call-id 1234 --e164 +CC<Mobile Number> --from-e164 +CC<Purchased Jaxl Number>
 ```
 
 ### Add Agent to an Active Call
 
 ```bash
-jaxl calls add --call-id 1234 --agent <someone@mycompany.com>
+jaxl calls add --call-id 1234 --email <someone@mycompany.com>
 ```
 
 ### Remove External Phone Number from an Active Call
 
 ```bash
-jaxl calls remove --call-id 1234 --phone +91<Mobile Number>
+jaxl calls remove --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 ### Remove Agent from an Active Call
 
 ```bash
-jaxl calls remove --call-id 1234 --agent <someone@mycompany.com>
+jaxl calls remove --call-id 1234 --email <someone@mycompany.com>
 ```
 
 ### Send Text Prompts (TTS) in an Active Call
@@ -378,13 +356,13 @@ jaxl calls play --call-id 1234 --audio /path/to/a/file/on/local/disk/or/public/u
 Mute a specific cellular user in a call.
 
 ```bash
-jaxl calls mute --call-id 1234 --phone +91<Mobile Number>
+jaxl calls mute --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Mute an agent (Jaxl App User) in a call.
 
 ```bash
-jaxl calls mute --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls mute --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Unmute a Participant in an Active Call
@@ -392,13 +370,13 @@ jaxl calls mute --call-id 1235 --agent <someone@mycompany.com>
 Unmute a specific cellular user in a call.
 
 ```bash
-jaxl calls unmute --call-id 1234 --phone +91<Mobile Number>
+jaxl calls unmute --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Unmute a specific agent (Jaxl App User) in a call.
 
 ```bash
-jaxl calls unmute --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls unmute --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Hold a Participant in an Active Call
@@ -406,13 +384,13 @@ jaxl calls unmute --call-id 1235 --agent <someone@mycompany.com>
 Put a cellular user on-hold in a call
 
 ```bash
-jaxl calls hold --call-id 1234 --phone +91<Mobile Number>
+jaxl calls hold --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Put an agent on-hold in a call
 
 ```bash
-jaxl calls hold --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls hold --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Unhold a Participant in an Active Call
@@ -420,13 +398,13 @@ jaxl calls hold --call-id 1235 --agent <someone@mycompany.com>
 Unhold a cellular user in a call
 
 ```bash
-jaxl calls unhold --call-id 1234 --phone +91<Mobile Number>
+jaxl calls unhold --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Unhold an agent in a call
 
 ```bash
-jaxl calls unhold --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls unhold --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Receive Call Events via Webhook IVRs
@@ -479,25 +457,21 @@ jaxl payments consumables total
 ## Jaxl Python SDK
 
 - Jaxl APIs is built upon [OpenAPI specification](https://www.openapis.org/)
-- `jaxl-python` contains following Python modules:
-  - `jaxl.api.client`: Generated OpenAPI SDK
-  - `jaxl.api.resources`: Wrapper methods written to support `jaxl` CLI
-  - `jaxl_api_client`: Helper function to retrieve an instance of `JaxlApiClient`
 
 ### SDK Example Usage:
 
 ```python
-from jaxl.api import JaxlApiModule, jaxl_api_client
-from jaxl.api.client.api.v1 import v1_calls_list
+from jaxl.api import JaxlSDK
 
 os.environ.setdefault("JAXL_API_CREDENTIALS", "/path/to/jaxl-api-credentials.json")
 
 os.environ.setdefault("JAXL_API_AUTH_TOKEN", "....authentication token...")
 
-response = v1_calls_list.sync_detailed(
-    client=jaxl_api_client(JaxlApiModule.CALL),
-    currency=2, # 1=USD, 2=INR
-)
+sdk = JaxlSDK()
+
+response = sdk.calls.create(to="+CC<Callee Number>", from_="+CC<Purchased Jaxl Number>", ivr=1234)
+response = sdk.calls.list(currency=2) # 1=USD, 2=INR
+response = sdk.accounts.me()
 ```
 
 ## SDK Documentation
@@ -516,7 +490,7 @@ python3 -m venv .venv
 source .venv/bin/activate
 
 # Install
-pip install -e ".[dev]"
+pip install -e ".[dev,docs]"
 
 # Generate documentation
 ./docs.sh
@@ -527,6 +501,10 @@ open docs/jaxl/index.html
 
 ## Status
 
-[![Python 3.x](https://img.shields.io/static/v1?label=Python&message=3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12&color=blue&style=flat-square)](https://www.python.org/)
+[![pypi version](https://img.shields.io/pypi/v/jaxl-python)](https://pypi.org/project/jaxl-python/)
+
+[![PyPi Monthly](https://img.shields.io/pypi/dm/jaxl-python)](https://pypi.org/project/jaxl-python/)
+
+[![Python 3.x](https://img.shields.io/static/v1?label=Python&message=3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12&color=blue)](https://www.python.org/)
 
-[![Checked with mypy](https://img.shields.io/static/v1?label=MyPy&message=checked&color=blue&style=flat-square)](http://mypy-lang.org/)
+[![Checked with mypy](https://img.shields.io/static/v1?label=MyPy&message=checked&color=blue)](http://mypy-lang.org/)

{jaxl_python-0.0.11 → jaxl_python-0.0.13}/README.md

@@ -15,10 +15,9 @@ Use Jaxl from Python code or directly via the `jaxl` command-line tool.
    - [Assign a Phone Number to IVR by ID](#assign-a-phone-number-to-ivr-by-id)
    - [Place Outgoing Cellular Call with Existing IVR](#place-outgoing-cellular-call-with-existing-ivr)
    - [Place Outgoing Cellular Call with Ad-hoc IVR](#place-outgoing-cellular-call-with-ad-hoc-ivr)
-   - [Dial-out Multi-Party Conference between Cellular Numbers](#dial-out-multi-party-conference-between-cellular-numbers)
-   - [Dial-out Agent Team and Cellular Numbers](#dial-out-agent-team-and-cellular-numbers)
    - [Dial-out 2-Party Conference with Ad-hoc IVR](#dial-out-2-party-conference-with-ad-hoc-ivr)
    - [Add External Phone Number to an Active Call](#add-external-phone-number-to-an-active-call)
+   - [Add External Phone Number via Another Phone Number to an Active Call](#add-external-phone-number-via-another-phone-number-to-an-active-call)
    - [Add Agent to an Active Call](#add-agent-to-an-active-call)
    - [Remove External Phone Number from an Active Call](#remove-external-phone-number-from-an-active-call)
    - [Remove Agent from an Active Call](#remove-agent-from-an-active-call)
@@ -114,13 +113,13 @@ This IVR will speak the message and then hangup the call.
 
 ```bash
 jaxl ivrs create \
-  --message "Hello, we are calling via Jaxl IVR demo created from CLI" \
+  --message "Hello, we are calling via Jaxl IVR demo created from CLI.  Will hang up after speaking this message." \
   --hangup
 ```
 
 ### Configure IVR Options
 
-This IVR option uses `--next` to send user to another IVR.
+This IVR option uses `--next` to send user to another IVR or to the same IVR for a "repeat this menu" experience.
 
 ```bash
 jaxl ivrs options configure \
@@ -130,7 +129,7 @@ jaxl ivrs options configure \
   --next <NEXT IVR ID>
 ```
 
-> Use &lt;IVR ID TO CONFIGURE&gt; as the &lt;NEXT IVR ID&gt; to complete the "repeat this menu" experience.
+> Use same value for &lt;IVR ID TO CONFIGURE&gt; and &lt;NEXT IVR ID&gt; to complete the "repeat this menu" experience.
 
 One of the CTA key flag must be provided. Allowed CTA keys are:
 
@@ -155,7 +154,7 @@ jaxl phones list
 You can also search for a specific purchased number:
 
 ```bash
-jaxl phones list --e164 "+91<Purchased Jaxl Number>"
+jaxl phones list --e164 "+CC<Purchased Jaxl Number>"
 ```
 
 ### Assign a Phone Number to IVR by ID
@@ -164,7 +163,7 @@ All incoming calls to this number will send user to the assigned IVR.
 
 ```bash
 jaxl phones ivrs \
-  --e164 "+91<Purchased Jaxl Number>" \
+  --e164 "+CC<Purchased Jaxl Number>" \
   --ivr <IVR ID>
 ```
 
@@ -178,8 +177,8 @@ Below command will execute the following flow:
 
 ```bash
 jaxl calls create \
-  --to "+91<Callee Number>" \
-  --from "+91<Purchased Jaxl Number>" \
+  --to "+CC<Callee Number>" \
+  --from "+CC<Purchased Jaxl Number>" \
   --ivr <IVR ID>
 ```
 
@@ -194,46 +193,13 @@ Below command will execute the following flow:
 
 ```bash
 jaxl calls create \
-  --to "+91<Callee Number>" \
-  --from "+91<Purchased Jaxl Number>" \
+  --to "+CC<Callee Number>" \
+  --from "+CC<Purchased Jaxl Number>" \
   --message "Hello, we are calling you from MyCompany" \
   --option "1=Press 1 for sales:team=<Sales Team ID>" \
   --option "2=Press 2 for HR department:team=<HR Team ID>
 ```
 
-## Dial-out Multi-Party Conference between Cellular Numbers
-
-Below command will execute the following flow:
-
-- Dials out all `--to` participants in parallel
-- Connects them together as they answer the call
-- Ends the call when one but all others have hanged up the call
-
-```bash
-jaxl calls create \
-  --to "+91<Doctors Number>" \
-  --to "+91<Patient Number>" \
-  --to "+91<Supervisor Number>" \
-  --from "+91<Purchased Jaxl Number>"
-```
-
-### Dial-out Agent Team and Cellular Numbers
-
-Below command will execute the following flow:
-
-- Dials out multiple teams of doctors & patient in parallel
-- Connects the patient with first doctor to pick the call from the teams
-- Doctors are called on their cellular number first (if added on Jaxl app),
-  followed by an attempt to call on Jaxl app directly (VoIP).
-- Calling preference can be controlled per agent (doctor) or team to dictate
-  whether to use cellular or voip first to connect with a doctor.
-
-```bash
-jaxl calls create \
-  --to "teams=<Doctors Team ID1>,<Doctors Team ID2>" \
-  --to "+91<Patient Number>"
-```
-
 ### Dial-out 2-Party Conference with Ad-hoc IVR
 
 Below command will execute the following flow:
@@ -245,34 +211,40 @@ Below command will execute the following flow:
 
 ```bash
 jaxl calls create \
-  --to "+91<Doctors Number>" \
-  --from "+91<Purchased Jaxl Number>" \
+  --to "+CC<Doctors Number>" \
+  --from "+CC<Purchased Jaxl Number>" \
   --message "Hello Doctor, this is a call from MyCompany regarding your appointment with Mr. Patient Name. When ready please, " \
-  --option "1=Press 1 to connect with the patient:phone=+91<Patient Number>"
+  --option "1=Press 1 to connect with the patient:phone=+CC<Patient Number>"
 ```
 
 ### Add External Phone Number to an Active Call
 
 ```bash
-jaxl calls add --call-id 1234 --phone +91<Mobile Number>
+jaxl calls add --call-id 1234 --e164 +CC<Mobile Number>
+```
+
+### Add External Phone Number via Another Phone Number to an Active Call
+
+```bash
+jaxl calls add --call-id 1234 --e164 +CC<Mobile Number> --from-e164 +CC<Purchased Jaxl Number>
 ```
 
 ### Add Agent to an Active Call
 
 ```bash
-jaxl calls add --call-id 1234 --agent <someone@mycompany.com>
+jaxl calls add --call-id 1234 --email <someone@mycompany.com>
 ```
 
 ### Remove External Phone Number from an Active Call
 
 ```bash
-jaxl calls remove --call-id 1234 --phone +91<Mobile Number>
+jaxl calls remove --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 ### Remove Agent from an Active Call
 
 ```bash
-jaxl calls remove --call-id 1234 --agent <someone@mycompany.com>
+jaxl calls remove --call-id 1234 --email <someone@mycompany.com>
 ```
 
 ### Send Text Prompts (TTS) in an Active Call
@@ -298,13 +270,13 @@ jaxl calls play --call-id 1234 --audio /path/to/a/file/on/local/disk/or/public/u
 Mute a specific cellular user in a call.
 
 ```bash
-jaxl calls mute --call-id 1234 --phone +91<Mobile Number>
+jaxl calls mute --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Mute an agent (Jaxl App User) in a call.
 
 ```bash
-jaxl calls mute --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls mute --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Unmute a Participant in an Active Call
@@ -312,13 +284,13 @@ jaxl calls mute --call-id 1235 --agent <someone@mycompany.com>
 Unmute a specific cellular user in a call.
 
 ```bash
-jaxl calls unmute --call-id 1234 --phone +91<Mobile Number>
+jaxl calls unmute --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Unmute a specific agent (Jaxl App User) in a call.
 
 ```bash
-jaxl calls unmute --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls unmute --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Hold a Participant in an Active Call
@@ -326,13 +298,13 @@ jaxl calls unmute --call-id 1235 --agent <someone@mycompany.com>
 Put a cellular user on-hold in a call
 
 ```bash
-jaxl calls hold --call-id 1234 --phone +91<Mobile Number>
+jaxl calls hold --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Put an agent on-hold in a call
 
 ```bash
-jaxl calls hold --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls hold --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Unhold a Participant in an Active Call
@@ -340,13 +312,13 @@ jaxl calls hold --call-id 1235 --agent <someone@mycompany.com>
 Unhold a cellular user in a call
 
 ```bash
-jaxl calls unhold --call-id 1234 --phone +91<Mobile Number>
+jaxl calls unhold --call-id 1234 --e164 +CC<Mobile Number>
 ```
 
 Unhold an agent in a call
 
 ```bash
-jaxl calls unhold --call-id 1235 --agent <someone@mycompany.com>
+jaxl calls unhold --call-id 1235 --email <someone@mycompany.com>
 ```
 
 ### Receive Call Events via Webhook IVRs
@@ -399,25 +371,21 @@ jaxl payments consumables total
 ## Jaxl Python SDK
 
 - Jaxl APIs is built upon [OpenAPI specification](https://www.openapis.org/)
-- `jaxl-python` contains following Python modules:
-  - `jaxl.api.client`: Generated OpenAPI SDK
-  - `jaxl.api.resources`: Wrapper methods written to support `jaxl` CLI
-  - `jaxl_api_client`: Helper function to retrieve an instance of `JaxlApiClient`
 
 ### SDK Example Usage:
 
 ```python
-from jaxl.api import JaxlApiModule, jaxl_api_client
-from jaxl.api.client.api.v1 import v1_calls_list
+from jaxl.api import JaxlSDK
 
 os.environ.setdefault("JAXL_API_CREDENTIALS", "/path/to/jaxl-api-credentials.json")
 
 os.environ.setdefault("JAXL_API_AUTH_TOKEN", "....authentication token...")
 
-response = v1_calls_list.sync_detailed(
-    client=jaxl_api_client(JaxlApiModule.CALL),
-    currency=2, # 1=USD, 2=INR
-)
+sdk = JaxlSDK()
+
+response = sdk.calls.create(to="+CC<Callee Number>", from_="+CC<Purchased Jaxl Number>", ivr=1234)
+response = sdk.calls.list(currency=2) # 1=USD, 2=INR
+response = sdk.accounts.me()
 ```
 
 ## SDK Documentation
@@ -436,7 +404,7 @@ python3 -m venv .venv
 source .venv/bin/activate
 
 # Install
-pip install -e ".[dev]"
+pip install -e ".[dev,docs]"
 
 # Generate documentation
 ./docs.sh
@@ -447,6 +415,10 @@ open docs/jaxl/index.html
 
 ## Status
 
-[![Python 3.x](https://img.shields.io/static/v1?label=Python&message=3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12&color=blue&style=flat-square)](https://www.python.org/)
+[![pypi version](https://img.shields.io/pypi/v/jaxl-python)](https://pypi.org/project/jaxl-python/)
+
+[![PyPi Monthly](https://img.shields.io/pypi/dm/jaxl-python)](https://pypi.org/project/jaxl-python/)
+
+[![Python 3.x](https://img.shields.io/static/v1?label=Python&message=3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12&color=blue)](https://www.python.org/)
 
-[![Checked with mypy](https://img.shields.io/static/v1?label=MyPy&message=checked&color=blue&style=flat-square)](http://mypy-lang.org/)
+[![Checked with mypy](https://img.shields.io/static/v1?label=MyPy&message=checked&color=blue)](http://mypy-lang.org/)

{jaxl_python-0.0.11 → jaxl_python-0.0.13}/examples/README.md

@@ -136,6 +136,7 @@ PYTHONPATH=. jaxl apps run --app examples:JaxlAppStreamingTranscription --transc
 ```bash
 # Requires ffmpeg installed on your system
 pip install -U jaxl-python[silence,transcribe]
+# Defaults to gemma3:1b model, ensure you have the model installed
 export JAXL_OLLAMA_URL=https://<llm.domain>/api/chat
 PYTHONPATH=. jaxl apps run --app examples:JaxlAppStreamingAIAgent --transcribe
 ```

jaxl_python-0.0.13/examples/prompts/example.txt

@@ -0,0 +1,15 @@
+You are a concise and precise virtual assistant 
+for the domain {domain}, representing the brand '{brand_name}'.
+Always reply in plain text.
+
+User may mispronounce '{brand_name}'.
+Try to infer the mispronunciations and treat all such variants 
+as references to '{brand_name}' and always refer to the name correctly 
+as '{brand_name}' in your responses.
+
+Keep your responses short (one or two sentences) and to the point, 
+unless the user asks for more details. Avoid unnecessary elaboration. 
+When appropriate, follow this template: provide a brief answer, 
+and ask a clarifying question. Your primary goal is to be concise, precise, clear and efficient.
+
+Use the system role context in following messages to answer queries related to {domain}.

{jaxl_python-0.0.11 → jaxl_python-0.0.13}/examples/request_code_and_send_to_phone.py

@@ -21,6 +21,8 @@ from jaxl.api.base import (
 
 ASK_FOR_CODE_RESPONSE = JaxlWebhookResponse(
     prompt=["Please enter your code followed by star sign"],
+    # Because we expect user to end their input with a star sign,
+    # we will use num_characters="*".  Only other option is "#".
     num_characters="*",
 )
 

{jaxl_python-0.0.11 → jaxl_python-0.0.13}/examples/send_to_phone.py

@@ -22,6 +22,8 @@ class JaxlAppSendToCellular(BaseJaxlApp):
     """This Jaxl App example bridges the user with another cellular user."""
 
     async def handle_setup(self, req: JaxlWebhookRequest) -> HANDLER_RESPONSE:
+        # As soon as someone calls this call flow,
+        # place another outgoing call and bridge them together.
         return JaxlCtaResponse(
             phone=JaxlPhoneCta(
                 to_number=os.environ.get(