Rhombus Systems Doorbell Camera Webservice API

openapi: 3.2.0
info:
  contact:
    email: developer@rhombussystems.com
  description: 'This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token` for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```'
  title: Rhombus Doorbell Camera Webservice API
  version: '1.0'
servers:
- description: Production Server
  url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Doorbell Camera Webservice
paths:
  /api/doorbellcamera/calibrateFloorplanProjection:
    post:
      description: Generate the homography to project detections onto a floorplan.
      operationId: doorbellCameraCalibrateFloorplanProjection
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSResponse'
          description: OK
      summary: Generate the homography to project detections onto a floorplan
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/createRuleForDoorbellCamera:
    post:
      description: Create rule for a doorbell camera.
      operationId: createRuleForDoorbellCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_CreateRuleForDoorbellCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_CreateRuleForDoorbellCameraWSResponse'
          description: OK
      summary: Create rule for a doorbell camera
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/createSharedLiveVideoStream:
    post:
      operationId: createDoorbellCameraSharedLiveVideoStream
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_CreateSharedLiveVideoStreamWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_CreateSharedLiveVideoStreamWSResponse'
          description: OK
      summary: Share an live video stream for a doorbell camera
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/delete:
    post:
      operationId: deleteDoorbellCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_DeleteDoorbellCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_DeleteDoorbellCameraWSResponse'
          description: OK
      summary: Remove the doorbell camera from the organization
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/deleteRuleForDoorbellCamera:
    post:
      description: Delete rule for a doorbell camera.
      operationId: deleteRuleForDoorbellCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_DeleteRuleForDoorbellCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_DeleteRuleForDoorbellCameraWSResponse'
          description: OK
      summary: Delete rule for a doorbell camera
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/findComponentEventsForDoorbellCamera:
    post:
      operationId: findComponentEventsForDoorbellCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_FindComponentEventsForDoorbellCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse'
          description: OK
      summary: Retrieve all component events relevant to the specified Doorbell Camera
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/findComponentSeekPointsForDoorbellCamera:
    post:
      operationId: findComponentSeekPointsForDoorbellCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_FindComponentSeekPointsForDoorbellCameraWSResponse'
          description: OK
      summary: Retrieve all component seekpoints relevant to the specified Doorbell Camera
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/findSharedLiveVideoStreams:
    post:
      operationId: findDoorbellCameraSharedLiveVideoStreams
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_FindSharedLiveVideoStreamsForWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_FindSharedLiveVideoStreamsWSResponse'
          description: OK
      summary: Get list of all shared live streams for doorbell camera
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/getDoorbellCameraRulesForOrg:
    post:
      description: Get rules for all doorbell cameras in an org.
      operationId: getDoorbellCameraRulesForOrg
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_GetDoorbellCameraRulesForOrgWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_GetDoorbellCameraRulesForOrgWSResponse'
          description: OK
      summary: Get rules for all doorbell cameras in an org
      tags:
      - Doorbell Camera Webservice
  /api/doorbellcamera/getRulesForDoorbellCamera:
    post:
      description: Get all rules for a doorbell camera.
      operationId: getRulesForDoorbellCamera
      parameters:
      - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
        example: api-token
        in: header
        name: x-auth-scheme
        required: true
        schema:
          type: string
          default: api-token
          enum:
          - api-token
          - api
          - partner-api-token
          - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doorbellcamera_GetRulesForDoorbellCameraWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doorbellcamera_GetRulesForDoorbellCameraWSResponse'
          description: OK
      summary: Get all rules for a doorbell camera
      tags:
      - Doorbell Camera Webservice
components:
  schemas:
    ComponentSeekPointType:
      type: object
      description: List of component seekpoints for the doorbell camera
      properties:
        activity:
          $ref: '#/components/schemas/ActivityEnum'
        componentCompositeUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        componentUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        customActivityColor:
          $ref: '#/components/schemas/FootageSeekPointColorEnum'
        customActivityDescription:
          type:
          - string
          - 'null'
        customActivityDisplayName:
          type:
          - string
          - 'null'
        locationUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        orgUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        originalEvent:
          type:
          - object
          - 'null'
        ownerDeviceUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        subLocationsHierarchyKey:
          type:
          - string
          - 'null'
          format: SubLocationsHierarchyKey
          description: 'A sequence of one or more base 64 (url-safe) uuid substrings.

            These substrings are separated by dots (.).

            '
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
        timestampMs:
          type:
          - integer
          - 'null'
          format: int64
        userUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        uuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
    ConnectAudioDeviceToPhoneNumberActionType:
      type: object
      properties:
        audioDeviceUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        deviceType:
          $ref: '#/components/schemas/DeviceTypeEnum'
        doorUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        optionalGreeting:
          type:
          - string
          - 'null'
        phoneNumber:
          type:
          - string
          - 'null'
    LockdownPlanScopeEnumType:
      type: string
      enum:
      - ORG_LOCKDOWN
      - LOCATION_LOCKDOWN
    DoorReaderStateEnumType:
      type: string
      enum:
      - CONNECTED
      - DISCONNECTED
      - UNKNOWN
    Common_devices_CalibrateFloorplanProjectionWSResponse:
      type: object
      description: Response containing the calibrated floorplan projection homography.
      properties:
        homography:
          type:
          - array
          - 'null'
          description: 3x3 homography matrix for floorplan projection
          items:
            type:
            - array
            - 'null'
            description: 3x3 homography matrix for floorplan projection
            items:
              type:
              - number
              - 'null'
              format: double
              description: 3x3 homography matrix for floorplan projection
    DoorFirstInStateChangeEventReference:
      type:
      - object
      - 'null'
      properties:
        doorUuidToEventUuidMap:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
            format: RUUID
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
        newState:
          $ref: '#/components/schemas/FirstInFirmwareStatusEnum'
        originatingDoorUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        originatingUserUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        originator:
          $ref: '#/components/schemas/BaseEventOriginator'
        source:
          $ref: '#/components/schemas/FirstInSourceEnum'
        stateChangedAtMs:
          type:
          - integer
          - 'null'
          format: int64
    CredentialEntryBleWave:
      type:
      - object
      - 'null'
      allOf:
      - type: object
        properties:
          finalRssi:
            type:
            - integer
            - 'null'
            format: int32
          firstRssi:
            type:
            - integer
            - 'null'
            format: int32
          firstRssiAtIntentElapsed:
            type:
            - integer
            - 'null'
            format: int32
          lostAtIntentElapsed:
            type:
            - integer
            - 'null'
            format: int32
          lostAtRssi:
            type:
            - integer
            - 'null'
            format: int32
          maxRssi:
            type:
            - integer
            - 'null'
            format: int32
          maxRssiAtIntentElapsed:
            type:
            - integer
            - 'null'
            format: int32
          sessionFirstRssi:
            type:
            - integer
            - 'null'
            format: int32
          sessionFirstRssiAtElapsed:
            type:
            - integer
            - 'null'
            format: int32
          sessionLostAtElapsed:
            type:
            - integer
            - 'null'
            format: int32
          sessionLostAtRssi:
            type:
            - integer
            - 'null'
            format: int32
          sessionMaxRssi:
            type:
            - integer
            - 'null'
            format: int32
          sessionMaxRssiAtElapsed:
            type:
            - integer
            - 'null'
            format: int32
      properties:
        credSource:
          $ref: '#/components/schemas/CredentialSourceEnumType'
        credentialId:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        firstInEligible:
          type:
          - boolean
          - 'null'
        originator:
          $ref: '#/components/schemas/BaseEventOriginator'
    WebResponseStatusEnum:
      type: string
      description: Status of the unregister operation
      enum:
      - BASIC_AUTH_FAILED
      - PASSWORD_MISMATCH
      - SAME_PASSWORD
      - USER_EXISTS
      - USER_NOT_FOUND
      - DEVICE_NOT_FOUND
      - POLICY_NOT_FOUND
      - LOCATION_NOT_FOUND
      - ORG_NOT_FOUND
      - BAD_INPUT
      - SUCCESS
      - PASSWORD_TOO_SHORT
    Doorbellcamera_CreateSharedLiveVideoStreamWSRequest:
      type: object
      description: Request object for creating a shared live video stream for a doorbell camera.
      properties:
        audioGatewayUuid:
          type:
          - string
          - 'null'
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
        doorbellCameraUuid:
          type:
          - string
          - 'null'
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
        expirationTimeSecs:
          type:
          - integer
          - 'null'
          format: int32
          description: Add a expiration date for accessing the stream in seconds
          example: 86400
        invertSchedule:
          type:
          - boolean
          - 'null'
          description: If given a schedule uuid, will hide the stream during the schedule instead and show it otherwise
          example: false
        name:
          type:
          - string
          - 'null'
          description: If not provided, will be named 'Unnamed'
          example: Front Door Stream
        password:
          type:
          - string
          - 'null'
          description: Add a password to allow access to your shared stream. If null or blank password is not set.
          example: mypassword123
        scheduleUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        streamType:
          $ref: '#/components/schemas/StreamTypeEnum'
        vodEnabled:
          type:
          - boolean
          - 'null'
          description: Enables recording of live footage to a VOD
          example: true
      required:
      - doorbellCameraUuid
      - streamType
      - vodEnabled
    RemoteDoorUnlockActionType:
      type: object
      properties:
        doorId:
          type:
          - string
          - 'null'
        placeId:
          type:
          - string
          - 'null'
        system:
          $ref: '#/components/schemas/RemoteDoorUnlockSystemEnum'
    IntercomTalkStateEnumType:
      type: string
      description: Whether the operator started or ended talking
      enum:
      - STARTED
      - ENDED
    ComponentEventEnumType:
      type: string
      description: Limits results to only contain the specified type of events, if applicable
      enum:
      - DoorbellEvent
      - DoorReaderStateChangeEvent
      - DoorRelayStateChangeEvent
      - DoorPositionIndicatorStateChangeEvent
      - RequestToExitStateChangeEvent
      - CredentialReceivedEvent
      - ButtonEvent
      - GenericInputStateChangeEvent
      - GenericRelayStateChangeEvent
      - AccessControlUnitTamperEvent
      - AccessControlUnitLocationLockdownStateEvent
      - DoorLocationLockdownStateEvent
      - PanicButtonEvent
      - AccessControlUnitBatteryStateChangeEvent
      - WaveToUnlockIntentExpiredEvent
      - DoorStateChangeEvent
      - DoorAuthFirstInStateEvent
      - DoorScheduleFirstInStateEvent
      - AccessControlUnitDoorFirstInStateEvent
      - AperioDoorExtensionStateEvent
      - AperioActivatorStateEvent
      - AperioKeyCylinderStateEvent
      - AperioDoorModeEvent
      - AperioDoorHandleStateEvent
      - AperioGatewayStateEvent
      - AperioGatewayConnectionStateChangeEvent
      - AperioDtcEvent
      - AperioTamperStateEvent
      - IntercomTalkEvent
    UserEventOriginator:
      type:
      - object
      - 'null'
      allOf:
      - type: object
        properties:
          userEmail:
            type:
            - string
            - 'null'
          userUuid:
            type:
            - string
            - 'null'
            format: RUUID
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
          username:
            type:
            - string
            - 'null'
      properties:
        type:
          $ref: '#/components/schemas/EventOriginatorEnum'
    ReportLookbackTypeEnum:
      type: string
      enum:
      - ROLLING
      - PREVIOUS_DAY
      - PREVIOUS_WEEK
      - PREVIOUS_MONTH
    Doorbellcamera_FindComponentEventsForDoorbellCameraWSResponse:
      type: object
      description: Response object containing component events for a doorbell camera.
      properties:
        componentEvents:
          type:
          - array
          - 'null'
          description: List of component events for the doorbell camera
          items:
            $ref: '#/components/schemas/ComponentEventType'
        error:
          type:
          - boolean
          - 'null'
        errorMsg:
          type:
          - string
          - 'null'
        warningMsg:
          type:
          - string
          - 'null'
    Doorbellcamera_ExternalDoorbellCameraComponentRuleType:
      type: object
      description: External representation of a doorbell camera component rule.
      properties:
        action:
          $ref: '#/components/schemas/RuleActionType'
        doorbellCameraComponentUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        doorbellCameraUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        ruleFilters:
          $ref: '#/components/schemas/RuleFilterType'
        ruleName:
          type:
          - string
          - 'null'
          description: Name of the rule
          example: Motion Detection Rule
        ruleUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        triggerActivity:
          $ref: '#/components/schemas/ActivityEnum'
    ActivityEnum:
      type: string
      enum:
      - SOUND_LOUD
      - SOUND_GUN_SHOT
      - TAMPER
      - VISUAL_TAMPER
      - MOTION_TAMPER
      - MOTION
      - MOTION_HUMAN
      - MOTION_CAR
      - MOTION_ANIMAL
      - FACE
      - FACE_IDENTIFIED
      - FACE_UNIDENTIFIED
      - FACE_BLACKLISTED
      - FACE_ALERT
      - POSE_ANOMALOUS
      - POSE_FALL
      - LICENSEPLATE
      - LICENSEPLATE_IDENTIFIED
      - LICENSEPLATE_UNIDENTIFIED
      - LICENSEPLATE_ALERT
      - LICENSEPLATE_BLACKLISTED
      - LICENSEPLATE_TRUSTED
      - PEOPLECOUNT_HIGH
      - PEOPLECOUNT_HIGH_RESET
      - PEOPLECOUNT_LOW
      - PEOPLECOUNT_LOW_RESET
      - HUMAN_ENTER
      - HUMAN_EXIT
      - CAR_ENTER
      - CAR_EXIT
      - TEMPERATURE_EXCEEDED_HIGH
      - TEMPERATURE_EXCEEDED_LOW
      - HUMIDITY_EXCEEDED_HIGH
      - HUMIDITY_EXCEEDED_LOW
      - PM25_EXCEEDED_HIGH
      - TVOC_EXCEEDED_HIGH
      - ETOH_EXCEEDED_HIGH
      - IAQ_EXCEEDED_HIGH
      - CO2_EXCEEDED_HIGH
      - CO2_EXCEEDED_LOW
      - PROBE_TEMPERATURE_EXCEEDED_HIGH
      - PROBE_TEMPERATURE_EXCEEDED_LOW
      - PROBE_DISCONNECTED
      - PROBE_CONNECTED
      - HEAT_INDEX_EXCEEDED_HIGH
      - PRESSURE_EXCEEDED_HIGH
      - PRESSURE_EXCEEDED_LOW
      - PM10_EXCEEDED_HIGH
      - PM40_EXCEEDED_HIGH
      - PM100_EXCEEDED_HIGH
      - VOC_IDX_EXCEEDED_HIGH
      - NOX_IDX_EXCEEDED_HIGH
      - FORMALDEHYDE_EXCEEDED_HIGH
      - CARBON_MONOXIDE_EXCEEDED_HIGH
      - AQI_EXCEEDED_HIGH
      - DOOR_AJAR
      - DOOR_OPENED
      - DOOR_CLOSED
      - BUTTON_SINGLE_PRESSED
      - BUTTON_DOUBLE_PRESSED
      - BUTTON_LONG_PRESSED
      - TAG_ARRIVED
      - TAG_DEPARTED
      - TAG_MOVED
      - TAG_POSITIONING_CHANGED
      - TAG_BOUNDARY_INGRESS
      - TAG_BOUNDARY_EGRESS
      - TAG_PANIC
      - BADGE_AUTHORIZED
      - BADGE_UNAUTHORIZED
      - BADGE_UNAUTHORIZED_V2
      - BADGE_AJAR
      - BADGE_MANUAL
      - BADGE_FORCED_OPEN
      - BADGE_LOCKDOWN
      - BADGE_REQUEST_TO_EXIT
      - BADGE_DURESS
      - BADGE_SECURITY_BREACH
      - BADGE_TAMPER
      - BADGE_FACE_MISMATCH
      - POS_ORDER
      - GUN_DETECT_EVENT
      - IOT_SOUND_AGGRESSION
      - IOT_SOUND_HELP
      - IOT_AIR_CO
      - IOT_AIR_CO2
      - IOT_AIR_MASKING
      - IOT_AIR_THC
      - IOT_AIR_VAPE
      - IOT_AIR_VOC
      - IOT_AIR_TEMP
      - IOT_TAMPER
      - IOT_GUNSHOT
      - IOT_BUTTON_SINGLE_CLICK
      - IOT_BUTTON_DOUBLE_CLICK
      - IOT_BUTTON_HOLD
      - IOT_PANIC_BUTTON_TRIGGERED
      - AUDIO_SOUND_SIGNIFICANT
      - AUDIO_SOUND_LOUD
      - AUDIO_SOUND_ABUSIVE
      - AUDIO_SOUND_GREETING
      - AUDIO_SOUND_HELP
      - AUDIO_SOUND_GUN
      - AUDIO_SOUND_GLASS_BREAK
      - AUDIO_SOUND_ALARM_SMOKE_FIRE
      - AUDIO_SOUND_ALARM_CARBON_MONOXIDE
      - AUDIO_SOUND_SIREN
      - CLIMATE_VOC
      - CLIMATE_VAPE
      - CLIMATE_SMOKE
      - CLIMATE_THC
      - CLIMATE_CO2
      - CLIMATE_ETOH
      - CLIMATE_PM25
      - CLIMATE_IAQ
      - CLIMATE_LEAK
      - SOUND_AGGRESSION
      - SOUND_HELP
      - AIR_CO
      - AIR_CO2
      - AIR_MASKING
      - AIR_THC
      - AIR_VAPE
      - AIR_VOC
      - MASK_MISSING
      - HELMET_MISSING
      - GLOVES_MISSING
      - PIR_OCCUPIED
      - PIR_MOVEMENT
      - PIR_VACANT
      - CUSTOM
      - VISITOR_ARRIVED
      - VISITOR_DEPARTED
      - AC_DR_CONNECTED
      - AC_DR_DISCONNECTED
      - AC_DPI_DOOR_OPEN
      - AC_DPI_DOOR_CLOSED
      - AC_DPI_DOOR_AJAR
      - AC_DPI_DOOR_FORCED_OPEN
      - AC_DSR_UNLOCKED
      - AC_DSR_LOCKED
      - AC_DB_TRIGGERED
      - AC_PANIC_BUTTON_TRIGGERED
      - AC_REMOTE_UNLOCK
      - AC_BADGE_AUTHORIZED
      - AC_BADGE_UNAUTHORIZED
      - AC_BADGE_FACE_MISMATCH
      - AC_LOCKDOWN_ACTIVATED
      - AC_LOCKDOWN_DEACTIVATED
      - AC_TAMPER_PROX
      - AC_TAMPER_ACCEL
      - AC_TAMPER_SWITCH
      - AC_GR_ACTIVE
      - AC_GR_INACTIVE
      - AC_GI_ACTIVE
      - AC_GI_INACTIVE
      - AC_REX_ACTIVE
      - AC_REX_INACTIVE
      - AC_APERIO_DEVICE_DISCONNECTED
      - AC_APERIO_DEVICE_CONNECTED
      - AC_APERIO_DEVICE_REBOOT
      - AC_APERIO_DEVICE_TAMPER
      - AC_APERIO_LOW_BATTERY
      - AC_APERIO_FLAT_BATTERY
      - AC_APERIO_OK_BATTERY
      - POWER_SWITCH_BATTERY
      - POWER_SWITCH_PRIMARY
      - AI_SEARCH_MATCH
      - CUSTOM_LLM_BOOLEAN_TRUE
      - CUSTOM_LLM_BOOLEAN_FALSE
      - CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW
      - CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH
      - ALM_AUTHORITIES_CONTACTED
      - ALM_MONITORING_ENABLED
      - ALM_MONITORING_DISABLED
      - ALM_MONITORING_SETTINGS_CHANGE
      - ALM_THREAT_CASE_CLOSED
      - ALM_THREAT_DETECTED
      - ALM_MONITORING_EVENT_DETECTED
      - ROBOT_DOG_DETECTED
      - ROBOT_ARRIVED_AT_WAYPOINT
      - ROBOT_ARRIVED_AT_POSE
      - ROBOT_WAITING_AT_POSE
      - ROBOT_MANUAL_CMD_VEL
      - ROBOT_MANUAL_ACTION
      - ROBOT_MANUAL_POSTURE
      - ROBOT_NAVIGATE_TO_POSE_START
      - ROBOT_NAVIGATE_TO_POSE_END
      - ROBOT_NAVIGATE_TO_HOME_START
      - ROBOT_NAVIGATE_TO_HOME_END
      - ROBOT_NAVIGATE_TO_WAYPOINT_START
      - ROBOT_NAVIGATE_TO_WAYPOINT_END
      - ROBOT_ROUTE_RUN_START
      - ROBOT_ROUTE_RUN_END
      - ROBOT_LOW_BATTERY_DOCKING
      - ROBOT_IDLE_DOCKING
      - ROBOT_EMERGENCY
      - LOITER_HUMAN
      - REID_HUMAN
      - INACTIVITY_HUMAN
      - INACTIVITY_CAR
      - ONGUARD_BADGE_AUTHORIZED
      - ONGUARD_BADGE_ANOMALY
      - ONGUARD_NO_ENTRY_MADE
      - ELEMENTS_BADGE_AUTHORIZED
      - ELEMENTS_BADGE_ANOMALY
      - ELEMENTS_NO_ENTRY_MADE
      - NETBOX_BADGE_AUTHORIZED
      - NETBOX_BADGE_ANOMALY
      - NETBOX_NO_ENTRY_MADE
      - THERMAL_TEMPERATURE_ALARM
      - THERMAL_TEMPERATURE_WARNING
      - THERMAL_FIRE_DETECTED
      - THERMAL_SMOKING_DETECTED
      - THERMAL_FIRE_VERIFIED
      - THERMAL_HEAT_NO_THREAT
      - THERMAL_VISUAL_HOTSPOT
      - THERMAL_VISUAL_HEAT_RISE
      - THERMAL_VISUAL_WARM_BODY
      - UNKNOWN
    ToastCheckInfo:
      type: object
      properties:
        totalAmount:
          type:
          - number
          - 'null'
          format: double
    RuleFilterType:
      type: object
      description: Optional filters to apply to this lockdown rule.
      prop

# --- truncated at 32 KB (153 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-doorbell-camera-webservice-api-openapi.yml