---
argument_specs:
  main:
    description:
      - Sets up a mautrix-whatsapp bridge
    options:
      mautrix_whatsapp_homeserver_name:
        description: Matrix server name of homeserver the bridge is connected to.
        type: str
        required: true
      mautrix_whatsapp_as_token:
        description: A secret token that the application service will use to authenticate requests to the homeserver
        type: str
        required: true
      mautrix_whatsapp_hs_token:
        description: A secret token that the homeserver will use authenticate requests to the application service
        type: str
        required: true
      mautrix_whatsapp_doublepuppet_token:
        description: Double puppeting as token to impersonate matrix users
        type: str
        required: true
      mautrix_whatsapp_os_name:
        description: Device name that's shown in the "WhatsApp Web" section in the mobile app
        type: str
        required: false
        default: Matrix bridge
      mautrix_whatsapp_bot_displayname:
        description: Display name for the bridge bot
        type: str
        required: false
        default: WhatsApp bridge
      mautrix_whatsapp_default_relays:
        description: List of user login IDs which anyone can set as a relay, as long as the relay user is in the room
        type: list
        required: false
        default: []
        elements: str
      mautrix_whatsapp_permissions:
        description: Permissions for using the bridge. All users are given the relay permission regardless of this.
        type: list
        required: false
        default: []
        elements: dict
        options:
          key:
            description: Domain or user id to apply permission value to
            type: str
            required: true
          value:
            description: Permission value to apply
            type: str
            required: true
            choices:
              - commands
              - user
              - admin