@seamapi/types 1.1084.0 → 1.1085.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/seam/connect/model-types.d.ts +1 -1
- package/lib/seam/connect/models/cameras/camera-live-view-answer.d.ts +9 -0
- package/lib/seam/connect/models/cameras/camera-live-view-answer.js +12 -0
- package/lib/seam/connect/models/cameras/camera-live-view-answer.js.map +1 -0
- package/lib/seam/connect/models/cameras/camera-live-view-session.d.ts +18 -0
- package/lib/seam/connect/models/cameras/camera-live-view-session.js +21 -0
- package/lib/seam/connect/models/cameras/camera-live-view-session.js.map +1 -0
- package/lib/seam/connect/models/cameras/index.d.ts +2 -0
- package/lib/seam/connect/models/cameras/index.js +3 -0
- package/lib/seam/connect/models/cameras/index.js.map +1 -0
- package/lib/seam/connect/models/devices/device-provider.d.ts +4 -1
- package/lib/seam/connect/models/devices/device-provider.js +2 -2
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +6 -0
- package/lib/seam/connect/models/devices/device.js +3 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +4 -0
- package/lib/seam/connect/models/index.d.ts +1 -0
- package/lib/seam/connect/models/index.js +1 -0
- package/lib/seam/connect/models/index.js.map +1 -1
- package/lib/seam/connect/openapi.js +98 -35
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +65 -8
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +2 -0
- package/src/lib/seam/connect/model-types.ts +2 -0
- package/src/lib/seam/connect/models/cameras/camera-live-view-answer.ts +16 -0
- package/src/lib/seam/connect/models/cameras/camera-live-view-session.ts +28 -0
- package/src/lib/seam/connect/models/cameras/index.ts +2 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +2 -2
- package/src/lib/seam/connect/models/devices/device.ts +5 -0
- package/src/lib/seam/connect/models/index.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +112 -36
- package/src/lib/seam/connect/route-types.ts +65 -4
- package/src/lib/seam/connect/schemas.ts +2 -0
|
@@ -11192,6 +11192,52 @@ const openapi = {
|
|
|
11192
11192
|
'x-route-path': '/seam/bridge/v1/bridge_connected_systems',
|
|
11193
11193
|
'x-undocumented': 'Seam Bridge client only.',
|
|
11194
11194
|
},
|
|
11195
|
+
camera_live_view_answer: {
|
|
11196
|
+
description: 'Represents the WebRTC SDP answer that starts streaming video from a camera for a live view session.',
|
|
11197
|
+
properties: {
|
|
11198
|
+
sdp_answer: {
|
|
11199
|
+
description: 'WebRTC SDP answer for the offer, limited to 64 KiB of UTF-8 data.',
|
|
11200
|
+
type: 'string',
|
|
11201
|
+
},
|
|
11202
|
+
},
|
|
11203
|
+
required: ['sdp_answer'],
|
|
11204
|
+
type: 'object',
|
|
11205
|
+
'x-route-path': '/cameras/live_views',
|
|
11206
|
+
},
|
|
11207
|
+
camera_live_view_session: {
|
|
11208
|
+
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.',
|
|
11209
|
+
properties: {
|
|
11210
|
+
camera_live_view_session_id: {
|
|
11211
|
+
description: 'ID of the camera live view session.',
|
|
11212
|
+
format: 'uuid',
|
|
11213
|
+
type: 'string',
|
|
11214
|
+
},
|
|
11215
|
+
device_id: {
|
|
11216
|
+
description: 'ID of the camera.',
|
|
11217
|
+
format: 'uuid',
|
|
11218
|
+
type: 'string',
|
|
11219
|
+
},
|
|
11220
|
+
expires_at: {
|
|
11221
|
+
description: 'Date and time at which the live view session expires.',
|
|
11222
|
+
format: 'date-time',
|
|
11223
|
+
type: 'string',
|
|
11224
|
+
},
|
|
11225
|
+
token: {
|
|
11226
|
+
description: 'Token that authorizes the offer and stop requests for this session.',
|
|
11227
|
+
maxLength: 512,
|
|
11228
|
+
minLength: 1,
|
|
11229
|
+
type: 'string',
|
|
11230
|
+
},
|
|
11231
|
+
},
|
|
11232
|
+
required: [
|
|
11233
|
+
'camera_live_view_session_id',
|
|
11234
|
+
'device_id',
|
|
11235
|
+
'token',
|
|
11236
|
+
'expires_at',
|
|
11237
|
+
],
|
|
11238
|
+
type: 'object',
|
|
11239
|
+
'x-route-path': '/cameras/live_views',
|
|
11240
|
+
},
|
|
11195
11241
|
client_session: {
|
|
11196
11242
|
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).",
|
|
11197
11243
|
properties: {
|
|
@@ -12106,6 +12152,10 @@ const openapi = {
|
|
|
12106
12152
|
description: 'Indicates whether the device supports simulating removal in a sandbox.',
|
|
12107
12153
|
type: 'boolean',
|
|
12108
12154
|
},
|
|
12155
|
+
can_stream_live_video: {
|
|
12156
|
+
description: 'Indicates whether the camera supports streaming live video through a camera live view session.',
|
|
12157
|
+
type: 'boolean',
|
|
12158
|
+
},
|
|
12109
12159
|
can_turn_off_hvac: {
|
|
12110
12160
|
description: 'Indicates whether the thermostat can be turned off.',
|
|
12111
12161
|
type: 'boolean',
|
|
@@ -16143,6 +16193,10 @@ const openapi = {
|
|
|
16143
16193
|
description: 'Indicates whether the device supports simulating removal in a sandbox.',
|
|
16144
16194
|
type: 'boolean',
|
|
16145
16195
|
},
|
|
16196
|
+
can_stream_live_video: {
|
|
16197
|
+
description: 'Indicates whether the camera supports streaming live video through a camera live view session.',
|
|
16198
|
+
type: 'boolean',
|
|
16199
|
+
},
|
|
16146
16200
|
can_turn_off_hvac: {
|
|
16147
16201
|
description: 'Indicates whether the thermostat can be turned off.',
|
|
16148
16202
|
type: 'boolean',
|
|
@@ -32472,6 +32526,10 @@ const openapi = {
|
|
|
32472
32526
|
description: 'Indicates whether the device supports simulating removal in a sandbox.',
|
|
32473
32527
|
type: 'boolean',
|
|
32474
32528
|
},
|
|
32529
|
+
can_stream_live_video: {
|
|
32530
|
+
description: 'Indicates whether the camera supports streaming live video through a camera live view session.',
|
|
32531
|
+
type: 'boolean',
|
|
32532
|
+
},
|
|
32475
32533
|
can_turn_off_hvac: {
|
|
32476
32534
|
description: 'Indicates whether the thermostat can be turned off.',
|
|
32477
32535
|
type: 'boolean',
|
|
@@ -41928,7 +41986,7 @@ const openapi = {
|
|
|
41928
41986
|
},
|
|
41929
41987
|
'/cameras/live_views/create': {
|
|
41930
41988
|
post: {
|
|
41931
|
-
description: 'Creates a short-lived
|
|
41989
|
+
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`.',
|
|
41932
41990
|
operationId: 'camerasLiveViewsCreatePost',
|
|
41933
41991
|
requestBody: {
|
|
41934
41992
|
content: {
|
|
@@ -41936,14 +41994,23 @@ const openapi = {
|
|
|
41936
41994
|
schema: {
|
|
41937
41995
|
additionalProperties: false,
|
|
41938
41996
|
properties: {
|
|
41939
|
-
device_id: {
|
|
41997
|
+
device_id: {
|
|
41998
|
+
description: 'ID of the camera to view.',
|
|
41999
|
+
format: 'uuid',
|
|
42000
|
+
type: 'string',
|
|
42001
|
+
},
|
|
41940
42002
|
duration_seconds: {
|
|
41941
42003
|
default: 600,
|
|
42004
|
+
description: 'Number of seconds for which the live view session is valid, up to 600.',
|
|
41942
42005
|
maximum: 600,
|
|
41943
42006
|
minimum: 1,
|
|
41944
42007
|
type: 'integer',
|
|
41945
42008
|
},
|
|
41946
|
-
include_audio: {
|
|
42009
|
+
include_audio: {
|
|
42010
|
+
default: false,
|
|
42011
|
+
description: "Indicates whether to include the camera's audio.",
|
|
42012
|
+
type: 'boolean',
|
|
42013
|
+
},
|
|
41947
42014
|
},
|
|
41948
42015
|
required: ['device_id'],
|
|
41949
42016
|
type: 'object',
|
|
@@ -41958,22 +42025,7 @@ const openapi = {
|
|
|
41958
42025
|
schema: {
|
|
41959
42026
|
properties: {
|
|
41960
42027
|
camera_live_view_session: {
|
|
41961
|
-
|
|
41962
|
-
camera_live_view_session_id: {
|
|
41963
|
-
format: 'uuid',
|
|
41964
|
-
type: 'string',
|
|
41965
|
-
},
|
|
41966
|
-
device_id: { format: 'uuid', type: 'string' },
|
|
41967
|
-
expires_at: { format: 'date-time', type: 'string' },
|
|
41968
|
-
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41969
|
-
},
|
|
41970
|
-
required: [
|
|
41971
|
-
'camera_live_view_session_id',
|
|
41972
|
-
'device_id',
|
|
41973
|
-
'expires_at',
|
|
41974
|
-
'token',
|
|
41975
|
-
],
|
|
41976
|
-
type: 'object',
|
|
42028
|
+
$ref: '#/components/schemas/camera_live_view_session',
|
|
41977
42029
|
},
|
|
41978
42030
|
ok: { type: 'boolean' },
|
|
41979
42031
|
},
|
|
@@ -41995,12 +42047,11 @@ const openapi = {
|
|
|
41995
42047
|
'x-fern-sdk-return-value': 'camera_live_view_session',
|
|
41996
42048
|
'x-response-key': 'camera_live_view_session',
|
|
41997
42049
|
'x-title': 'Create a Camera Live View Session',
|
|
41998
|
-
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
41999
42050
|
},
|
|
42000
42051
|
},
|
|
42001
42052
|
'/cameras/live_views/offer': {
|
|
42002
42053
|
post: {
|
|
42003
|
-
description: 'Exchanges
|
|
42054
|
+
description: '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.',
|
|
42004
42055
|
operationId: 'camerasLiveViewsOfferPost',
|
|
42005
42056
|
requestBody: {
|
|
42006
42057
|
content: {
|
|
@@ -42009,16 +42060,22 @@ const openapi = {
|
|
|
42009
42060
|
additionalProperties: false,
|
|
42010
42061
|
properties: {
|
|
42011
42062
|
camera_live_view_session_id: {
|
|
42063
|
+
description: 'ID of the camera live view session.',
|
|
42012
42064
|
format: 'uuid',
|
|
42013
42065
|
type: 'string',
|
|
42014
42066
|
},
|
|
42015
42067
|
sdp_offer: {
|
|
42016
|
-
description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
|
|
42068
|
+
description: 'WebRTC SDP offer from the viewer, limited to 64 KiB of UTF-8 data.',
|
|
42017
42069
|
maxLength: 65_536,
|
|
42018
42070
|
minLength: 1,
|
|
42019
42071
|
type: 'string',
|
|
42020
42072
|
},
|
|
42021
|
-
token: {
|
|
42073
|
+
token: {
|
|
42074
|
+
description: 'Token returned when the camera live view session was created.',
|
|
42075
|
+
maxLength: 512,
|
|
42076
|
+
minLength: 1,
|
|
42077
|
+
type: 'string',
|
|
42078
|
+
},
|
|
42022
42079
|
},
|
|
42023
42080
|
required: ['camera_live_view_session_id', 'token', 'sdp_offer'],
|
|
42024
42081
|
type: 'object',
|
|
@@ -42032,15 +42089,12 @@ const openapi = {
|
|
|
42032
42089
|
'application/json': {
|
|
42033
42090
|
schema: {
|
|
42034
42091
|
properties: {
|
|
42035
|
-
|
|
42036
|
-
|
|
42037
|
-
description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
|
|
42038
|
-
maxLength: 65_536,
|
|
42039
|
-
minLength: 1,
|
|
42040
|
-
type: 'string',
|
|
42092
|
+
camera_live_view_answer: {
|
|
42093
|
+
$ref: '#/components/schemas/camera_live_view_answer',
|
|
42041
42094
|
},
|
|
42095
|
+
ok: { type: 'boolean' },
|
|
42042
42096
|
},
|
|
42043
|
-
required: ['
|
|
42097
|
+
required: ['camera_live_view_answer', 'ok'],
|
|
42044
42098
|
type: 'object',
|
|
42045
42099
|
},
|
|
42046
42100
|
},
|
|
@@ -42055,14 +42109,14 @@ const openapi = {
|
|
|
42055
42109
|
tags: [],
|
|
42056
42110
|
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
42057
42111
|
'x-fern-sdk-method-name': 'offer',
|
|
42058
|
-
'x-
|
|
42112
|
+
'x-fern-sdk-return-value': 'camera_live_view_answer',
|
|
42113
|
+
'x-response-key': 'camera_live_view_answer',
|
|
42059
42114
|
'x-title': 'Negotiate a Camera Live View',
|
|
42060
|
-
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
42061
42115
|
},
|
|
42062
42116
|
},
|
|
42063
42117
|
'/cameras/live_views/stop': {
|
|
42064
42118
|
post: {
|
|
42065
|
-
description: 'Stops a camera live view session
|
|
42119
|
+
description: '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.',
|
|
42066
42120
|
operationId: 'camerasLiveViewsStopPost',
|
|
42067
42121
|
requestBody: {
|
|
42068
42122
|
content: {
|
|
@@ -42071,10 +42125,16 @@ const openapi = {
|
|
|
42071
42125
|
additionalProperties: false,
|
|
42072
42126
|
properties: {
|
|
42073
42127
|
camera_live_view_session_id: {
|
|
42128
|
+
description: 'ID of the camera live view session.',
|
|
42074
42129
|
format: 'uuid',
|
|
42075
42130
|
type: 'string',
|
|
42076
42131
|
},
|
|
42077
|
-
token: {
|
|
42132
|
+
token: {
|
|
42133
|
+
description: 'Token returned when the camera live view session was created.',
|
|
42134
|
+
maxLength: 512,
|
|
42135
|
+
minLength: 1,
|
|
42136
|
+
type: 'string',
|
|
42137
|
+
},
|
|
42078
42138
|
},
|
|
42079
42139
|
required: ['camera_live_view_session_id', 'token'],
|
|
42080
42140
|
type: 'object',
|
|
@@ -42105,7 +42165,6 @@ const openapi = {
|
|
|
42105
42165
|
'x-fern-sdk-method-name': 'stop',
|
|
42106
42166
|
'x-response-key': null,
|
|
42107
42167
|
'x-title': 'Stop a Camera Live View Session',
|
|
42108
|
-
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
42109
42168
|
},
|
|
42110
42169
|
},
|
|
42111
42170
|
'/client_sessions/create': {
|
|
@@ -46270,6 +46329,7 @@ const openapi = {
|
|
|
46270
46329
|
'can_simulate_hub_disconnection',
|
|
46271
46330
|
'can_simulate_paid_subscription',
|
|
46272
46331
|
'can_configure_auto_lock',
|
|
46332
|
+
'can_stream_live_video',
|
|
46273
46333
|
],
|
|
46274
46334
|
type: 'string',
|
|
46275
46335
|
},
|
|
@@ -46304,6 +46364,7 @@ const openapi = {
|
|
|
46304
46364
|
'can_simulate_hub_disconnection',
|
|
46305
46365
|
'can_simulate_paid_subscription',
|
|
46306
46366
|
'can_configure_auto_lock',
|
|
46367
|
+
'can_stream_live_video',
|
|
46307
46368
|
],
|
|
46308
46369
|
type: 'string',
|
|
46309
46370
|
},
|
|
@@ -48514,6 +48575,7 @@ const openapi = {
|
|
|
48514
48575
|
'can_simulate_hub_disconnection',
|
|
48515
48576
|
'can_simulate_paid_subscription',
|
|
48516
48577
|
'can_configure_auto_lock',
|
|
48578
|
+
'can_stream_live_video',
|
|
48517
48579
|
],
|
|
48518
48580
|
type: 'string',
|
|
48519
48581
|
},
|
|
@@ -48548,6 +48610,7 @@ const openapi = {
|
|
|
48548
48610
|
'can_simulate_hub_disconnection',
|
|
48549
48611
|
'can_simulate_paid_subscription',
|
|
48550
48612
|
'can_configure_auto_lock',
|
|
48613
|
+
'can_stream_live_video',
|
|
48551
48614
|
],
|
|
48552
48615
|
type: 'string',
|
|
48553
48616
|
},
|