Updating OpenAPI Spec

static/plex-api-spec-dereferenced.yaml

@@ -3400,6 +3400,64 @@ paths:
                           example: 401
         '500':
           description: If the update process failed to start
+  /companions:
+    servers:
+      - url: 'https://plex.tv/api/v2'
+    get:
+      tags:
+        - Plex.tv
+      summary: Get Companions Data
+      description: Get Companions Data
+      operationId: getCompanionsData
+      responses:
+        '200':
+          description: Companions Data
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    identifier:
+                      type: string
+                      example: tv.plex.sonos
+                    baseURL:
+                      type: string
+                      example: 'https://sonos.plex.tv'
+                    title:
+                      type: string
+                      example: Sonos
+                    linkURL:
+                      type: string
+                      example: 'https://sonos.plex.tv/link'
+                    provides:
+                      type: string
+                      example: clientplayer
+                    token:
+                      type: string
+                      example: VFnxitsRFdWx_WrzsKL
+        '401':
+          description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  errors:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        code:
+                          type: number
+                          example: 1001
+                        message:
+                          type: string
+                          example: User could not be authenticated
+                        status:
+                          type: number
+                          example: 401
   /geoip:
     servers:
       - url: 'https://plex.tv/api/v2'
@@ -3858,6 +3916,209 @@ paths:
                         status:
                           type: number
                           example: 401
+  /user/settings:
+    servers:
+      - url: 'https://plex.tv/api/v2'
+    get:
+      tags:
+        - Plex.tv
+      summary: Get User Settings
+      description: Get User Settings
+      operationId: getUserSettings
+      responses:
+        '200':
+          description: User Settings
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      example: experience
+                    type:
+                      type: string
+                      example: json
+                    value:
+                      type: string
+                    hidden:
+                      type: boolean
+                    updatedAt:
+                      type: number
+                      example: 1681769995
+        '401':
+          description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  errors:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        code:
+                          type: number
+                          example: 1001
+                        message:
+                          type: string
+                          example: User could not be authenticated
+                        status:
+                          type: number
+                          example: 401
+  /user/settings/opt_outs:
+    servers:
+      - url: 'https://plex.tv/api/v2'
+    get:
+      tags:
+        - Plex.tv
+      summary: Get User Opt Out Settings
+      description: Get User Opt Out Settings
+      operationId: getUserOptOutSettings
+      responses:
+        '200':
+          description: User Opt Out Settings
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  tv.plex.provider.podcasts:
+                    type: string
+                    example: opt_in
+                  tv.plex.provider.news:
+                    type: string
+                    example: opt_in
+                  tv.plex.provider.webshows:
+                    type: string
+                    example: opt_out
+                  tv.plex.provider.music:
+                    type: string
+                    example: opt_out
+                  tv.plex.provider.vod:
+                    type: string
+                    example: opt_in
+                  scrobbling:
+                    type: string
+                    example: opt_in
+        '401':
+          description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  errors:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        code:
+                          type: number
+                          example: 1001
+                        message:
+                          type: string
+                          example: User could not be authenticated
+                        status:
+                          type: number
+                          example: 401
+  /rooms:
+    servers:
+      - url: 'https://together.plex.tv'
+    get:
+      tags:
+        - Plex.tv
+        - Watch Together
+      summary: Get Watch Together Rooms
+      description: Get Watch Together Rooms
+      operationId: getWatchTogetherRooms
+      responses:
+        '200':
+          description: Watch Together Rooms
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  rooms:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        endsAt:
+                          type: number
+                          example: 1681926945
+                        id:
+                          type: string
+                          example: 1p0qq82tg3ff
+                        sourceUri:
+                          type: string
+                          example: 'server://96f2fe7a78c9dc1f16a16bedbe90f98149be16b4/com.plexapp.plugins.library/library/metadata/59409'
+                        startsAt:
+                          type: number
+                          example: 1681916145
+                        syncplayHost:
+                          type: string
+                          example: pop-atl01.syncplay.plex.services
+                        syncplayPort:
+                          type: number
+                          example: 7776
+                        title:
+                          type: string
+                          example: The Rookie · S5 · E20 · S.T.R.
+                        type:
+                          type: string
+                          example: watch
+                        updatedAt:
+                          type: number
+                          example: 1681916145
+                        users:
+                          type: array
+                          items:
+                            type: object
+                            properties:
+                              id:
+                                type: number
+                                example: 9539173
+                              thumb:
+                                type: string
+                                example: 'https://plex.tv/users/844780fc6f8a26b5/avatar?c=1679685540'
+                              title:
+                                type: string
+                                example: Luke
+                              username:
+                                type: string
+                                example: Blindkitty38
+                              uuid:
+                                type: string
+                                example: 844780fc6f8a26b5
+                        source:
+                          type: string
+                          example: 'server://96f2fe7a78c9dc1f16a16bedbe90f98149be16b4/com.plexapp.plugins.library/library/metadata/59409'
+        '401':
+          description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  errors:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        code:
+                          type: number
+                          example: 1001
+                        message:
+                          type: string
+                          example: User could not be authenticated
+                        status:
+                          type: number
+                          example: 401
 tags:
   - name: Activities
     description: |