@seamapi/http 2.42.0 → 2.44.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/resources/access-method.d.ts +15 -0
- package/lib/resources/acs-credential.d.ts +15 -0
- package/lib/resources/action-attempt.d.ts +4 -4
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +9 -1
- package/lib/resources/unmanaged-access-method.d.ts +15 -0
- package/lib/resources/unmanaged-device.d.ts +1 -1
- package/lib/routes/cameras/live-views/live-views.d.ts +3 -3
- package/lib/routes/cameras/live-views/live-views.js +3 -3
- package/lib/routes/connect-webviews/connect-webviews.d.ts +1 -1
- package/lib/routes/devices/devices.d.ts +2 -2
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +2 -2
- package/lib/routes/locks/locks.d.ts +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +3 -3
- package/lib/routes/seam-http-endpoints.js +3 -3
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-method.ts +18 -0
- package/src/lib/resources/acs-credential.ts +18 -0
- package/src/lib/resources/action-attempt.ts +4 -0
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +13 -0
- package/src/lib/resources/unmanaged-access-method.ts +18 -0
- package/src/lib/resources/unmanaged-device.ts +1 -0
- package/src/lib/routes/cameras/live-views/live-views.ts +3 -3
- package/src/lib/routes/connect-webviews/connect-webviews.ts +1 -0
- package/src/lib/routes/devices/devices.ts +2 -0
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +2 -0
- package/src/lib/routes/locks/locks.ts +2 -0
- package/src/lib/routes/seam-http-endpoints.ts +3 -3
- package/src/lib/version.ts +1 -1
|
@@ -348,6 +348,21 @@ export type AccessMethod = {
|
|
|
348
348
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
349
349
|
*/
|
|
350
350
|
warning_code: 'requested_code_unavailable';
|
|
351
|
+
} /**
|
|
352
|
+
* Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.
|
|
353
|
+
*/ | {
|
|
354
|
+
/**
|
|
355
|
+
* Date and time at which Seam created the warning.
|
|
356
|
+
*/
|
|
357
|
+
created_at: string;
|
|
358
|
+
/**
|
|
359
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
360
|
+
*/
|
|
361
|
+
message: string;
|
|
362
|
+
/**
|
|
363
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
364
|
+
*/
|
|
365
|
+
warning_code: 'schedule_rounded_up';
|
|
351
366
|
}>;
|
|
352
367
|
/**
|
|
353
368
|
* ID of the Seam workspace associated with the access method.
|
|
@@ -304,6 +304,21 @@ export type AcsCredential = {
|
|
|
304
304
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
305
305
|
*/
|
|
306
306
|
warning_code: 'requested_code_unavailable';
|
|
307
|
+
} /**
|
|
308
|
+
* Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.
|
|
309
|
+
*/ | {
|
|
310
|
+
/**
|
|
311
|
+
* Date and time at which Seam created the warning.
|
|
312
|
+
*/
|
|
313
|
+
created_at: string;
|
|
314
|
+
/**
|
|
315
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
316
|
+
*/
|
|
317
|
+
message: string;
|
|
318
|
+
/**
|
|
319
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
320
|
+
*/
|
|
321
|
+
warning_code: 'schedule_rounded_up';
|
|
307
322
|
}>;
|
|
308
323
|
/**
|
|
309
324
|
* ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
@@ -423,7 +423,7 @@ export type ActionAttempt = {
|
|
|
423
423
|
/**
|
|
424
424
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
425
425
|
*/
|
|
426
|
-
warning_code: 'waiting_to_be_issued' | 'schedule_externally_modified' | 'schedule_modified' | 'being_deleted' | 'unknown_issue_with_acs_credential' | 'needs_to_be_reissued' | 'requested_code_unavailable';
|
|
426
|
+
warning_code: 'waiting_to_be_issued' | 'schedule_externally_modified' | 'schedule_modified' | 'being_deleted' | 'unknown_issue_with_acs_credential' | 'needs_to_be_reissued' | 'requested_code_unavailable' | 'schedule_rounded_up';
|
|
427
427
|
/**
|
|
428
428
|
* The PIN code that was assigned instead.
|
|
429
429
|
*/
|
|
@@ -696,7 +696,7 @@ export type ActionAttempt = {
|
|
|
696
696
|
/**
|
|
697
697
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
698
698
|
*/
|
|
699
|
-
warning_code: 'waiting_to_be_issued' | 'schedule_externally_modified' | 'schedule_modified' | 'being_deleted' | 'unknown_issue_with_acs_credential' | 'needs_to_be_reissued' | 'requested_code_unavailable';
|
|
699
|
+
warning_code: 'waiting_to_be_issued' | 'schedule_externally_modified' | 'schedule_modified' | 'being_deleted' | 'unknown_issue_with_acs_credential' | 'needs_to_be_reissued' | 'requested_code_unavailable' | 'schedule_rounded_up';
|
|
700
700
|
/**
|
|
701
701
|
* The PIN code that was assigned instead.
|
|
702
702
|
*/
|
|
@@ -958,7 +958,7 @@ export type ActionAttempt = {
|
|
|
958
958
|
/**
|
|
959
959
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
960
960
|
*/
|
|
961
|
-
warning_code: 'waiting_to_be_issued' | 'schedule_externally_modified' | 'schedule_modified' | 'being_deleted' | 'unknown_issue_with_acs_credential' | 'needs_to_be_reissued' | 'requested_code_unavailable';
|
|
961
|
+
warning_code: 'waiting_to_be_issued' | 'schedule_externally_modified' | 'schedule_modified' | 'being_deleted' | 'unknown_issue_with_acs_credential' | 'needs_to_be_reissued' | 'requested_code_unavailable' | 'schedule_rounded_up';
|
|
962
962
|
/**
|
|
963
963
|
* The PIN code that was assigned instead.
|
|
964
964
|
*/
|
|
@@ -1162,7 +1162,7 @@ export type ActionAttempt = {
|
|
|
1162
1162
|
/**
|
|
1163
1163
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1164
1164
|
*/
|
|
1165
|
-
warning_code: 'being_deleted' | 'updating_access_times' | 'pulled_backup_access_code' | 'delay_in_issuing' | 'user_identity_missing_email_address' | 'user_identity_missing_phone_number' | 'requested_code_unavailable';
|
|
1165
|
+
warning_code: 'being_deleted' | 'updating_access_times' | 'pulled_backup_access_code' | 'delay_in_issuing' | 'user_identity_missing_email_address' | 'user_identity_missing_phone_number' | 'requested_code_unavailable' | 'schedule_rounded_up';
|
|
1166
1166
|
/**
|
|
1167
1167
|
* ID of the original access method from which this backup access method was split, if applicable.
|
|
1168
1168
|
*/
|
|
@@ -90,7 +90,7 @@ export type DeviceProvider = {
|
|
|
90
90
|
/**
|
|
91
91
|
* Name of the device provider.
|
|
92
92
|
*/
|
|
93
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'sonos';
|
|
93
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
|
|
94
94
|
/**
|
|
95
95
|
* Display name for the device provider.
|
|
96
96
|
*/
|
|
@@ -151,7 +151,7 @@ export type Device = {
|
|
|
151
151
|
/**
|
|
152
152
|
* Type of the device.
|
|
153
153
|
*/
|
|
154
|
-
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker';
|
|
154
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker';
|
|
155
155
|
/**
|
|
156
156
|
* Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
157
157
|
*/
|
|
@@ -945,6 +945,14 @@ export type Device = {
|
|
|
945
945
|
*/
|
|
946
946
|
ecobee_device_id?: string | undefined;
|
|
947
947
|
} | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* Metadata for a Eufy device.
|
|
950
|
+
*/
|
|
951
|
+
eufy_metadata?: {
|
|
952
|
+
device_id?: string | undefined;
|
|
953
|
+
device_name?: string | undefined;
|
|
954
|
+
model?: string | undefined;
|
|
955
|
+
} | undefined;
|
|
948
956
|
/**
|
|
949
957
|
* Metadata for a 4SUITES device.
|
|
950
958
|
*/
|
|
@@ -336,6 +336,21 @@ export type UnmanagedAccessMethod = {
|
|
|
336
336
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
337
337
|
*/
|
|
338
338
|
warning_code: 'requested_code_unavailable';
|
|
339
|
+
} /**
|
|
340
|
+
* Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.
|
|
341
|
+
*/ | {
|
|
342
|
+
/**
|
|
343
|
+
* Date and time at which Seam created the warning.
|
|
344
|
+
*/
|
|
345
|
+
created_at: string;
|
|
346
|
+
/**
|
|
347
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
348
|
+
*/
|
|
349
|
+
message: string;
|
|
350
|
+
/**
|
|
351
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
352
|
+
*/
|
|
353
|
+
warning_code: 'schedule_rounded_up';
|
|
339
354
|
}>;
|
|
340
355
|
/**
|
|
341
356
|
* ID of the Seam workspace associated with the access method.
|
|
@@ -113,7 +113,7 @@ export type UnmanagedDevice = {
|
|
|
113
113
|
/**
|
|
114
114
|
* Type of the device.
|
|
115
115
|
*/
|
|
116
|
-
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker';
|
|
116
|
+
device_type: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker';
|
|
117
117
|
/**
|
|
118
118
|
* Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
119
119
|
*/
|
|
@@ -19,19 +19,19 @@ export declare class SeamHttpCamerasLiveViews {
|
|
|
19
19
|
/**
|
|
20
20
|
* 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.
|
|
21
21
|
*
|
|
22
|
-
* Camera live view is in beta.
|
|
22
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Use your API key on your backend to create a client session with access to the camera's connected account, then authenticate live view requests with that client session's token. To check whether a camera supports live view, use `device.can_stream_live_video`.
|
|
23
23
|
*/
|
|
24
24
|
create(parameters: CamerasLiveViewsCreateParameters, options?: CamerasLiveViewsCreateOptions): CamerasLiveViewsCreateRequest;
|
|
25
25
|
/**
|
|
26
26
|
* 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`.
|
|
27
27
|
*
|
|
28
|
-
* Camera live view is in beta.
|
|
28
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
29
29
|
*/
|
|
30
30
|
offer(parameters: CamerasLiveViewsOfferParameters, options?: CamerasLiveViewsOfferOptions): CamerasLiveViewsOfferRequest;
|
|
31
31
|
/**
|
|
32
32
|
* Stops a camera live view session that the current client session owns.
|
|
33
33
|
*
|
|
34
|
-
* Camera live view is in beta.
|
|
34
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
35
35
|
*/
|
|
36
36
|
stop(parameters: CamerasLiveViewsStopParameters, options?: CamerasLiveViewsStopOptions): CamerasLiveViewsStopRequest;
|
|
37
37
|
}
|
|
@@ -85,7 +85,7 @@ export class SeamHttpCamerasLiveViews {
|
|
|
85
85
|
/**
|
|
86
86
|
* 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.
|
|
87
87
|
*
|
|
88
|
-
* Camera live view is in beta.
|
|
88
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Use your API key on your backend to create a client session with access to the camera's connected account, then authenticate live view requests with that client session's token. To check whether a camera supports live view, use `device.can_stream_live_video`.
|
|
89
89
|
*/
|
|
90
90
|
create(parameters, options = {}) {
|
|
91
91
|
return new SeamHttpRequest(this, {
|
|
@@ -103,7 +103,7 @@ export class SeamHttpCamerasLiveViews {
|
|
|
103
103
|
/**
|
|
104
104
|
* 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`.
|
|
105
105
|
*
|
|
106
|
-
* Camera live view is in beta.
|
|
106
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
107
107
|
*/
|
|
108
108
|
offer(parameters, options = {}) {
|
|
109
109
|
return new SeamHttpRequest(this, {
|
|
@@ -125,7 +125,7 @@ export class SeamHttpCamerasLiveViews {
|
|
|
125
125
|
/**
|
|
126
126
|
* Stops a camera live view session that the current client session owns.
|
|
127
127
|
*
|
|
128
|
-
* Camera live view is in beta.
|
|
128
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
129
129
|
*/
|
|
130
130
|
stop(parameters, options = {}) {
|
|
131
131
|
return new SeamHttpRequest(this, {
|
|
@@ -50,7 +50,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
50
50
|
/**
|
|
51
51
|
* Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters.
|
|
52
52
|
*/
|
|
53
|
-
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'sonos' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
|
|
53
|
+
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
|
|
54
54
|
/**
|
|
55
55
|
* Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
|
|
56
56
|
*/
|
|
@@ -101,11 +101,11 @@ export type DevicesListParameters = {
|
|
|
101
101
|
/**
|
|
102
102
|
* Device type for which you want to list devices.
|
|
103
103
|
*/
|
|
104
|
-
device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker' | undefined;
|
|
104
|
+
device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker' | undefined;
|
|
105
105
|
/**
|
|
106
106
|
* Array of device types for which you want to list devices.
|
|
107
107
|
*/
|
|
108
|
-
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker'> | undefined;
|
|
108
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker'> | undefined;
|
|
109
109
|
/**
|
|
110
110
|
* Numerical limit on the number of devices to return.
|
|
111
111
|
*/
|
|
@@ -84,11 +84,11 @@ export type DevicesUnmanagedListParameters = {
|
|
|
84
84
|
/**
|
|
85
85
|
* Device type for which you want to list devices.
|
|
86
86
|
*/
|
|
87
|
-
device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker' | undefined;
|
|
87
|
+
device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker' | undefined;
|
|
88
88
|
/**
|
|
89
89
|
* Array of device types for which you want to list devices.
|
|
90
90
|
*/
|
|
91
|
-
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker'> | undefined;
|
|
91
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | 'keynest_key' | 'noiseaware_activity_zone' | 'minut_sensor' | 'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat' | 'ios_phone' | 'android_phone' | 'ring_camera' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'sonos_speaker'> | undefined;
|
|
92
92
|
/**
|
|
93
93
|
* Numerical limit on the number of devices to return.
|
|
94
94
|
*/
|
|
@@ -98,11 +98,11 @@ export type LocksListParameters = {
|
|
|
98
98
|
/**
|
|
99
99
|
* Device type of the locks that you want to list.
|
|
100
100
|
*/
|
|
101
|
-
device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | undefined;
|
|
101
|
+
device_type?: 'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | undefined;
|
|
102
102
|
/**
|
|
103
103
|
* Device types of the locks that you want to list.
|
|
104
104
|
*/
|
|
105
|
-
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock'> | undefined;
|
|
105
|
+
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock'> | undefined;
|
|
106
106
|
/**
|
|
107
107
|
* Manufacturer of the locks that you want to list.
|
|
108
108
|
*/
|
|
@@ -428,19 +428,19 @@ export declare class SeamHttpEndpoints {
|
|
|
428
428
|
/**
|
|
429
429
|
* 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.
|
|
430
430
|
*
|
|
431
|
-
* Camera live view is in beta.
|
|
431
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Use your API key on your backend to create a client session with access to the camera's connected account, then authenticate live view requests with that client session's token. To check whether a camera supports live view, use `device.can_stream_live_video`.
|
|
432
432
|
*/
|
|
433
433
|
get '/cameras/live_views/create'(): (parameters: CamerasLiveViewsCreateParameters, options?: CamerasLiveViewsCreateOptions) => CamerasLiveViewsCreateRequest;
|
|
434
434
|
/**
|
|
435
435
|
* 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`.
|
|
436
436
|
*
|
|
437
|
-
* Camera live view is in beta.
|
|
437
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
438
438
|
*/
|
|
439
439
|
get '/cameras/live_views/offer'(): (parameters: CamerasLiveViewsOfferParameters, options?: CamerasLiveViewsOfferOptions) => CamerasLiveViewsOfferRequest;
|
|
440
440
|
/**
|
|
441
441
|
* Stops a camera live view session that the current client session owns.
|
|
442
442
|
*
|
|
443
|
-
* Camera live view is in beta.
|
|
443
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
444
444
|
*/
|
|
445
445
|
get '/cameras/live_views/stop'(): (parameters: CamerasLiveViewsStopParameters, options?: CamerasLiveViewsStopOptions) => CamerasLiveViewsStopRequest;
|
|
446
446
|
/**
|
|
@@ -980,7 +980,7 @@ export class SeamHttpEndpoints {
|
|
|
980
980
|
/**
|
|
981
981
|
* 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.
|
|
982
982
|
*
|
|
983
|
-
* Camera live view is in beta.
|
|
983
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Use your API key on your backend to create a client session with access to the camera's connected account, then authenticate live view requests with that client session's token. To check whether a camera supports live view, use `device.can_stream_live_video`.
|
|
984
984
|
*/
|
|
985
985
|
get '/cameras/live_views/create'() {
|
|
986
986
|
const { client, defaults } = this;
|
|
@@ -992,7 +992,7 @@ export class SeamHttpEndpoints {
|
|
|
992
992
|
/**
|
|
993
993
|
* 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`.
|
|
994
994
|
*
|
|
995
|
-
* Camera live view is in beta.
|
|
995
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
996
996
|
*/
|
|
997
997
|
get '/cameras/live_views/offer'() {
|
|
998
998
|
const { client, defaults } = this;
|
|
@@ -1004,7 +1004,7 @@ export class SeamHttpEndpoints {
|
|
|
1004
1004
|
/**
|
|
1005
1005
|
* Stops a camera live view session that the current client session owns.
|
|
1006
1006
|
*
|
|
1007
|
-
* Camera live view is in beta.
|
|
1007
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
1008
1008
|
*/
|
|
1009
1009
|
get '/cameras/live_views/stop'() {
|
|
1010
1010
|
const { client, defaults } = this;
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.44.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.44.0",
|
|
4
4
|
"description": "JavaScript HTTP client for the Seam API written in TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
"@seamapi/blueprint": "^1.10.0",
|
|
89
89
|
"@seamapi/fake-seam-connect": "^2.0.4",
|
|
90
90
|
"@seamapi/smith": "^1.1.0",
|
|
91
|
-
"@seamapi/types": "1.
|
|
91
|
+
"@seamapi/types": "1.1136.0",
|
|
92
92
|
"@types/jsonwebtoken": "^9.0.6",
|
|
93
93
|
"@types/node": "^24.10.9",
|
|
94
94
|
"ava": "^8.0.1",
|
|
@@ -407,6 +407,24 @@ export type AccessMethod = {
|
|
|
407
407
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
408
408
|
*/
|
|
409
409
|
warning_code: 'requested_code_unavailable'
|
|
410
|
+
} /**
|
|
411
|
+
* Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.
|
|
412
|
+
*/
|
|
413
|
+
| {
|
|
414
|
+
/**
|
|
415
|
+
* Date and time at which Seam created the warning.
|
|
416
|
+
*/
|
|
417
|
+
created_at: string
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
421
|
+
*/
|
|
422
|
+
message: string
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
426
|
+
*/
|
|
427
|
+
warning_code: 'schedule_rounded_up'
|
|
410
428
|
}
|
|
411
429
|
>
|
|
412
430
|
|
|
@@ -362,6 +362,24 @@ export type AcsCredential = {
|
|
|
362
362
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
363
363
|
*/
|
|
364
364
|
warning_code: 'requested_code_unavailable'
|
|
365
|
+
} /**
|
|
366
|
+
* Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.
|
|
367
|
+
*/
|
|
368
|
+
| {
|
|
369
|
+
/**
|
|
370
|
+
* Date and time at which Seam created the warning.
|
|
371
|
+
*/
|
|
372
|
+
created_at: string
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
376
|
+
*/
|
|
377
|
+
message: string
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
381
|
+
*/
|
|
382
|
+
warning_code: 'schedule_rounded_up'
|
|
365
383
|
}
|
|
366
384
|
>
|
|
367
385
|
|
|
@@ -505,6 +505,7 @@ export type ActionAttempt =
|
|
|
505
505
|
| 'unknown_issue_with_acs_credential'
|
|
506
506
|
| 'needs_to_be_reissued'
|
|
507
507
|
| 'requested_code_unavailable'
|
|
508
|
+
| 'schedule_rounded_up'
|
|
508
509
|
|
|
509
510
|
/**
|
|
510
511
|
* The PIN code that was assigned instead.
|
|
@@ -845,6 +846,7 @@ export type ActionAttempt =
|
|
|
845
846
|
| 'unknown_issue_with_acs_credential'
|
|
846
847
|
| 'needs_to_be_reissued'
|
|
847
848
|
| 'requested_code_unavailable'
|
|
849
|
+
| 'schedule_rounded_up'
|
|
848
850
|
|
|
849
851
|
/**
|
|
850
852
|
* The PIN code that was assigned instead.
|
|
@@ -1174,6 +1176,7 @@ export type ActionAttempt =
|
|
|
1174
1176
|
| 'unknown_issue_with_acs_credential'
|
|
1175
1177
|
| 'needs_to_be_reissued'
|
|
1176
1178
|
| 'requested_code_unavailable'
|
|
1179
|
+
| 'schedule_rounded_up'
|
|
1177
1180
|
|
|
1178
1181
|
/**
|
|
1179
1182
|
* The PIN code that was assigned instead.
|
|
@@ -1427,6 +1430,7 @@ export type ActionAttempt =
|
|
|
1427
1430
|
| 'user_identity_missing_email_address'
|
|
1428
1431
|
| 'user_identity_missing_phone_number'
|
|
1429
1432
|
| 'requested_code_unavailable'
|
|
1433
|
+
| 'schedule_rounded_up'
|
|
1430
1434
|
|
|
1431
1435
|
/**
|
|
1432
1436
|
* ID of the original access method from which this backup access method was split, if applicable.
|
|
@@ -207,6 +207,7 @@ export type Device = {
|
|
|
207
207
|
| 'omnitec_lock'
|
|
208
208
|
| 'kisi_lock'
|
|
209
209
|
| 'aqara_lock'
|
|
210
|
+
| 'eufy_lock'
|
|
210
211
|
| 'keynest_key'
|
|
211
212
|
| 'noiseaware_activity_zone'
|
|
212
213
|
| 'minut_sensor'
|
|
@@ -1130,6 +1131,18 @@ export type Device = {
|
|
|
1130
1131
|
ecobee_device_id?: string | undefined
|
|
1131
1132
|
}
|
|
1132
1133
|
| undefined
|
|
1134
|
+
/**
|
|
1135
|
+
* Metadata for a Eufy device.
|
|
1136
|
+
*/
|
|
1137
|
+
eufy_metadata?:
|
|
1138
|
+
| {
|
|
1139
|
+
device_id?: string | undefined
|
|
1140
|
+
|
|
1141
|
+
device_name?: string | undefined
|
|
1142
|
+
|
|
1143
|
+
model?: string | undefined
|
|
1144
|
+
}
|
|
1145
|
+
| undefined
|
|
1133
1146
|
/**
|
|
1134
1147
|
* Metadata for a 4SUITES device.
|
|
1135
1148
|
*/
|
|
@@ -395,6 +395,24 @@ export type UnmanagedAccessMethod = {
|
|
|
395
395
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
396
396
|
*/
|
|
397
397
|
warning_code: 'requested_code_unavailable'
|
|
398
|
+
} /**
|
|
399
|
+
* Indicates that the access system can only end card access on fixed time marks, so access was extended past `ends_at` to the next mark. The message states when access actually ends.
|
|
400
|
+
*/
|
|
401
|
+
| {
|
|
402
|
+
/**
|
|
403
|
+
* Date and time at which Seam created the warning.
|
|
404
|
+
*/
|
|
405
|
+
created_at: string
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
409
|
+
*/
|
|
410
|
+
message: string
|
|
411
|
+
|
|
412
|
+
/**
|
|
413
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
414
|
+
*/
|
|
415
|
+
warning_code: 'schedule_rounded_up'
|
|
398
416
|
}
|
|
399
417
|
>
|
|
400
418
|
|
|
@@ -165,7 +165,7 @@ export class SeamHttpCamerasLiveViews {
|
|
|
165
165
|
/**
|
|
166
166
|
* 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.
|
|
167
167
|
*
|
|
168
|
-
* Camera live view is in beta.
|
|
168
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Use your API key on your backend to create a client session with access to the camera's connected account, then authenticate live view requests with that client session's token. To check whether a camera supports live view, use `device.can_stream_live_video`.
|
|
169
169
|
*/
|
|
170
170
|
create(
|
|
171
171
|
parameters: CamerasLiveViewsCreateParameters,
|
|
@@ -187,7 +187,7 @@ export class SeamHttpCamerasLiveViews {
|
|
|
187
187
|
/**
|
|
188
188
|
* 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`.
|
|
189
189
|
*
|
|
190
|
-
* Camera live view is in beta.
|
|
190
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
191
191
|
*/
|
|
192
192
|
offer(
|
|
193
193
|
parameters: CamerasLiveViewsOfferParameters,
|
|
@@ -213,7 +213,7 @@ export class SeamHttpCamerasLiveViews {
|
|
|
213
213
|
/**
|
|
214
214
|
* Stops a camera live view session that the current client session owns.
|
|
215
215
|
*
|
|
216
|
-
* Camera live view is in beta.
|
|
216
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
217
217
|
*/
|
|
218
218
|
stop(
|
|
219
219
|
parameters: CamerasLiveViewsStopParameters,
|
|
@@ -371,6 +371,7 @@ export type DevicesListParameters = {
|
|
|
371
371
|
| 'omnitec_lock'
|
|
372
372
|
| 'kisi_lock'
|
|
373
373
|
| 'aqara_lock'
|
|
374
|
+
| 'eufy_lock'
|
|
374
375
|
| 'keynest_key'
|
|
375
376
|
| 'noiseaware_activity_zone'
|
|
376
377
|
| 'minut_sensor'
|
|
@@ -424,6 +425,7 @@ export type DevicesListParameters = {
|
|
|
424
425
|
| 'omnitec_lock'
|
|
425
426
|
| 'kisi_lock'
|
|
426
427
|
| 'aqara_lock'
|
|
428
|
+
| 'eufy_lock'
|
|
427
429
|
| 'keynest_key'
|
|
428
430
|
| 'noiseaware_activity_zone'
|
|
429
431
|
| 'minut_sensor'
|
|
@@ -318,6 +318,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
318
318
|
| 'omnitec_lock'
|
|
319
319
|
| 'kisi_lock'
|
|
320
320
|
| 'aqara_lock'
|
|
321
|
+
| 'eufy_lock'
|
|
321
322
|
| 'keynest_key'
|
|
322
323
|
| 'noiseaware_activity_zone'
|
|
323
324
|
| 'minut_sensor'
|
|
@@ -371,6 +372,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
371
372
|
| 'omnitec_lock'
|
|
372
373
|
| 'kisi_lock'
|
|
373
374
|
| 'aqara_lock'
|
|
375
|
+
| 'eufy_lock'
|
|
374
376
|
| 'keynest_key'
|
|
375
377
|
| 'noiseaware_activity_zone'
|
|
376
378
|
| 'minut_sensor'
|
|
@@ -389,6 +389,7 @@ export type LocksListParameters = {
|
|
|
389
389
|
| 'omnitec_lock'
|
|
390
390
|
| 'kisi_lock'
|
|
391
391
|
| 'aqara_lock'
|
|
392
|
+
| 'eufy_lock'
|
|
392
393
|
| undefined
|
|
393
394
|
/**
|
|
394
395
|
* Device types of the locks that you want to list.
|
|
@@ -426,6 +427,7 @@ export type LocksListParameters = {
|
|
|
426
427
|
| 'omnitec_lock'
|
|
427
428
|
| 'kisi_lock'
|
|
428
429
|
| 'aqara_lock'
|
|
430
|
+
| 'eufy_lock'
|
|
429
431
|
>
|
|
430
432
|
| undefined
|
|
431
433
|
/**
|
|
@@ -2268,7 +2268,7 @@ export class SeamHttpEndpoints {
|
|
|
2268
2268
|
/**
|
|
2269
2269
|
* 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.
|
|
2270
2270
|
*
|
|
2271
|
-
* Camera live view is in beta.
|
|
2271
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Use your API key on your backend to create a client session with access to the camera's connected account, then authenticate live view requests with that client session's token. To check whether a camera supports live view, use `device.can_stream_live_video`.
|
|
2272
2272
|
*/
|
|
2273
2273
|
get '/cameras/live_views/create'(): (
|
|
2274
2274
|
parameters: CamerasLiveViewsCreateParameters,
|
|
@@ -2286,7 +2286,7 @@ export class SeamHttpEndpoints {
|
|
|
2286
2286
|
/**
|
|
2287
2287
|
* 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`.
|
|
2288
2288
|
*
|
|
2289
|
-
* Camera live view is in beta.
|
|
2289
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
2290
2290
|
*/
|
|
2291
2291
|
get '/cameras/live_views/offer'(): (
|
|
2292
2292
|
parameters: CamerasLiveViewsOfferParameters,
|
|
@@ -2304,7 +2304,7 @@ export class SeamHttpEndpoints {
|
|
|
2304
2304
|
/**
|
|
2305
2305
|
* Stops a camera live view session that the current client session owns.
|
|
2306
2306
|
*
|
|
2307
|
-
* Camera live view is in beta.
|
|
2307
|
+
* Camera live view is in public beta and enabled by default in production and sandbox workspaces. Authenticate with the client session token used to create the live view session.
|
|
2308
2308
|
*/
|
|
2309
2309
|
get '/cameras/live_views/stop'(): (
|
|
2310
2310
|
parameters: CamerasLiveViewsStopParameters,
|
package/src/lib/version.ts
CHANGED