wxcli 1.2.0__py3-none-any.whl

wxcli/commands/pstn.py

@@ -0,0 +1,280 @@
+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 pstn.")
+
+
+@app.command("list")
+def cmd_list(
+    location_id: str = typer.Argument(help="locationId"),
+    service_types: str = typer.Option(None, "--service-types", help="Use the `serviceTypes` parameter to fetch connections for th"),
+    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"),
+):
+    """Retrieve PSTN Connection Options for a Location."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/pstn/locations/{location_id}/connectionOptions"
+    params = {}
+    if service_types is not None:
+        params["serviceTypes"] = service_types
+    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("items", 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'), ('PSTN Services', 'pstnServices')], limit=limit)
+
+
+
+@app.command("list-connection")
+def list_connection(
+    location_id: str = typer.Argument(help="locationId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Retrieve PSTN Connection for a Location."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/pstn/locations/{location_id}/connection"
+    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(
+    location_id: str = typer.Argument(help="locationId"),
+    id_param: str = typer.Option(None, "--id", help="A unique identifier for the connection. This is required for"),
+    premise_route_type: str = typer.Option(None, "--premise-route-type", help="Premise route type. The possible types are TRUNK and ROUTE_G"),
+    premise_route_id: str = typer.Option(None, "--premise-route-id", help="Premise route ID. This refers to either a Trunk ID or a Rout"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Setup PSTN Connection for a Location."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/pstn/locations/{location_id}/connection"
+    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 id_param is not None:
+            body["id"] = id_param
+        if premise_route_type is not None:
+            body["premiseRouteType"] = premise_route_type
+        if premise_route_id is not None:
+            body["premiseRouteId"] = premise_route_id
+    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("update-emergency-address")
+def update_emergency_address(
+    phone_number: str = typer.Argument(help="phoneNumber"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Update the Emergency Address for a Phone Number\n\nExample --json-body:\n  '{"emergencyAddress":{"address1":"...","address2":"...","city":"...","state":"...","postalCode":"...","country":"..."}}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/pstn/numbers/{phone_number}/emergencyAddress"
+    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_put(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("create")
+def create(
+    location_id: str = typer.Argument(help="locationId"),
+    address1: str = typer.Option(None, "--address1", help="Primary street information for the emergency address."),
+    address2: str = typer.Option(None, "--address2", help="Apartment number or any other secondary information for the"),
+    city: str = typer.Option(None, "--city", help="City for the emergency address."),
+    state: str = typer.Option(None, "--state", help="State or Province or Region for the emergency address."),
+    postal_code: str = typer.Option(None, "--postal-code", help="Postal code for the emergency address."),
+    country: str = typer.Option(None, "--country", help="Country for the emergency address."),
+    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"),
+):
+    """Emergency Address Lookup to Verify if Address is Valid."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/pstn/locations/{location_id}/emergencyAddress/lookup"
+    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 address1 is not None:
+            body["address1"] = address1
+        if address2 is not None:
+            body["address2"] = address2
+        if city is not None:
+            body["city"] = city
+        if state is not None:
+            body["state"] = state
+        if postal_code is not None:
+            body["postalCode"] = postal_code
+        if country is not None:
+            body["country"] = country
+    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("create-emergency-address")
+def create_emergency_address(
+    location_id: str = typer.Argument(help="locationId"),
+    address1: str = typer.Option(None, "--address1", help="Primary street information for the emergency address."),
+    address2: str = typer.Option(None, "--address2", help="Apartment number or any other secondary information for the"),
+    city: str = typer.Option(None, "--city", help="City for the emergency address."),
+    state: str = typer.Option(None, "--state", help="State or Province or Region for the emergency address."),
+    postal_code: str = typer.Option(None, "--postal-code", help="Postal code for the emergency address."),
+    country: str = typer.Option(None, "--country", help="Country for the emergency address."),
+    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"),
+):
+    """Add an Emergency Address to a Location."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/pstn/locations/{location_id}/emergencyAddress"
+    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 address1 is not None:
+            body["address1"] = address1
+        if address2 is not None:
+            body["address2"] = address2
+        if city is not None:
+            body["city"] = city
+        if state is not None:
+            body["state"] = state
+        if postal_code is not None:
+            body["postalCode"] = postal_code
+        if country is not None:
+            body["country"] = country
+    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("update-emergency-addresses")
+def update_emergency_addresses(
+    location_id: str = typer.Argument(help="locationId"),
+    address_id: str = typer.Argument(help="addressId"),
+    address1: str = typer.Option(None, "--address1", help="Primary street information for the emergency address."),
+    address2: str = typer.Option(None, "--address2", help="Apartment number or any other secondary information for the"),
+    city: str = typer.Option(None, "--city", help="City for the emergency address."),
+    state: str = typer.Option(None, "--state", help="State or Province or Region for the emergency address."),
+    postal_code: str = typer.Option(None, "--postal-code", help="Postal code for the emergency address."),
+    country: str = typer.Option(None, "--country", help="Country for the emergency address."),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Update the Emergency Address of a Location."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/pstn/locations/{location_id}/emergencyAddresses/{address_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 address1 is not None:
+            body["address1"] = address1
+        if address2 is not None:
+            body["address2"] = address2
+        if city is not None:
+            body["city"] = city
+        if state is not None:
+            body["state"] = state
+        if postal_code is not None:
+            body["postalCode"] = postal_code
+        if country is not None:
+            body["country"] = country
+    try:
+        result = api.session.rest_put(url, json=body, params=params)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+

wxcli/commands/recording_report.py

@@ -0,0 +1,154 @@
+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
+
+
+app = typer.Typer(help="Manage Webex Calling recording-report.")
+
+
+@app.command("list")
+def cmd_list(
+    from_param: str = typer.Option(None, "--from", help="Starting date and time (inclusive) for recording audit repor"),
+    to: str = typer.Option(None, "--to", help="Ending date and time (exclusive) for recording audit report"),
+    host_email: str = typer.Option(None, "--host-email", help="Email address for the meeting host. This parameter is only u"),
+    site_url: str = typer.Option(None, "--site-url", help="URL of the Webex site which the API lists recording audit re"),
+    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"),
+):
+    """List of Recording Audit Report Summaries."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/recordingReport/accessSummary"
+    params = {}
+    if from_param is not None:
+        params["from"] = from_param
+    if to is not None:
+        params["to"] = to
+    if host_email is not None:
+        params["hostEmail"] = host_email
+    if site_url is not None:
+        params["siteUrl"] = site_url
+    if limit > 0:
+        params["max"] = limit
+    if offset > 0:
+        params["start"] = offset
+    try:
+        if limit > 0:
+            result = api.session.rest_get(url, params=params)
+            result = result or {}
+            items = result.get("items", result.get("data", result if isinstance(result, list) else [])) if isinstance(result, dict) else (result if isinstance(result, list) else [])
+        else:
+            items = list(api.session.follow_pagination(url=url, params=params, item_key="items"))
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(items)
+    else:
+        print_table(items, columns=[("ID", "id"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("list-access-detail")
+def list_access_detail(
+    recording_id: str = typer.Option(..., "--recording-id", help="A unique identifier for the recording."),
+    host_email: str = typer.Option(None, "--host-email", help="Email address for the meeting host. This parameter is only u"),
+    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 Recording Audit Report Details."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/recordingReport/accessDetail"
+    params = {}
+    if recording_id is not None:
+        params["recordingId"] = recording_id
+    if host_email is not None:
+        params["hostEmail"] = host_email
+    if limit > 0:
+        params["max"] = limit
+    if offset > 0:
+        params["start"] = offset
+    try:
+        if limit > 0:
+            result = api.session.rest_get(url, params=params)
+            result = result or {}
+            items = result.get("items", result.get("data", result if isinstance(result, list) else [])) if isinstance(result, dict) else (result if isinstance(result, list) else [])
+        else:
+            items = list(api.session.follow_pagination(url=url, params=params, item_key="items"))
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(items)
+    else:
+        print_table(items, columns=[("ID", "id"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("list-meeting-archive-summaries")
+def list_meeting_archive_summaries(
+    from_param: str = typer.Option(None, "--from", help="Starting date and time (inclusive) for meeting archive summa"),
+    to: str = typer.Option(None, "--to", help="Ending date and time (exclusive) for meeting archive summari"),
+    site_url: str = typer.Option(None, "--site-url", help="URL of the Webex site which the API lists meeting archive su"),
+    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"),
+):
+    """List Meeting Archive Summaries."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/recordingReport/meetingArchiveSummaries"
+    params = {}
+    if from_param is not None:
+        params["from"] = from_param
+    if to is not None:
+        params["to"] = to
+    if site_url is not None:
+        params["siteUrl"] = site_url
+    if limit > 0:
+        params["max"] = limit
+    if offset > 0:
+        params["start"] = offset
+    try:
+        if limit > 0:
+            result = api.session.rest_get(url, params=params)
+            result = result or {}
+            items = result.get("items", result.get("data", result if isinstance(result, list) else [])) if isinstance(result, dict) else (result if isinstance(result, list) else [])
+        else:
+            items = list(api.session.follow_pagination(url=url, params=params, item_key="items"))
+    except WebexError as e:
+        handle_rest_error(e)
+    if output == "json":
+        print_json(items)
+    else:
+        print_table(items, columns=[("ID", "id"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("show")
+def show(
+    archive_id: str = typer.Argument(help="archiveId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Meeting Archive Details."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/recordingReport/meetingArchives/{archive_id}"
+    try:
+        result = api.session.rest_get(url)
+    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)
+
+

wxcli/commands/report_templates.py

@@ -0,0 +1,38 @@
+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
+
+
+app = typer.Typer(help="Manage Webex Calling report-templates.")
+
+
+@app.command("list")
+def cmd_list(
+    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"),
+):
+    """List Report Templates."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/report/templates"
+    params = {}
+    if limit > 0:
+        params["max"] = limit
+    if offset > 0:
+        params["start"] = offset
+    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("items", 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'), ('Title', 'title'), ('Service', 'service'), ('Max Days', 'maxDays')], limit=limit)
+
+

wxcli/commands/reports.py

@@ -0,0 +1,144 @@
+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
+
+
+app = typer.Typer(help="Manage Webex Calling reports.")
+
+
+@app.command("list")
+def cmd_list(
+    report_id: str = typer.Option(None, "--report-id", help="List reports by ID."),
+    service: str = typer.Option(None, "--service", help="List reports which use this service."),
+    template_id: str = typer.Option(None, "--template-id", help="List reports with this report template ID."),
+    from_param: str = typer.Option(None, "--from", help="List reports that were created on or after this date."),
+    to: str = typer.Option(None, "--to", help="List reports that were created before this date."),
+    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"),
+):
+    """List Reports."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/reports"
+    params = {}
+    if report_id is not None:
+        params["reportId"] = report_id
+    if service is not None:
+        params["service"] = service
+    if template_id is not None:
+        params["templateId"] = template_id
+    if from_param is not None:
+        params["from"] = from_param
+    if to is not None:
+        params["to"] = to
+    if limit > 0:
+        params["max"] = limit
+    if offset > 0:
+        params["start"] = offset
+    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("Report Attributes", 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")
+def create(
+    template_id: str = typer.Option(None, "--template-id", help="(required) Unique ID representing valid report templates."),
+    start_date: str = typer.Option(None, "--start-date", help="Data in the report will be from this date onwards."),
+    end_date: str = typer.Option(None, "--end-date", help="Data in the report will be until this date."),
+    site_list: str = typer.Option(None, "--site-list", help="Sites belonging to user's organization. This attribute is ne"),
+    time_zone: str = typer.Option(None, "--time-zone", help="Time zone used for report date and time values. Use an IANA"),
+    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 Report."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/reports"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if template_id is not None:
+            body["templateId"] = template_id
+        if start_date is not None:
+            body["startDate"] = start_date
+        if end_date is not None:
+            body["endDate"] = end_date
+        if site_list is not None:
+            body["siteList"] = site_list
+        if time_zone is not None:
+            body["timeZone"] = time_zone
+        _missing = [f for f in ['templateId'] 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)
+    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(
+    report_id: str = typer.Argument(help="reportId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Report Details."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/reports/{report_id}"
+    try:
+        result = api.session.rest_get(url)
+    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")
+def delete(
+    report_id: str = typer.Argument(help="reportId"),
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Delete a Report."""
+    if not force:
+        typer.confirm(f"Delete {report_id}?", abort=True)
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/reports/{report_id}"
+    try:
+        api.session.rest_delete(url)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Deleted: {report_id}")
+
+