@seamapi/types 1.1084.0 → 1.1086.0

package/src/lib/seam/connect/route-types.ts

@@ -16314,6 +16314,8 @@ export type Routes = {
               can_simulate_paid_subscription?: boolean | undefined
               /** Indicates whether the lock supports configuring automatic locking. */
               can_configure_auto_lock?: boolean | undefined
+              /** Indicates whether the camera supports streaming live video through a camera live view session. */
+              can_stream_live_video?: boolean | undefined
             }[]
           | undefined
         acs_entrances?:
@@ -24930,6 +24932,8 @@ export type Routes = {
               can_simulate_paid_subscription?: boolean | undefined
               /** Indicates whether the lock supports configuring automatic locking. */
               can_configure_auto_lock?: boolean | undefined
+              /** Indicates whether the camera supports streaming live video through a camera live view session. */
+              can_stream_live_video?: boolean | undefined
             }[]
           | undefined
         acs_entrances?:
@@ -49113,18 +49117,26 @@ export type Routes = {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the camera to view. */
       device_id: string
+      /** Indicates whether to include the camera's audio. */
       include_audio?: boolean
+      /** Number of seconds for which the live view session is valid, up to 600. */
       duration_seconds?: number
     }
     commonParams: {}
     formData: {}
     jsonResponse: {
+      /** 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. */
       camera_live_view_session: {
+        /** ID of the camera live view session. */
         camera_live_view_session_id: string
+        /** ID of the camera. */
         device_id: string
-        expires_at: string
+        /** Token that authorizes the offer and stop requests for this session. */
         token: string
+        /** Date and time at which the live view session expires. */
+        expires_at: string
       }
     }
     maxDuration: undefined
@@ -49134,16 +49146,21 @@ export type Routes = {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the camera live view session. */
       camera_live_view_session_id: string
+      /** Token returned when the camera live view session was created. */
       token: string
-      /** WebRTC SDP, limited to 64 KiB of UTF-8 data. */
+      /** WebRTC SDP offer from the viewer, limited to 64 KiB of UTF-8 data. */
       sdp_offer: string
     }
     commonParams: {}
     formData: {}
     jsonResponse: {
-      /** WebRTC SDP, limited to 64 KiB of UTF-8 data. */
-      sdp_answer: string
+      /** Represents the WebRTC SDP answer that starts streaming video from a camera for a live view session. */
+      camera_live_view_answer: {
+        /** WebRTC SDP answer for the offer, limited to 64 KiB of UTF-8 data. */
+        sdp_answer: string
+      }
     }
     maxDuration: undefined
   }
@@ -49152,7 +49169,9 @@ export type Routes = {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the camera live view session. */
       camera_live_view_session_id: string
+      /** Token returned when the camera live view session was created. */
       token: string
     }
     commonParams: {}
@@ -53584,6 +53603,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }
     }
     maxDuration: undefined
@@ -53803,6 +53824,7 @@ export type Routes = {
             | 'can_simulate_hub_disconnection'
             | 'can_simulate_paid_subscription'
             | 'can_configure_auto_lock'
+            | 'can_stream_live_video'
           )[]
         | undefined
       /**  */
@@ -53829,6 +53851,7 @@ export type Routes = {
             | 'can_simulate_hub_disconnection'
             | 'can_simulate_paid_subscription'
             | 'can_configure_auto_lock'
+            | 'can_stream_live_video'
           )[]
         | undefined
       /**
@@ -55761,6 +55784,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
       /** Information about the current page of results. */
       pagination: {
@@ -55924,6 +55949,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
     }
     maxDuration: undefined
@@ -57939,6 +57966,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }
     }
     maxDuration: undefined
@@ -58148,6 +58177,7 @@ export type Routes = {
             | 'can_simulate_hub_disconnection'
             | 'can_simulate_paid_subscription'
             | 'can_configure_auto_lock'
+            | 'can_stream_live_video'
           )[]
         | undefined
       /**  */
@@ -58174,6 +58204,7 @@ export type Routes = {
             | 'can_simulate_hub_disconnection'
             | 'can_simulate_paid_subscription'
             | 'can_configure_auto_lock'
+            | 'can_stream_live_video'
           )[]
         | undefined
       /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
@@ -58778,6 +58809,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
       /** Information about the current page of results. */
       pagination: {
@@ -62715,10 +62748,8 @@ export type Routes = {
                 image_url?: string | undefined
                 /** URL to a short video clip captured at the time of activation. */
                 video_url?: string | undefined
-                /** 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. */
-                media_status?:
-                  | ('pending' | 'available' | 'unavailable' | 'failed')
-                  | undefined
+                /** IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one. */
+                media_ids?: string[] | undefined
               }
             | {
                 /** ID of the event. */
@@ -62754,6 +62785,8 @@ export type Routes = {
                 image_url?: string | undefined
                 /** URL to a short video clip captured at the time the doorbell was pressed. */
                 video_url?: string | undefined
+                /** 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. */
+                media_ids?: string[] | undefined
               }
             | {
                 /** ID of the event. */
@@ -67012,9 +67045,8 @@ export type Routes = {
             image_url?: string | undefined
             /** URL to a short video clip captured at the time of activation. */
             video_url?: string | undefined
-            /** 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. */
-            media_status?:
-              ('pending' | 'available' | 'unavailable' | 'failed') | undefined
+            /** IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one. */
+            media_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -67050,6 +67082,8 @@ export type Routes = {
             image_url?: string | undefined
             /** URL to a short video clip captured at the time the doorbell was pressed. */
             video_url?: string | undefined
+            /** 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. */
+            media_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -71353,6 +71387,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }
       /** Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam. */
       device: {
@@ -73275,6 +73311,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }
     }
     maxDuration: undefined
@@ -75326,6 +75364,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
       devices: {
         /** ID of the device. */
@@ -77247,6 +77287,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
     }
     maxDuration: undefined
@@ -85873,6 +85915,45 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/media/get': {
+    route: '/media/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of the media that you want to get. */
+      media_id: string
+      /** 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. */
+      format?: 'json' | 'redirect'
+    }
+    formData: {}
+    jsonResponse: {
+      /** 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. */
+      media: {
+        /** ID of the media. */
+        media_id: string
+        /** ID of the workspace that contains the media. */
+        workspace_id: string
+        /** ID of the device that captured the media. */
+        device_id: string | null
+        /** ID of the event that the media belongs to. */
+        event_id: string | null
+        /** Type of the media: a video clip or a still image. */
+        media_type: 'video' | 'image'
+        /** MIME type of the media, such as `video/mp4` or `image/jpeg`. */
+        content_type: string | null
+        /** 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. */
+        status: 'pending' | 'available' | 'unavailable' | 'failed'
+        /** 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. */
+        url: string | null
+        /** Date and time at which the media stops being available. Null when Seam does not know when the media expires. */
+        expires_at: string | null
+        /** Date and time at which the media was created. */
+        created_at: string
+      }
+    }
+    maxDuration: undefined
+  }
   '/noise_sensors/list': {
     route: '/noise_sensors/list'
     method: 'GET' | 'POST'
@@ -87814,6 +87895,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
       devices: {
         /** ID of the device. */
@@ -89735,6 +89818,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
     }
     maxDuration: undefined
@@ -105540,9 +105625,8 @@ export type Routes = {
             image_url?: string | undefined
             /** URL to a short video clip captured at the time of activation. */
             video_url?: string | undefined
-            /** 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. */
-            media_status?:
-              ('pending' | 'available' | 'unavailable' | 'failed') | undefined
+            /** IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one. */
+            media_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -105578,6 +105662,8 @@ export type Routes = {
             image_url?: string | undefined
             /** URL to a short video clip captured at the time the doorbell was pressed. */
             video_url?: string | undefined
+            /** 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. */
+            media_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -112181,9 +112267,8 @@ export type Routes = {
             image_url?: string | undefined
             /** URL to a short video clip captured at the time of activation. */
             video_url?: string | undefined
-            /** 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. */
-            media_status?:
-              ('pending' | 'available' | 'unavailable' | 'failed') | undefined
+            /** IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one. */
+            media_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -112219,6 +112304,8 @@ export type Routes = {
             image_url?: string | undefined
             /** URL to a short video clip captured at the time the doorbell was pressed. */
             video_url?: string | undefined
+            /** 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. */
+            media_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -114621,6 +114708,8 @@ export type Routes = {
               can_simulate_paid_subscription?: boolean | undefined
               /** Indicates whether the lock supports configuring automatic locking. */
               can_configure_auto_lock?: boolean | undefined
+              /** Indicates whether the camera supports streaming live video through a camera live view session. */
+              can_stream_live_video?: boolean | undefined
             }[]
           | undefined
         acs_entrances?:
@@ -126390,6 +126479,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }
     }
     maxDuration: undefined
@@ -132686,6 +132777,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
       devices: {
         /** ID of the device. */
@@ -134607,6 +134700,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
     }
     maxDuration: undefined
@@ -146198,6 +146293,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
       /**
        * @deprecated Use devices.*/
@@ -148121,6 +148218,8 @@ export type Routes = {
         can_simulate_paid_subscription?: boolean | undefined
         /** Indicates whether the lock supports configuring automatic locking. */
         can_configure_auto_lock?: boolean | undefined
+        /** Indicates whether the camera supports streaming live video through a camera live view session. */
+        can_stream_live_video?: boolean | undefined
       }[]
     }
     maxDuration: undefined
@@ -151635,6 +151734,8 @@ export type Routes = {
               can_simulate_paid_subscription?: boolean | undefined
               /** Indicates whether the lock supports configuring automatic locking. */
               can_configure_auto_lock?: boolean | undefined
+              /** Indicates whether the camera supports streaming live video through a camera live view session. */
+              can_stream_live_video?: boolean | undefined
             }[]
           | undefined
         acs_entrances?:
@@ -155956,6 +156057,8 @@ export type Routes = {
               can_simulate_paid_subscription?: boolean | undefined
               /** Indicates whether the lock supports configuring automatic locking. */
               can_configure_auto_lock?: boolean | undefined
+              /** Indicates whether the camera supports streaming live video through a camera live view session. */
+              can_stream_live_video?: boolean | undefined
             }[]
           | undefined
         connect_webviews?:
@@ -160494,10 +160597,8 @@ export type Routes = {
                   image_url?: string | undefined
                   /** URL to a short video clip captured at the time of activation. */
                   video_url?: string | undefined
-                  /** 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. */
-                  media_status?:
-                    | ('pending' | 'available' | 'unavailable' | 'failed')
-                    | undefined
+                  /** IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one. */
+                  media_ids?: string[] | undefined
                 }
               | {
                   /** ID of the event. */
@@ -160533,6 +160634,8 @@ export type Routes = {
                   image_url?: string | undefined
                   /** URL to a short video clip captured at the time the doorbell was pressed. */
                   video_url?: string | undefined
+                  /** 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. */
+                  media_ids?: string[] | undefined
                 }
               | {
                   /** ID of the event. */

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

@@ -10,6 +10,8 @@ export {
   batch,
   bridge,
   bridge_client_session,
+  camera_live_view_answer,
+  camera_live_view_session,
   client_session,
   common_failed_action_attempt,
   common_pending_action_attempt,
@@ -23,6 +25,7 @@ export {
   device_provider,
   instant_key,
   magic_link,
+  media,
   noise_threshold,
   pagination,
   seam_event,