wxcli 1.2.0__py3-none-any.whl

wxcli/commands/memberships.py

@@ -0,0 +1,164 @@
+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 memberships.")
+
+
+@app.command("list")
+def cmd_list(
+    room_id: str = typer.Option(None, "--room-id", help="List memberships associated with a room, by ID."),
+    person_id: str = typer.Option(None, "--person-id", help="List memberships associated with a person, by ID. The `roomI"),
+    person_email: str = typer.Option(None, "--person-email", help="List memberships associated with a person, by email address."),
+    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 Memberships."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/memberships"
+    params = {}
+    if room_id is not None:
+        params["roomId"] = room_id
+    if person_id is not None:
+        params["personId"] = person_id
+    if person_email is not None:
+        params["personEmail"] = person_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'), ('Person', 'personDisplayName'), ('Email', 'personEmail'), ('Moderator', 'isModerator')], limit=limit)
+
+
+
+@app.command("create")
+def create(
+    room_id: str = typer.Option(None, "--room-id", help="(required) The room ID."),
+    person_id: str = typer.Option(None, "--person-id", help="The person ID."),
+    person_email: str = typer.Option(None, "--person-email", help="The email address of the person."),
+    is_moderator: bool = typer.Option(None, "--is-moderator/--no-is-moderator", help="Whether or not the participant is a room moderator."),
+    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 Membership."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/memberships"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if room_id is not None:
+            body["roomId"] = room_id
+        if person_id is not None:
+            body["personId"] = person_id
+        if person_email is not None:
+            body["personEmail"] = person_email
+        if is_moderator is not None:
+            body["isModerator"] = is_moderator
+        _missing = [f for f in ['roomId'] 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(
+    membership_id: str = typer.Argument(help="membershipId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Membership Details."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/memberships/{membership_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(
+    membership_id: str = typer.Argument(help="membershipId"),
+    is_moderator: bool = typer.Option(None, "--is-moderator/--no-is-moderator", help="Whether or not the participant is a room moderator."),
+    is_room_hidden: bool = typer.Option(None, "--is-room-hidden/--no-is-room-hidden", help="When set to true, hides direct spaces in the teams client. A"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Update a Membership."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/memberships/{membership_id}"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if is_moderator is not None:
+            body["isModerator"] = is_moderator
+        if is_room_hidden is not None:
+            body["isRoomHidden"] = is_room_hidden
+    try:
+        result = api.session.rest_put(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("delete")
+def delete(
+    membership_id: str = typer.Argument(help="membershipId"),
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Delete a Membership."""
+    if not force:
+        typer.confirm(f"Delete {membership_id}?", abort=True)
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/memberships/{membership_id}"
+    try:
+        api.session.rest_delete(url)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Deleted: {membership_id}")
+
+

wxcli/commands/messages.py

@@ -0,0 +1,213 @@
+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 messages.")
+
+
+@app.command("list")
+def cmd_list(
+    room_id: str = typer.Option(..., "--room-id", help="List messages in a room, by ID."),
+    parent_id: str = typer.Option(None, "--parent-id", help="List messages with a parent, by ID."),
+    mentioned_people: str = typer.Option(None, "--mentioned-people", help="List messages with these people mentioned, by ID. Use `me` a"),
+    before: str = typer.Option(None, "--before", help="List messages sent before a date and time."),
+    before_message: str = typer.Option(None, "--before-message", help="List messages sent before a message, by ID."),
+    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 Messages."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/messages"
+    params = {}
+    if room_id is not None:
+        params["roomId"] = room_id
+    if parent_id is not None:
+        params["parentId"] = parent_id
+    if mentioned_people is not None:
+        params["mentionedPeople"] = mentioned_people
+    if before is not None:
+        params["before"] = before
+    if before_message is not None:
+        params["beforeMessage"] = before_message
+    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'), ('Person Email', 'personEmail'), ('Text', 'text')], limit=limit)
+
+
+
+@app.command("create")
+def create(
+    room_id: str = typer.Option(None, "--room-id", help="The room ID of the message."),
+    parent_id: str = typer.Option(None, "--parent-id", help="The parent message to reply to."),
+    to_person_id: str = typer.Option(None, "--to-person-id", help="The person ID of the recipient when sending a private 1:1 me"),
+    to_person_email: str = typer.Option(None, "--to-person-email", help="The email address of the recipient when sending a private 1:"),
+    text: str = typer.Option(None, "--text", help="The message, in plain text. If `markdown` is specified this"),
+    markdown: str = typer.Option(None, "--markdown", help="The message, in Markdown format. The maximum message length"),
+    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 Message\n\nExample --json-body:\n  '{"roomId":"...","parentId":"...","toPersonId":"...","toPersonEmail":"...","text":"...","markdown":"...","files":["..."],"attachments":[{"content":"..."}]}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/messages"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if room_id is not None:
+            body["roomId"] = room_id
+        if parent_id is not None:
+            body["parentId"] = parent_id
+        if to_person_id is not None:
+            body["toPersonId"] = to_person_id
+        if to_person_email is not None:
+            body["toPersonEmail"] = to_person_email
+        if text is not None:
+            body["text"] = text
+        if markdown is not None:
+            body["markdown"] = markdown
+    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-direct")
+def list_direct(
+    parent_id: str = typer.Option(None, "--parent-id", help="List messages with a parent, by ID."),
+    person_id: str = typer.Option(None, "--person-id", help="List messages in a 1:1 room, by person ID."),
+    person_email: str = typer.Option(None, "--person-email", help="List messages in a 1:1 room, by person email."),
+    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 Direct Messages."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/messages/direct"
+    params = {}
+    if parent_id is not None:
+        params["parentId"] = parent_id
+    if person_id is not None:
+        params["personId"] = person_id
+    if person_email is not None:
+        params["personEmail"] = person_email
+    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'), ('Person Email', 'personEmail'), ('Text', 'text')], limit=limit)
+
+
+
+@app.command("show")
+def show(
+    message_id: str = typer.Argument(help="messageId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Message Details."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/messages/{message_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(
+    message_id: str = typer.Argument(help="messageId"),
+    room_id: str = typer.Option(None, "--room-id", help="The room ID of the message."),
+    text: str = typer.Option(None, "--text", help="The message, in plain text. If `markdown` is specified this"),
+    markdown: str = typer.Option(None, "--markdown", help="The message, in Markdown format. If this attribute is set en"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Edit a Message."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/messages/{message_id}"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if room_id is not None:
+            body["roomId"] = room_id
+        if text is not None:
+            body["text"] = text
+        if markdown is not None:
+            body["markdown"] = markdown
+    try:
+        result = api.session.rest_put(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("delete")
+def delete(
+    message_id: str = typer.Argument(help="messageId"),
+    force: bool = typer.Option(False, "--force", help="Skip confirmation"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Delete a Message."""
+    if not force:
+        typer.confirm(f"Delete {message_id}?", abort=True)
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/messages/{message_id}"
+    try:
+        api.session.rest_delete(url)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Deleted: {message_id}")
+
+

wxcli/commands/mode_management.py

@@ -0,0 +1,244 @@
+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 mode-management.")
+
+
+@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"),
+):
+    """Get Mode Management Features."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features"
+    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("features", 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-common-modes")
+def list_common_modes(
+    feature_ids: str = typer.Option(..., "--feature-ids", help="List of feature IDs (comma-separated) for auto attendants, c"),
+    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 Common Modes."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/commonModes"
+    params = {}
+    if feature_ids is not None:
+        params["featureIds"] = feature_ids
+    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("commonModeNames", 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("switch-mode-for-invoke")
+def switch_mode_for_invoke(
+    operating_mode_name: str = typer.Option(None, "--operating-mode-name", help="Name of the common operating mode to be set as current opera"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Switch Mode for Multiple Features\n\nExample --json-body:\n  '{"featureIds":["..."],"operatingModeName":"..."}'."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/actions/switchMode/invoke"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if operating_mode_name is not None:
+            body["operatingModeName"] = operating_mode_name
+    try:
+        result = api.session.rest_post(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    print_json(result)
+
+
+
+@app.command("show")
+def show(
+    feature_id: str = typer.Argument(help="featureId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Mode Management Feature."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/{feature_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("show-normal-operation-mode")
+def show_normal_operation_mode(
+    feature_id: str = typer.Argument(help="featureId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Normal Operation Mode."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/{feature_id}/normalOperationMode"
+    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("show-modes")
+def show_modes(
+    feature_id: str = typer.Argument(help="featureId"),
+    mode_id: str = typer.Argument(help="modeId"),
+    output: str = typer.Option("json", "--output", "-o", help="Output format: table|json"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Get Operating Mode."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/{feature_id}/modes/{mode_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("switch-to-normal")
+def switch_to_normal(
+    feature_id: str = typer.Argument(help="featureId"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Switch to Normal Operation."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/{feature_id}/actions/switchToNormalOperation/invoke"
+    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)
+    print_json(result)
+
+
+
+@app.command("switch-mode-for-invoke-1")
+def switch_mode_for_invoke_1(
+    feature_id: str = typer.Argument(help="featureId"),
+    operating_mode_id: str = typer.Option(None, "--operating-mode-id", help="Operating mode ID to switch to"),
+    is_manual_switchback_enabled: str = typer.Option(None, "--is-manual-switchback-enabled", help="Determines if switch back will be manual (if true) or automa"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Switch Mode for Single Feature."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/{feature_id}/actions/switchMode/invoke"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if operating_mode_id is not None:
+            body["operatingModeId"] = operating_mode_id
+        if is_manual_switchback_enabled is not None:
+            body["isManualSwitchbackEnabled"] = is_manual_switchback_enabled
+    try:
+        result = api.session.rest_post(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    print_json(result)
+
+
+
+@app.command("extend-current-operating")
+def extend_current_operating(
+    feature_id: str = typer.Argument(help="featureId"),
+    operating_mode_id: str = typer.Option(None, "--operating-mode-id", help="Unique identifier for the operating mode for which the exten"),
+    extension_time: str = typer.Option(None, "--extension-time", help="Extension time in minutes (must be multiple of 30). If not s"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Extend Current Operating Mode Duration."""
+    api = get_api(debug=debug)
+    url = f"https://webexapis.com/v1/telephony/config/people/me/settings/modeManagement/features/{feature_id}/actions/extendMode/invoke"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if operating_mode_id is not None:
+            body["operatingModeId"] = operating_mode_id
+        if extension_time is not None:
+            body["extensionTime"] = extension_time
+    try:
+        result = api.session.rest_post(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    print_json(result)
+
+