@seamapi/types 1.1084.0 → 1.1086.0

package/src/lib/seam/connect/models/media/media.ts

@@ -0,0 +1,55 @@
+import * as z from 'zod/v3'
+
+import { datetime } from '../datetime.js'
+
+export const media = z.object({
+  media_id: z.string().uuid().describe('ID of the media.'),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe('ID of the workspace that contains the media.'),
+  device_id: z
+    .string()
+    .uuid()
+    .nullable()
+    .describe('ID of the device that captured the media.'),
+  event_id: z
+    .string()
+    .uuid()
+    .nullable()
+    .describe('ID of the event that the media belongs to.'),
+  media_type: z
+    .enum(['video', 'image'])
+    .describe('Type of the media: a video clip or a still image.'),
+  content_type: z
+    .string()
+    .nullable()
+    .describe('MIME type of the media, such as `video/mp4` or `image/jpeg`.'),
+  status: z
+    .enum(['pending', 'available', 'unavailable', 'failed'])
+    .describe(
+      'Status of the media. `pending` means that Seam is still retrieving the media. `available` means that `url` can be used to download it. `unavailable` means that no media exists for the event, and `failed` means that Seam could not retrieve it.',
+    ),
+  url: z
+    .string()
+    .url()
+    .nullable()
+    .describe(
+      'Short-lived URL from which you can download the media. Null unless `status` is `available`. The URL expires after about five minutes. Call `/media/get` again for a new URL.',
+    ),
+  expires_at: datetime
+    .nullable()
+    .describe(
+      'Date and time at which the media stops being available. Null when Seam does not know when the media expires.',
+    ),
+  created_at: datetime.describe(
+    'Date and time at which the media was created.',
+  ),
+}).describe(`
+  ---
+  route_path: /media
+  ---
+  Represents a piece of media, such as a video clip or a thumbnail image, that a device captured for an event. Media is in beta.
+`)
+
+export type Media = z.infer<typeof media>

package/src/lib/seam/connect/openapi.ts

@@ -12644,6 +12644,57 @@ const openapi: OpenAPISpec = {
         'x-route-path': '/seam/bridge/v1/bridge_connected_systems',
         'x-undocumented': 'Seam Bridge client only.',
       },
+      camera_live_view_answer: {
+        description:
+          'Represents the WebRTC SDP answer that starts streaming video from a camera for a live view session.',
+        properties: {
+          sdp_answer: {
+            description:
+              'WebRTC SDP answer for the offer, limited to 64 KiB of UTF-8 data.',
+            type: 'string',
+          },
+        },
+        required: ['sdp_answer'],
+        type: 'object',
+        'x-route-path': '/cameras/live_views',
+      },
+      camera_live_view_session: {
+        description:
+          'Represents a short-lived live view session for a single camera. Use the session ID and token to start a WebRTC stream and to stop the session.',
+        properties: {
+          camera_live_view_session_id: {
+            description: 'ID of the camera live view session.',
+            format: 'uuid',
+            type: 'string',
+          },
+          device_id: {
+            description: 'ID of the camera.',
+            format: 'uuid',
+            type: 'string',
+          },
+          expires_at: {
+            description:
+              'Date and time at which the live view session expires.',
+            format: 'date-time',
+            type: 'string',
+          },
+          token: {
+            description:
+              'Token that authorizes the offer and stop requests for this session.',
+            maxLength: 512,
+            minLength: 1,
+            type: 'string',
+          },
+        },
+        required: [
+          'camera_live_view_session_id',
+          'device_id',
+          'token',
+          'expires_at',
+        ],
+        type: 'object',
+        'x-route-path': '/cameras/live_views',
+      },
       client_session: {
         description:
           "Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).",
@@ -13699,6 +13750,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the device supports simulating removal in a sandbox.',
             type: 'boolean',
           },
+          can_stream_live_video: {
+            description:
+              'Indicates whether the camera supports streaming live video through a camera live view session.',
+            type: 'boolean',
+          },
           can_turn_off_hvac: {
             description: 'Indicates whether the thermostat can be turned off.',
             type: 'boolean',
@@ -18278,6 +18334,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the device supports simulating removal in a sandbox.',
             type: 'boolean',
           },
+          can_stream_live_video: {
+            description:
+              'Indicates whether the camera supports streaming live video through a camera live view session.',
+            type: 'boolean',
+          },
           can_turn_off_hvac: {
             description: 'Indicates whether the thermostat can be turned off.',
             type: 'boolean',
@@ -29111,11 +29172,11 @@ const openapi: OpenAPISpec = {
                 format: 'uri',
                 type: 'string',
               },
-              media_status: {
+              media_ids: {
                 description:
-                  'Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed.',
-                enum: ['pending', 'available', 'unavailable', 'failed'],
-                type: 'string',
+                  'IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one.',
+                items: { format: 'uuid', type: 'string' },
+                type: 'array',
               },
               motion_sub_type: {
                 description: 'Sub-type of motion detected, if available.',
@@ -29209,6 +29270,12 @@ const openapi: OpenAPISpec = {
                 format: 'uri',
                 type: 'string',
               },
+              media_ids: {
+                description:
+                  'IDs of the media, such as a video clip and a thumbnail image, captured when the doorbell was pressed. Use `/media/get` to retrieve each one.',
+                items: { format: 'uuid', type: 'string' },
+                type: 'array',
+              },
               occurred_at: {
                 description: 'Date and time at which the event occurred.',
                 format: 'date-time',
@@ -29671,6 +29738,84 @@ const openapi: OpenAPISpec = {
         'x-route-path': '/unstable_partner/building_blocks',
         'x-undocumented': 'Unreleased.',
       },
+      media: {
+        description:
+          'Represents a piece of media, such as a video clip or a thumbnail image, that a device captured for an event. Media is in beta.',
+        properties: {
+          content_type: {
+            description:
+              'MIME type of the media, such as `video/mp4` or `image/jpeg`.',
+            nullable: true,
+            type: 'string',
+          },
+          created_at: {
+            description: 'Date and time at which the media was created.',
+            format: 'date-time',
+            type: 'string',
+          },
+          device_id: {
+            description: 'ID of the device that captured the media.',
+            format: 'uuid',
+            nullable: true,
+            type: 'string',
+          },
+          event_id: {
+            description: 'ID of the event that the media belongs to.',
+            format: 'uuid',
+            nullable: true,
+            type: 'string',
+          },
+          expires_at: {
+            description:
+              'Date and time at which the media stops being available. Null when Seam does not know when the media expires.',
+            format: 'date-time',
+            nullable: true,
+            type: 'string',
+          },
+          media_id: {
+            description: 'ID of the media.',
+            format: 'uuid',
+            type: 'string',
+          },
+          media_type: {
+            description: 'Type of the media: a video clip or a still image.',
+            enum: ['video', 'image'],
+            type: 'string',
+          },
+          status: {
+            description:
+              'Status of the media. `pending` means that Seam is still retrieving the media. `available` means that `url` can be used to download it. `unavailable` means that no media exists for the event, and `failed` means that Seam could not retrieve it.',
+            enum: ['pending', 'available', 'unavailable', 'failed'],
+            type: 'string',
+          },
+          url: {
+            description:
+              'Short-lived URL from which you can download the media. Null unless `status` is `available`. The URL expires after about five minutes. Call `/media/get` again for a new URL.',
+            format: 'uri',
+            nullable: true,
+            type: 'string',
+          },
+          workspace_id: {
+            description: 'ID of the workspace that contains the media.',
+            format: 'uuid',
+            type: 'string',
+          },
+        },
+        required: [
+          'media_id',
+          'workspace_id',
+          'device_id',
+          'event_id',
+          'media_type',
+          'content_type',
+          'status',
+          'url',
+          'expires_at',
+          'created_at',
+        ],
+        type: 'object',
+        'x-route-path': '/media',
+      },
       noise_threshold: {
         description:
           'Represents a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.',
@@ -36343,6 +36488,11 @@ const openapi: OpenAPISpec = {
               'Indicates whether the device supports simulating removal in a sandbox.',
             type: 'boolean',
           },
+          can_stream_live_video: {
+            description:
+              'Indicates whether the camera supports streaming live video through a camera live view session.',
+            type: 'boolean',
+          },
           can_turn_off_hvac: {
             description: 'Indicates whether the thermostat can be turned off.',
             type: 'boolean',
@@ -46486,7 +46636,8 @@ const openapi: OpenAPISpec = {
     },
     '/cameras/live_views/create': {
       post: {
-        description: 'Creates a short-lived, single-camera live view session.',
+        description:
+          'Creates a short-lived live view session for a single camera. Pass the returned session ID and token to `/cameras/live_views/offer` to start a WebRTC stream, and to `/cameras/live_views/stop` to end the session.\n\nCamera live view is in beta. To enable it for your workspace, contact Seam support. To check whether a camera supports live view, use `device.can_stream_live_video`.',
         operationId: 'camerasLiveViewsCreatePost',
         requestBody: {
           content: {
@@ -46494,14 +46645,25 @@ const openapi: OpenAPISpec = {
               schema: {
                 additionalProperties: false,
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
+                  device_id: {
+                    description: 'ID of the camera to view.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                   duration_seconds: {
                     default: 600,
+                    description:
+                      'Number of seconds for which the live view session is valid, up to 600.',
                     maximum: 600,
                     minimum: 1,
                     type: 'integer',
                   },
-                  include_audio: { default: false, type: 'boolean' },
+                  include_audio: {
+                    default: false,
+                    description:
+                      "Indicates whether to include the camera's audio.",
+                    type: 'boolean',
+                  },
                 },
                 required: ['device_id'],
                 type: 'object',
@@ -46516,22 +46678,7 @@ const openapi: OpenAPISpec = {
                 schema: {
                   properties: {
                     camera_live_view_session: {
-                      properties: {
-                        camera_live_view_session_id: {
-                          format: 'uuid',
-                          type: 'string',
-                        },
-                        device_id: { format: 'uuid', type: 'string' },
-                        expires_at: { format: 'date-time', type: 'string' },
-                        token: { maxLength: 512, minLength: 1, type: 'string' },
-                      },
-                      required: [
-                        'camera_live_view_session_id',
-                        'device_id',
-                        'expires_at',
-                        'token',
-                      ],
-                      type: 'object',
+                      $ref: '#/components/schemas/camera_live_view_session',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -46553,13 +46700,12 @@ const openapi: OpenAPISpec = {
         'x-fern-sdk-return-value': 'camera_live_view_session',
         'x-response-key': 'camera_live_view_session',
         'x-title': 'Create a Camera Live View Session',
-        'x-undocumented': 'Camera pilot; not yet for customer use.',
       },
     },
     '/cameras/live_views/offer': {
       post: {
         description:
-          'Exchanges one WebRTC offer for an authorized camera live view session.',
+          'Exchanges a WebRTC SDP offer for an SDP answer that starts streaming video from the camera, for a live view session that you created using `/cameras/live_views/create`.\n\nCamera live view is in beta. To enable it for your workspace, contact Seam support.',
         operationId: 'camerasLiveViewsOfferPost',
         requestBody: {
           content: {
@@ -46568,16 +46714,24 @@ const openapi: OpenAPISpec = {
                 additionalProperties: false,
                 properties: {
                   camera_live_view_session_id: {
+                    description: 'ID of the camera live view session.',
                     format: 'uuid',
                     type: 'string',
                   },
                   sdp_offer: {
-                    description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
+                    description:
+                      'WebRTC SDP offer from the viewer, limited to 64 KiB of UTF-8 data.',
                     maxLength: 65_536,
                     minLength: 1,
                     type: 'string',
                   },
-                  token: { maxLength: 512, minLength: 1, type: 'string' },
+                  token: {
+                    description:
+                      'Token returned when the camera live view session was created.',
+                    maxLength: 512,
+                    minLength: 1,
+                    type: 'string',
+                  },
                 },
                 required: ['camera_live_view_session_id', 'token', 'sdp_offer'],
                 type: 'object',
@@ -46591,16 +46745,12 @@ const openapi: OpenAPISpec = {
               'application/json': {
                 schema: {
                   properties: {
-                    ok: { type: 'boolean' },
-                    sdp_answer: {
-                      description:
-                        'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
-                      maxLength: 65_536,
-                      minLength: 1,
-                      type: 'string',
+                    camera_live_view_answer: {
+                      $ref: '#/components/schemas/camera_live_view_answer',
                     },
+                    ok: { type: 'boolean' },
                   },
-                  required: ['sdp_answer', 'ok'],
+                  required: ['camera_live_view_answer', 'ok'],
                   type: 'object',
                 },
               },
@@ -46615,15 +46765,15 @@ const openapi: OpenAPISpec = {
         tags: [],
         'x-fern-sdk-group-name': ['cameras', 'live_views'],
         'x-fern-sdk-method-name': 'offer',
-        'x-response-key': null,
+        'x-fern-sdk-return-value': 'camera_live_view_answer',
+        'x-response-key': 'camera_live_view_answer',
         'x-title': 'Negotiate a Camera Live View',
-        'x-undocumented': 'Camera pilot; not yet for customer use.',
       },
     },
     '/cameras/live_views/stop': {
       post: {
         description:
-          'Stops a camera live view session owned by the current client session.',
+          'Stops a camera live view session that the current client session owns.\n\nCamera live view is in beta. To enable it for your workspace, contact Seam support.',
         operationId: 'camerasLiveViewsStopPost',
         requestBody: {
           content: {
@@ -46632,10 +46782,17 @@ const openapi: OpenAPISpec = {
                 additionalProperties: false,
                 properties: {
                   camera_live_view_session_id: {
+                    description: 'ID of the camera live view session.',
                     format: 'uuid',
                     type: 'string',
                   },
-                  token: { maxLength: 512, minLength: 1, type: 'string' },
+                  token: {
+                    description:
+                      'Token returned when the camera live view session was created.',
+                    maxLength: 512,
+                    minLength: 1,
+                    type: 'string',
+                  },
                 },
                 required: ['camera_live_view_session_id', 'token'],
                 type: 'object',
@@ -46666,7 +46823,6 @@ const openapi: OpenAPISpec = {
         'x-fern-sdk-method-name': 'stop',
         'x-response-key': null,
         'x-title': 'Stop a Camera Live View Session',
-        'x-undocumented': 'Camera pilot; not yet for customer use.',
       },
     },
     '/client_sessions/create': {
@@ -51212,6 +51368,7 @@ const openapi: OpenAPISpec = {
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
                   'can_configure_auto_lock',
+                  'can_stream_live_video',
                 ],
                 type: 'string',
               },
@@ -51246,6 +51403,7 @@ const openapi: OpenAPISpec = {
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
                   'can_configure_auto_lock',
+                  'can_stream_live_video',
                 ],
                 type: 'string',
               },
@@ -53483,6 +53641,7 @@ const openapi: OpenAPISpec = {
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
                   'can_configure_auto_lock',
+                  'can_stream_live_video',
                 ],
                 type: 'string',
               },
@@ -53517,6 +53676,7 @@ const openapi: OpenAPISpec = {
                   'can_simulate_hub_disconnection',
                   'can_simulate_paid_subscription',
                   'can_configure_auto_lock',
+                  'can_stream_live_video',
                 ],
                 type: 'string',
               },
@@ -55139,6 +55299,72 @@ const openapi: OpenAPISpec = {
         'x-title': 'Unlock a Lock',
       },
     },
+    '/media/get': {
+      get: {
+        description:
+          'Returns a specified piece of media, such as a video clip or thumbnail image captured for a camera event, with a short-lived URL from which you can download it. Camera events list their media in `media_ids`. This endpoint is in beta.',
+        operationId: 'mediaGetGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'media_id',
+            required: true,
+            schema: {
+              description: 'ID of the media that you want to get.',
+              format: 'uuid',
+              type: 'string',
+            },
+          },
+          {
+            in: 'query',
+            name: 'format',
+            required: false,
+            schema: {
+              default: 'json',
+              description:
+                "Response format. `json` returns the media object. `redirect` responds with a `302` redirect to the media's download URL, so you can use this endpoint directly as the source of an image or video.",
+              enum: ['json', 'redirect'],
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    media: { $ref: '#/components/schemas/media' },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['media', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { client_session: [] },
+          { client_session_with_customer: [] },
+          { client_session_with_customer_ro: [] },
+          { support_read_only_token: [] },
+        ],
+        summary: '/media/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['media'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'media',
+        'x-response-key': 'media',
+        'x-title': 'Get Media',
+      },
+    },
     '/noise_sensors/list': {
       get: {
         description: