wxcli 1.2.0__py3-none-any.whl

wxcli/commands/numbers.py

@@ -0,0 +1,405 @@
+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 numbers.")
+
+
+@app.command("create")
+def create(
+    location_id: str = typer.Argument(help="locationId"),
+    number_type: str = typer.Option(None, "--number-type", help="Choices: TOLLFREE, DID, MOBILE"),
+    number_usage_type: str = typer.Option(None, "--number-usage-type", help="Choices: NONE, SERVICE"),
+    state: str = typer.Option(None, "--state", help="Choices: ACTIVE, INACTIVE"),
+    subscription_id: str = typer.Option(None, "--subscription-id", help="The `subscriptionId` to be used for the mobile number order."),
+    carrier_id: str = typer.Option(None, "--carrier-id", help="The `carrierId` to be used for the mobile number order."),
+    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 Phone Numbers to a Location\n\nExample --json-body:\n  '{"phoneNumbers":["..."],"numberType":"TOLLFREE","numberUsageType":"NONE","state":"ACTIVE","subscriptionId":"...","carrierId":"..."}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/locations/{location_id}/numbers"
+    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 number_type is not None:
+            body["numberType"] = number_type
+        if number_usage_type is not None:
+            body["numberUsageType"] = number_usage_type
+        if state is not None:
+            body["state"] = state
+        if subscription_id is not None:
+            body["subscriptionId"] = subscription_id
+        if carrier_id is not None:
+            body["carrierId"] = carrier_id
+    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")
+def update(
+    location_id: str = typer.Argument(help="locationId"),
+    action: str = typer.Option(None, "--action", help="Choices: ACTIVATE, DEACTIVATE"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Manage Number State in a Location\n\nExample --json-body:\n  '{"phoneNumbers":["..."],"action":"ACTIVATE"}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/locations/{location_id}/numbers"
+    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 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("delete")
+def delete(
+    location_id: str = typer.Argument(help="locationId"),
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Remove Phone Numbers from a Location."""
+    if not force:
+        typer.confirm(f"Delete {location_id}?", abort=True)
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/locations/{location_id}/numbers"
+    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: {location_id}")
+
+
+
+@app.command("validate-phone-numbers")
+def validate_phone_numbers(
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Validate Phone Numbers\n\nExample --json-body:\n  '{"phoneNumbers":["..."]}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/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")
+def cmd_list(
+    location_id: str = typer.Option(None, "--location-id", help="Return the list of phone numbers for this location within th"),
+    phone_number: str = typer.Option(None, "--phone-number", help="Search for this `phoneNumber`."),
+    available: str = typer.Option(None, "--available", help="Search among the available phone numbers. This parameter can"),
+    order: str = typer.Option(None, "--order", help="Sort the list of phone numbers based on the following:`lastN"),
+    owner_name: str = typer.Option(None, "--owner-name", help="Return the list of phone numbers that are owned by the given"),
+    owner_id: str = typer.Option(None, "--owner-id", help="Returns only the matched number/extension entries assigned t"),
+    owner_type: str = typer.Option(None, "--owner-type", help="Choices: PEOPLE, PLACE, AUTO_ATTENDANT, CALL_QUEUE, PAGING_GROUP, HUNT_GROUP, VOICE_MESSAGING, BROADWORKS_ANYWHERE, CONTACT_CENTER_LINK, ROUTE_LIST, VOICEMAIL_GROUP, VIRTUAL_LINE"),
+    extension: str = typer.Option(None, "--extension", help="Returns the list of phone numbers with the given extension."),
+    number_type: str = typer.Option(None, "--number-type", help="Choices: NUMBER, EXTENSION"),
+    phone_number_type: str = typer.Option(None, "--phone-number-type", help="Choices: PRIMARY, ALTERNATE, FAX, DNIS, Default"),
+    state: str = typer.Option(None, "--state", help="Choices: ACTIVE, INACTIVE, Default"),
+    details: str = typer.Option(None, "--details", help="Returns the overall count of the phone numbers along with ot"),
+    toll_free_numbers: str = typer.Option(None, "--toll-free-numbers", help="Returns the list of toll-free phone numbers."),
+    restricted_non_geo_numbers: str = typer.Option(None, "--restricted-non-geo-numbers", help="Returns the list of restricted non-geographical numbers."),
+    included_telephony_types: str = typer.Option(None, "--included-telephony-types", help="Returns the list of phone numbers that are of given `include"),
+    service_number: str = typer.Option(None, "--service-number", help="Returns the list of service phone numbers."),
+    reserved_number: str = typer.Option(None, "--reserved-number", help="Filters reserved phone numbers. When set to `true`, returns"),
+    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 Phone Numbers for an Organization with Given Criteria."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/numbers"
+    params = {}
+    if location_id is not None:
+        params["locationId"] = location_id
+    if phone_number is not None:
+        params["phoneNumber"] = phone_number
+    if available is not None:
+        params["available"] = available
+    if order is not None:
+        params["order"] = order
+    if owner_name is not None:
+        params["ownerName"] = owner_name
+    if owner_id is not None:
+        params["ownerId"] = owner_id
+    if owner_type is not None:
+        params["ownerType"] = owner_type
+    if extension is not None:
+        params["extension"] = extension
+    if number_type is not None:
+        params["numberType"] = number_type
+    if phone_number_type is not None:
+        params["phoneNumberType"] = phone_number_type
+    if state is not None:
+        params["state"] = state
+    if details is not None:
+        params["details"] = details
+    if toll_free_numbers is not None:
+        params["tollFreeNumbers"] = toll_free_numbers
+    if restricted_non_geo_numbers is not None:
+        params["restrictedNonGeoNumbers"] = restricted_non_geo_numbers
+    if included_telephony_types is not None:
+        params["includedTelephonyTypes"] = included_telephony_types
+    if service_number is not None:
+        params["serviceNumber"] = service_number
+    if reserved_number is not None:
+        params["reservedNumber"] = reserved_number
+    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("phoneNumbers", 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=[('Phone Number', 'phoneNumber'), ('Extension', 'extension'), ('State', 'state'), ('Owner Type', 'owner.type'), ('Owner Name', 'owner.firstName')], limit=limit)
+
+
+
+@app.command("list-manage-numbers")
+def list_manage_numbers(
+    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 Manage Numbers Jobs."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/jobs/numbers/manageNumbers"
+    params = {}
+    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'), ('Operation', 'operationType'), ('Status', 'latestExecutionStatus')], limit=limit)
+
+
+
+@app.command("create-manage-numbers")
+def create_manage_numbers(
+    operation: str = typer.Option(None, "--operation", help="(required) The kind of operation to be carried out."),
+    target_location_id: str = typer.Option(None, "--target-location-id", help="Mandatory for a `MOVE` operation. The target location within"),
+    number_usage_type: str = typer.Option(None, "--number-usage-type", help="The number usage type. Mandatory for `NUMBER_USAGE_CHANGE` o"),
+    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"),
+):
+    """Initiate Number Jobs\n\nExample --json-body:\n  '{"operation":"...","numberList":[{"locationId":"...","numbers":"..."}],"targetLocationId":"...","numberUsageType":"..."}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/jobs/numbers/manageNumbers"
+    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 operation is not None:
+            body["operation"] = operation
+        if target_location_id is not None:
+            body["targetLocationId"] = target_location_id
+        if number_usage_type is not None:
+            body["numberUsageType"] = number_usage_type
+        _missing = [f for f in ['operation'] 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(
+    job_id: str = typer.Argument(help="jobId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Manage Numbers Job Status."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/jobs/numbers/manageNumbers/{job_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("pause-the-manage")
+def pause_the_manage(
+    job_id: str = typer.Argument(help="jobId"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Pause the Manage Numbers Job."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/jobs/numbers/manageNumbers/{job_id}/actions/pause/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("resume-the-manage")
+def resume_the_manage(
+    job_id: str = typer.Argument(help="jobId"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Resume the Manage Numbers Job."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/jobs/numbers/manageNumbers/{job_id}/actions/resume/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-errors")
+def list_errors(
+    job_id: str = typer.Argument(help="jobId"),
+    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 Manage Numbers Job Errors."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/jobs/numbers/manageNumbers/{job_id}/errors"
+    params = {}
+    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", "name")], limit=limit)
+
+