Skip to content

CreateBotRequest

Source code in docs_src/capo_wickr/types/create_bot_request.py
class CreateBotRequest(TypedDict, closed=True):
    network_id: "capo_wickr.types.network_id.NetworkId"
    """<p>The ID of the Wickr network where the bot will be created.</p>"""
    username: "capo_wickr.types.generic_string.GenericString"
    """<p>The username for the bot. This must be unique within the network and follow the network's naming conventions.</p>"""
    display_name: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The display name for the bot that will be visible to users in the network.</p>"""
    group_id: "capo_wickr.types.generic_string.GenericString"
    """<p>The ID of the security group to which the bot will be assigned.</p>"""
    challenge: "capo_wickr.types.sensitive_string.SensitiveString"
    """<p>The password for the bot account.</p>"""

challenge instance-attribute

challenge: SensitiveString

The password for the bot account.

display_name instance-attribute

display_name: NotRequired[GenericString]

The display name for the bot that will be visible to users in the network.

group_id instance-attribute

group_id: GenericString

The ID of the security group to which the bot will be assigned.

network_id instance-attribute

network_id: NetworkId

The ID of the Wickr network where the bot will be created.

username instance-attribute

username: GenericString

The username for the bot. This must be unique within the network and follow the network's naming conventions.