@seamapi/http 2.17.0 → 2.18.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-code.d.ts +87 -0
- package/lib/resources/unmanaged-access-code.d.ts +87 -0
- package/lib/routes/events/events.d.ts +2 -2
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +100 -0
- package/src/lib/resources/unmanaged-access-code.ts +100 -0
- package/src/lib/routes/events/events.ts +12 -0
- package/src/lib/version.ts +1 -1
|
@@ -258,6 +258,63 @@ export type AccessCode = {
|
|
|
258
258
|
*/
|
|
259
259
|
message: string;
|
|
260
260
|
} /**
|
|
261
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.
|
|
262
|
+
*/ | {
|
|
263
|
+
/**
|
|
264
|
+
* Date and time at which Seam created the error.
|
|
265
|
+
*/
|
|
266
|
+
created_at?: string | undefined;
|
|
267
|
+
/**
|
|
268
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
269
|
+
*/
|
|
270
|
+
error_code: 'failed_to_issue';
|
|
271
|
+
/**
|
|
272
|
+
* Indicates that this is an access code error.
|
|
273
|
+
*/
|
|
274
|
+
is_access_code_error: true;
|
|
275
|
+
/**
|
|
276
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
277
|
+
*/
|
|
278
|
+
message: string;
|
|
279
|
+
} /**
|
|
280
|
+
* Seam was unable to apply this access code's pending mutations to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the mutations are applied.
|
|
281
|
+
*/ | {
|
|
282
|
+
/**
|
|
283
|
+
* Date and time at which Seam created the error.
|
|
284
|
+
*/
|
|
285
|
+
created_at?: string | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
288
|
+
*/
|
|
289
|
+
error_code: 'failed_to_apply_mutations';
|
|
290
|
+
/**
|
|
291
|
+
* Indicates that this is an access code error.
|
|
292
|
+
*/
|
|
293
|
+
is_access_code_error: true;
|
|
294
|
+
/**
|
|
295
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
296
|
+
*/
|
|
297
|
+
message: string;
|
|
298
|
+
} /**
|
|
299
|
+
* This access code 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 this error clears automatically once the access code is no longer active.
|
|
300
|
+
*/ | {
|
|
301
|
+
/**
|
|
302
|
+
* Date and time at which Seam created the error.
|
|
303
|
+
*/
|
|
304
|
+
created_at?: string | undefined;
|
|
305
|
+
/**
|
|
306
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
307
|
+
*/
|
|
308
|
+
error_code: 'failed_to_expire';
|
|
309
|
+
/**
|
|
310
|
+
* Indicates that this is an access code error.
|
|
311
|
+
*/
|
|
312
|
+
is_access_code_error: true;
|
|
313
|
+
/**
|
|
314
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
315
|
+
*/
|
|
316
|
+
message: string;
|
|
317
|
+
} /**
|
|
261
318
|
* Indicates that the account is disconnected.
|
|
262
319
|
*/ | {
|
|
263
320
|
/**
|
|
@@ -860,6 +917,36 @@ export type AccessCode = {
|
|
|
860
917
|
*/
|
|
861
918
|
warning_code: 'delay_in_removing_from_device';
|
|
862
919
|
} /**
|
|
920
|
+
* Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
|
|
921
|
+
*/ | {
|
|
922
|
+
/**
|
|
923
|
+
* Date and time at which Seam created the warning.
|
|
924
|
+
*/
|
|
925
|
+
created_at?: string | undefined;
|
|
926
|
+
/**
|
|
927
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
928
|
+
*/
|
|
929
|
+
message: string;
|
|
930
|
+
/**
|
|
931
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
932
|
+
*/
|
|
933
|
+
warning_code: 'delay_in_issuing';
|
|
934
|
+
} /**
|
|
935
|
+
* Seam has not yet applied this access code's pending mutations to the device, so the code on the device does not yet match its requested state. Seam is still attempting to apply them, and this warning clears automatically once the mutations are applied.
|
|
936
|
+
*/ | {
|
|
937
|
+
/**
|
|
938
|
+
* Date and time at which Seam created the warning.
|
|
939
|
+
*/
|
|
940
|
+
created_at?: string | undefined;
|
|
941
|
+
/**
|
|
942
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
943
|
+
*/
|
|
944
|
+
message: string;
|
|
945
|
+
/**
|
|
946
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
947
|
+
*/
|
|
948
|
+
warning_code: 'delay_in_applying_mutations';
|
|
949
|
+
} /**
|
|
863
950
|
* Third-party integration detected that may cause access codes to fail.
|
|
864
951
|
*/ | {
|
|
865
952
|
/**
|
|
@@ -264,6 +264,63 @@ export type UnmanagedAccessCode = {
|
|
|
264
264
|
*/
|
|
265
265
|
message: string;
|
|
266
266
|
} /**
|
|
267
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.
|
|
268
|
+
*/ | {
|
|
269
|
+
/**
|
|
270
|
+
* Date and time at which Seam created the error.
|
|
271
|
+
*/
|
|
272
|
+
created_at?: string | undefined;
|
|
273
|
+
/**
|
|
274
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
275
|
+
*/
|
|
276
|
+
error_code: 'failed_to_issue';
|
|
277
|
+
/**
|
|
278
|
+
* Indicates that this is an access code error.
|
|
279
|
+
*/
|
|
280
|
+
is_access_code_error: true;
|
|
281
|
+
/**
|
|
282
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
283
|
+
*/
|
|
284
|
+
message: string;
|
|
285
|
+
} /**
|
|
286
|
+
* Seam was unable to apply this access code's pending mutations to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the mutations are applied.
|
|
287
|
+
*/ | {
|
|
288
|
+
/**
|
|
289
|
+
* Date and time at which Seam created the error.
|
|
290
|
+
*/
|
|
291
|
+
created_at?: string | undefined;
|
|
292
|
+
/**
|
|
293
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
294
|
+
*/
|
|
295
|
+
error_code: 'failed_to_apply_mutations';
|
|
296
|
+
/**
|
|
297
|
+
* Indicates that this is an access code error.
|
|
298
|
+
*/
|
|
299
|
+
is_access_code_error: true;
|
|
300
|
+
/**
|
|
301
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
302
|
+
*/
|
|
303
|
+
message: string;
|
|
304
|
+
} /**
|
|
305
|
+
* This access code 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 this error clears automatically once the access code is no longer active.
|
|
306
|
+
*/ | {
|
|
307
|
+
/**
|
|
308
|
+
* Date and time at which Seam created the error.
|
|
309
|
+
*/
|
|
310
|
+
created_at?: string | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
313
|
+
*/
|
|
314
|
+
error_code: 'failed_to_expire';
|
|
315
|
+
/**
|
|
316
|
+
* Indicates that this is an access code error.
|
|
317
|
+
*/
|
|
318
|
+
is_access_code_error: true;
|
|
319
|
+
/**
|
|
320
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
321
|
+
*/
|
|
322
|
+
message: string;
|
|
323
|
+
} /**
|
|
267
324
|
* Indicates that the account is disconnected.
|
|
268
325
|
*/ | {
|
|
269
326
|
/**
|
|
@@ -672,6 +729,36 @@ export type UnmanagedAccessCode = {
|
|
|
672
729
|
*/
|
|
673
730
|
warning_code: 'delay_in_removing_from_device';
|
|
674
731
|
} /**
|
|
732
|
+
* Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
|
|
733
|
+
*/ | {
|
|
734
|
+
/**
|
|
735
|
+
* Date and time at which Seam created the warning.
|
|
736
|
+
*/
|
|
737
|
+
created_at?: string | undefined;
|
|
738
|
+
/**
|
|
739
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
740
|
+
*/
|
|
741
|
+
message: string;
|
|
742
|
+
/**
|
|
743
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
744
|
+
*/
|
|
745
|
+
warning_code: 'delay_in_issuing';
|
|
746
|
+
} /**
|
|
747
|
+
* Seam has not yet applied this access code's pending mutations to the device, so the code on the device does not yet match its requested state. Seam is still attempting to apply them, and this warning clears automatically once the mutations are applied.
|
|
748
|
+
*/ | {
|
|
749
|
+
/**
|
|
750
|
+
* Date and time at which Seam created the warning.
|
|
751
|
+
*/
|
|
752
|
+
created_at?: string | undefined;
|
|
753
|
+
/**
|
|
754
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
755
|
+
*/
|
|
756
|
+
message: string;
|
|
757
|
+
/**
|
|
758
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
759
|
+
*/
|
|
760
|
+
warning_code: 'delay_in_applying_mutations';
|
|
761
|
+
} /**
|
|
675
762
|
* Third-party integration detected that may cause access codes to fail.
|
|
676
763
|
*/ | {
|
|
677
764
|
/**
|
|
@@ -132,11 +132,11 @@ export type EventsListParameters = RequireAtLeastOne<{
|
|
|
132
132
|
/**
|
|
133
133
|
* Type of the events that you want to list.
|
|
134
134
|
*/
|
|
135
|
-
event_type?: 'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted' | undefined;
|
|
135
|
+
event_type?: 'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.delay_in_applying_mutations' | 'access_code.failed_to_apply_mutations' | 'access_code.failed_to_expire' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted' | undefined;
|
|
136
136
|
/**
|
|
137
137
|
* Types of the events that you want to list.
|
|
138
138
|
*/
|
|
139
|
-
event_types?: Array<'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted'> | undefined;
|
|
139
|
+
event_types?: Array<'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.delay_in_applying_mutations' | 'access_code.failed_to_apply_mutations' | 'access_code.failed_to_expire' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted'> | undefined;
|
|
140
140
|
/**
|
|
141
141
|
* Numerical limit on the number of events to return.
|
|
142
142
|
*/
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.18.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.18.0",
|
|
4
4
|
"description": "JavaScript HTTP client for the Seam API written in TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
"@seamapi/blueprint": "^1.8.0",
|
|
88
88
|
"@seamapi/fake-seam-connect": "^2.0.4",
|
|
89
89
|
"@seamapi/smith": "^1.1.0",
|
|
90
|
-
"@seamapi/types": "1.
|
|
90
|
+
"@seamapi/types": "1.1028.0",
|
|
91
91
|
"@types/jsonwebtoken": "^9.0.6",
|
|
92
92
|
"@types/node": "^24.10.9",
|
|
93
93
|
"ava": "^8.0.1",
|
|
@@ -292,6 +292,72 @@ export type AccessCode = {
|
|
|
292
292
|
*/
|
|
293
293
|
is_access_code_error: true
|
|
294
294
|
|
|
295
|
+
/**
|
|
296
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
297
|
+
*/
|
|
298
|
+
message: string
|
|
299
|
+
} /**
|
|
300
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.
|
|
301
|
+
*/
|
|
302
|
+
| {
|
|
303
|
+
/**
|
|
304
|
+
* Date and time at which Seam created the error.
|
|
305
|
+
*/
|
|
306
|
+
created_at?: string | undefined
|
|
307
|
+
/**
|
|
308
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
309
|
+
*/
|
|
310
|
+
error_code: 'failed_to_issue'
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* Indicates that this is an access code error.
|
|
314
|
+
*/
|
|
315
|
+
is_access_code_error: true
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
319
|
+
*/
|
|
320
|
+
message: string
|
|
321
|
+
} /**
|
|
322
|
+
* Seam was unable to apply this access code's pending mutations to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the mutations are applied.
|
|
323
|
+
*/
|
|
324
|
+
| {
|
|
325
|
+
/**
|
|
326
|
+
* Date and time at which Seam created the error.
|
|
327
|
+
*/
|
|
328
|
+
created_at?: string | undefined
|
|
329
|
+
/**
|
|
330
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
331
|
+
*/
|
|
332
|
+
error_code: 'failed_to_apply_mutations'
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Indicates that this is an access code error.
|
|
336
|
+
*/
|
|
337
|
+
is_access_code_error: true
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
341
|
+
*/
|
|
342
|
+
message: string
|
|
343
|
+
} /**
|
|
344
|
+
* This access code 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 this error clears automatically once the access code is no longer active.
|
|
345
|
+
*/
|
|
346
|
+
| {
|
|
347
|
+
/**
|
|
348
|
+
* Date and time at which Seam created the error.
|
|
349
|
+
*/
|
|
350
|
+
created_at?: string | undefined
|
|
351
|
+
/**
|
|
352
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
353
|
+
*/
|
|
354
|
+
error_code: 'failed_to_expire'
|
|
355
|
+
|
|
356
|
+
/**
|
|
357
|
+
* Indicates that this is an access code error.
|
|
358
|
+
*/
|
|
359
|
+
is_access_code_error: true
|
|
360
|
+
|
|
295
361
|
/**
|
|
296
362
|
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
297
363
|
*/
|
|
@@ -1005,6 +1071,40 @@ export type AccessCode = {
|
|
|
1005
1071
|
*/
|
|
1006
1072
|
warning_code: 'delay_in_removing_from_device'
|
|
1007
1073
|
} /**
|
|
1074
|
+
* Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
|
|
1075
|
+
*/
|
|
1076
|
+
| {
|
|
1077
|
+
/**
|
|
1078
|
+
* Date and time at which Seam created the warning.
|
|
1079
|
+
*/
|
|
1080
|
+
created_at?: string | undefined
|
|
1081
|
+
/**
|
|
1082
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
1083
|
+
*/
|
|
1084
|
+
message: string
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1088
|
+
*/
|
|
1089
|
+
warning_code: 'delay_in_issuing'
|
|
1090
|
+
} /**
|
|
1091
|
+
* Seam has not yet applied this access code's pending mutations to the device, so the code on the device does not yet match its requested state. Seam is still attempting to apply them, and this warning clears automatically once the mutations are applied.
|
|
1092
|
+
*/
|
|
1093
|
+
| {
|
|
1094
|
+
/**
|
|
1095
|
+
* Date and time at which Seam created the warning.
|
|
1096
|
+
*/
|
|
1097
|
+
created_at?: string | undefined
|
|
1098
|
+
/**
|
|
1099
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
1100
|
+
*/
|
|
1101
|
+
message: string
|
|
1102
|
+
|
|
1103
|
+
/**
|
|
1104
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
1105
|
+
*/
|
|
1106
|
+
warning_code: 'delay_in_applying_mutations'
|
|
1107
|
+
} /**
|
|
1008
1108
|
* Third-party integration detected that may cause access codes to fail.
|
|
1009
1109
|
*/
|
|
1010
1110
|
| {
|
|
@@ -298,6 +298,72 @@ export type UnmanagedAccessCode = {
|
|
|
298
298
|
*/
|
|
299
299
|
is_access_code_error: true
|
|
300
300
|
|
|
301
|
+
/**
|
|
302
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
303
|
+
*/
|
|
304
|
+
message: string
|
|
305
|
+
} /**
|
|
306
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.
|
|
307
|
+
*/
|
|
308
|
+
| {
|
|
309
|
+
/**
|
|
310
|
+
* Date and time at which Seam created the error.
|
|
311
|
+
*/
|
|
312
|
+
created_at?: string | undefined
|
|
313
|
+
/**
|
|
314
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
315
|
+
*/
|
|
316
|
+
error_code: 'failed_to_issue'
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* Indicates that this is an access code error.
|
|
320
|
+
*/
|
|
321
|
+
is_access_code_error: true
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
325
|
+
*/
|
|
326
|
+
message: string
|
|
327
|
+
} /**
|
|
328
|
+
* Seam was unable to apply this access code's pending mutations to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the mutations are applied.
|
|
329
|
+
*/
|
|
330
|
+
| {
|
|
331
|
+
/**
|
|
332
|
+
* Date and time at which Seam created the error.
|
|
333
|
+
*/
|
|
334
|
+
created_at?: string | undefined
|
|
335
|
+
/**
|
|
336
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
337
|
+
*/
|
|
338
|
+
error_code: 'failed_to_apply_mutations'
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Indicates that this is an access code error.
|
|
342
|
+
*/
|
|
343
|
+
is_access_code_error: true
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
347
|
+
*/
|
|
348
|
+
message: string
|
|
349
|
+
} /**
|
|
350
|
+
* This access code 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 this error clears automatically once the access code is no longer active.
|
|
351
|
+
*/
|
|
352
|
+
| {
|
|
353
|
+
/**
|
|
354
|
+
* Date and time at which Seam created the error.
|
|
355
|
+
*/
|
|
356
|
+
created_at?: string | undefined
|
|
357
|
+
/**
|
|
358
|
+
* Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
359
|
+
*/
|
|
360
|
+
error_code: 'failed_to_expire'
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* Indicates that this is an access code error.
|
|
364
|
+
*/
|
|
365
|
+
is_access_code_error: true
|
|
366
|
+
|
|
301
367
|
/**
|
|
302
368
|
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
303
369
|
*/
|
|
@@ -787,6 +853,40 @@ export type UnmanagedAccessCode = {
|
|
|
787
853
|
*/
|
|
788
854
|
warning_code: 'delay_in_removing_from_device'
|
|
789
855
|
} /**
|
|
856
|
+
* Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
|
|
857
|
+
*/
|
|
858
|
+
| {
|
|
859
|
+
/**
|
|
860
|
+
* Date and time at which Seam created the warning.
|
|
861
|
+
*/
|
|
862
|
+
created_at?: string | undefined
|
|
863
|
+
/**
|
|
864
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
865
|
+
*/
|
|
866
|
+
message: string
|
|
867
|
+
|
|
868
|
+
/**
|
|
869
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
870
|
+
*/
|
|
871
|
+
warning_code: 'delay_in_issuing'
|
|
872
|
+
} /**
|
|
873
|
+
* Seam has not yet applied this access code's pending mutations to the device, so the code on the device does not yet match its requested state. Seam is still attempting to apply them, and this warning clears automatically once the mutations are applied.
|
|
874
|
+
*/
|
|
875
|
+
| {
|
|
876
|
+
/**
|
|
877
|
+
* Date and time at which Seam created the warning.
|
|
878
|
+
*/
|
|
879
|
+
created_at?: string | undefined
|
|
880
|
+
/**
|
|
881
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
882
|
+
*/
|
|
883
|
+
message: string
|
|
884
|
+
|
|
885
|
+
/**
|
|
886
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
887
|
+
*/
|
|
888
|
+
warning_code: 'delay_in_applying_mutations'
|
|
889
|
+
} /**
|
|
790
890
|
* Third-party integration detected that may cause access codes to fail.
|
|
791
891
|
*/
|
|
792
892
|
| {
|
|
@@ -318,6 +318,12 @@ export type EventsListParameters = RequireAtLeastOne<{
|
|
|
318
318
|
| 'access_code.removed_from_device'
|
|
319
319
|
| 'access_code.delay_in_setting_on_device'
|
|
320
320
|
| 'access_code.failed_to_set_on_device'
|
|
321
|
+
| 'access_code.issued'
|
|
322
|
+
| 'access_code.delay_in_issuing'
|
|
323
|
+
| 'access_code.failed_to_issue'
|
|
324
|
+
| 'access_code.delay_in_applying_mutations'
|
|
325
|
+
| 'access_code.failed_to_apply_mutations'
|
|
326
|
+
| 'access_code.failed_to_expire'
|
|
321
327
|
| 'access_code.deleted'
|
|
322
328
|
| 'access_code.delay_in_removing_from_device'
|
|
323
329
|
| 'access_code.failed_to_remove_from_device'
|
|
@@ -433,6 +439,12 @@ export type EventsListParameters = RequireAtLeastOne<{
|
|
|
433
439
|
| 'access_code.removed_from_device'
|
|
434
440
|
| 'access_code.delay_in_setting_on_device'
|
|
435
441
|
| 'access_code.failed_to_set_on_device'
|
|
442
|
+
| 'access_code.issued'
|
|
443
|
+
| 'access_code.delay_in_issuing'
|
|
444
|
+
| 'access_code.failed_to_issue'
|
|
445
|
+
| 'access_code.delay_in_applying_mutations'
|
|
446
|
+
| 'access_code.failed_to_apply_mutations'
|
|
447
|
+
| 'access_code.failed_to_expire'
|
|
436
448
|
| 'access_code.deleted'
|
|
437
449
|
| 'access_code.delay_in_removing_from_device'
|
|
438
450
|
| 'access_code.failed_to_remove_from_device'
|
package/src/lib/version.ts
CHANGED