wxcli 1.2.0__py3-none-any.whl

wxcli/commands/virtual_extensions.py

@@ -0,0 +1,502 @@
+import json
+import typer
+from wxcli.auth import get_api
+from wxcli.errors import WebexError, handle_rest_error
+from wxcli.output import print_table, print_json
+from wxcli.config import get_org_id
+
+
+app = typer.Typer(help="Manage Webex Calling virtual-extensions.")
+
+
+@app.command("list")
+def cmd_list(
+    order: str = typer.Option(None, "--order", help="Order the list of virtual extensions in ascending or descend"),
+    extension: str = typer.Option(None, "--extension", help="Filter the list of virtual extensions by extension number."),
+    phone_number: str = typer.Option(None, "--phone-number", help="Filter the list of virtual extensions by phone number."),
+    name: str = typer.Option(None, "--name", help="Filter the list of virtual extensions by name. This can be e"),
+    location_name: str = typer.Option(None, "--location-name", help="Filter the list of virtual extensions by location name.(Only"),
+    location_id: str = typer.Option(None, "--location-id", help="Filter the list of virtual extensions by location ID."),
+    org_level_only: str = typer.Option(None, "--org-level-only", help="Filter the list of virtual extensions by organization level."),
+    output: str = typer.Option("table", "--output", "-o", help="Output format: table|json"),
+    limit: int = typer.Option(0, "--limit", help="Max results (0=all for paginated endpoints, API default for non-paginated)"),
+    offset: int = typer.Option(0, "--offset", help="Start offset"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Read the List of Virtual Extensions."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions"
+    params = {}
+    if order is not None:
+        params["order"] = order
+    if extension is not None:
+        params["extension"] = extension
+    if phone_number is not None:
+        params["phoneNumber"] = phone_number
+    if name is not None:
+        params["name"] = name
+    if location_name is not None:
+        params["locationName"] = location_name
+    if location_id is not None:
+        params["locationId"] = location_id
+    if org_level_only is not None:
+        params["orgLevelOnly"] = org_level_only
+    if limit > 0:
+        params["max"] = limit
+    if offset > 0:
+        params["start"] = offset
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    result = None
+    try:
+        result = api.session.rest_get(url, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    result = result or []
+    items = result.get("virtualExtensions", result.get("data", result if isinstance(result, list) else [])) if isinstance(result, dict) else (result if isinstance(result, list) else [])
+    if output == "json":
+        print_json(items)
+    else:
+        print_table(items, columns=[('ID', 'id'), ('Name', 'displayName'), ('Extension', 'extension'), ('Phone Number', 'phoneNumber')], limit=limit)
+
+
+
+@app.command("create")
+def create(
+    first_name: str = typer.Option(None, "--first-name", help="First name of the person at the virtual extension."),
+    last_name: str = typer.Option(None, "--last-name", help="Last name of the person at the virtual extension."),
+    display_name: str = typer.Option(None, "--display-name", help="(required) Display name of the person at the virtual extension."),
+    phone_number: str = typer.Option(None, "--phone-number", help="(required) Directory number of the virtual extension."),
+    extension: str = typer.Option(None, "--extension", help="(required) Extension of the virtual extension."),
+    location_id: str = typer.Option(None, "--location-id", help="ID of the location to which the virtual extension is assigne"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    output: str = typer.Option("id", "--output", "-o", help="Output format: id|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Create a Virtual Extension."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if first_name is not None:
+            body["firstName"] = first_name
+        if last_name is not None:
+            body["lastName"] = last_name
+        if display_name is not None:
+            body["displayName"] = display_name
+        if phone_number is not None:
+            body["phoneNumber"] = phone_number
+        if extension is not None:
+            body["extension"] = extension
+        if location_id is not None:
+            body["locationId"] = location_id
+        _missing = [f for f in ['displayName', 'phoneNumber', 'extension'] if f not in body or body[f] is None]
+        if _missing:
+            typer.echo("Error: Missing required fields: " + ", ".join(_missing), err=True)
+            raise typer.Exit(1)
+    try:
+        result = api.session.rest_post(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(result)
+    elif isinstance(result, dict) and "id" in result:
+        typer.echo(f"Created: {result['id']}")
+    elif not result or result == {}:
+        typer.echo("Created.")
+    else:
+        print_json(result)
+
+
+
+@app.command("show")
+def show(
+    extension_id: str = typer.Argument(help="extensionId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get a Virtual Extension."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions/{extension_id}"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    try:
+        result = api.session.rest_get(url, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(result)
+    else:
+        if isinstance(result, dict):
+            print_table([result], columns=[("Key", ""), ("Value", "")], limit=0)
+        elif isinstance(result, list):
+            print_table(result, columns=[("ID", "id"), ("Name", "name")], limit=0)
+        else:
+            print_json(result)
+
+
+
+@app.command("update")
+def update(
+    extension_id: str = typer.Argument(help="extensionId"),
+    first_name: str = typer.Option(None, "--first-name", help="First name of the person at the virtual extension."),
+    last_name: str = typer.Option(None, "--last-name", help="Last name of the person at the virtual extension."),
+    display_name: str = typer.Option(None, "--display-name", help="Display name of the person at the virtual extension."),
+    phone_number: str = typer.Option(None, "--phone-number", help="Directory number of the virtual extension."),
+    extension: str = typer.Option(None, "--extension", help="Extension of the virtual extension."),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Update a Virtual Extension."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions/{extension_id}"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if first_name is not None:
+            body["firstName"] = first_name
+        if last_name is not None:
+            body["lastName"] = last_name
+        if display_name is not None:
+            body["displayName"] = display_name
+        if phone_number is not None:
+            body["phoneNumber"] = phone_number
+        if extension is not None:
+            body["extension"] = extension
+    try:
+        result = api.session.rest_put(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("delete")
+def delete(
+    extension_id: str = typer.Argument(help="extensionId"),
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Delete a Virtual Extension."""
+    if not force:
+        typer.confirm(f"Delete {extension_id}?", abort=True)
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions/{extension_id}"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    try:
+        api.session.rest_delete(url, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Deleted: {extension_id}")
+
+
+
+@app.command("show-settings")
+def show_settings(
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Virtual extension settings."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions/settings"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    try:
+        result = api.session.rest_get(url, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(result)
+    else:
+        if isinstance(result, dict):
+            print_table([result], columns=[("Key", ""), ("Value", "")], limit=0)
+        elif isinstance(result, list):
+            print_table(result, columns=[("ID", "id"), ("Name", "name")], limit=0)
+        else:
+            print_json(result)
+
+
+
+@app.command("update-settings")
+def update_settings(
+    mode: str = typer.Option(None, "--mode", help="Choices: STANDARD"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Modify Virtual Extension Settings."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions/settings"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if mode is not None:
+            body["mode"] = mode
+    try:
+        result = api.session.rest_put(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("validate-an-external")
+def validate_an_external(
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Validate an external phone number\n\nExample --json-body:\n  '{"phoneNumbers":["..."]}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensions/actions/validateNumbers/invoke"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+    try:
+        result = api.session.rest_post(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    print_json(result)
+
+
+
+@app.command("list-virtual-extension-ranges")
+def list_virtual_extension_ranges(
+    order: str = typer.Option(None, "--order", help="Sort the list of virtual extension ranges by name or prefix,"),
+    name: str = typer.Option(None, "--name", help="Filter the list of virtual extension ranges by name."),
+    prefix: str = typer.Option(None, "--prefix", help="Filter the list of virtual extension ranges by prefix."),
+    location_id: str = typer.Option(None, "--location-id", help="Filter the list of virtual extension ranges by location ID."),
+    org_level_only: str = typer.Option(None, "--org-level-only", help="Filter the list of virtual extension ranges by organization"),
+    output: str = typer.Option("table", "--output", "-o", help="Output format: table|json"),
+    limit: int = typer.Option(0, "--limit", help="Max results (0=all for paginated endpoints, API default for non-paginated)"),
+    offset: int = typer.Option(0, "--offset", help="Start offset"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get a list of a Virtual Extension Range."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensionRanges"
+    params = {}
+    if order is not None:
+        params["order"] = order
+    if name is not None:
+        params["name"] = name
+    if prefix is not None:
+        params["prefix"] = prefix
+    if location_id is not None:
+        params["locationId"] = location_id
+    if org_level_only is not None:
+        params["orgLevelOnly"] = org_level_only
+    if limit > 0:
+        params["max"] = limit
+    if offset > 0:
+        params["start"] = offset
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    result = None
+    try:
+        result = api.session.rest_get(url, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    result = result or []
+    items = result.get("virtualExtensionRanges", result.get("data", result if isinstance(result, list) else [])) if isinstance(result, dict) else (result if isinstance(result, list) else [])
+    if output == "json":
+        print_json(items)
+    else:
+        print_table(items, columns=[("ID", "id"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("create-virtual-extension-ranges")
+def create_virtual_extension_ranges(
+    name: str = typer.Option(None, "--name", help="(required) Name of the virtual extension range. This is a unique name f"),
+    prefix: str = typer.Option(None, "--prefix", help="(required) Prefix used for a virtual extension range. Prefix works in S"),
+    location_id: str = typer.Option(None, "--location-id", help="ID of the location to which the virtual extension range is a"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    output: str = typer.Option("id", "--output", "-o", help="Output format: id|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Create a Virtual Extension Range\n\nExample --json-body:\n  '{"name":"...","prefix":"...","patterns":["..."],"locationId":"..."}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensionRanges"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if name is not None:
+            body["name"] = name
+        if prefix is not None:
+            body["prefix"] = prefix
+        if location_id is not None:
+            body["locationId"] = location_id
+        _missing = [f for f in ['name', 'prefix'] if f not in body or body[f] is None]
+        if _missing:
+            typer.echo("Error: Missing required fields: " + ", ".join(_missing), err=True)
+            raise typer.Exit(1)
+    try:
+        result = api.session.rest_post(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(result)
+    elif isinstance(result, dict) and "id" in result:
+        typer.echo(f"Created: {result['id']}")
+    elif not result or result == {}:
+        typer.echo("Created.")
+    else:
+        print_json(result)
+
+
+
+@app.command("show-virtual-extension-ranges")
+def show_virtual_extension_ranges(
+    extension_range_id: str = typer.Argument(help="extensionRangeId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get details of a Virtual Extension Range."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensionRanges/{extension_range_id}"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    try:
+        result = api.session.rest_get(url, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(result)
+    else:
+        if isinstance(result, dict):
+            print_table([result], columns=[("Key", ""), ("Value", "")], limit=0)
+        elif isinstance(result, list):
+            print_table(result, columns=[("ID", "id"), ("Name", "name")], limit=0)
+        else:
+            print_json(result)
+
+
+
+@app.command("delete-virtual-extension-ranges")
+def delete_virtual_extension_ranges(
+    extension_range_id: str = typer.Argument(help="extensionRangeId"),
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Delete a Virtual Extension Range."""
+    if not force:
+        typer.confirm(f"Delete {extension_range_id}?", abort=True)
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensionRanges/{extension_range_id}"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    try:
+        api.session.rest_delete(url, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Deleted: {extension_range_id}")
+
+
+
+@app.command("update-virtual-extension-ranges")
+def update_virtual_extension_ranges(
+    extension_range_id: str = typer.Argument(help="extensionRangeId"),
+    name: str = typer.Option(None, "--name", help="Name of the virtual extension range. This is a unique name f"),
+    prefix: str = typer.Option(None, "--prefix", help="Prefix used for a virtual extension range."),
+    action: str = typer.Option(None, "--action", help="Choices: ADD, REMOVE, REPLACE"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Modify Virtual Extension Range\n\nExample --json-body:\n  '{"name":"...","prefix":"...","patterns":["..."],"action":"ADD"}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensionRanges/{extension_range_id}/"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if name is not None:
+            body["name"] = name
+        if prefix is not None:
+            body["prefix"] = prefix
+        if action is not None:
+            body["action"] = action
+    try:
+        result = api.session.rest_put(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("validate-the-prefix")
+def validate_the_prefix(
+    location_id: str = typer.Option(None, "--location-id", help="ID of the location to which the virtual extension range is a"),
+    name: str = typer.Option(None, "--name", help="Name of the virtual extension range. This is a unique name f"),
+    prefix: str = typer.Option(None, "--prefix", help="Prefix used for a virtual extension range."),
+    range_id: str = typer.Option(None, "--range-id", help="ID of the virtual extension range. This is mandatory when va"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Validate the prefix and extension pattern for a Virtual Extension Range\n\nExample --json-body:\n  '{"locationId":"...","name":"...","prefix":"...","patterns":["..."],"rangeId":"..."}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/virtualExtensionRanges/actions/validate/invoke"
+    params = {}
+    org_id = get_org_id()
+    if org_id is not None:
+        params["orgId"] = org_id
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if location_id is not None:
+            body["locationId"] = location_id
+        if name is not None:
+            body["name"] = name
+        if prefix is not None:
+            body["prefix"] = prefix
+        if range_id is not None:
+            body["rangeId"] = range_id
+    try:
+        result = api.session.rest_post(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    print_json(result)
+
+