@seamapi/types 1.1076.0 → 1.1078.0

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

@@ -478,7 +478,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['failed_to_expire'],
+                      enum: ['failed_to_remove'],
                       type: 'string',
                     },
                     is_access_code_error: {
@@ -20556,7 +20556,7 @@ const openapi: OpenAPISpec = {
           },
           {
             description:
-              'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and the accompanying `failed_to_expire` error clears automatically once the access code is no longer active.',
+              'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and the accompanying `failed_to_remove` error clears automatically once the access code is no longer active.',
             properties: {
               access_code_errors: {
                 description: 'Errors associated with the access code.',
@@ -20775,7 +20775,7 @@ const openapi: OpenAPISpec = {
                 type: 'string',
               },
               event_type: {
-                enum: ['access_code.failed_to_expire'],
+                enum: ['access_code.failed_to_remove'],
                 type: 'string',
               },
               occurred_at: {
@@ -32045,7 +32045,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['failed_to_expire'],
+                      enum: ['failed_to_remove'],
                       type: 'string',
                     },
                     is_access_code_error: {
@@ -39039,7 +39039,7 @@ const openapi: OpenAPISpec = {
                   'access_code.delay_in_issuing',
                   'access_code.failed_to_issue',
                   'access_code.failed_to_update',
-                  'access_code.failed_to_expire',
+                  'access_code.failed_to_remove',
                   'access_code.scheduled_on_device',
                   'access_code.set_on_device',
                   'access_code.removed_from_device',
@@ -39140,7 +39140,7 @@ const openapi: OpenAPISpec = {
                               'access_code.delay_in_issuing',
                               'access_code.failed_to_issue',
                               'access_code.failed_to_update',
-                              'access_code.failed_to_expire',
+                              'access_code.failed_to_remove',
                               'access_code.scheduled_on_device',
                               'access_code.set_on_device',
                               'access_code.removed_from_device',
@@ -46324,6 +46324,191 @@ const openapi: OpenAPISpec = {
         'x-undocumented': 'Not yet for customer use.',
       },
     },
+    '/cameras/live_views/create': {
+      post: {
+        description: 'Creates a short-lived, single-camera live view session.',
+        operationId: 'camerasLiveViewsCreatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                additionalProperties: false,
+                properties: {
+                  device_id: { format: 'uuid', type: 'string' },
+                  duration_seconds: {
+                    default: 600,
+                    maximum: 600,
+                    minimum: 1,
+                    type: 'integer',
+                  },
+                  include_audio: { default: false, type: 'boolean' },
+                },
+                required: ['device_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                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',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['camera_live_view_session', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [{ client_session: [] }],
+        summary: '/cameras/live_views/create',
+        tags: [],
+        'x-fern-sdk-group-name': ['cameras', 'live_views'],
+        'x-fern-sdk-method-name': 'create',
+        '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.',
+        operationId: 'camerasLiveViewsOfferPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                additionalProperties: false,
+                properties: {
+                  camera_live_view_session_id: {
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  sdp_offer: {
+                    description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
+                    maxLength: 65_536,
+                    minLength: 1,
+                    type: 'string',
+                  },
+                  token: { maxLength: 512, minLength: 1, type: 'string' },
+                },
+                required: ['camera_live_view_session_id', 'token', 'sdp_offer'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              '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',
+                    },
+                  },
+                  required: ['sdp_answer', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [{ client_session: [] }],
+        summary: '/cameras/live_views/offer',
+        tags: [],
+        'x-fern-sdk-group-name': ['cameras', 'live_views'],
+        'x-fern-sdk-method-name': 'offer',
+        'x-response-key': null,
+        '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.',
+        operationId: 'camerasLiveViewsStopPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                additionalProperties: false,
+                properties: {
+                  camera_live_view_session_id: {
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  token: { maxLength: 512, minLength: 1, type: 'string' },
+                },
+                required: ['camera_live_view_session_id', 'token'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          '400': { description: 'Bad Request' },
+          '401': { description: 'Unauthorized' },
+        },
+        security: [{ client_session: [] }],
+        summary: '/cameras/live_views/stop',
+        tags: [],
+        'x-fern-sdk-group-name': ['cameras', 'live_views'],
+        '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': {
       put: {
         description:
@@ -53594,7 +53779,7 @@ const openapi: OpenAPISpec = {
                 'access_code.delay_in_issuing',
                 'access_code.failed_to_issue',
                 'access_code.failed_to_update',
-                'access_code.failed_to_expire',
+                'access_code.failed_to_remove',
                 'access_code.deleted',
                 'access_code.delay_in_removing_from_device',
                 'access_code.failed_to_remove_from_device',
@@ -53719,7 +53904,7 @@ const openapi: OpenAPISpec = {
                   'access_code.delay_in_issuing',
                   'access_code.failed_to_issue',
                   'access_code.failed_to_update',
-                  'access_code.failed_to_expire',
+                  'access_code.failed_to_remove',
                   'access_code.deleted',
                   'access_code.delay_in_removing_from_device',
                   'access_code.failed_to_remove_from_device',
@@ -61531,7 +61716,7 @@ const openapi: OpenAPISpec = {
                 'access_code.delay_in_issuing',
                 'access_code.failed_to_issue',
                 'access_code.failed_to_update',
-                'access_code.failed_to_expire',
+                'access_code.failed_to_remove',
                 'access_code.deleted',
                 'access_code.delay_in_removing_from_device',
                 'access_code.failed_to_remove_from_device',
@@ -61657,7 +61842,7 @@ const openapi: OpenAPISpec = {
                   'access_code.delay_in_issuing',
                   'access_code.failed_to_issue',
                   'access_code.failed_to_update',
-                  'access_code.failed_to_expire',
+                  'access_code.failed_to_remove',
                   'access_code.deleted',
                   'access_code.delay_in_removing_from_device',
                   'access_code.failed_to_remove_from_device',
@@ -65095,7 +65280,7 @@ const openapi: OpenAPISpec = {
                       'access_code.delay_in_issuing',
                       'access_code.failed_to_issue',
                       'access_code.failed_to_update',
-                      'access_code.failed_to_expire',
+                      'access_code.failed_to_remove',
                       'access_code.deleted',
                       'access_code.delay_in_removing_from_device',
                       'access_code.failed_to_remove_from_device',
@@ -65306,7 +65491,7 @@ const openapi: OpenAPISpec = {
                       'access_code.delay_in_issuing',
                       'access_code.failed_to_issue',
                       'access_code.failed_to_update',
-                      'access_code.failed_to_expire',
+                      'access_code.failed_to_remove',
                       'access_code.deleted',
                       'access_code.delay_in_removing_from_device',
                       'access_code.failed_to_remove_from_device',

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

@@ -2307,7 +2307,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -2893,7 +2893,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -5603,7 +5603,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -6033,7 +6033,7 @@ export type Routes = {
             | 'access_code.delay_in_issuing'
             | 'access_code.failed_to_issue'
             | 'access_code.failed_to_update'
-            | 'access_code.failed_to_expire'
+            | 'access_code.failed_to_remove'
             | 'access_code.scheduled_on_device'
             | 'access_code.set_on_device'
             | 'access_code.removed_from_device'
@@ -6071,7 +6071,7 @@ export type Routes = {
           | 'access_code.delay_in_issuing'
           | 'access_code.failed_to_issue'
           | 'access_code.failed_to_update'
-          | 'access_code.failed_to_expire'
+          | 'access_code.failed_to_remove'
           | 'access_code.scheduled_on_device'
           | 'access_code.set_on_device'
           | 'access_code.removed_from_device'
@@ -6300,7 +6300,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -6877,7 +6877,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -7431,7 +7431,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -8018,7 +8018,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -10630,7 +10630,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -11096,7 +11096,7 @@ export type Routes = {
               /** Date and time at which Seam created the error. */
               created_at?: string | undefined
               /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-              error_code: 'failed_to_expire'
+              error_code: 'failed_to_remove'
             }
           | {
               /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -48574,6 +48574,58 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/cameras/live_views/create': {
+    route: '/cameras/live_views/create'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      device_id: string
+      include_audio?: boolean
+      duration_seconds?: number
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      camera_live_view_session: {
+        camera_live_view_session_id: string
+        device_id: string
+        expires_at: string
+        token: string
+      }
+    }
+    maxDuration: undefined
+  }
+  '/cameras/live_views/offer': {
+    route: '/cameras/live_views/offer'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      camera_live_view_session_id: string
+      token: string
+      /** WebRTC SDP, 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
+    }
+    maxDuration: undefined
+  }
+  '/cameras/live_views/stop': {
+    route: '/cameras/live_views/stop'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      camera_live_view_session_id: string
+      token: string
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+    maxDuration: undefined
+  }
   '/client_sessions/create': {
     route: '/client_sessions/create'
     method: 'POST' | 'PUT'
@@ -59067,7 +59119,7 @@ export type Routes = {
                       [x: string]: string | boolean
                     }
                   | undefined
-                event_type: 'access_code.failed_to_expire'
+                event_type: 'access_code.failed_to_remove'
                 /** Errors associated with the connected account. */
                 connected_account_errors: {
                   /** Date and time at which Seam created the error. */
@@ -62261,7 +62313,7 @@ export type Routes = {
             | 'access_code.delay_in_issuing'
             | 'access_code.failed_to_issue'
             | 'access_code.failed_to_update'
-            | 'access_code.failed_to_expire'
+            | 'access_code.failed_to_remove'
             | 'access_code.deleted'
             | 'access_code.delay_in_removing_from_device'
             | 'access_code.failed_to_remove_from_device'
@@ -62380,7 +62432,7 @@ export type Routes = {
             | 'access_code.delay_in_issuing'
             | 'access_code.failed_to_issue'
             | 'access_code.failed_to_update'
-            | 'access_code.failed_to_expire'
+            | 'access_code.failed_to_remove'
             | 'access_code.deleted'
             | 'access_code.delay_in_removing_from_device'
             | 'access_code.failed_to_remove_from_device'
@@ -63363,7 +63415,7 @@ export type Routes = {
                   [x: string]: string | boolean
                 }
               | undefined
-            event_type: 'access_code.failed_to_expire'
+            event_type: 'access_code.failed_to_remove'
             /** Errors associated with the connected account. */
             connected_account_errors: {
               /** Date and time at which Seam created the error. */
@@ -100353,7 +100405,7 @@ export type Routes = {
             | 'access_code.delay_in_issuing'
             | 'access_code.failed_to_issue'
             | 'access_code.failed_to_update'
-            | 'access_code.failed_to_expire'
+            | 'access_code.failed_to_remove'
             | 'access_code.deleted'
             | 'access_code.delay_in_removing_from_device'
             | 'access_code.failed_to_remove_from_device'
@@ -100472,7 +100524,7 @@ export type Routes = {
             | 'access_code.delay_in_issuing'
             | 'access_code.failed_to_issue'
             | 'access_code.failed_to_update'
-            | 'access_code.failed_to_expire'
+            | 'access_code.failed_to_remove'
             | 'access_code.deleted'
             | 'access_code.delay_in_removing_from_device'
             | 'access_code.failed_to_remove_from_device'
@@ -101425,7 +101477,7 @@ export type Routes = {
                   [x: string]: string | boolean
                 }
               | undefined
-            event_type: 'access_code.failed_to_expire'
+            event_type: 'access_code.failed_to_remove'
             /** Errors associated with the connected account. */
             connected_account_errors: {
               /** Date and time at which Seam created the error. */
@@ -106964,7 +107016,7 @@ export type Routes = {
         | 'access_code.delay_in_issuing'
         | 'access_code.failed_to_issue'
         | 'access_code.failed_to_update'
-        | 'access_code.failed_to_expire'
+        | 'access_code.failed_to_remove'
         | 'access_code.deleted'
         | 'access_code.delay_in_removing_from_device'
         | 'access_code.failed_to_remove_from_device'
@@ -107106,7 +107158,7 @@ export type Routes = {
         | 'access_code.delay_in_issuing'
         | 'access_code.failed_to_issue'
         | 'access_code.failed_to_update'
-        | 'access_code.failed_to_expire'
+        | 'access_code.failed_to_remove'
         | 'access_code.deleted'
         | 'access_code.delay_in_removing_from_device'
         | 'access_code.failed_to_remove_from_device'
@@ -108063,7 +108115,7 @@ export type Routes = {
                   [x: string]: string | boolean
                 }
               | undefined
-            event_type: 'access_code.failed_to_expire'
+            event_type: 'access_code.failed_to_remove'
             /** Errors associated with the connected account. */
             connected_account_errors: {
               /** Date and time at which Seam created the error. */
@@ -153690,7 +153742,7 @@ export type Routes = {
                         [x: string]: string | boolean
                       }
                     | undefined
-                  event_type: 'access_code.failed_to_expire'
+                  event_type: 'access_code.failed_to_remove'
                   /** Errors associated with the connected account. */
                   connected_account_errors: {
                     /** Date and time at which Seam created the error. */
@@ -157389,7 +157441,7 @@ export type Routes = {
                     /** Date and time at which Seam created the error. */
                     created_at?: string | undefined
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-                    error_code: 'failed_to_expire'
+                    error_code: 'failed_to_remove'
                   }
                 | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
@@ -157841,7 +157893,7 @@ export type Routes = {
                     /** Date and time at which Seam created the error. */
                     created_at?: string | undefined
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
-                    error_code: 'failed_to_expire'
+                    error_code: 'failed_to_remove'
                   }
                 | {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */