@seamapi/types 1.1076.0 → 1.1077.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.
|
@@ -41778,6 +41778,188 @@ const openapi = {
|
|
|
41778
41778
|
'x-undocumented': 'Not yet for customer use.',
|
|
41779
41779
|
},
|
|
41780
41780
|
},
|
|
41781
|
+
'/cameras/live_views/create': {
|
|
41782
|
+
post: {
|
|
41783
|
+
description: 'Creates a short-lived, single-camera live view session.',
|
|
41784
|
+
operationId: 'camerasLiveViewsCreatePost',
|
|
41785
|
+
requestBody: {
|
|
41786
|
+
content: {
|
|
41787
|
+
'application/json': {
|
|
41788
|
+
schema: {
|
|
41789
|
+
additionalProperties: false,
|
|
41790
|
+
properties: {
|
|
41791
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
41792
|
+
duration_seconds: {
|
|
41793
|
+
default: 600,
|
|
41794
|
+
maximum: 600,
|
|
41795
|
+
minimum: 1,
|
|
41796
|
+
type: 'integer',
|
|
41797
|
+
},
|
|
41798
|
+
include_audio: { default: false, type: 'boolean' },
|
|
41799
|
+
},
|
|
41800
|
+
required: ['device_id'],
|
|
41801
|
+
type: 'object',
|
|
41802
|
+
},
|
|
41803
|
+
},
|
|
41804
|
+
},
|
|
41805
|
+
},
|
|
41806
|
+
responses: {
|
|
41807
|
+
'200': {
|
|
41808
|
+
content: {
|
|
41809
|
+
'application/json': {
|
|
41810
|
+
schema: {
|
|
41811
|
+
properties: {
|
|
41812
|
+
camera_live_view_session: {
|
|
41813
|
+
properties: {
|
|
41814
|
+
camera_live_view_session_id: {
|
|
41815
|
+
format: 'uuid',
|
|
41816
|
+
type: 'string',
|
|
41817
|
+
},
|
|
41818
|
+
device_id: { format: 'uuid', type: 'string' },
|
|
41819
|
+
expires_at: { format: 'date-time', type: 'string' },
|
|
41820
|
+
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41821
|
+
},
|
|
41822
|
+
required: [
|
|
41823
|
+
'camera_live_view_session_id',
|
|
41824
|
+
'device_id',
|
|
41825
|
+
'expires_at',
|
|
41826
|
+
'token',
|
|
41827
|
+
],
|
|
41828
|
+
type: 'object',
|
|
41829
|
+
},
|
|
41830
|
+
ok: { type: 'boolean' },
|
|
41831
|
+
},
|
|
41832
|
+
required: ['camera_live_view_session', 'ok'],
|
|
41833
|
+
type: 'object',
|
|
41834
|
+
},
|
|
41835
|
+
},
|
|
41836
|
+
},
|
|
41837
|
+
description: 'OK',
|
|
41838
|
+
},
|
|
41839
|
+
'400': { description: 'Bad Request' },
|
|
41840
|
+
'401': { description: 'Unauthorized' },
|
|
41841
|
+
},
|
|
41842
|
+
security: [{ client_session: [] }],
|
|
41843
|
+
summary: '/cameras/live_views/create',
|
|
41844
|
+
tags: [],
|
|
41845
|
+
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
41846
|
+
'x-fern-sdk-method-name': 'create',
|
|
41847
|
+
'x-fern-sdk-return-value': 'camera_live_view_session',
|
|
41848
|
+
'x-response-key': 'camera_live_view_session',
|
|
41849
|
+
'x-title': 'Create a Camera Live View Session',
|
|
41850
|
+
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
41851
|
+
},
|
|
41852
|
+
},
|
|
41853
|
+
'/cameras/live_views/offer': {
|
|
41854
|
+
post: {
|
|
41855
|
+
description: 'Exchanges one WebRTC offer for an authorized camera live view session.',
|
|
41856
|
+
operationId: 'camerasLiveViewsOfferPost',
|
|
41857
|
+
requestBody: {
|
|
41858
|
+
content: {
|
|
41859
|
+
'application/json': {
|
|
41860
|
+
schema: {
|
|
41861
|
+
additionalProperties: false,
|
|
41862
|
+
properties: {
|
|
41863
|
+
camera_live_view_session_id: {
|
|
41864
|
+
format: 'uuid',
|
|
41865
|
+
type: 'string',
|
|
41866
|
+
},
|
|
41867
|
+
sdp_offer: {
|
|
41868
|
+
description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
|
|
41869
|
+
maxLength: 65_536,
|
|
41870
|
+
minLength: 1,
|
|
41871
|
+
type: 'string',
|
|
41872
|
+
},
|
|
41873
|
+
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41874
|
+
},
|
|
41875
|
+
required: ['camera_live_view_session_id', 'token', 'sdp_offer'],
|
|
41876
|
+
type: 'object',
|
|
41877
|
+
},
|
|
41878
|
+
},
|
|
41879
|
+
},
|
|
41880
|
+
},
|
|
41881
|
+
responses: {
|
|
41882
|
+
'200': {
|
|
41883
|
+
content: {
|
|
41884
|
+
'application/json': {
|
|
41885
|
+
schema: {
|
|
41886
|
+
properties: {
|
|
41887
|
+
ok: { type: 'boolean' },
|
|
41888
|
+
sdp_answer: {
|
|
41889
|
+
description: 'WebRTC SDP, limited to 64 KiB of UTF-8 data.',
|
|
41890
|
+
maxLength: 65_536,
|
|
41891
|
+
minLength: 1,
|
|
41892
|
+
type: 'string',
|
|
41893
|
+
},
|
|
41894
|
+
},
|
|
41895
|
+
required: ['sdp_answer', 'ok'],
|
|
41896
|
+
type: 'object',
|
|
41897
|
+
},
|
|
41898
|
+
},
|
|
41899
|
+
},
|
|
41900
|
+
description: 'OK',
|
|
41901
|
+
},
|
|
41902
|
+
'400': { description: 'Bad Request' },
|
|
41903
|
+
'401': { description: 'Unauthorized' },
|
|
41904
|
+
},
|
|
41905
|
+
security: [{ client_session: [] }],
|
|
41906
|
+
summary: '/cameras/live_views/offer',
|
|
41907
|
+
tags: [],
|
|
41908
|
+
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
41909
|
+
'x-fern-sdk-method-name': 'offer',
|
|
41910
|
+
'x-response-key': null,
|
|
41911
|
+
'x-title': 'Negotiate a Camera Live View',
|
|
41912
|
+
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
41913
|
+
},
|
|
41914
|
+
},
|
|
41915
|
+
'/cameras/live_views/stop': {
|
|
41916
|
+
post: {
|
|
41917
|
+
description: 'Stops a camera live view session owned by the current client session.',
|
|
41918
|
+
operationId: 'camerasLiveViewsStopPost',
|
|
41919
|
+
requestBody: {
|
|
41920
|
+
content: {
|
|
41921
|
+
'application/json': {
|
|
41922
|
+
schema: {
|
|
41923
|
+
additionalProperties: false,
|
|
41924
|
+
properties: {
|
|
41925
|
+
camera_live_view_session_id: {
|
|
41926
|
+
format: 'uuid',
|
|
41927
|
+
type: 'string',
|
|
41928
|
+
},
|
|
41929
|
+
token: { maxLength: 512, minLength: 1, type: 'string' },
|
|
41930
|
+
},
|
|
41931
|
+
required: ['camera_live_view_session_id', 'token'],
|
|
41932
|
+
type: 'object',
|
|
41933
|
+
},
|
|
41934
|
+
},
|
|
41935
|
+
},
|
|
41936
|
+
},
|
|
41937
|
+
responses: {
|
|
41938
|
+
'200': {
|
|
41939
|
+
content: {
|
|
41940
|
+
'application/json': {
|
|
41941
|
+
schema: {
|
|
41942
|
+
properties: { ok: { type: 'boolean' } },
|
|
41943
|
+
required: ['ok'],
|
|
41944
|
+
type: 'object',
|
|
41945
|
+
},
|
|
41946
|
+
},
|
|
41947
|
+
},
|
|
41948
|
+
description: 'OK',
|
|
41949
|
+
},
|
|
41950
|
+
'400': { description: 'Bad Request' },
|
|
41951
|
+
'401': { description: 'Unauthorized' },
|
|
41952
|
+
},
|
|
41953
|
+
security: [{ client_session: [] }],
|
|
41954
|
+
summary: '/cameras/live_views/stop',
|
|
41955
|
+
tags: [],
|
|
41956
|
+
'x-fern-sdk-group-name': ['cameras', 'live_views'],
|
|
41957
|
+
'x-fern-sdk-method-name': 'stop',
|
|
41958
|
+
'x-response-key': null,
|
|
41959
|
+
'x-title': 'Stop a Camera Live View Session',
|
|
41960
|
+
'x-undocumented': 'Camera pilot; not yet for customer use.',
|
|
41961
|
+
},
|
|
41962
|
+
},
|
|
41781
41963
|
'/client_sessions/create': {
|
|
41782
41964
|
put: {
|
|
41783
41965
|
description: 'Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).',
|