@seamapi/types 1.1083.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 -36
- 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 -37
- 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',
|
|
@@ -37896,7 +37954,6 @@ const openapi = {
|
|
|
37896
37954
|
'401': { description: 'Unauthorized' },
|
|
37897
37955
|
},
|
|
37898
37956
|
security: [
|
|
37899
|
-
{ client_session: [] },
|
|
37900
37957
|
{ pat_with_workspace: [] },
|
|
37901
37958
|
{ console_session_with_workspace: [] },
|
|
37902
37959
|
{ api_key: [] },
|
|
@@ -41929,7 +41986,7 @@ const openapi = {
|
|
|
41929
41986
|
},
|
|
41930
41987
|
'/cameras/live_views/create': {
|
|
41931
41988
|
post: {
|
|
41932
|
-
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`.',
|
|
41933
41990
|
operationId: 'camerasLiveViewsCreatePost',
|
|
41934
41991
|
requestBody: {
|
|
41935
41992
|
content: {
|
|
@@ -41937,14 +41994,23 @@ const openapi = {
|
|
|
41937
41994
|
schema: {
|
|
41938
41995
|
additionalProperties: false,
|
|
41939
41996
|
properties: {
|
|
41940
|
-
device_id: {
|
|
41997
|
+
device_id: {
|
|
41998
|
+
description: 'ID of the camera to view.',
|
|
41999
|
+
format: 'uuid',
|
|
42000
|
+
type: 'string',
|
|
42001
|
+
},
|
|
41941
42002
|
duration_seconds: {
|
|
41942
42003
|
default: 600,
|
|
42004
|
+
description: 'Number of seconds for which the live view session is valid, up to 600.',
|
|
41943
42005
|
maximum: 600,
|
|
41944
42006
|
minimum: 1,
|
|
41945
42007
|
type: 'integer',
|
|
41946
42008
|
},
|
|
41947
|
-
include_audio: {
|
|
42009
|
+
include_audio: {
|
|
42010
|
+
default: false,
|
|
42011
|
+
description: "Indicates whether to include the camera's audio.",
|
|
42012
|
+
type: 'boolean',
|
|
42013
|
+
},
|
|
41948
42014
|
},
|
|
41949
42015
|
required: ['device_id'],
|
|
41950
42016
|
type: 'object',
|
|
@@ -41959,22 +42025,7 @@ const openapi = {
|
|
|
41959
42025
|
schema: {
|
|
41960
42026
|
properties: {
|
|
41961
42027
|
camera_live_view_session: {
|
|
41962
|
-
|
|
41963
|
-
camera_live_view_session_id: {
|
|
41964
|
-
format: 'uuid',
|
|
41965
|
-
type: 'string',
|
|
41966
|
-
},
|
|
41967
|
-
device_id: { format: 'uuid', type: 'string' },
|
|
41968
|
-
expires_at: { format: 'date-time', type: 'string' },
|
|
41969
|
-
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41970
|
-
},
|
|
41971
|
-
required: [
|
|
41972
|
-
'camera_live_view_session_id',
|
|
41973
|
-
'device_id',
|
|
41974
|
-
'expires_at',
|
|
41975
|
-
'token',
|
|
41976
|
-
],
|
|
41977
|
-
type: 'object',
|
|
42028
|
+
$ref: '#/components/schemas/camera_live_view_session',
|
|
41978
42029
|
},
|
|
41979
42030
|
ok: { type: 'boolean' },
|
|
41980
42031
|
},
|
|
@@ -41996,12 +42047,11 @@ const openapi = {
|
|
|
41996
42047
|
'x-fern-sdk-return-value': 'camera_live_view_session',
|
|
41997
42048
|
'x-response-key': 'camera_live_view_session',
|
|
41998
42049
|
'x-title': 'Create a Camera Live View Session',
|
|
41999
|
-
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
42000
42050
|
},
|
|
42001
42051
|
},
|
|
42002
42052
|
'/cameras/live_views/offer': {
|
|
42003
42053
|
post: {
|
|
42004
|
-
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.',
|
|
42005
42055
|
operationId: 'camerasLiveViewsOfferPost',
|
|
42006
42056
|
requestBody: {
|
|
42007
42057
|
content: {
|
|
@@ -42010,16 +42060,22 @@ const openapi = {
|
|
|
42010
42060
|
additionalProperties: false,
|
|
42011
42061
|
properties: {
|
|
42012
42062
|
camera_live_view_session_id: {
|
|
42063
|
+
description: 'ID of the camera live view session.',
|
|
42013
42064
|
format: 'uuid',
|
|
42014
42065
|
type: 'string',
|
|
42015
42066
|
},
|
|
42016
42067
|
sdp_offer: {
|
|
42017
|
-
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.',
|
|
42018
42069
|
maxLength: 65_536,
|
|
42019
42070
|
minLength: 1,
|
|
42020
42071
|
type: 'string',
|
|
42021
42072
|
},
|
|
42022
|
-
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
|
+
},
|
|
42023
42079
|
},
|
|
42024
42080
|
required: ['camera_live_view_session_id', 'token', 'sdp_offer'],
|
|
42025
42081
|
type: 'object',
|
|
@@ -42033,15 +42089,12 @@ const openapi = {
|
|
|
42033
42089
|
'application/json': {
|
|
42034
42090
|
schema: {
|
|
42035
42091
|
properties: {
|
|
42036
|
-
|
|
42037
|
-
|
|
42038
|
-
description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
|
|
42039
|
-
maxLength: 65_536,
|
|
42040
|
-
minLength: 1,
|
|
42041
|
-
type: 'string',
|
|
42092
|
+
camera_live_view_answer: {
|
|
42093
|
+
$ref: '#/components/schemas/camera_live_view_answer',
|
|
42042
42094
|
},
|
|
42095
|
+
ok: { type: 'boolean' },
|
|
42043
42096
|
},
|
|
42044
|
-
required: ['
|
|
42097
|
+
required: ['camera_live_view_answer', 'ok'],
|
|
42045
42098
|
type: 'object',
|
|
42046
42099
|
},
|
|
42047
42100
|
},
|
|
@@ -42056,14 +42109,14 @@ const openapi = {
|
|
|
42056
42109
|
tags: [],
|
|
42057
42110
|
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
42058
42111
|
'x-fern-sdk-method-name': 'offer',
|
|
42059
|
-
'x-
|
|
42112
|
+
'x-fern-sdk-return-value': 'camera_live_view_answer',
|
|
42113
|
+
'x-response-key': 'camera_live_view_answer',
|
|
42060
42114
|
'x-title': 'Negotiate a Camera Live View',
|
|
42061
|
-
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
42062
42115
|
},
|
|
42063
42116
|
},
|
|
42064
42117
|
'/cameras/live_views/stop': {
|
|
42065
42118
|
post: {
|
|
42066
|
-
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.',
|
|
42067
42120
|
operationId: 'camerasLiveViewsStopPost',
|
|
42068
42121
|
requestBody: {
|
|
42069
42122
|
content: {
|
|
@@ -42072,10 +42125,16 @@ const openapi = {
|
|
|
42072
42125
|
additionalProperties: false,
|
|
42073
42126
|
properties: {
|
|
42074
42127
|
camera_live_view_session_id: {
|
|
42128
|
+
description: 'ID of the camera live view session.',
|
|
42075
42129
|
format: 'uuid',
|
|
42076
42130
|
type: 'string',
|
|
42077
42131
|
},
|
|
42078
|
-
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
|
+
},
|
|
42079
42138
|
},
|
|
42080
42139
|
required: ['camera_live_view_session_id', 'token'],
|
|
42081
42140
|
type: 'object',
|
|
@@ -42106,7 +42165,6 @@ const openapi = {
|
|
|
42106
42165
|
'x-fern-sdk-method-name': 'stop',
|
|
42107
42166
|
'x-response-key': null,
|
|
42108
42167
|
'x-title': 'Stop a Camera Live View Session',
|
|
42109
|
-
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
42110
42168
|
},
|
|
42111
42169
|
},
|
|
42112
42170
|
'/client_sessions/create': {
|
|
@@ -46271,6 +46329,7 @@ const openapi = {
|
|
|
46271
46329
|
'can_simulate_hub_disconnection',
|
|
46272
46330
|
'can_simulate_paid_subscription',
|
|
46273
46331
|
'can_configure_auto_lock',
|
|
46332
|
+
'can_stream_live_video',
|
|
46274
46333
|
],
|
|
46275
46334
|
type: 'string',
|
|
46276
46335
|
},
|
|
@@ -46305,6 +46364,7 @@ const openapi = {
|
|
|
46305
46364
|
'can_simulate_hub_disconnection',
|
|
46306
46365
|
'can_simulate_paid_subscription',
|
|
46307
46366
|
'can_configure_auto_lock',
|
|
46367
|
+
'can_stream_live_video',
|
|
46308
46368
|
],
|
|
46309
46369
|
type: 'string',
|
|
46310
46370
|
},
|
|
@@ -48515,6 +48575,7 @@ const openapi = {
|
|
|
48515
48575
|
'can_simulate_hub_disconnection',
|
|
48516
48576
|
'can_simulate_paid_subscription',
|
|
48517
48577
|
'can_configure_auto_lock',
|
|
48578
|
+
'can_stream_live_video',
|
|
48518
48579
|
],
|
|
48519
48580
|
type: 'string',
|
|
48520
48581
|
},
|
|
@@ -48549,6 +48610,7 @@ const openapi = {
|
|
|
48549
48610
|
'can_simulate_hub_disconnection',
|
|
48550
48611
|
'can_simulate_paid_subscription',
|
|
48551
48612
|
'can_configure_auto_lock',
|
|
48613
|
+
'can_stream_live_video',
|
|
48552
48614
|
],
|
|
48553
48615
|
type: 'string',
|
|
48554
48616
|
},
|