wxcli 1.2.0__py3-none-any.whl

wxcli/commands/cc_agents.py

@@ -0,0 +1,425 @@
+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, get_cc_base_url, get_cc_org_id
+
+
+app = typer.Typer(help="Manage Webex Contact Center cc-agents.")
+
+
+@app.command("create")
+def create(
+    dial_number: str = typer.Option(None, "--dial-number", help="(required) A dialNumber field contains the number to dial such as a rou"),
+    team_id: str = typer.Option(None, "--team-id", help="The unique ID representing a team of users. Leaving this fie"),
+    is_extension: bool = typer.Option(None, "--is-extension/--no-is-extension", help="It indicates if the dialNumber field is full number or exten"),
+    device_type: str = typer.Option(None, "--device-type", help="It represents the way to differentiate type of login request"),
+    device_id: str = typer.Option(None, "--device-id", help="It is equal to dialNumber for AGENT_DN & EXTENSION deviceTyp"),
+    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"),
+):
+    """Login\n\nExample --json-body:\n  '{"dialNumber":"...","roles":["..."],"teamId":"...","isExtension":true,"deviceType":"...","deviceId":"..."}'."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/agents/login"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if dial_number is not None:
+            body["dialNumber"] = dial_number
+        if team_id is not None:
+            body["teamId"] = team_id
+        if is_extension is not None:
+            body["isExtension"] = is_extension
+        if device_type is not None:
+            body["deviceType"] = device_type
+        if device_id is not None:
+            body["deviceId"] = device_id
+        _missing = [f for f in ['dialNumber'] 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("update")
+def update(
+    logout_reason: str = typer.Option(None, "--logout-reason", help="The reason for performing logout operation, maximum length 1"),
+    agent_id: str = typer.Option(None, "--agent-id", help="Unique ID of the user who is being logged out, maximum lengt"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Logout."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/agents/logout"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if logout_reason is not None:
+            body["logoutReason"] = logout_reason
+        if agent_id is not None:
+            body["agentId"] = agent_id
+    try:
+        result = api.session.rest_put(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("update-state-session")
+def update_state_session(
+    state: str = typer.Option(None, "--state", help="It represents the current state of the user. Can be set to `"),
+    aux_code_id: str = typer.Option(None, "--aux-code-id", help="Auxiliary Codes are status codes which an agent can select i"),
+    last_state_change_reason: str = typer.Option(None, "--last-state-change-reason", help="It represents the reason of the last state change request, m"),
+    agent_id: str = typer.Option(None, "--agent-id", help="User for which state change is initiated, maximum length 36"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """State Change."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/agents/session/state"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if state is not None:
+            body["state"] = state
+        if aux_code_id is not None:
+            body["auxCodeId"] = aux_code_id
+        if last_state_change_reason is not None:
+            body["lastStateChangeReason"] = last_state_change_reason
+        if agent_id is not None:
+            body["agentId"] = agent_id
+    try:
+        result = api.session.rest_put(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("create-reload-agents")
+def create_reload_agents(
+    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"),
+):
+    """Reload."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/agents/reload"
+    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("create-buddy-list")
+def create_buddy_list(
+    agent_profile_id: str = typer.Option(None, "--agent-profile-id", help="(required) The profile ID of a particular agent. Can be obtained from ["),
+    media_type: str = typer.Option(None, "--media-type", help="(required) The media type for the request. The supported values are ```"),
+    state: str = typer.Option(None, "--state", help="It represents the current state of the returned agents which"),
+    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"),
+):
+    """Buddy Agents List."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/agents/buddyList"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if agent_profile_id is not None:
+            body["agentProfileId"] = agent_profile_id
+        if media_type is not None:
+            body["mediaType"] = media_type
+        if state is not None:
+            body["state"] = state
+        _missing = [f for f in ['agentProfileId', 'mediaType'] 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("list")
+def cmd_list(
+    agent_ids: str = typer.Option(None, "--agent-ids", help="Filter agent activities by agent ids separated with commas i"),
+    team_ids: str = typer.Option(None, "--team-ids", help="Filter agent activities by team ids separated with commas if"),
+    channel_types: str = typer.Option(None, "--channel-types", help="Channel type(s) permitted in response. Separate values with"),
+    from_param: str = typer.Option(..., "--from", help="Filter agent activities created after given epoch timestamp"),
+    to: str = typer.Option(None, "--to", help="Filter agent activities created before given epoch timestamp"),
+    page_size: str = typer.Option(None, "--page-size", help="Maximum page size in response. Maximum allowed value is 1000"),
+    page: str = typer.Option(None, "--page", help="Page number to be passed. Maximum number of records that can"),
+    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 Agent Activities."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/agents/activities"
+    params = {}
+    if agent_ids is not None:
+        params["agentIds"] = agent_ids
+    if team_ids is not None:
+        params["teamIds"] = team_ids
+    if channel_types is not None:
+        params["channelTypes"] = channel_types
+    if from_param is not None:
+        params["from"] = from_param
+    if to is not None:
+        params["to"] = to
+    if page_size is not None:
+        params["pageSize"] = page_size
+    if page is not None:
+        params["page"] = page
+    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("data", 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-statistics")
+def list_statistics(
+    from_param: str = typer.Option(..., "--from", help="Start time for the query (in epoch milliseconds). Any epoch"),
+    to: str = typer.Option(..., "--to", help="End time for the query (in epoch milliseconds). Any epoch ti"),
+    interval: str = typer.Option(None, "--interval", help="Time interval (in minutes) to chunk statistics by i.e. break"),
+    agent_ids: str = typer.Option(None, "--agent-ids", help="Comma-separated list of agent IDs. A maximum of 100 values 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"),
+):
+    """Get Agent Statistics."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/agents/statistics"
+    params = {}
+    if from_param is not None:
+        params["from"] = from_param
+    if to is not None:
+        params["to"] = to
+    if interval is not None:
+        params["interval"] = interval
+    if agent_ids is not None:
+        params["agentIds"] = agent_ids
+    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("data", 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-login")
+def create_login(
+    dial_number: str = typer.Option(None, "--dial-number", help="(required) A dialNumber field contains the number to dial such as a rou"),
+    team_id: str = typer.Option(None, "--team-id", help="The unique ID representing a team of users. Leaving this fie"),
+    is_extension: bool = typer.Option(None, "--is-extension/--no-is-extension", help="It indicates if the dialNumber field is full number or exten"),
+    device_type: str = typer.Option(None, "--device-type", help="It represents the way to differentiate type of login request"),
+    device_id: str = typer.Option(None, "--device-id", help="It is equal to dialNumber for AGENT_DN & EXTENSION deviceTyp"),
+    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"),
+):
+    """Login\n\nExample --json-body:\n  '{"dialNumber":"...","roles":["..."],"teamId":"...","isExtension":true,"deviceType":"...","deviceId":"..."}'."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/v2/agents/login"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if dial_number is not None:
+            body["dialNumber"] = dial_number
+        if team_id is not None:
+            body["teamId"] = team_id
+        if is_extension is not None:
+            body["isExtension"] = is_extension
+        if device_type is not None:
+            body["deviceType"] = device_type
+        if device_id is not None:
+            body["deviceId"] = device_id
+        _missing = [f for f in ['dialNumber'] 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("update-logout")
+def update_logout(
+    logout_reason: str = typer.Option(None, "--logout-reason", help="The reason for performing logout operation, maximum length 1"),
+    agent_id: str = typer.Option(None, "--agent-id", help="Unique ID of the user who is being logged out, maximum lengt"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """Logout."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/v2/agents/logout"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if logout_reason is not None:
+            body["logoutReason"] = logout_reason
+        if agent_id is not None:
+            body["agentId"] = agent_id
+    try:
+        result = api.session.rest_put(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("update-state-session-1")
+def update_state_session_1(
+    state: str = typer.Option(None, "--state", help="It represents the current state of the user. Can be set to `"),
+    aux_code_id: str = typer.Option(None, "--aux-code-id", help="Auxiliary Codes are status codes which an agent can select i"),
+    reason: str = typer.Option(None, "--reason", help="It represents the reason of the last agent channel state cha"),
+    agent_id: str = typer.Option(None, "--agent-id", help="User for which agent channel state change is initiated, maxi"),
+    json_body: str = typer.Option(None, "--json-body", help="Full JSON body (overrides other options)"),
+    debug: bool = typer.Option(False, "--debug"),
+):
+    """State Change\n\nExample --json-body:\n  '{"channelType":["..."],"state":"...","auxCodeId":"...","reason":"...","agentId":"..."}'."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/v2/agents/session/state"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if state is not None:
+            body["state"] = state
+        if aux_code_id is not None:
+            body["auxCodeId"] = aux_code_id
+        if reason is not None:
+            body["reason"] = reason
+        if agent_id is not None:
+            body["agentId"] = agent_id
+    try:
+        result = api.session.rest_put(url, json=body)
+    except WebexError as e:
+        handle_rest_error(e)
+    typer.echo(f"Updated.")
+
+
+
+@app.command("create-reload-agents-1")
+def create_reload_agents_1(
+    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"),
+):
+    """Reload."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/v2/agents/reload"
+    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)
+
+

wxcli/commands/cc_ai_assistant.py

@@ -0,0 +1,55 @@
+import json
+import typer
+from wxcli.errors import WebexError, handle_rest_error
+from wxcli.auth import get_api
+from wxcli.output import print_table, print_json
+from wxcli.config import get_cc_base_url
+
+
+app = typer.Typer(help="Manage Webex Contact Center cc-ai-assistant.")
+
+
+@app.command("create")
+def create(
+    agent_id: str = typer.Option(None, "--agent-id", help="(required) Agent identifier"),
+    org_id: str = typer.Option(None, "--org-id", help="(required) Organization identifier"),
+    event_type: str = typer.Option(None, "--event-type", help="(required) Choices: CUSTOM_EVENT"),
+    event_name: str = typer.Option(None, "--event-name", help="(required) Choices: GET_SUGGESTIONS"),
+    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"),
+):
+    """Get suggestions\n\nExample --json-body:\n  '{"agentId":"...","orgId":"...","eventType":"CUSTOM_EVENT","eventName":"GET_SUGGESTIONS","eventDetails":{"data":{"interactionId":"...","actionTimeStamp":"...","trackingId":"...","languageCode":"...","aiAssistantSkillId":"...","source":"..."}}}'."""
+    api = get_api(debug=debug)
+    cc_base_url = get_cc_base_url()
+    url = f"{cc_base_url}/event"
+    if json_body:
+        body = json.loads(json_body)
+    else:
+        body = {}
+        if agent_id is not None:
+            body["agentId"] = agent_id
+        if org_id is not None:
+            body["orgId"] = org_id
+        if event_type is not None:
+            body["eventType"] = event_type
+        if event_name is not None:
+            body["eventName"] = event_name
+        _missing = [f for f in ['agentId', 'orgId', 'eventType', 'eventName'] 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)
+
+