Rhombus Systems AudioGateway 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 AudioGateway Webservice API
  version: '1.0'
servers:
- description: Production Server
  url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: AudioGateway Webservice
paths:
  /api/audiogateway/delete:
    post:
      description: Remove an audio gateway from organization
      operationId: deleteAudioGateway
      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/Audiogateway_DeleteAudioGatewayWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_DeleteAudioGatewayWSResponse'
          description: OK
      summary: Delete audio gateway
      tags:
      - AudioGateway Webservice
  /api/audiogateway/getAudioSeekpoints:
    post:
      operationId: getAudioSeekpoints
      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/Audiogateway_GetAudioSeekpointsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_GetAudioSeekpointsWSResponse'
          description: OK
      summary: Get audio seek points
      tags:
      - AudioGateway Webservice
  /api/audiogateway/getConfig:
    post:
      description: Get an audio gateway config
      operationId: getAudioGatewayConfig
      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/Audiogateway_GetAudioGatewayConfigWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_GetAudioGatewayConfigWSResponse'
          description: OK
      summary: Get audio gateway config
      tags:
      - AudioGateway Webservice
  /api/audiogateway/getFullAudioGatewayState:
    post:
      description: Get detailed information about state of specified audio gateway
      operationId: getFullAudioGatewayState
      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/Audiogateway_GetFullAudioGatewayStateWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_GetFullAudioGatewayStateWSResponse'
          description: OK
      summary: Get full audio gateway state
      tags:
      - AudioGateway Webservice
  /api/audiogateway/getMediaUris:
    post:
      description: Get media uris for audio gateway to retrieve footage
      operationId: getAudioGatewayMediaUris
      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/Audiogateway_GetMediaUrisWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_GetMediaUrisWSResponse'
          description: OK
      summary: Get media URIs for audio gateway
      tags:
      - AudioGateway Webservice
  /api/audiogateway/getMinimalAudioGatewayStateList:
    post:
      description: Get basic state information for all audio gateways
      operationId: getMinimalAudioGatewayStateList
      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/Audiogateway_GetMinimalAudioGatewayStatesWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_GetMinimalAudioGatewayStatesWSResponse'
          description: OK
      summary: Get minimal audio gateway state list
      tags:
      - AudioGateway Webservice
  /api/audiogateway/getPresenceWindows:
    post:
      description: Get stored video information for an audio gateway
      operationId: getAudioGatewayPresenceWindows
      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_GetPresenceWindowsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_devices_GetPresenceWindowsWSResponse'
          description: OK
      summary: Get audio gateway presence windows
      tags:
      - AudioGateway Webservice
  /api/audiogateway/getUptimeWindows:
    post:
      description: Get uptime information for an audio gateway
      operationId: getAudioGatewayUptimeWindows
      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_GetUptimeWindowsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Common_devices_GetUptimeWindowsWSResponse'
          description: OK
      summary: Get audio gateway uptime windows
      tags:
      - AudioGateway Webservice
  /api/audiogateway/updateConfig:
    post:
      description: Update config for audio gateway
      operationId: updateAudioGatewayConfig
      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/Audiogateway_UpdateAudioGatewayConfigWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_UpdateAudioGatewayConfigWSResponse'
          description: OK
      summary: Update audio gateway config
      tags:
      - AudioGateway Webservice
  /api/audiogateway/updateDetails:
    post:
      description: 'Update details for audio gateway. Note: uuid is a required field'
      operationId: updateAudioGatewayDetails
      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/Audiogateway_UpdateAudioGatewayDetailsWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audiogateway_UpdateAudioGatewayDetailsWSResponse'
          description: OK
      summary: Update audio gateway details
      tags:
      - AudioGateway Webservice
components:
  schemas:
    LEDModeEnum:
      type: string
      enum:
      - LED_OFF
      - LED_RED_SOLID
      - LED_GREEN_SOLID
      - LED_ORANGE_SOLID
      - LED_RED_BLINK
      - LED_GREEN_BLINK
      - LED_ORANGE_BLINK
      - LED_NORMAL
    Audiogateway_UpdateAudioGatewayDetailsWSRequest:
      type: object
      description: 'Request to update details for an audio gateway. Note: uuid is a required field.'
      properties:
        associatedCameras:
          type:
          - array
          - 'null'
          description: List of associated camera device UUIDs
          items:
            type:
            - string
            - 'null'
            format: DeviceFacetUuid
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
        associatedCamerasUpdated:
          type:
          - boolean
          - 'null'
        deleted:
          type:
          - boolean
          - 'null'
          description: Indicates whether the audio gateway is deleted
          example: false
        deletedUpdated:
          type:
          - boolean
          - 'null'
        description:
          type:
          - string
          - 'null'
          description: Description of the audio gateway
          example: Audio gateway for main entrance monitoring
        descriptionUpdated:
          type:
          - boolean
          - 'null'
        floorNumber:
          type:
          - integer
          - 'null'
          format: int32
          description: Floor number where the audio gateway is located
          example: 1
        floorNumberUpdated:
          type:
          - boolean
          - 'null'
        latitude:
          type:
          - number
          - 'null'
          format: double
          description: Latitude coordinate of the audio gateway location
          example: 37.7749
        latitudeUpdated:
          type:
          - boolean
          - 'null'
        locationUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        locationUuidUpdated:
          type:
          - boolean
          - 'null'
        longitude:
          type:
          - number
          - 'null'
          format: double
          description: Longitude coordinate of the audio gateway location
          example: -122.4194
        longitudeUpdated:
          type:
          - boolean
          - 'null'
        name:
          type:
          - string
          - 'null'
          description: Name of the audio gateway
          example: Main Entrance Audio Gateway
        nameUpdated:
          type:
          - boolean
          - 'null'
        policyUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        policyUuidUpdated:
          type:
          - boolean
          - 'null'
        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})*$
        subLocationsHierarchyKeyUpdated:
          type:
          - boolean
          - 'null'
        uuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
    Audiogateway_GetMediaUrisWSResponse:
      type: object
      description: Response containing media URIs for audio gateway footage retrieval.
      properties:
        error:
          type:
          - boolean
          - 'null'
        errorMsg:
          type:
          - string
          - 'null'
        lanCheckUrls:
          type:
          - array
          - 'null'
          description: List of LAN check URLs to verify device availability on local network
          items:
            type:
            - string
            - 'null'
            description: List of LAN check URLs to verify device availability on local network
        lanLiveMpdUris:
          type:
          - array
          - 'null'
          description: List of LAN live MPD URIs for local network media streaming
          items:
            type:
            - string
            - 'null'
            description: List of LAN live MPD URIs for local network media streaming
        lanLiveOpusUris:
          type:
          - array
          - 'null'
          description: List of LAN live Opus URIs for local network audio streaming
          items:
            type:
            - string
            - 'null'
            description: List of LAN live Opus URIs for local network audio streaming
        lanVodMpdUrisTemplates:
          type:
          - array
          - 'null'
          description: List of LAN VOD MPD URI templates for local network video on demand
          items:
            type:
            - string
            - 'null'
            description: List of LAN VOD MPD URI templates for local network video on demand
        wanLiveMpdUri:
          type:
          - string
          - 'null'
          description: WAN live MPD URI for real-time media streaming
        wanLiveOpusUri:
          type:
          - string
          - 'null'
          description: WAN live Opus URI for real-time audio streaming
        wanVodMpdUriTemplate:
          type:
          - string
          - 'null'
          description: WAN VOD MPD URI template for video on demand content
        warningMsg:
          type:
          - string
          - 'null'
    Audiogateway_DeleteAudioGatewayWSRequest:
      type: object
      description: Request to remove an audio gateway from organization.
      properties:
        gatewayUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        mummify:
          type:
          - boolean
          - 'null'
          description: Indicates whether to mummify the audio gateway
          example: false
    Audiogateway_UpdateAudioGatewayDetailsWSResponse:
      type: object
      description: Response indicating the result of updating audio gateway details.
      properties:
        error:
          type:
          - boolean
          - 'null'
        errorMsg:
          type:
          - string
          - 'null'
        warningMsg:
          type:
          - string
          - 'null'
    Audiogateway_GetAudioSeekpointsWSRequest:
      type: object
      description: Request to get audio seek points for an audio gateway.
      properties:
        deviceUuid:
          type:
          - string
          - 'null'
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
        duration:
          type:
          - integer
          - 'null'
          format: int32
          description: Duration in seconds
          example: 3600
        startTime:
          type:
          - integer
          - 'null'
          format: int64
          description: Start time in milliseconds since epoch
          example: 1640995200000
    Audiogateway_GetMediaUrisWSRequest:
      type: object
      description: Request to get media URIs for an audio gateway to retrieve footage.
      properties:
        gatewayUuid:
          type:
          - string
          - 'null'
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
    Audiogateway_UpdateAudioGatewayConfigWSResponse:
      type: object
      description: Response indicating the result of updating audio gateway configuration.
      properties:
        error:
          type:
          - boolean
          - 'null'
        errorMsg:
          type:
          - string
          - 'null'
        warningMsg:
          type:
          - string
          - 'null'
    ToastOrderIdType:
      type: object
      properties:
        employeeName:
          type:
          - string
          - 'null'
        guid:
          type:
          - string
          - 'null'
        locationName:
          type:
          - string
          - 'null'
        restaurantName:
          type:
          - string
          - 'null'
        toastCheckInfo:
          $ref: '#/components/schemas/ToastCheckInfo'
    UploadTargetEnum:
      type: string
      enum:
      - '0'
      - '1'
      - '2'
    Audiogateway_UpdateAudioGatewayConfigWSRequest:
      type: object
      description: Request to update configuration for an audio gateway.
      properties:
        audioAnalysisParams:
          $ref: '#/components/schemas/AudioParamConfig'
        audioExternalMicBoost:
          type:
          - integer
          - 'null'
          format: int32
          description: Adjust boost for external mic. Integer between 0 and 3.
          example: 1
        audioExternalMicVolume:
          type:
          - integer
          - 'null'
          format: int32
          description: Adjust volume for external mic. Integer between 0 and 63.
          example: 32
        audioExternalSpeakerVolume:
          type:
          - integer
          - 'null'
          format: int32
          description: Adjust volume for external speaker. Integer between 0 and 127.
          example: 64
        audioInternalMicAecEnabled:
          type:
          - boolean
          - 'null'
          description: Enable acoustic echo cancellation for internal microphone
          example: true
        audioInternalMicBoost:
          type:
          - integer
          - 'null'
          format: int32
          description: Adjust boost for internal mic. Integer between 0 and 3.
          example: 1
        audioInternalMicVolume:
          type:
          - integer
          - 'null'
          format: int32
          description: Adjust volume for internal mic. Integer between 0 and 63.
          example: 32
        audioInternalSpeakerVolume:
          type:
          - integer
          - 'null'
          format: int32
          description: Adjust volume for internal speaker. Integer between 0 and 127.
          example: 64
        audioRecord:
          type:
          - boolean
          - 'null'
          description: Enable/disable audio recording. Cannot set to true unless organization settings allow it
          example: true
        audioUseExternalMic:
          type:
          - boolean
          - 'null'
          description: Use external microphone instead of internal
          example: false
        audioUseExternalSpeaker:
          type:
          - boolean
          - 'null'
          description: Use external speaker instead of internal
          example: false
        deviceMicEnabled:
          type:
          - boolean
          - 'null'
          description: Enable/disable device mic. Cannot set to true unless organization settings allow it
          example: true
        deviceSpeakerEnabled:
          type:
          - boolean
          - 'null'
          description: Enable/disable device speaker
          example: true
        frontendEqualizerHighShelf:
          $ref: '#/components/schemas/FrontendEqualizerSettings'
        frontendEqualizerLowShelf:
          $ref: '#/components/schemas/FrontendEqualizerSettings'
        frontendEqualizerPeaking1:
          $ref: '#/components/schemas/FrontendEqualizerSettings'
        frontendEqualizerPeaking2:
          $ref: '#/components/schemas/FrontendEqualizerSettings'
        frontendEqualizerPeaking3:
          $ref: '#/components/schemas/FrontendEqualizerSettings'
        frontendNoiseSuppression:
          type:
          - boolean
          - 'null'
          description: Enable frontend noise suppression
          example: true
        uuid:
          type:
          - string
          - 'null'
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
    DeviceStatusEnum:
      type: string
      enum:
      - RED
      - ORANGE
      - YELLOW
      - GREEN
    FootageSeekPointV2Type:
      type: object
      description: List of shared footage seekpoints (deprecated)
      properties:
        a:
          $ref: '#/components/schemas/ActivityEnum'
        ae:
          type:
          - string
          - 'null'
          description: area being entered
        al:
          type:
          - boolean
          - 'null'
          description: alerted on this?
        ax:
          type:
          - string
          - 'null'
          description: area being exited
        bs:
          type:
          - string
          - 'null'
          description: badge status (e.g. Active, Lost)
        bt:
          type:
          - string
          - 'null'
          description: badge type
        cc:
          $ref: '#/components/schemas/FootageSeekPointColorEnum'
        cd:
          type:
          - string
          - 'null'
          description: Custom activity display description, maximum 100 characters
        cdn:
          type:
          - string
          - 'null'
          description: Custom activity display name, maximum 32 characters
        ch:
          type:
          - string
          - 'null'
          description: badge holder's name
        dcao:
          type:
          - boolean
          - 'null'
        dwelling:
          type:
          - boolean
          - 'null'
        em:
          type:
          - boolean
          - 'null'
          description: access granted and entry made (false = no entry / possible tailgating)
        fn:
          type:
          - string
          - 'null'
          description: face names
        id:
          type:
          - integer
          - 'null'
          format: int32
        loudness:
          type:
          - integer
          - 'null'
          format: int32
        lp:
          type:
          - string
          - 'null'
          description: license plate
        m:
          type:
          - boolean
          - 'null'
          description: object in motion?
        p:
          type:
          - string
          - 'null'
          description: pose
        ro:
          type:
          - array
          - 'null'
          description: recognized objects
          items:
            type:
            - string
            - 'null'
            description: recognized objects
        sensorValType:
          $ref: '#/components/schemas/SensorValType'
        stableTrackId:
          type:
          - integer
          - 'null'
          format: int32
        toi:
          $ref: '#/components/schemas/ToastOrderIdType'
        ts:
          type:
          - integer
          - 'null'
          format: int64
          description: timestamp
        tu:
          type:
          - string
          - 'null'
        uf:
          type:
          - string
          - 'null'
          description: FaceId for an unidentified face
        vn:
          type:
          - string
          - 'null'
          description: vehicle name
      required:
      - a
      - ts
    TimeWindowSeconds:
      type: object
      description: List of uptime windows for the device
      properties:
        durationSeconds:
          type:
          - integer
          - 'null'
          format: int64
        startSeconds:
          type:
          - integer
          - 'null'
          format: int64
    MinimalAudioGatewayStateType:
      type: object
      description: List of minimal audio gateway state information
      properties:
        associatedCameras:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
            format: DeviceFacetUuid
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
        connectionStatus:
          $ref: '#/components/schemas/DeviceStatusEnum'
        createdAtMillis:
          type:
          - integer
          - 'null'
          format: int64
        defaultInterface:
          type:
          - string
          - 'null'
        defaultInterfaceMac:
          type:
          - string
          - 'null'
        directionRadians:
          type:
          - number
          - 'null'
          format: float
        externalIPAddress:
          type:
          - string
          - 'null'
        facetNameMap:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        firmwareUpdateInProgress:
          type:
          - boolean
          - 'null'
        firmwareVersion:
          type:
          - string
          - 'null'
        floorNumber:
          type:
          - integer
          - 'null'
          format: int32
        healthStatus:
          $ref: '#/components/schemas/DeviceStatusEnum'
        healthStatusDetails:
          $ref: '#/components/schemas/DeviceHealthStatusDetailsEnum'
        hwVariation:
          $ref: '#/components/schemas/HardwareVariationEnum'
        lanAddresses:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        latitude:
          type:
          - number
          - 'null'
          format: double
        liveStreamShared:
          type:
          - boolean
          - 'null'
        liveStreamsSharedCount:
          type:
          - integer
          - 'null'
          format: int32
        locationUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        longitude:
          type:
          - number
          - 'null'
          format: double
        mediaRegion:
          type:
          - string
          - 'null'
        mediaStorageDeviceUuid:
          type:
          - string
          - 'null'
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
        mummified:
          type:
          - boolean
          - 'null'
        name:
          type:
          - string
          - 'null'
        policyUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        region:
          type:
          - string
          - 'null'
        secondaryLanAddresses:
          type:
          - array
          - 'null'
          items:
            type:
            - string
            - 'null'
        sensorUuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        serialNumber:
          type:
          - string
          - 'null'
        ssid:
          type:
          - string
          - 'null'
        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})*$
        supportedFacets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DeviceFacetEnum'
          uniqueItems: true
        uuid:
          type:
          - string
          - 'null'
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
        wifiApMa

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