@portpowered/reference-data 0.4.5 → 0.4.7

package/generated/public/docs/references/openapi.yaml

@@ -858,7 +858,19 @@ paths:
       operationId: endpointQuery
       tags:
         - Endpoints
-      description: Query for endpoints
+      description: >-
+        Return a bounded page of authorized endpoints matching the shared Query expression,
+        including endpoints shared by other owners. Read permission is evaluated before filtering,
+        pagination and state expansion. See the request schema for supported fields and operators.
+        Use groupId to select members of a readable room/group, then intersect type or declared
+        interfaces to select lights. Group predicates additionally require group:read for delegated
+        OAuth. Repeat the complete query settings and grant when following nextToken; cursors expire
+        after fifteen minutes. Device attributes are returned only when expanded. Report per-target
+        command acceptance and observed state separately; querying a group does not grant permission
+        to control its members.
+      x-portos-conditional-scopes:
+        groupId:
+          - group:read
       requestBody:
         required: true
         content:
@@ -868,8 +880,10 @@ paths:
             example:
               query:
                 match:
-                  key: name
-                  value: test
+                  key: type
+                  value: LIGHT
+              paginationContext:
+                maxResults: 10
       responses:
         '200':
           description: Endpoints retrieved successfully
@@ -879,10 +893,8 @@ paths:
                 $ref: '#/components/schemas/EndpointQueryResponse'
               example:
                 results: []
-                paginationContext:
-                  nextToken: abc123
         '400':
-          description: Bad request - missing required parameters
+          description: Invalid query, unsupported expansion, or invalid/expired/mismatched cursor.
           content:
             application/json:
               schema:
@@ -901,6 +913,36 @@ paths:
                 message: Unauthorized - invalid or missing authentication token
                 code: UNAUTHORIZED
                 family: AUTHENTICATION
+        '403':
+          description: Missing conditional OAuth scope or permission to read a referenced group.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              example:
+                message: Permission to read the requested group is required.
+                code: FORBIDDEN
+                family: FORBIDDEN
+        '404':
+          description: A referenced group does not exist.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              example:
+                message: Requested group was not found.
+                code: NOT_FOUND
+                family: NOT_FOUND
+        '409':
+          description: A selected disabled endpoint cannot be forcibly refreshed.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              example:
+                message: endpoint messaging is disabled
+                code: ENDPOINT_DISABLED
+                family: CONFLICT
         '500':
           description: Internal server error
           content:
@@ -9795,12 +9837,31 @@ components:
       x-version: '1.0'
       x-type: message
       x-directionality: in
+      description: >-
+        Search for and play media by title or query using a service advertised by the endpoint.
+        Omitting mediaType retains audio search behavior; video-only endpoints may default to video.
       type: object
       properties:
         query:
           type: string
-          description: Query to search for audio content
+          description: Query to search for media content
           minLength: 1
+        provider:
+          $ref: '#/components/schemas/MediaProvider'
+        mediaType:
+          type: string
+          enum:
+            - AUDIO
+            - VIDEO
+          description: Media search domain. The endpoint must advertise support for the selected type.
+          x-enum-varnames:
+            - MediaSearchTypeAudio
+            - MediaSearchTypeVideo
+        timerSeconds:
+          type: integer
+          minimum: 1
+          maximum: 86400
+          description: Optional provider playback timer in seconds.
       required:
         - query
       additionalProperties: false
@@ -10774,6 +10835,7 @@ components:
             - LEFT
             - RIGHT
             - SELECT
+            - HOME
             - BACK
             - EXIT
             - MENU
@@ -10868,6 +10930,17 @@ components:
       x-directionality: in
       type: object
       additionalProperties: false
+    MediaPlayerInterfaceFastForwardMessage:
+      x-namespace: port1/systems/zero/capability-interfaces/media-player
+      x-name: fast-forward
+      x-version: '1.0'
+      x-type: message
+      x-directionality: in
+      description: >-
+        Begin provider-defined fast-forward playback. This does not seek by a specific duration; use
+        skip-forward or seek for a known position change.
+      type: object
+      additionalProperties: false
     MediaPlayerInterfaceStartOverMessage:
       x-namespace: port1/systems/zero/capability-interfaces/media-player
       x-name: start-over
@@ -11229,6 +11302,24 @@ components:
           maximum: 100
       required:
         - brightness
+    BrightnessInterfaceAdjustBrightnessMessage:
+      x-namespace: port1/systems/zero/capability-interfaces/brightness
+      x-name: adjust-brightness
+      x-version: '1.0'
+      x-type: message
+      x-directionality: in
+      description: >-
+        Adjust brightness by a signed number of percentage points. The endpoint must advertise this
+        message separately from set-brightness.
+      type: object
+      properties:
+        brightnessDelta:
+          type: integer
+          minimum: -100
+          maximum: 100
+      required:
+        - brightnessDelta
+      additionalProperties: false
     MediaSearchInterfaceAudioMediaResultsMessage:
       x-namespace: port1/systems/zero/capability-interfaces/media-search
       x-name: audio-media-results
@@ -17245,6 +17336,7 @@ components:
               - LEFT
               - RIGHT
               - SELECT
+              - HOME
               - BACK
               - EXIT
               - MENU
@@ -17331,6 +17423,28 @@ components:
         implemented by this endpoint.
       type: object
       properties:
+        supportedAudioProviders:
+          type: array
+          uniqueItems: true
+          description: >-
+            Audio services accepted by search-and-play on this endpoint. These describe command
+            support, not active subscriptions.
+          items:
+            $ref: '#/components/schemas/MediaProvider'
+        supportedVideoProviders:
+          type: array
+          uniqueItems: true
+          description: >-
+            Video services accepted by search-and-play on this endpoint. These describe command
+            support, not installed applications or active subscriptions.
+          items:
+            $ref: '#/components/schemas/MediaProvider'
+        defaultAudioProvider:
+          $ref: '#/components/schemas/MediaProvider'
+          description: Default service for an audio search. Must be in supportedAudioProviders.
+        defaultVideoProvider:
+          $ref: '#/components/schemas/MediaProvider'
+          description: Default service for a video search. Must be in supportedVideoProviders.
         supportedPlaybackStates:
           type: array
           items:
@@ -17921,6 +18035,15 @@ components:
       x-version: '1.0'
       x-type: configuration
       type: object
+      properties:
+        supportedInputTypes:
+          type: array
+          uniqueItems: true
+          items:
+            type: string
+            enum:
+              - SSML
+              - CANNED_TTS
       additionalProperties: false
     TemperatureSensorInterfaceConfiguration:
       x-namespace: port1/systems/zero/capability-interfaces/temperature-sensor
@@ -18543,18 +18666,59 @@ components:
           description: The value to match on
     EndpointQueryRequest:
       type: object
+      additionalProperties: false
       required:
         - query
       properties:
         query:
           $ref: '#/components/schemas/Query'
+          description: >-
+            A bounded shared Query expression. An empty object selects unfiltered readable
+            inventory. This endpoint supports match, and, or, and not. Scalar match keys are id,
+            name, type, ownerId, manufacturer, model, and enablement. interfaces matches membership
+            in the endpoint's declared interface names; groupId matches membership in a readable
+            endpoint group. Comparisons, patterns, freeform search, unknown keys, ambiguous nodes,
+            expressions deeper than eight levels, or more than 64 nodes return 400. Values are exact
+            strings. Collections hide disabled endpoints unless the expression explicitly filters
+            enablement. Results include readable shared endpoints, regardless of their owner. A
+            groupId predicate additionally requires group:read for delegated OAuth and read
+            permission on that group.
         paginationContext:
-          $ref: '#/components/schemas/PaginationContext'
+          type: object
+          additionalProperties: false
+          properties:
+            maxResults:
+              type: integer
+              minimum: 1
+              maximum: 100
+              default: 10
+              description: Maximum authorized matching endpoints in this page.
+            nextToken:
+              type: string
+              minLength: 1
+              description: >-
+                Opaque server-issued continuation token. Repeat the same query, page size,
+                expansions, forceDeviceQuery setting, and authenticated grant. Modified, expired, or
+                differently bound tokens return 400; restart without nextToken. Follow nextToken
+                until absent, including empty pages.
         expand:
           type: array
-          description: Expansion tokens that request related or computed endpoint fields.
+          uniqueItems: true
+          maxItems: 1
+          description: Optional reported state expansion; only interfaces.attributes is supported.
           items:
             type: string
+            enum:
+              - interfaces.attributes
+            x-enum-exempt: Existing published REST expansion token shared with GET /endpoints.
+        forceDeviceQuery:
+          type: boolean
+          default: false
+          description: >-
+            Refresh reported device attributes for the selected page. Requires expand to contain
+            interfaces.attributes. An accepted command is not proof of device state; inspect the
+            returned sample times and partial errors. Disabled endpoints cannot be forcibly
+            refreshed.
     Simulator:
       description: Legacy string-name application/json projection; default representation remains unchanged.
       allOf:
@@ -21043,6 +21207,41 @@ components:
           type: string
           description: The ID of the view that was created or updated
       additionalProperties: false
+    MediaProvider:
+      type: string
+      description: >-
+        Media service identifier. A provider enum value does not imply that every endpoint supports
+        that service; use the endpoint's advertised provider lists.
+      enum:
+        - SPOTIFY
+        - AMAZON_MUSIC
+        - APPLE_MUSIC
+        - AUDIBLE
+        - TUNE_IN
+        - PANDORA
+        - IHEART_RADIO
+        - SIRIUSXM
+        - DEEZER
+        - TIDAL
+        - YOUTUBE
+        - NETFLIX
+        - PRIME_VIDEO
+        - DAILYMOTION
+      x-enum-varnames:
+        - MediaProviderSpotify
+        - MediaProviderAmazonMusic
+        - MediaProviderAppleMusic
+        - MediaProviderAudible
+        - MediaProviderTuneIn
+        - MediaProviderPandora
+        - MediaProviderIHeartRadio
+        - MediaProviderSiriusXM
+        - MediaProviderDeezer
+        - MediaProviderTidal
+        - MediaProviderYouTube
+        - MediaProviderNetflix
+        - MediaProviderPrimeVideo
+        - MediaProviderDailymotion
     NotificationPayload:
       type: object
       description: Notification payload information
@@ -21529,8 +21728,15 @@ components:
           type: string
           enum:
             - SSML
+            - CANNED_TTS
         ssml:
           type: string
+        cannedTtsStringId:
+          type: string
+          minLength: 1
+          description: >-
+            Provider-defined canned speech identifier; supported only by integrations advertising
+            canned speech.
     AttributeSchema:
       type: object
       properties:

package/generated/public/docs/references/schemas/BrightnessInterfaceAdjustBrightnessMessage.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/brightness",
+  "x-name": "adjust-brightness",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "description": "Adjust brightness by a signed number of percentage points. The endpoint must advertise this message separately from set-brightness.",
+  "type": "object",
+  "properties": {
+    "brightnessDelta": {
+      "type": "integer",
+      "minimum": -100,
+      "maximum": 100
+    }
+  },
+  "required": [
+    "brightnessDelta"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/EndpointQueryRequest.json

@@ -1,22 +1,50 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
+  "additionalProperties": false,
   "required": [
     "query"
   ],
   "properties": {
     "query": {
-      "$ref": "/docs/references/schemas/Query.json"
+      "$ref": "/docs/references/schemas/Query.json",
+      "description": "A bounded shared Query expression. An empty object selects unfiltered readable inventory. This endpoint supports match, and, or, and not. Scalar match keys are id, name, type, ownerId, manufacturer, model, and enablement. interfaces matches membership in the endpoint's declared interface names; groupId matches membership in a readable endpoint group. Comparisons, patterns, freeform search, unknown keys, ambiguous nodes, expressions deeper than eight levels, or more than 64 nodes return 400. Values are exact strings. Collections hide disabled endpoints unless the expression explicitly filters enablement. Results include readable shared endpoints, regardless of their owner. A groupId predicate additionally requires group:read for delegated OAuth and read permission on that group."
     },
     "paginationContext": {
-      "$ref": "/docs/references/schemas/PaginationContext.json"
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "maxResults": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100,
+          "default": 10,
+          "description": "Maximum authorized matching endpoints in this page."
+        },
+        "nextToken": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Opaque server-issued continuation token. Repeat the same query, page size, expansions, forceDeviceQuery setting, and authenticated grant. Modified, expired, or differently bound tokens return 400; restart without nextToken. Follow nextToken until absent, including empty pages."
+        }
+      }
     },
     "expand": {
       "type": "array",
-      "description": "Expansion tokens that request related or computed endpoint fields.",
+      "uniqueItems": true,
+      "maxItems": 1,
+      "description": "Optional reported state expansion; only interfaces.attributes is supported.",
       "items": {
-        "type": "string"
+        "type": "string",
+        "enum": [
+          "interfaces.attributes"
+        ],
+        "x-enum-exempt": "Existing published REST expansion token shared with GET /endpoints."
       }
+    },
+    "forceDeviceQuery": {
+      "type": "boolean",
+      "default": false,
+      "description": "Refresh reported device attributes for the selected page. Requires expand to contain interfaces.attributes. An accepted command is not proof of device state; inspect the returned sample times and partial errors. Disabled endpoints cannot be forcibly refreshed."
     }
   }
 }

package/generated/public/docs/references/schemas/KeypadInputInterfaceConfiguration.json

@@ -27,6 +27,7 @@
           "LEFT",
           "RIGHT",
           "SELECT",
+          "HOME",
           "BACK",
           "EXIT",
           "MENU",

package/generated/public/docs/references/schemas/KeypadInputInterfaceSendKeyMessage.json

@@ -26,6 +26,7 @@
         "LEFT",
         "RIGHT",
         "SELECT",
+        "HOME",
         "BACK",
         "EXIT",
         "MENU",

package/generated/public/docs/references/schemas/MediaPlayerInterfaceConfiguration.json

@@ -7,6 +7,30 @@
   "description": "Configure media playback, media selection and audio playback. Advertise only the messages implemented by this endpoint.",
   "type": "object",
   "properties": {
+    "supportedAudioProviders": {
+      "type": "array",
+      "uniqueItems": true,
+      "description": "Audio services accepted by search-and-play on this endpoint. These describe command support, not active subscriptions.",
+      "items": {
+        "$ref": "/docs/references/schemas/MediaProvider.json"
+      }
+    },
+    "supportedVideoProviders": {
+      "type": "array",
+      "uniqueItems": true,
+      "description": "Video services accepted by search-and-play on this endpoint. These describe command support, not installed applications or active subscriptions.",
+      "items": {
+        "$ref": "/docs/references/schemas/MediaProvider.json"
+      }
+    },
+    "defaultAudioProvider": {
+      "$ref": "/docs/references/schemas/MediaProvider.json",
+      "description": "Default service for an audio search. Must be in supportedAudioProviders."
+    },
+    "defaultVideoProvider": {
+      "$ref": "/docs/references/schemas/MediaProvider.json",
+      "description": "Default service for a video search. Must be in supportedVideoProviders."
+    },
     "supportedPlaybackStates": {
       "type": "array",
       "items": {

package/generated/public/docs/references/schemas/MediaPlayerInterfaceFastForwardMessage.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-player",
+  "x-name": "fast-forward",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "description": "Begin provider-defined fast-forward playback. This does not seek by a specific duration; use skip-forward or seek for a known position change.",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/MediaPlayerInterfaceSearchAndPlayMessage.json

@@ -5,12 +5,34 @@
   "x-version": "1.0",
   "x-type": "message",
   "x-directionality": "in",
+  "description": "Search for and play media by title or query using a service advertised by the endpoint. Omitting mediaType retains audio search behavior; video-only endpoints may default to video.",
   "type": "object",
   "properties": {
     "query": {
       "type": "string",
-      "description": "Query to search for audio content",
+      "description": "Query to search for media content",
       "minLength": 1
+    },
+    "provider": {
+      "$ref": "/docs/references/schemas/MediaProvider.json"
+    },
+    "mediaType": {
+      "type": "string",
+      "enum": [
+        "AUDIO",
+        "VIDEO"
+      ],
+      "description": "Media search domain. The endpoint must advertise support for the selected type.",
+      "x-enum-varnames": [
+        "MediaSearchTypeAudio",
+        "MediaSearchTypeVideo"
+      ]
+    },
+    "timerSeconds": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 86400,
+      "description": "Optional provider playback timer in seconds."
     }
   },
   "required": [

package/generated/public/docs/references/schemas/MediaProvider.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "Media service identifier. A provider enum value does not imply that every endpoint supports that service; use the endpoint's advertised provider lists.",
+  "enum": [
+    "SPOTIFY",
+    "AMAZON_MUSIC",
+    "APPLE_MUSIC",
+    "AUDIBLE",
+    "TUNE_IN",
+    "PANDORA",
+    "IHEART_RADIO",
+    "SIRIUSXM",
+    "DEEZER",
+    "TIDAL",
+    "YOUTUBE",
+    "NETFLIX",
+    "PRIME_VIDEO",
+    "DAILYMOTION"
+  ],
+  "x-enum-varnames": [
+    "MediaProviderSpotify",
+    "MediaProviderAmazonMusic",
+    "MediaProviderAppleMusic",
+    "MediaProviderAudible",
+    "MediaProviderTuneIn",
+    "MediaProviderPandora",
+    "MediaProviderIHeartRadio",
+    "MediaProviderSiriusXM",
+    "MediaProviderDeezer",
+    "MediaProviderTidal",
+    "MediaProviderYouTube",
+    "MediaProviderNetflix",
+    "MediaProviderPrimeVideo",
+    "MediaProviderDailymotion"
+  ]
+}

package/generated/public/docs/references/schemas/SpeechInput.json

@@ -9,11 +9,17 @@
     "type": {
       "type": "string",
       "enum": [
-        "SSML"
+        "SSML",
+        "CANNED_TTS"
       ]
     },
     "ssml": {
       "type": "string"
+    },
+    "cannedTtsStringId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Provider-defined canned speech identifier; supported only by integrations advertising canned speech."
     }
   }
 }

package/generated/public/docs/references/schemas/SpeechSynthesizerInterfaceConfiguration.json

@@ -5,5 +5,18 @@
   "x-version": "1.0",
   "x-type": "configuration",
   "type": "object",
+  "properties": {
+    "supportedInputTypes": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "enum": [
+          "SSML",
+          "CANNED_TTS"
+        ]
+      }
+    }
+  },
   "additionalProperties": false
 }

package/generated/public/docs/references/schemas/index.json

@@ -361,6 +361,12 @@
       "path": "/docs/references/schemas/BrandingInformation.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/BrandingInformation"
     },
+    {
+      "kind": "schemas",
+      "name": "BrightnessInterfaceAdjustBrightnessMessage",
+      "path": "/docs/references/schemas/BrightnessInterfaceAdjustBrightnessMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/BrightnessInterfaceAdjustBrightnessMessage"
+    },
     {
       "kind": "schemas",
       "name": "BrightnessInterfaceBrightnessAttribute",
@@ -2077,6 +2083,12 @@
       "path": "/docs/references/schemas/MediaPlayerInterfaceConfiguration.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceConfiguration"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaPlayerInterfaceFastForwardMessage",
+      "path": "/docs/references/schemas/MediaPlayerInterfaceFastForwardMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceFastForwardMessage"
+    },
     {
       "kind": "schemas",
       "name": "MediaPlayerInterfaceNextMessage",
@@ -2215,6 +2227,12 @@
       "path": "/docs/references/schemas/MediaPlaylistInterfaceShufflePlaylistMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfaceShufflePlaylistMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaProvider",
+      "path": "/docs/references/schemas/MediaProvider.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaProvider"
+    },
     {
       "kind": "schemas",
       "name": "MediaSearchCapabilityInterfaceConfiguration",

package/generated/resources/brightness/message-adjust-brightness.json

@@ -0,0 +1,15 @@
+{
+  "description": "Adjust brightness by a signed number of percentage points. The endpoint must advertise this message separately from set-brightness.",
+  "type": "object",
+  "properties": {
+    "brightnessDelta": {
+      "type": "integer",
+      "minimum": -100,
+      "maximum": 100
+    }
+  },
+  "required": [
+    "brightnessDelta"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/keypad-input/configuration.json

@@ -21,6 +21,7 @@
           "LEFT",
           "RIGHT",
           "SELECT",
+          "HOME",
           "BACK",
           "EXIT",
           "MENU",

package/generated/resources/keypad-input/message-send-key.json

@@ -19,6 +19,7 @@
         "LEFT",
         "RIGHT",
         "SELECT",
+        "HOME",
         "BACK",
         "EXIT",
         "MENU",