wxcli 1.2.0__py3-none-any.whl

wxcli/commands/cc_dial_number.py

@@ -0,0 +1,511 @@
+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 resolve_org_id, get_cc_base_url, get_cc_org_id
+
+
+app = typer.Typer(help="Manage Webex Contact Center cc-dial-number.")
+
+
+@app.command("list")
+def cmd_list(
+    filter_param: str = typer.Option(None, "--filter", help="Specify a filter based on which the results will be fetched."),
+    attributes: str = typer.Option(None, "--attributes", help="Specify the attributes to be returned. By default, all attri"),
+    page: str = typer.Option(None, "--page", help="Defines the number of displayed page. The page number starts"),
+    page_size: str = typer.Option(None, "--page-size", help="Defines the number of items to be displayed on a page. If 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"),
+):
+    """List Dialed Number Mapping(s)."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number"
+    params = {}
+    if filter_param is not None:
+        params["filter"] = filter_param
+    if attributes is not None:
+        params["attributes"] = attributes
+    if page is not None:
+        params["page"] = page
+    if page_size is not None:
+        params["pageSize"] = page_size
+    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"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("create")
+def create(
+    organization_id: str = typer.Option(None, "--organization-id", help="ID of the contact center organization. This field is require"),
+    id_param: str = typer.Option(None, "--id", help="ID of this contact center resource. It should not be specifi"),
+    version: str = typer.Option(None, "--version", help="The version of this resource. For a newly created resource,"),
+    dialled_number: str = typer.Option(None, "--dialled-number", help="The dialed number(DN) used to map to entry points."),
+    extension: str = typer.Option(None, "--extension", help="The extension used to map to entry points."),
+    routing_prefix: str = typer.Option(None, "--routing-prefix", help="The routing prefix is mapped to a location and can be prefix"),
+    esn: str = typer.Option(None, "--esn", help="The esn is routing prefix with extension"),
+    route_point_id: str = typer.Option(None, "--route-point-id", help="The identifier of a route point of WxC which is similar to e"),
+    entry_point_id: str = typer.Option(None, "--entry-point-id", help="(required) The identifier of an entry point to which you want to map th"),
+    entry_point_name: str = typer.Option(None, "--entry-point-name", help="(required) The entryPoint name of the entryPointId."),
+    default_ani: bool = typer.Option(None, "--default-ani/--no-default-ani", help="The default dial number for the tenant to make outdial calls"),
+    location: str = typer.Option(None, "--location", help="The name of the location as configured on Webex Calling(appl"),
+    region_id: str = typer.Option(None, "--region-id", help="Specify the telephony region id.  You can pass id for one of"),
+    created_time: str = typer.Option(None, "--created-time", help="This is the created time of the entity."),
+    last_updated_time: str = typer.Option(None, "--last-updated-time", help="This is the updated time of the entity."),
+    dialled_number_digits: str = typer.Option(None, "--dialled-number-digits", help=""),
+    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 new Dialed Number Mapping."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if organization_id is not None:
+            body["organizationId"] = organization_id
+        if id_param is not None:
+            body["id"] = id_param
+        if version is not None:
+            body["version"] = version
+        if dialled_number is not None:
+            body["dialledNumber"] = dialled_number
+        if extension is not None:
+            body["extension"] = extension
+        if routing_prefix is not None:
+            body["routingPrefix"] = routing_prefix
+        if esn is not None:
+            body["esn"] = esn
+        if route_point_id is not None:
+            body["routePointId"] = route_point_id
+        if entry_point_id is not None:
+            body["entryPointId"] = entry_point_id
+        if entry_point_name is not None:
+            body["entryPointName"] = entry_point_name
+        if default_ani is not None:
+            body["defaultAni"] = default_ani
+        if location is not None:
+            body["location"] = location
+        if region_id is not None:
+            body["regionId"] = region_id
+        if created_time is not None:
+            body["createdTime"] = created_time
+        if last_updated_time is not None:
+            body["lastUpdatedTime"] = last_updated_time
+        if dialled_number_digits is not None:
+            body["dialledNumberDigits"] = dialled_number_digits
+        _missing = [f for f in ['entryPointId', 'entryPointName'] 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("delete")
+def delete(
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Delete all Dialed Number Mapping(s)."""
+    if not force:
+        typer.confirm(f"Delete {orgid}?", abort=True)
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number"
+    try:
+        api.session.rest_delete(url)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Deleted: {orgid}")
+
+
+
+@app.command("create-bulk")
+def create_bulk(
+    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"),
+):
+    """Bulk save Dialed Number Mapping(s)\n\nExample --json-body:\n  '{"items":[{"itemIdentifier":"...","item":"...","requestAction":"..."}]}'."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number/bulk"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+    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("list-bulk-export")
+def list_bulk_export(
+    page: str = typer.Option(None, "--page", help="Defines the number of displayed page. The page number starts"),
+    page_size: str = typer.Option(None, "--page-size", help="Defines the number of items to be displayed on a page. If 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"),
+):
+    """Bulk export Dialed Number Mapping(s)."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number/bulk-export"
+    params = {}
+    if page is not None:
+        params["page"] = page
+    if page_size is not None:
+        params["pageSize"] = page_size
+    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"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("list-numbers-only")
+def list_numbers_only(
+    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  only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number/numbers-only"
+    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"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("show")
+def show(
+    id: str = typer.Argument(help="id"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get specific Dialed Number Mapping by ID."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number/{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("update")
+def update(
+    id: str = typer.Argument(help="id"),
+    organization_id: str = typer.Option(None, "--organization-id", help="ID of the contact center organization. This field is require"),
+    id_param: str = typer.Option(None, "--id", help="ID of this contact center resource. It should not be specifi"),
+    version: str = typer.Option(None, "--version", help="The version of this resource. For a newly created resource,"),
+    dialled_number: str = typer.Option(None, "--dialled-number", help="The dialed number(DN) used to map to entry points."),
+    extension: str = typer.Option(None, "--extension", help="The extension used to map to entry points."),
+    routing_prefix: str = typer.Option(None, "--routing-prefix", help="The routing prefix is mapped to a location and can be prefix"),
+    esn: str = typer.Option(None, "--esn", help="The esn is routing prefix with extension"),
+    route_point_id: str = typer.Option(None, "--route-point-id", help="The identifier of a route point of WxC which is similar to e"),
+    entry_point_id: str = typer.Option(None, "--entry-point-id", help="The identifier of an entry point to which you want to map th"),
+    entry_point_name: str = typer.Option(None, "--entry-point-name", help="The entryPoint name of the entryPointId."),
+    default_ani: bool = typer.Option(None, "--default-ani/--no-default-ani", help="The default dial number for the tenant to make outdial calls"),
+    location: str = typer.Option(None, "--location", help="The name of the location as configured on Webex Calling(appl"),
+    region_id: str = typer.Option(None, "--region-id", help="Specify the telephony region id.  You can pass id for one of"),
+    created_time: str = typer.Option(None, "--created-time", help="This is the created time of the entity."),
+    last_updated_time: str = typer.Option(None, "--last-updated-time", help="This is the updated time of the entity."),
+    dialled_number_digits: str = typer.Option(None, "--dialled-number-digits", help=""),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Update specific Dialed Number Mapping by ID."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number/{id}"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if organization_id is not None:
+            body["organizationId"] = organization_id
+        if id_param is not None:
+            body["id"] = id_param
+        if version is not None:
+            body["version"] = version
+        if dialled_number is not None:
+            body["dialledNumber"] = dialled_number
+        if extension is not None:
+            body["extension"] = extension
+        if routing_prefix is not None:
+            body["routingPrefix"] = routing_prefix
+        if esn is not None:
+            body["esn"] = esn
+        if route_point_id is not None:
+            body["routePointId"] = route_point_id
+        if entry_point_id is not None:
+            body["entryPointId"] = entry_point_id
+        if entry_point_name is not None:
+            body["entryPointName"] = entry_point_name
+        if default_ani is not None:
+            body["defaultAni"] = default_ani
+        if location is not None:
+            body["location"] = location
+        if region_id is not None:
+            body["regionId"] = region_id
+        if created_time is not None:
+            body["createdTime"] = created_time
+        if last_updated_time is not None:
+            body["lastUpdatedTime"] = last_updated_time
+        if dialled_number_digits is not None:
+            body["dialledNumberDigits"] = dialled_number_digits
+    try:
+        result = api.session.rest_put(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("delete-dial-number")
+def delete_dial_number(
+    id: str = typer.Argument(help="id"),
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Delete specific Dialed Number Mapping by ID."""
+    if not force:
+        typer.confirm(f"Delete {id}?", abort=True)
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number/{id}"
+    try:
+        api.session.rest_delete(url)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Deleted: {id}")
+
+
+
+@app.command("list-incoming-references")
+def list_incoming_references(
+    id: str = typer.Argument(help="id"),
+    type_param: str = typer.Option(None, "--type", help="Entity type of the other entity that has a reference to this"),
+    page: str = typer.Option(None, "--page", help="Defines the number of displayed page. The page number starts"),
+    page_size: str = typer.Option(None, "--page-size", help="Defines the number of items to be displayed on a page. If 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"),
+):
+    """List references for a specific Dialed Number Mapping."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/dial-number/{id}/incoming-references"
+    params = {}
+    if type_param is not None:
+        params["type"] = type_param
+    if page is not None:
+        params["page"] = page
+    if page_size is not None:
+        params["pageSize"] = page_size
+    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"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("list-dial-number-v2")
+def list_dial_number_v2(
+    filter_param: str = typer.Option(None, "--filter", help="Specify a filter based on which the results will be fetched."),
+    attributes: str = typer.Option(None, "--attributes", help="Specify the attributes to be returned. By default, all attri"),
+    search: str = typer.Option(None, "--search", help="Filter data based on the search keyword.Supported search col"),
+    page: str = typer.Option(None, "--page", help="Defines the number of displayed page. The page number starts"),
+    page_size: str = typer.Option(None, "--page-size", help="Defines the number of items to be displayed on a page. If th"),
+    include_entry_point_name: str = typer.Option(None, "--include-entry-point-name", help="If includeEntryPointName is set to true and entryPointName i"),
+    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 Dialed Number Mapping(s)."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/v2/dial-number"
+    params = {}
+    if filter_param is not None:
+        params["filter"] = filter_param
+    if attributes is not None:
+        params["attributes"] = attributes
+    if search is not None:
+        params["search"] = search
+    if page is not None:
+        params["page"] = page
+    if page_size is not None:
+        params["pageSize"] = page_size
+    if include_entry_point_name is not None:
+        params["includeEntryPointName"] = include_entry_point_name
+    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"), ("Name", "name")], limit=limit)
+
+
+
+@app.command("list-dial-number-v3")
+def list_dial_number_v3(
+    filter_param: str = typer.Option(None, "--filter", help="Specify a filter based on which the results will be fetched."),
+    attributes: str = typer.Option(None, "--attributes", help="Specify the attributes to be returned. By default, all attri"),
+    search: str = typer.Option(None, "--search", help="Filter data based on the search keyword.Supported search col"),
+    page: str = typer.Option(None, "--page", help="Defines the number of displayed page. The page number starts"),
+    page_size: str = typer.Option(None, "--page-size", help="Defines the number of items to be displayed on a page. If th"),
+    include_entry_point_name: str = typer.Option(None, "--include-entry-point-name", help="If includeEntryPointName is set to true and entryPointName i"),
+    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 Dialed Number Mapping(s)."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    orgid = get_cc_org_id(api.session)
+    url = f"{cc_base_url}/organization/{orgid}/v3/dial-number"
+    params = {}
+    if filter_param is not None:
+        params["filter"] = filter_param
+    if attributes is not None:
+        params["attributes"] = attributes
+    if search is not None:
+        params["search"] = search
+    if page is not None:
+        params["page"] = page
+    if page_size is not None:
+        params["pageSize"] = page_size
+    if include_entry_point_name is not None:
+        params["includeEntryPointName"] = include_entry_point_name
+    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"), ("Name", "name")], limit=limit)
+
+