Skip to content
Abra GraphQL APIs
/
Other
/
/
hubUpdatedNotification

GraphQL Overview

Download GraphQL schema
schema.graphql
Home

Queries

Overview

Mutations

Overview
Users

Queries

Overview

Mutations

Overview
Fire

Queries

Overview

Mutations

Overview
Water

Queries

Overview

Mutations

Overview
Access

Queries

Overview

Mutations

Overview
Energy

Queries

Overview

Mutations

Overview
Misc

Queries

Overview

Mutations

Overview
Other

Queries

Overview

Mutations

Overview

userAcceptInvitation

(...args)
UserAcceptInvitationPayload

Arguments

invitationId
ID!,non-nullrequired
token
String!,non-nullrequired

Return type

UserAcceptInvitationPayload
errors
[UserAcceptInvitationError!],non-null
Mutation sample
mutation userAcceptInvitation($invitationId: ID!, $token: String!) {
  userAcceptInvitation(invitationId: $invitationId, token: $token) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "invitationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "token": "Example String"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

userAccountSetRole

(...args)
UserAccountSetRolePayload

Arguments

userId
ID!,non-nullrequired
role
Role!,non-nullrequired

Return type

UserAccountSetRolePayload
errors
[UserAccountSetRoleError!]!,non-null
Mutation sample
mutation userAccountSetRole($userId: ID!, $role: Role!) {
  userAccountSetRole(userId: $userId, role: $role) {
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "role": "INSTALLER"
}
Response sample
{
  "data": {
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

userDelete

(id)
UserDeletePayload

Arguments

id
ID!,non-nullrequired

Return type

UserDeletePayload
id
ID
errors
[UserDeleteError!]!,non-null
Mutation sample
mutation userDelete($id: ID!) {
  userDelete(id: $id) {
    id 
    errors {
      message 
      path 
    }
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "errors": [
      {
        "message": "Example String",
        "path": "Example String"
      }
    ]
  }
}

commandUpdateNotification

(...args)
CommandUpdatePayload

Arguments

commandId
ID!,non-nullrequired
data
CommandUpdateInput!,non-nullrequired

Return type

CommandUpdatePayload
homeId
ID!,non-null
commandId
ID!,non-null
command
Command!,non-null
Mutation sample
mutation commandUpdateNotification($commandId: ID!, $data: CommandUpdateInput!) {
  commandUpdateNotification(commandId: $commandId, data: $data) {
    homeId 
    commandId 
    command {
      id 
      homeId 
      commandType 
      commandState 
      triggeredAt 
      source 
      target 
      deviceIds 
    }
  }
}
Variables
{
  "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "commandState": "FAILED"
  }
}
Response sample
{
  "data": {
    "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "command": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "commandType": "ALARM",
      "commandState": "FAILED",
      "triggeredAt": "Example String",
      "source": "CUSTOMER",
      "target": "DEVICE",
      "deviceIds": [
        "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      ]
    }
  }
}

updateNotificationCommand

(...args)
CommandUpdatedPayloadV2

Arguments

commandId
ID!,non-nullrequired
commandState
CommandState!,non-nullrequired

Return type

CommandUpdatedPayloadV2
commandId
ID!,non-null
commandState
CommandState!,non-null
Mutation sample
mutation updateNotificationCommand($commandId: ID!, $commandState: CommandState!) {
  updateNotificationCommand(commandId: $commandId, commandState: $commandState) {
    commandId 
    commandState 
  }
}
Variables
{
  "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "commandState": "FAILED"
}
Response sample
{
  "data": {
    "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "commandState": "FAILED"
  }
}

hubUpdatedNotification

(...args)
HubUpdatedPayload

Arguments

homeId
ID!,non-nullrequired
hubId
ID!,non-nullrequired

Return type

HubUpdatedPayload
homeId
ID!,non-null
hubId
ID!,non-null
hub
Hub!,non-null
Mutation sample
mutation hubUpdatedNotification($homeId: ID!, $hubId: ID!) {
  hubUpdatedNotification(homeId: $homeId, hubId: $hubId) {
    homeId 
    hubId 
    hub {
      id 
      name 
      hubType 
      productType 
      brandName 
      firmwareVersion 
      serialNumber 
      macAddress 
      manufacturerInformation 
      wasWaterSensorTapePreviouslyConnected 
      waterGuard {
        wasWaterSensorTapePreviouslyConnected 
        mode 
        tamperModeWarningTriggeredAt 
        tamperModeTriggersAt 
        overrideModeTriggeredAt 
        showLevel1Warning 
        showLevel2Warning 
      }
      hubTemplate {
        id 
        name 
        hubAssetUrl 
        hubWithBgAssetUrl 
        hubQrCodeAssetUrl 
        hubConnectionAssetUrl 
        hubSearchAssetUrl 
        waterLeakDetectorAssetUrl 
        waterLeakDetectorInstructionsAssetUrl 
        waterLeakDetectorHelpAssetUrl 
        waterSensorTapeAssetUrl 
        waterSensorTapeInstructionsAssetUrl 
        waterLeakSystemPressHubButtonAssetUrl 
        sintefLogoAssetUrl 
      }
      area {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      devices(
        # Arguments Here
      ) {
        id 
        deviceType 
        name 
        serialNumber 
        imei 
        macAddress 
        ipAddress 
        roomPlacement 
        manufacturer {
          id 
          name 
          logo {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
        }
        deviceTemplate(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          primaryPairingMode 
          secondaryPairingModes 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          imageWithBg {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          instructions {
            installation {
              __typename
              # ...DeviceInstructionItemFragment
            }
            configuration {
              __typename
              # ...DeviceInstructionItemFragment
            }
            help {
              __typename
              # ...DeviceInstructionItemFragment
            }
            connectionAssetUrl 
          }
        }
        image {
          url 
          urlSmall 
          urlMedium 
          urlLarge 
        }
        favorite 
        favoriteChangedAt 
        registeredAt 
        canBeUnregistered 
        firmwareVersion 
        latestFirmware {
          variant 
          version 
          downloadUrl 
        }
        relayConfiguration {
          supportedDeviceTypes 
          endDeviceType 
        }
        ioModuleConfiguration {
          supportedConfigurations 
          configuration 
        }
        area {
          id 
          areaName 
          areaType 
          size 
          floor 
          children 
          devices(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            serialNumber 
            imei 
            macAddress 
            ipAddress 
            roomPlacement 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            deviceTemplate(
              # Arguments Here
            ) {
              __typename
              # ...DeviceTemplateFragment
            }
            image {
              __typename
              # ...DeviceImageFragment
            }
            favorite 
            favoriteChangedAt 
            registeredAt 
            canBeUnregistered 
            firmwareVersion 
            latestFirmware {
              __typename
              # ...DeviceFirmwareFragment
            }
            relayConfiguration {
              __typename
              # ...DeviceRelayConfigurationFragment
            }
            ioModuleConfiguration {
              __typename
              # ...DeviceIoModuleConfigurationFragment
            }
            area {
              __typename
              # ...AreaFragment
            }
            traits {
              __typename
              # ...TraitFragment
            }
            accessPolicy {
              __typename
              # ...DeviceAccessPolicyFragment
            }
          }
          accessPolicies {
            actionType 
            create 
            update 
            delete 
            read 
          }
        }
        traits {
          traitType 
          commands 
          attributes {
            name 
            dataType 
            editable 
            availableArmLevels {
              __typename
              # ...ArmLevelFragment
            }
          }
        }
        accessPolicy {
          read 
          write 
          delete 
          expiresAt 
        }
      }
      repeaters {
        id 
        name 
        hubType 
        productType 
        brandName 
        firmwareVersion 
        serialNumber 
        macAddress 
        manufacturerInformation 
        wasWaterSensorTapePreviouslyConnected 
        waterGuard {
          wasWaterSensorTapePreviouslyConnected 
          mode 
          tamperModeWarningTriggeredAt 
          tamperModeTriggersAt 
          overrideModeTriggeredAt 
          showLevel1Warning 
          showLevel2Warning 
        }
        hubTemplate {
          id 
          name 
          hubAssetUrl 
          hubWithBgAssetUrl 
          hubQrCodeAssetUrl 
          hubConnectionAssetUrl 
          hubSearchAssetUrl 
          waterLeakDetectorAssetUrl 
          waterLeakDetectorInstructionsAssetUrl 
          waterLeakDetectorHelpAssetUrl 
          waterSensorTapeAssetUrl 
          waterSensorTapeInstructionsAssetUrl 
          waterLeakSystemPressHubButtonAssetUrl 
          sintefLogoAssetUrl 
        }
        area {
          id 
          areaName 
          areaType 
          size 
          floor 
          children 
          devices(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            serialNumber 
            imei 
            macAddress 
            ipAddress 
            roomPlacement 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            deviceTemplate(
              # Arguments Here
            ) {
              __typename
              # ...DeviceTemplateFragment
            }
            image {
              __typename
              # ...DeviceImageFragment
            }
            favorite 
            favoriteChangedAt 
            registeredAt 
            canBeUnregistered 
            firmwareVersion 
            latestFirmware {
              __typename
              # ...DeviceFirmwareFragment
            }
            relayConfiguration {
              __typename
              # ...DeviceRelayConfigurationFragment
            }
            ioModuleConfiguration {
              __typename
              # ...DeviceIoModuleConfigurationFragment
            }
            area {
              __typename
              # ...AreaFragment
            }
            traits {
              __typename
              # ...TraitFragment
            }
            accessPolicy {
              __typename
              # ...DeviceAccessPolicyFragment
            }
          }
          accessPolicies {
            actionType 
            create 
            update 
            delete 
            read 
          }
        }
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        repeaters {
          id 
          name 
          hubType 
          productType 
          brandName 
          firmwareVersion 
          serialNumber 
          macAddress 
          manufacturerInformation 
          wasWaterSensorTapePreviouslyConnected 
          waterGuard {
            wasWaterSensorTapePreviouslyConnected 
            mode 
            tamperModeWarningTriggeredAt 
            tamperModeTriggersAt 
            overrideModeTriggeredAt 
            showLevel1Warning 
            showLevel2Warning 
          }
          hubTemplate {
            id 
            name 
            hubAssetUrl 
            hubWithBgAssetUrl 
            hubQrCodeAssetUrl 
            hubConnectionAssetUrl 
            hubSearchAssetUrl 
            waterLeakDetectorAssetUrl 
            waterLeakDetectorInstructionsAssetUrl 
            waterLeakDetectorHelpAssetUrl 
            waterSensorTapeAssetUrl 
            waterSensorTapeInstructionsAssetUrl 
            waterLeakSystemPressHubButtonAssetUrl 
            sintefLogoAssetUrl 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          devices(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            serialNumber 
            imei 
            macAddress 
            ipAddress 
            roomPlacement 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            deviceTemplate(
              # Arguments Here
            ) {
              __typename
              # ...DeviceTemplateFragment
            }
            image {
              __typename
              # ...DeviceImageFragment
            }
            favorite 
            favoriteChangedAt 
            registeredAt 
            canBeUnregistered 
            firmwareVersion 
            latestFirmware {
              __typename
              # ...DeviceFirmwareFragment
            }
            relayConfiguration {
              __typename
              # ...DeviceRelayConfigurationFragment
            }
            ioModuleConfiguration {
              __typename
              # ...DeviceIoModuleConfigurationFragment
            }
            area {
              __typename
              # ...AreaFragment
            }
            traits {
              __typename
              # ...TraitFragment
            }
            accessPolicy {
              __typename
              # ...DeviceAccessPolicyFragment
            }
          }
          repeaters {
            id 
            name 
            hubType 
            productType 
            brandName 
            firmwareVersion 
            serialNumber 
            macAddress 
            manufacturerInformation 
            wasWaterSensorTapePreviouslyConnected 
            waterGuard {
              __typename
              # ...HubWaterGuardFragment
            }
            hubTemplate {
              __typename
              # ...HubTemplateFragment
            }
            area {
              __typename
              # ...AreaFragment
            }
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            repeaters {
              __typename
              # ...HubFragment
            }
            traits {
              __typename
              # ...TraitFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
        }
        traits {
          traitType 
          commands 
          attributes {
            name 
            dataType 
            editable 
            availableArmLevels {
              __typename
              # ...ArmLevelFragment
            }
          }
        }
      }
      traits {
        traitType 
        commands 
        attributes {
          name 
          dataType 
          editable 
          availableArmLevels {
            id 
            description 
          }
        }
      }
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "hubId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "hub": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "name": "Example String",
      "hubType": "GATEWAY",
      "productType": "HUB_4G",
      "brandName": "Example String",
      "firmwareVersion": "Example String",
      "serialNumber": "Example String",
      "macAddress": "Example String",
      "manufacturerInformation": "Example String",
      "wasWaterSensorTapePreviouslyConnected": true,
      "waterGuard": {
        "wasWaterSensorTapePreviouslyConnected": true,
        "mode": "NORMAL",
        "tamperModeWarningTriggeredAt": "Example String",
        "tamperModeTriggersAt": "Example String",
        "overrideModeTriggeredAt": "Example String",
        "showLevel1Warning": true,
        "showLevel2Warning": true
      },
      "hubTemplate": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String",
        "hubAssetUrl": "Example String",
        "hubWithBgAssetUrl": "Example String",
        "hubQrCodeAssetUrl": "Example String",
        "hubConnectionAssetUrl": "Example String",
        "hubSearchAssetUrl": "Example String",
        "waterLeakDetectorAssetUrl": "Example String",
        "waterLeakDetectorInstructionsAssetUrl": "Example String",
        "waterLeakDetectorHelpAssetUrl": "Example String",
        "waterSensorTapeAssetUrl": "Example String",
        "waterSensorTapeInstructionsAssetUrl": "Example String",
        "waterLeakSystemPressHubButtonAssetUrl": "Example String",
        "sintefLogoAssetUrl": "Example String"
      },
      "area": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "areaName": "Example String",
        "areaType": "BATHROOM",
        "size": 40,
        "floor": 40,
        "children": true,
        "devices": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "serialNumber": "Example String",
            "imei": "Example String",
            "macAddress": "Example String",
            "ipAddress": "Example String",
            "roomPlacement": "Example String",
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "deviceTemplate": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "primaryPairingMode": "PLUG",
              "secondaryPairingModes": [
                "PLUG"
              ],
              "manufacturer": {
                "__typename": "DeviceManufacturer"
              },
              "image": {
                "__typename": "DeviceTemplateImage"
              },
              "imageWithBg": {
                "__typename": "DeviceTemplateImage"
              },
              "instructions": {
                "__typename": "DeviceTemplateInstructions"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "favorite": true,
            "favoriteChangedAt": "Example String",
            "registeredAt": "Example String",
            "canBeUnregistered": true,
            "firmwareVersion": "Example String",
            "latestFirmware": [
              {
                "variant": "ROUTER",
                "version": "Example String",
                "downloadUrl": "Example String"
              }
            ],
            "relayConfiguration": {
              "supportedDeviceTypes": [
                "AIR_QUALITY_SENSOR"
              ],
              "endDeviceType": "AIR_QUALITY_SENSOR"
            },
            "ioModuleConfiguration": {
              "supportedConfigurations": [
                "BMS"
              ],
              "configuration": "BMS"
            },
            "area": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "areaName": "Example String",
              "areaType": "BATHROOM",
              "size": 40,
              "floor": 40,
              "children": true,
              "devices": [
                {
                  "__typename": "Device"
                }
              ],
              "accessPolicies": [
                {
                  "__typename": "HomeProfileActionAccess"
                }
              ]
            },
            "traits": [
              {
                "traitType": "ARM_DISARM",
                "commands": [
                  "ALARM"
                ],
                "attributes": [
                  {
                    "__typename": "TraitAttributeAvailableArmLevels"
                  }
                ]
              }
            ],
            "accessPolicy": {
              "read": true,
              "write": true,
              "delete": true,
              "expiresAt": "Example String"
            }
          }
        ],
        "accessPolicies": [
          {
            "actionType": "ALARMS_AND_NOTIFICATIONS",
            "create": true,
            "update": true,
            "delete": true,
            "read": true
          }
        ]
      },
      "devices": [
        {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "deviceType": "AIR_QUALITY_SENSOR",
          "name": "Example String",
          "serialNumber": "Example String",
          "imei": "Example String",
          "macAddress": "Example String",
          "ipAddress": "Example String",
          "roomPlacement": "Example String",
          "manufacturer": {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "name": "Example String",
            "logo": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            }
          },
          "deviceTemplate": {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "deviceType": "AIR_QUALITY_SENSOR",
            "name": "Example String",
            "primaryPairingMode": "PLUG",
            "secondaryPairingModes": [
              "PLUG"
            ],
            "manufacturer": {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "logo": {
                "__typename": "DeviceManufacturerLogo"
              }
            },
            "image": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "imageWithBg": {
              "url": "Example String",
              "urlSmall": "Example String",
              "urlMedium": "Example String",
              "urlLarge": "Example String"
            },
            "instructions": {
              "installation": [
                {
                  "__typename": "DeviceInstructionItem"
                }
              ],
              "configuration": [
                {
                  "__typename": "DeviceInstructionItem"
                }
              ],
              "help": [
                {
                  "__typename": "DeviceInstructionItem"
                }
              ],
              "connectionAssetUrl": "Example String"
            }
          },
          "image": {
            "url": "Example String",
            "urlSmall": "Example String",
            "urlMedium": "Example String",
            "urlLarge": "Example String"
          },
          "favorite": true,
          "favoriteChangedAt": "Example String",
          "registeredAt": "Example String",
          "canBeUnregistered": true,
          "firmwareVersion": "Example String",
          "latestFirmware": [
            {
              "variant": "ROUTER",
              "version": "Example String",
              "downloadUrl": "Example String"
            }
          ],
          "relayConfiguration": {
            "supportedDeviceTypes": [
              "AIR_QUALITY_SENSOR"
            ],
            "endDeviceType": "AIR_QUALITY_SENSOR"
          },
          "ioModuleConfiguration": {
            "supportedConfigurations": [
              "BMS"
            ],
            "configuration": "BMS"
          },
          "area": {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "areaName": "Example String",
            "areaType": "BATHROOM",
            "size": 40,
            "floor": 40,
            "children": true,
            "devices": [
              {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "deviceType": "AIR_QUALITY_SENSOR",
                "name": "Example String",
                "serialNumber": "Example String",
                "imei": "Example String",
                "macAddress": "Example String",
                "ipAddress": "Example String",
                "roomPlacement": "Example String",
                "manufacturer": {
                  "__typename": "DeviceManufacturer"
                },
                "deviceTemplate": {
                  "__typename": "DeviceTemplate"
                },
                "image": {
                  "__typename": "DeviceImage"
                },
                "favorite": true,
                "favoriteChangedAt": "Example String",
                "registeredAt": "Example String",
                "canBeUnregistered": true,
                "firmwareVersion": "Example String",
                "latestFirmware": [
                  {
                    "__typename": "DeviceFirmware"
                  }
                ],
                "relayConfiguration": {
                  "__typename": "DeviceRelayConfiguration"
                },
                "ioModuleConfiguration": {
                  "__typename": "DeviceIoModuleConfiguration"
                },
                "area": {
                  "__typename": "Area"
                },
                "traits": [
                  {
                    "__typename": "Trait"
                  }
                ],
                "accessPolicy": {
                  "__typename": "DeviceAccessPolicy"
                }
              }
            ],
            "accessPolicies": [
              {
                "actionType": "ALARMS_AND_NOTIFICATIONS",
                "create": true,
                "update": true,
                "delete": true,
                "read": true
              }
            ]
          },
          "traits": [
            {
              "traitType": "ARM_DISARM",
              "commands": [
                "ALARM"
              ],
              "attributes": [
                {
                  "name": "Example String",
                  "dataType": "ALARM_TYPE",
                  "editable": true,
                  "availableArmLevels": [
                    {
                      "__typename": "ArmLevel"
                    }
                  ]
                }
              ]
            }
          ],
          "accessPolicy": {
            "read": true,
            "write": true,
            "delete": true,
            "expiresAt": "Example String"
          }
        }
      ],
      "repeaters": [
        {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "name": "Example String",
          "hubType": "GATEWAY",
          "productType": "HUB_4G",
          "brandName": "Example String",
          "firmwareVersion": "Example String",
          "serialNumber": "Example String",
          "macAddress": "Example String",
          "manufacturerInformation": "Example String",
          "wasWaterSensorTapePreviouslyConnected": true,
          "waterGuard": {
            "wasWaterSensorTapePreviouslyConnected": true,
            "mode": "NORMAL",
            "tamperModeWarningTriggeredAt": "Example String",
            "tamperModeTriggersAt": "Example String",
            "overrideModeTriggeredAt": "Example String",
            "showLevel1Warning": true,
            "showLevel2Warning": true
          },
          "hubTemplate": {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "name": "Example String",
            "hubAssetUrl": "Example String",
            "hubWithBgAssetUrl": "Example String",
            "hubQrCodeAssetUrl": "Example String",
            "hubConnectionAssetUrl": "Example String",
            "hubSearchAssetUrl": "Example String",
            "waterLeakDetectorAssetUrl": "Example String",
            "waterLeakDetectorInstructionsAssetUrl": "Example String",
            "waterLeakDetectorHelpAssetUrl": "Example String",
            "waterSensorTapeAssetUrl": "Example String",
            "waterSensorTapeInstructionsAssetUrl": "Example String",
            "waterLeakSystemPressHubButtonAssetUrl": "Example String",
            "sintefLogoAssetUrl": "Example String"
          },
          "area": {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "areaName": "Example String",
            "areaType": "BATHROOM",
            "size": 40,
            "floor": 40,
            "children": true,
            "devices": [
              {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "deviceType": "AIR_QUALITY_SENSOR",
                "name": "Example String",
                "serialNumber": "Example String",
                "imei": "Example String",
                "macAddress": "Example String",
                "ipAddress": "Example String",
                "roomPlacement": "Example String",
                "manufacturer": {
                  "__typename": "DeviceManufacturer"
                },
                "deviceTemplate": {
                  "__typename": "DeviceTemplate"
                },
                "image": {
                  "__typename": "DeviceImage"
                },
                "favorite": true,
                "favoriteChangedAt": "Example String",
                "registeredAt": "Example String",
                "canBeUnregistered": true,
                "firmwareVersion": "Example String",
                "latestFirmware": [
                  {
                    "__typename": "DeviceFirmware"
                  }
                ],
                "relayConfiguration": {
                  "__typename": "DeviceRelayConfiguration"
                },
                "ioModuleConfiguration": {
                  "__typename": "DeviceIoModuleConfiguration"
                },
                "area": {
                  "__typename": "Area"
                },
                "traits": [
                  {
                    "__typename": "Trait"
                  }
                ],
                "accessPolicy": {
                  "__typename": "DeviceAccessPolicy"
                }
              }
            ],
            "accessPolicies": [
              {
                "actionType": "ALARMS_AND_NOTIFICATIONS",
                "create": true,
                "update": true,
                "delete": true,
                "read": true
              }
            ]
          },
          "devices": [
            {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "deviceType": "AIR_QUALITY_SENSOR",
              "name": "Example String",
              "serialNumber": "Example String",
              "imei": "Example String",
              "macAddress": "Example String",
              "ipAddress": "Example String",
              "roomPlacement": "Example String",
              "manufacturer": {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "name": "Example String",
                "logo": {
                  "__typename": "DeviceManufacturerLogo"
                }
              },
              "deviceTemplate": {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "deviceType": "AIR_QUALITY_SENSOR",
                "name": "Example String",
                "primaryPairingMode": "PLUG",
                "secondaryPairingModes": [
                  "PLUG"
                ],
                "manufacturer": {
                  "__typename": "DeviceManufacturer"
                },
                "image": {
                  "__typename": "DeviceTemplateImage"
                },
                "imageWithBg": {
                  "__typename": "DeviceTemplateImage"
                },
                "instructions": {
                  "__typename": "DeviceTemplateInstructions"
                }
              },
              "image": {
                "url": "Example String",
                "urlSmall": "Example String",
                "urlMedium": "Example String",
                "urlLarge": "Example String"
              },
              "favorite": true,
              "favoriteChangedAt": "Example String",
              "registeredAt": "Example String",
              "canBeUnregistered": true,
              "firmwareVersion": "Example String",
              "latestFirmware": [
                {
                  "variant": "ROUTER",
                  "version": "Example String",
                  "downloadUrl": "Example String"
                }
              ],
              "relayConfiguration": {
                "supportedDeviceTypes": [
                  "AIR_QUALITY_SENSOR"
                ],
                "endDeviceType": "AIR_QUALITY_SENSOR"
              },
              "ioModuleConfiguration": {
                "supportedConfigurations": [
                  "BMS"
                ],
                "configuration": "BMS"
              },
              "area": {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "areaName": "Example String",
                "areaType": "BATHROOM",
                "size": 40,
                "floor": 40,
                "children": true,
                "devices": [
                  {
                    "__typename": "Device"
                  }
                ],
                "accessPolicies": [
                  {
                    "__typename": "HomeProfileActionAccess"
                  }
                ]
              },
              "traits": [
                {
                  "traitType": "ARM_DISARM",
                  "commands": [
                    "ALARM"
                  ],
                  "attributes": [
                    {
                      "__typename": "TraitAttributeAvailableArmLevels"
                    }
                  ]
                }
              ],
              "accessPolicy": {
                "read": true,
                "write": true,
                "delete": true,
                "expiresAt": "Example String"
              }
            }
          ],
          "repeaters": [
            {
              "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "name": "Example String",
              "hubType": "GATEWAY",
              "productType": "HUB_4G",
              "brandName": "Example String",
              "firmwareVersion": "Example String",
              "serialNumber": "Example String",
              "macAddress": "Example String",
              "manufacturerInformation": "Example String",
              "wasWaterSensorTapePreviouslyConnected": true,
              "waterGuard": {
                "wasWaterSensorTapePreviouslyConnected": true,
                "mode": "NORMAL",
                "tamperModeWarningTriggeredAt": "Example String",
                "tamperModeTriggersAt": "Example String",
                "overrideModeTriggeredAt": "Example String",
                "showLevel1Warning": true,
                "showLevel2Warning": true
              },
              "hubTemplate": {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "name": "Example String",
                "hubAssetUrl": "Example String",
                "hubWithBgAssetUrl": "Example String",
                "hubQrCodeAssetUrl": "Example String",
                "hubConnectionAssetUrl": "Example String",
                "hubSearchAssetUrl": "Example String",
                "waterLeakDetectorAssetUrl": "Example String",
                "waterLeakDetectorInstructionsAssetUrl": "Example String",
                "waterLeakDetectorHelpAssetUrl": "Example String",
                "waterSensorTapeAssetUrl": "Example String",
                "waterSensorTapeInstructionsAssetUrl": "Example String",
                "waterLeakSystemPressHubButtonAssetUrl": "Example String",
                "sintefLogoAssetUrl": "Example String"
              },
              "area": {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "areaName": "Example String",
                "areaType": "BATHROOM",
                "size": 40,
                "floor": 40,
                "children": true,
                "devices": [
                  {
                    "__typename": "Device"
                  }
                ],
                "accessPolicies": [
                  {
                    "__typename": "HomeProfileActionAccess"
                  }
                ]
              },
              "devices": [
                {
                  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                  "deviceType": "AIR_QUALITY_SENSOR",
                  "name": "Example String",
                  "serialNumber": "Example String",
                  "imei": "Example String",
                  "macAddress": "Example String",
                  "ipAddress": "Example String",
                  "roomPlacement": "Example String",
                  "manufacturer": {
                    "__typename": "DeviceManufacturer"
                  },
                  "deviceTemplate": {
                    "__typename": "DeviceTemplate"
                  },
                  "image": {
                    "__typename": "DeviceImage"
                  },
                  "favorite": true,
                  "favoriteChangedAt": "Example String",
                  "registeredAt": "Example String",
                  "canBeUnregistered": true,
                  "firmwareVersion": "Example String",
                  "latestFirmware": [
                    {
                      "__typename": "DeviceFirmware"
                    }
                  ],
                  "relayConfiguration": {
                    "__typename": "DeviceRelayConfiguration"
                  },
                  "ioModuleConfiguration": {
                    "__typename": "DeviceIoModuleConfiguration"
                  },
                  "area": {
                    "__typename": "Area"
                  },
                  "traits": [
                    {
                      "__typename": "Trait"
                    }
                  ],
                  "accessPolicy": {
                    "__typename": "DeviceAccessPolicy"
                  }
                }
              ],
              "repeaters": [
                {
                  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                  "name": "Example String",
                  "hubType": "GATEWAY",
                  "productType": "HUB_4G",
                  "brandName": "Example String",
                  "firmwareVersion": "Example String",
                  "serialNumber": "Example String",
                  "macAddress": "Example String",
                  "manufacturerInformation": "Example String",
                  "wasWaterSensorTapePreviouslyConnected": true,
                  "waterGuard": {
                    "__typename": "HubWaterGuard"
                  },
                  "hubTemplate": {
                    "__typename": "HubTemplate"
                  },
                  "area": {
                    "__typename": "Area"
                  },
                  "devices": [
                    {
                      "__typename": "Device"
                    }
                  ],
                  "repeaters": [
                    {
                      "__typename": "Hub"
                    }
                  ],
                  "traits": [
                    {
                      "__typename": "Trait"
                    }
                  ]
                }
              ],
              "traits": [
                {
                  "traitType": "ARM_DISARM",
                  "commands": [
                    "ALARM"
                  ],
                  "attributes": [
                    {
                      "__typename": "TraitAttributeAvailableArmLevels"
                    }
                  ]
                }
              ]
            }
          ],
          "traits": [
            {
              "traitType": "ARM_DISARM",
              "commands": [
                "ALARM"
              ],
              "attributes": [
                {
                  "name": "Example String",
                  "dataType": "ALARM_TYPE",
                  "editable": true,
                  "availableArmLevels": [
                    {
                      "__typename": "ArmLevel"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "traits": [
        {
          "traitType": "ARM_DISARM",
          "commands": [
            "ALARM"
          ],
          "attributes": [
            {
              "name": "Example String",
              "dataType": "ALARM_TYPE",
              "editable": true,
              "availableArmLevels": [
                {
                  "id": 40,
                  "description": "Example String"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

userMyAccountVerifyEmailNotification

(account)
UserMyAccountVerifyEmailNotificationPayload

Arguments

account
MyAccountInternalUpdateInput!,non-nullrequired

Return type

UserMyAccountVerifyEmailNotificationPayload
email
String!,non-null
account
Account!,non-null
Mutation sample
mutation userMyAccountVerifyEmailNotification($account: MyAccountInternalUpdateInput!) {
  userMyAccountVerifyEmailNotification(account: $account) {
    email 
    account {
      id 
      email 
      emailVerified 
      phoneNumber {
        countryCode 
        nationalNumber 
      }
      firstName 
      lastName 
      avatar {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
        uploadUrl 
      }
      avatarV2(
        # Arguments Here
      ) {
        url {
          original 
          small 
          medium 
          large 
        }
        uploadUrl 
      }
      roles 
    }
  }
}
Variables
{
  "account": {
    "email": "Example String",
    "emailVerified": true,
    "url": "Example String",
    "urlSmall": "Example String",
    "urlMedium": "Example String",
    "urlLarge": "Example String"
  }
}
Response sample
{
  "data": {
    "email": "Example String",
    "account": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "email": "Example String",
      "emailVerified": true,
      "phoneNumber": {
        "countryCode": "Example String",
        "nationalNumber": "Example String"
      },
      "firstName": "Example String",
      "lastName": "Example String",
      "avatar": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String",
        "uploadUrl": "Example String"
      },
      "avatarV2": {
        "url": {
          "original": "Example String",
          "small": "Example String",
          "medium": "Example String",
          "large": "Example String"
        },
        "uploadUrl": "Example String"
      },
      "roles": [
        "INSTALLER"
      ]
    }
  }
}

userMyAccountAvatarUpdateNotification

(account)
UserMyAccountAvatarUpdateNotificationPayload

Arguments

account
MyAccountInternalUpdateInput!,non-nullrequired

Return type

UserMyAccountAvatarUpdateNotificationPayload
email
String!,non-null
account
Account!,non-null
Mutation sample
mutation userMyAccountAvatarUpdateNotification($account: MyAccountInternalUpdateInput!) {
  userMyAccountAvatarUpdateNotification(account: $account) {
    email 
    account {
      id 
      email 
      emailVerified 
      phoneNumber {
        countryCode 
        nationalNumber 
      }
      firstName 
      lastName 
      avatar {
        url 
        urlSmall 
        urlMedium 
        urlLarge 
        uploadUrl 
      }
      avatarV2(
        # Arguments Here
      ) {
        url {
          original 
          small 
          medium 
          large 
        }
        uploadUrl 
      }
      roles 
    }
  }
}
Variables
{
  "account": {
    "email": "Example String",
    "emailVerified": true,
    "url": "Example String",
    "urlSmall": "Example String",
    "urlMedium": "Example String",
    "urlLarge": "Example String"
  }
}
Response sample
{
  "data": {
    "email": "Example String",
    "account": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "email": "Example String",
      "emailVerified": true,
      "phoneNumber": {
        "countryCode": "Example String",
        "nationalNumber": "Example String"
      },
      "firstName": "Example String",
      "lastName": "Example String",
      "avatar": {
        "url": "Example String",
        "urlSmall": "Example String",
        "urlMedium": "Example String",
        "urlLarge": "Example String",
        "uploadUrl": "Example String"
      },
      "avatarV2": {
        "url": {
          "original": "Example String",
          "small": "Example String",
          "medium": "Example String",
          "large": "Example String"
        },
        "uploadUrl": "Example String"
      },
      "roles": [
        "INSTALLER"
      ]
    }
  }
}

updateNotificationUserSubscription

(...args)
UserSubscriptionUpdatedPayload

Arguments

userId
ID!,non-nullrequired
data
UserSubscriptionUpdateInput!,non-nullrequired

Return type

UserSubscriptionUpdatedPayload
userId
ID!,non-null
subscriptionType
SubscriptionType!,non-null
tokensTotal
Int!,non-null
tokensAvailable
Int!,non-null
Mutation sample
mutation updateNotificationUserSubscription($userId: ID!, $data: UserSubscriptionUpdateInput!) {
  updateNotificationUserSubscription(userId: $userId, data: $data) {
    userId 
    subscriptionType 
    tokensTotal 
    tokensAvailable 
  }
}
Variables
{
  "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "subscriptionType": "ALARM_STATION",
    "tokensTotal": 40,
    "tokensAvailable": 40
  }
}
Response sample
{
  "data": {
    "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "subscriptionType": "ALARM_STATION",
    "tokensTotal": 40,
    "tokensAvailable": 40
  }
}

homeAvatarUpdateNotification

(...args)
HomeAvatarUpdatedPayload

Arguments

homeId
ID!,non-nullrequired
data
HomeAvatarUpdateNotificationInput!,non-nullrequired

Return type

HomeAvatarUpdatedPayload
homeId
ID!,non-null
avatar
Avatar!,non-null
Mutation sample
mutation homeAvatarUpdateNotification($homeId: ID!, $data: HomeAvatarUpdateNotificationInput!) {
  homeAvatarUpdateNotification(homeId: $homeId, data: $data) {
    homeId 
    avatar {
      url 
      urlSmall 
      urlMedium 
      urlLarge 
      uploadUrl 
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "data": {
    "url": "Example String",
    "urlSmall": "Example String",
    "urlMedium": "Example String",
    "urlLarge": "Example String"
  }
}
Response sample
{
  "data": {
    "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "avatar": {
      "url": "Example String",
      "urlSmall": "Example String",
      "urlMedium": "Example String",
      "urlLarge": "Example String",
      "uploadUrl": "Example String"
    }
  }
}

updateNotificationProject

(projectId)
ProjectUpdatedPayload

Arguments

projectId
ID!,non-nullrequired

Return type

ProjectUpdatedPayload
projectId
ID!,non-null
project
Project
Mutation sample
mutation updateNotificationProject($projectId: ID!) {
  updateNotificationProject(projectId: $projectId) {
    projectId 
    project {
      id 
      installerId 
      status 
      avatar(
        # Arguments Here
      ) {
        url {
          original 
          small 
          medium 
          large 
        }
        uploadUrl 
      }
      buildingType 
      buildingYear 
      buildingSize 
      locationInfo {
        country 
        city 
        postalCode 
        street 
        streetNumber 
        unitNumber 
        geoLocation {
          latitude 
          longitude 
        }
        apartmentNumber 
        associationId 
      }
      constructionType 
      description {
        projectNumber 
        orderReferenceNumber 
        buildingTitle 
      }
      hubs {
        area {
          areaName 
          areaType 
        }
      }
      devices {
        area {
          areaName 
          areaType 
        }
        deviceType 
      }
    }
  }
}
Variables
{
  "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "project": {
      "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "installerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
      "status": "FINISHED",
      "avatar": {
        "url": {
          "original": "Example String",
          "small": "Example String",
          "medium": "Example String",
          "large": "Example String"
        },
        "uploadUrl": "Example String"
      },
      "buildingType": "APARTMENT",
      "buildingYear": 40,
      "buildingSize": 40,
      "locationInfo": {
        "country": "Example String",
        "city": "Example String",
        "postalCode": "Example String",
        "street": "Example String",
        "streetNumber": "Example String",
        "unitNumber": "Example String",
        "geoLocation": {
          "latitude": 40,
          "longitude": 40
        },
        "apartmentNumber": "Example String",
        "associationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
      },
      "constructionType": "CONCRETE",
      "description": {
        "projectNumber": "Example String",
        "orderReferenceNumber": "Example String",
        "buildingTitle": "Example String"
      },
      "hubs": [
        {
          "area": {
            "areaName": "Example String",
            "areaType": "BATHROOM"
          }
        }
      ],
      "devices": [
        {
          "area": {
            "areaName": "Example String",
            "areaType": "BATHROOM"
          },
          "deviceType": "AIR_QUALITY_SENSOR"
        }
      ]
    }
  }
}

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview