@seamapi/types 1.919.0 → 1.921.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/dist/connect.cjs +142 -4
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +212 -6
- package/dist/index.cjs +142 -4
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/events/access-codes.d.ts +118 -0
- package/lib/seam/connect/models/events/access-codes.js +34 -0
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +59 -1
- package/lib/seam/connect/openapi.js +112 -4
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +154 -6
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +48 -0
- package/src/lib/seam/connect/openapi.ts +121 -4
- package/src/lib/seam/connect/route-types.ts +216 -2
|
@@ -43,7 +43,7 @@ export type Routes = {
|
|
|
43
43
|
/** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
|
|
44
44
|
is_one_time_use?: boolean | undefined;
|
|
45
45
|
/** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
|
|
46
|
-
max_time_rounding?: '1hour' | '1day' | '1h' | '1d';
|
|
46
|
+
max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined;
|
|
47
47
|
};
|
|
48
48
|
commonParams: {};
|
|
49
49
|
formData: {};
|
|
@@ -9848,7 +9848,7 @@ export type Routes = {
|
|
|
9848
9848
|
/** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
|
|
9849
9849
|
is_one_time_use?: boolean | undefined;
|
|
9850
9850
|
/** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
|
|
9851
|
-
max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined;
|
|
9851
|
+
max_time_rounding?: (('1hour' | '1day' | '1h' | '1d') | undefined) | undefined;
|
|
9852
9852
|
/** ID of the access code that you want to update. */
|
|
9853
9853
|
access_code_id: string;
|
|
9854
9854
|
/** ID of the device containing the access code that you want to update. */
|
|
@@ -45442,6 +45442,43 @@ export type Routes = {
|
|
|
45442
45442
|
};
|
|
45443
45443
|
/** Human-readable description of the change and its source. */
|
|
45444
45444
|
description: string;
|
|
45445
|
+
} | {
|
|
45446
|
+
/** ID of the event. */
|
|
45447
|
+
event_id: string;
|
|
45448
|
+
/** ID of the workspace associated with the event. */
|
|
45449
|
+
workspace_id: string;
|
|
45450
|
+
/** Date and time at which the event was created. */
|
|
45451
|
+
created_at: string;
|
|
45452
|
+
/** Date and time at which the event occurred. */
|
|
45453
|
+
occurred_at: string;
|
|
45454
|
+
/** ID of the affected access code. */
|
|
45455
|
+
access_code_id: string;
|
|
45456
|
+
/** ID of the device associated with the affected access code. */
|
|
45457
|
+
device_id: string;
|
|
45458
|
+
/** ID of the connected account associated with the affected access code. */
|
|
45459
|
+
connected_account_id: string;
|
|
45460
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
45461
|
+
device_custom_metadata?: {
|
|
45462
|
+
[x: string]: string | boolean;
|
|
45463
|
+
} | undefined;
|
|
45464
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
45465
|
+
connected_account_custom_metadata?: {
|
|
45466
|
+
[x: string]: string | boolean;
|
|
45467
|
+
} | undefined;
|
|
45468
|
+
event_type: 'access_code.mutations_requested';
|
|
45469
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
45470
|
+
requested_mutations: {
|
|
45471
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
45472
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
45473
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
45474
|
+
from?: {
|
|
45475
|
+
[x: string]: unknown;
|
|
45476
|
+
} | undefined;
|
|
45477
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
45478
|
+
to?: {
|
|
45479
|
+
[x: string]: unknown;
|
|
45480
|
+
} | undefined;
|
|
45481
|
+
}[];
|
|
45445
45482
|
} | {
|
|
45446
45483
|
/** ID of the event. */
|
|
45447
45484
|
event_id: string;
|
|
@@ -48233,9 +48270,9 @@ export type Routes = {
|
|
|
48233
48270
|
/** IDs of the access codes for which you want to list events. */
|
|
48234
48271
|
access_code_ids?: string[] | undefined;
|
|
48235
48272
|
/** Type of the events that you want to list. */
|
|
48236
|
-
event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | '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' | '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;
|
|
48273
|
+
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' | '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;
|
|
48237
48274
|
/** Types of the events that you want to list. */
|
|
48238
|
-
event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | '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' | '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;
|
|
48275
|
+
event_types?: ('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' | '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;
|
|
48239
48276
|
/** ID of the connected account for which you want to list events. */
|
|
48240
48277
|
connected_account_id?: string | undefined;
|
|
48241
48278
|
/** ID of the Connect Webview for which you want to list events. */
|
|
@@ -48442,6 +48479,43 @@ export type Routes = {
|
|
|
48442
48479
|
};
|
|
48443
48480
|
/** Human-readable description of the change and its source. */
|
|
48444
48481
|
description: string;
|
|
48482
|
+
} | {
|
|
48483
|
+
/** ID of the event. */
|
|
48484
|
+
event_id: string;
|
|
48485
|
+
/** ID of the workspace associated with the event. */
|
|
48486
|
+
workspace_id: string;
|
|
48487
|
+
/** Date and time at which the event was created. */
|
|
48488
|
+
created_at: string;
|
|
48489
|
+
/** Date and time at which the event occurred. */
|
|
48490
|
+
occurred_at: string;
|
|
48491
|
+
/** ID of the affected access code. */
|
|
48492
|
+
access_code_id: string;
|
|
48493
|
+
/** ID of the device associated with the affected access code. */
|
|
48494
|
+
device_id: string;
|
|
48495
|
+
/** ID of the connected account associated with the affected access code. */
|
|
48496
|
+
connected_account_id: string;
|
|
48497
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
48498
|
+
device_custom_metadata?: {
|
|
48499
|
+
[x: string]: string | boolean;
|
|
48500
|
+
} | undefined;
|
|
48501
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
48502
|
+
connected_account_custom_metadata?: {
|
|
48503
|
+
[x: string]: string | boolean;
|
|
48504
|
+
} | undefined;
|
|
48505
|
+
event_type: 'access_code.mutations_requested';
|
|
48506
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
48507
|
+
requested_mutations: {
|
|
48508
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
48509
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
48510
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
48511
|
+
from?: {
|
|
48512
|
+
[x: string]: unknown;
|
|
48513
|
+
} | undefined;
|
|
48514
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
48515
|
+
to?: {
|
|
48516
|
+
[x: string]: unknown;
|
|
48517
|
+
} | undefined;
|
|
48518
|
+
}[];
|
|
48445
48519
|
} | {
|
|
48446
48520
|
/** ID of the event. */
|
|
48447
48521
|
event_id: string;
|
|
@@ -77099,9 +77173,9 @@ export type Routes = {
|
|
|
77099
77173
|
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
|
|
77100
77174
|
between?: (string | Date)[] | undefined;
|
|
77101
77175
|
/** Type of the events that you want to list. */
|
|
77102
|
-
event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | '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' | '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;
|
|
77176
|
+
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' | '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;
|
|
77103
77177
|
/** Types of the events that you want to list. */
|
|
77104
|
-
event_types?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | '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' | '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;
|
|
77178
|
+
event_types?: ('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' | '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;
|
|
77105
77179
|
/** Numerical limit on the number of events to return. */
|
|
77106
77180
|
limit?: number;
|
|
77107
77181
|
};
|
|
@@ -77278,6 +77352,43 @@ export type Routes = {
|
|
|
77278
77352
|
};
|
|
77279
77353
|
/** Human-readable description of the change and its source. */
|
|
77280
77354
|
description: string;
|
|
77355
|
+
} | {
|
|
77356
|
+
/** ID of the event. */
|
|
77357
|
+
event_id: string;
|
|
77358
|
+
/** ID of the workspace associated with the event. */
|
|
77359
|
+
workspace_id: string;
|
|
77360
|
+
/** Date and time at which the event was created. */
|
|
77361
|
+
created_at: string;
|
|
77362
|
+
/** Date and time at which the event occurred. */
|
|
77363
|
+
occurred_at: string;
|
|
77364
|
+
/** ID of the affected access code. */
|
|
77365
|
+
access_code_id: string;
|
|
77366
|
+
/** ID of the device associated with the affected access code. */
|
|
77367
|
+
device_id: string;
|
|
77368
|
+
/** ID of the connected account associated with the affected access code. */
|
|
77369
|
+
connected_account_id: string;
|
|
77370
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
77371
|
+
device_custom_metadata?: {
|
|
77372
|
+
[x: string]: string | boolean;
|
|
77373
|
+
} | undefined;
|
|
77374
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
77375
|
+
connected_account_custom_metadata?: {
|
|
77376
|
+
[x: string]: string | boolean;
|
|
77377
|
+
} | undefined;
|
|
77378
|
+
event_type: 'access_code.mutations_requested';
|
|
77379
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
77380
|
+
requested_mutations: {
|
|
77381
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
77382
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
77383
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
77384
|
+
from?: {
|
|
77385
|
+
[x: string]: unknown;
|
|
77386
|
+
} | undefined;
|
|
77387
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
77388
|
+
to?: {
|
|
77389
|
+
[x: string]: unknown;
|
|
77390
|
+
} | undefined;
|
|
77391
|
+
}[];
|
|
77281
77392
|
} | {
|
|
77282
77393
|
/** ID of the event. */
|
|
77283
77394
|
event_id: string;
|
|
@@ -114435,6 +114546,43 @@ export type Routes = {
|
|
|
114435
114546
|
};
|
|
114436
114547
|
/** Human-readable description of the change and its source. */
|
|
114437
114548
|
description: string;
|
|
114549
|
+
} | {
|
|
114550
|
+
/** ID of the event. */
|
|
114551
|
+
event_id: string;
|
|
114552
|
+
/** ID of the workspace associated with the event. */
|
|
114553
|
+
workspace_id: string;
|
|
114554
|
+
/** Date and time at which the event was created. */
|
|
114555
|
+
created_at: string;
|
|
114556
|
+
/** Date and time at which the event occurred. */
|
|
114557
|
+
occurred_at: string;
|
|
114558
|
+
/** ID of the affected access code. */
|
|
114559
|
+
access_code_id: string;
|
|
114560
|
+
/** ID of the device associated with the affected access code. */
|
|
114561
|
+
device_id: string;
|
|
114562
|
+
/** ID of the connected account associated with the affected access code. */
|
|
114563
|
+
connected_account_id: string;
|
|
114564
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
114565
|
+
device_custom_metadata?: {
|
|
114566
|
+
[x: string]: string | boolean;
|
|
114567
|
+
} | undefined;
|
|
114568
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
114569
|
+
connected_account_custom_metadata?: {
|
|
114570
|
+
[x: string]: string | boolean;
|
|
114571
|
+
} | undefined;
|
|
114572
|
+
event_type: 'access_code.mutations_requested';
|
|
114573
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
114574
|
+
requested_mutations: {
|
|
114575
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
114576
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
114577
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
114578
|
+
from?: {
|
|
114579
|
+
[x: string]: unknown;
|
|
114580
|
+
} | undefined;
|
|
114581
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
114582
|
+
to?: {
|
|
114583
|
+
[x: string]: unknown;
|
|
114584
|
+
} | undefined;
|
|
114585
|
+
}[];
|
|
114438
114586
|
} | {
|
|
114439
114587
|
/** ID of the event. */
|
|
114440
114588
|
event_id: string;
|
package/package.json
CHANGED
|
@@ -182,6 +182,53 @@ export type AccessCodeTimeFrameChangedEvent = z.infer<
|
|
|
182
182
|
typeof access_code_time_frame_changed_event
|
|
183
183
|
>
|
|
184
184
|
|
|
185
|
+
const requested_mutation = z
|
|
186
|
+
.object({
|
|
187
|
+
mutation_code: z
|
|
188
|
+
.enum([
|
|
189
|
+
'updating_name',
|
|
190
|
+
'updating_code',
|
|
191
|
+
'updating_time_frame',
|
|
192
|
+
'deleting',
|
|
193
|
+
'creating',
|
|
194
|
+
'deferring_creation',
|
|
195
|
+
])
|
|
196
|
+
.describe(
|
|
197
|
+
'Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`.',
|
|
198
|
+
),
|
|
199
|
+
from: z
|
|
200
|
+
.record(z.string(), z.unknown())
|
|
201
|
+
.optional()
|
|
202
|
+
.describe(
|
|
203
|
+
'Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.',
|
|
204
|
+
),
|
|
205
|
+
to: z
|
|
206
|
+
.record(z.string(), z.unknown())
|
|
207
|
+
.optional()
|
|
208
|
+
.describe(
|
|
209
|
+
'New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.',
|
|
210
|
+
),
|
|
211
|
+
})
|
|
212
|
+
.describe('Record describing a single requested mutation.')
|
|
213
|
+
|
|
214
|
+
export const access_code_mutations_requested_event = access_code_event.extend({
|
|
215
|
+
event_type: z.literal('access_code.mutations_requested'),
|
|
216
|
+
requested_mutations: z
|
|
217
|
+
.array(requested_mutation)
|
|
218
|
+
.describe(
|
|
219
|
+
'Array of mutations requested on the access code, each containing the mutation type and from/to values.',
|
|
220
|
+
),
|
|
221
|
+
}).describe(`
|
|
222
|
+
---
|
|
223
|
+
route_path: /access_codes
|
|
224
|
+
---
|
|
225
|
+
Mutations were requested on an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device.
|
|
226
|
+
`)
|
|
227
|
+
|
|
228
|
+
export type AccessCodeMutationsRequestedEvent = z.infer<
|
|
229
|
+
typeof access_code_mutations_requested_event
|
|
230
|
+
>
|
|
231
|
+
|
|
185
232
|
export const access_code_scheduled_on_device_event = access_code_event.extend({
|
|
186
233
|
event_type: z.literal('access_code.scheduled_on_device'),
|
|
187
234
|
code,
|
|
@@ -404,6 +451,7 @@ export const access_code_events = [
|
|
|
404
451
|
access_code_name_changed_event,
|
|
405
452
|
access_code_code_changed_event,
|
|
406
453
|
access_code_time_frame_changed_event,
|
|
454
|
+
access_code_mutations_requested_event,
|
|
407
455
|
access_code_scheduled_on_device_event,
|
|
408
456
|
access_code_set_on_device_event,
|
|
409
457
|
access_code_removed_from_device_event,
|
|
@@ -17985,6 +17985,119 @@ const openapi: OpenAPISpec = {
|
|
|
17985
17985
|
type: 'object',
|
|
17986
17986
|
'x-route-path': '/access_codes',
|
|
17987
17987
|
},
|
|
17988
|
+
{
|
|
17989
|
+
description:
|
|
17990
|
+
'Mutations were requested on an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). This event fires at request time, before the change is confirmed on the device.',
|
|
17991
|
+
properties: {
|
|
17992
|
+
access_code_id: {
|
|
17993
|
+
description: 'ID of the affected access code.',
|
|
17994
|
+
format: 'uuid',
|
|
17995
|
+
type: 'string',
|
|
17996
|
+
},
|
|
17997
|
+
connected_account_custom_metadata: {
|
|
17998
|
+
additionalProperties: {
|
|
17999
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18000
|
+
},
|
|
18001
|
+
description:
|
|
18002
|
+
'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18003
|
+
type: 'object',
|
|
18004
|
+
},
|
|
18005
|
+
connected_account_id: {
|
|
18006
|
+
description:
|
|
18007
|
+
'ID of the connected account associated with the affected access code.',
|
|
18008
|
+
format: 'uuid',
|
|
18009
|
+
type: 'string',
|
|
18010
|
+
},
|
|
18011
|
+
created_at: {
|
|
18012
|
+
description: 'Date and time at which the event was created.',
|
|
18013
|
+
format: 'date-time',
|
|
18014
|
+
type: 'string',
|
|
18015
|
+
},
|
|
18016
|
+
device_custom_metadata: {
|
|
18017
|
+
additionalProperties: {
|
|
18018
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18019
|
+
},
|
|
18020
|
+
description:
|
|
18021
|
+
'Custom metadata of the device, present when device_id is provided.',
|
|
18022
|
+
type: 'object',
|
|
18023
|
+
},
|
|
18024
|
+
device_id: {
|
|
18025
|
+
description:
|
|
18026
|
+
'ID of the device associated with the affected access code.',
|
|
18027
|
+
format: 'uuid',
|
|
18028
|
+
type: 'string',
|
|
18029
|
+
},
|
|
18030
|
+
event_id: {
|
|
18031
|
+
description: 'ID of the event.',
|
|
18032
|
+
format: 'uuid',
|
|
18033
|
+
type: 'string',
|
|
18034
|
+
},
|
|
18035
|
+
event_type: {
|
|
18036
|
+
enum: ['access_code.mutations_requested'],
|
|
18037
|
+
type: 'string',
|
|
18038
|
+
},
|
|
18039
|
+
occurred_at: {
|
|
18040
|
+
description: 'Date and time at which the event occurred.',
|
|
18041
|
+
format: 'date-time',
|
|
18042
|
+
type: 'string',
|
|
18043
|
+
},
|
|
18044
|
+
requested_mutations: {
|
|
18045
|
+
description:
|
|
18046
|
+
'Array of mutations requested on the access code, each containing the mutation type and from/to values.',
|
|
18047
|
+
items: {
|
|
18048
|
+
description: 'Record describing a single requested mutation.',
|
|
18049
|
+
properties: {
|
|
18050
|
+
from: {
|
|
18051
|
+
additionalProperties: {},
|
|
18052
|
+
description:
|
|
18053
|
+
'Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.',
|
|
18054
|
+
type: 'object',
|
|
18055
|
+
},
|
|
18056
|
+
mutation_code: {
|
|
18057
|
+
description:
|
|
18058
|
+
'Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`.',
|
|
18059
|
+
enum: [
|
|
18060
|
+
'updating_name',
|
|
18061
|
+
'updating_code',
|
|
18062
|
+
'updating_time_frame',
|
|
18063
|
+
'deleting',
|
|
18064
|
+
'creating',
|
|
18065
|
+
'deferring_creation',
|
|
18066
|
+
],
|
|
18067
|
+
type: 'string',
|
|
18068
|
+
},
|
|
18069
|
+
to: {
|
|
18070
|
+
additionalProperties: {},
|
|
18071
|
+
description:
|
|
18072
|
+
'New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.',
|
|
18073
|
+
type: 'object',
|
|
18074
|
+
},
|
|
18075
|
+
},
|
|
18076
|
+
required: ['mutation_code'],
|
|
18077
|
+
type: 'object',
|
|
18078
|
+
},
|
|
18079
|
+
type: 'array',
|
|
18080
|
+
},
|
|
18081
|
+
workspace_id: {
|
|
18082
|
+
description: 'ID of the workspace associated with the event.',
|
|
18083
|
+
format: 'uuid',
|
|
18084
|
+
type: 'string',
|
|
18085
|
+
},
|
|
18086
|
+
},
|
|
18087
|
+
required: [
|
|
18088
|
+
'event_id',
|
|
18089
|
+
'workspace_id',
|
|
18090
|
+
'created_at',
|
|
18091
|
+
'occurred_at',
|
|
18092
|
+
'access_code_id',
|
|
18093
|
+
'device_id',
|
|
18094
|
+
'connected_account_id',
|
|
18095
|
+
'event_type',
|
|
18096
|
+
'requested_mutations',
|
|
18097
|
+
],
|
|
18098
|
+
type: 'object',
|
|
18099
|
+
'x-route-path': '/access_codes',
|
|
18100
|
+
},
|
|
17988
18101
|
{
|
|
17989
18102
|
description:
|
|
17990
18103
|
'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) on a device.',
|
|
@@ -34229,7 +34342,6 @@ const openapi: OpenAPISpec = {
|
|
|
34229
34342
|
type: 'boolean',
|
|
34230
34343
|
},
|
|
34231
34344
|
max_time_rounding: {
|
|
34232
|
-
default: '1hour',
|
|
34233
34345
|
description:
|
|
34234
34346
|
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
34235
34347
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
@@ -36668,7 +36780,6 @@ const openapi: OpenAPISpec = {
|
|
|
36668
36780
|
type: 'boolean',
|
|
36669
36781
|
},
|
|
36670
36782
|
max_time_rounding: {
|
|
36671
|
-
default: '1hour',
|
|
36672
36783
|
description:
|
|
36673
36784
|
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
36674
36785
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
@@ -36822,7 +36933,6 @@ const openapi: OpenAPISpec = {
|
|
|
36822
36933
|
type: 'boolean',
|
|
36823
36934
|
},
|
|
36824
36935
|
max_time_rounding: {
|
|
36825
|
-
default: '1hour',
|
|
36826
36936
|
description:
|
|
36827
36937
|
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
36828
36938
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
@@ -36976,7 +37086,6 @@ const openapi: OpenAPISpec = {
|
|
|
36976
37086
|
type: 'boolean',
|
|
36977
37087
|
},
|
|
36978
37088
|
max_time_rounding: {
|
|
36979
|
-
default: '1hour',
|
|
36980
37089
|
description:
|
|
36981
37090
|
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
36982
37091
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
@@ -60690,6 +60799,7 @@ const openapi: OpenAPISpec = {
|
|
|
60690
60799
|
'access_code.name_changed',
|
|
60691
60800
|
'access_code.code_changed',
|
|
60692
60801
|
'access_code.time_frame_changed',
|
|
60802
|
+
'access_code.mutations_requested',
|
|
60693
60803
|
'access_code.scheduled_on_device',
|
|
60694
60804
|
'access_code.set_on_device',
|
|
60695
60805
|
'access_code.removed_from_device',
|
|
@@ -60807,6 +60917,7 @@ const openapi: OpenAPISpec = {
|
|
|
60807
60917
|
'access_code.name_changed',
|
|
60808
60918
|
'access_code.code_changed',
|
|
60809
60919
|
'access_code.time_frame_changed',
|
|
60920
|
+
'access_code.mutations_requested',
|
|
60810
60921
|
'access_code.scheduled_on_device',
|
|
60811
60922
|
'access_code.set_on_device',
|
|
60812
60923
|
'access_code.removed_from_device',
|
|
@@ -61257,6 +61368,7 @@ const openapi: OpenAPISpec = {
|
|
|
61257
61368
|
'access_code.name_changed',
|
|
61258
61369
|
'access_code.code_changed',
|
|
61259
61370
|
'access_code.time_frame_changed',
|
|
61371
|
+
'access_code.mutations_requested',
|
|
61260
61372
|
'access_code.scheduled_on_device',
|
|
61261
61373
|
'access_code.set_on_device',
|
|
61262
61374
|
'access_code.removed_from_device',
|
|
@@ -61370,6 +61482,7 @@ const openapi: OpenAPISpec = {
|
|
|
61370
61482
|
'access_code.name_changed',
|
|
61371
61483
|
'access_code.code_changed',
|
|
61372
61484
|
'access_code.time_frame_changed',
|
|
61485
|
+
'access_code.mutations_requested',
|
|
61373
61486
|
'access_code.scheduled_on_device',
|
|
61374
61487
|
'access_code.set_on_device',
|
|
61375
61488
|
'access_code.removed_from_device',
|
|
@@ -71641,6 +71754,7 @@ const openapi: OpenAPISpec = {
|
|
|
71641
71754
|
'access_code.name_changed',
|
|
71642
71755
|
'access_code.code_changed',
|
|
71643
71756
|
'access_code.time_frame_changed',
|
|
71757
|
+
'access_code.mutations_requested',
|
|
71644
71758
|
'access_code.scheduled_on_device',
|
|
71645
71759
|
'access_code.set_on_device',
|
|
71646
71760
|
'access_code.removed_from_device',
|
|
@@ -71759,6 +71873,7 @@ const openapi: OpenAPISpec = {
|
|
|
71759
71873
|
'access_code.name_changed',
|
|
71760
71874
|
'access_code.code_changed',
|
|
71761
71875
|
'access_code.time_frame_changed',
|
|
71876
|
+
'access_code.mutations_requested',
|
|
71762
71877
|
'access_code.scheduled_on_device',
|
|
71763
71878
|
'access_code.set_on_device',
|
|
71764
71879
|
'access_code.removed_from_device',
|
|
@@ -71940,6 +72055,7 @@ const openapi: OpenAPISpec = {
|
|
|
71940
72055
|
'access_code.name_changed',
|
|
71941
72056
|
'access_code.code_changed',
|
|
71942
72057
|
'access_code.time_frame_changed',
|
|
72058
|
+
'access_code.mutations_requested',
|
|
71943
72059
|
'access_code.scheduled_on_device',
|
|
71944
72060
|
'access_code.set_on_device',
|
|
71945
72061
|
'access_code.removed_from_device',
|
|
@@ -72053,6 +72169,7 @@ const openapi: OpenAPISpec = {
|
|
|
72053
72169
|
'access_code.name_changed',
|
|
72054
72170
|
'access_code.code_changed',
|
|
72055
72171
|
'access_code.time_frame_changed',
|
|
72172
|
+
'access_code.mutations_requested',
|
|
72056
72173
|
'access_code.scheduled_on_device',
|
|
72057
72174
|
'access_code.set_on_device',
|
|
72058
72175
|
'access_code.removed_from_device',
|