@seamapi/types 1.919.0 → 1.920.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 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +210 -4
- package/dist/index.cjs +142 -0
- 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 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +152 -4
- 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 -0
- package/src/lib/seam/connect/route-types.ts +212 -0
package/dist/connect.d.cts
CHANGED
|
@@ -23932,6 +23932,64 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
|
|
|
23932
23932
|
connected_account_id: z.ZodString;
|
|
23933
23933
|
device_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
23934
23934
|
connected_account_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
23935
|
+
} & {
|
|
23936
|
+
event_type: z.ZodLiteral<"access_code.mutations_requested">;
|
|
23937
|
+
requested_mutations: z.ZodArray<z.ZodObject<{
|
|
23938
|
+
mutation_code: z.ZodEnum<["updating_name", "updating_code", "updating_time_frame", "deleting", "creating", "deferring_creation"]>;
|
|
23939
|
+
from: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
23940
|
+
to: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
23941
|
+
}, "strip", z.ZodTypeAny, {
|
|
23942
|
+
mutation_code: "creating" | "deferring_creation" | "deleting" | "updating_code" | "updating_name" | "updating_time_frame";
|
|
23943
|
+
from?: Record<string, unknown> | undefined;
|
|
23944
|
+
to?: Record<string, unknown> | undefined;
|
|
23945
|
+
}, {
|
|
23946
|
+
mutation_code: "creating" | "deferring_creation" | "deleting" | "updating_code" | "updating_name" | "updating_time_frame";
|
|
23947
|
+
from?: Record<string, unknown> | undefined;
|
|
23948
|
+
to?: Record<string, unknown> | undefined;
|
|
23949
|
+
}>, "many">;
|
|
23950
|
+
}, "strip", z.ZodTypeAny, {
|
|
23951
|
+
device_id: string;
|
|
23952
|
+
workspace_id: string;
|
|
23953
|
+
created_at: string;
|
|
23954
|
+
connected_account_id: string;
|
|
23955
|
+
access_code_id: string;
|
|
23956
|
+
event_id: string;
|
|
23957
|
+
occurred_at: string;
|
|
23958
|
+
event_type: "access_code.mutations_requested";
|
|
23959
|
+
requested_mutations: {
|
|
23960
|
+
mutation_code: "creating" | "deferring_creation" | "deleting" | "updating_code" | "updating_name" | "updating_time_frame";
|
|
23961
|
+
from?: Record<string, unknown> | undefined;
|
|
23962
|
+
to?: Record<string, unknown> | undefined;
|
|
23963
|
+
}[];
|
|
23964
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
23965
|
+
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
23966
|
+
}, {
|
|
23967
|
+
device_id: string;
|
|
23968
|
+
workspace_id: string;
|
|
23969
|
+
created_at: string;
|
|
23970
|
+
connected_account_id: string;
|
|
23971
|
+
access_code_id: string;
|
|
23972
|
+
event_id: string;
|
|
23973
|
+
occurred_at: string;
|
|
23974
|
+
event_type: "access_code.mutations_requested";
|
|
23975
|
+
requested_mutations: {
|
|
23976
|
+
mutation_code: "creating" | "deferring_creation" | "deleting" | "updating_code" | "updating_name" | "updating_time_frame";
|
|
23977
|
+
from?: Record<string, unknown> | undefined;
|
|
23978
|
+
to?: Record<string, unknown> | undefined;
|
|
23979
|
+
}[];
|
|
23980
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
23981
|
+
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
23982
|
+
}>, z.ZodObject<{
|
|
23983
|
+
event_id: z.ZodString;
|
|
23984
|
+
workspace_id: z.ZodString;
|
|
23985
|
+
created_at: z.ZodString;
|
|
23986
|
+
occurred_at: z.ZodString;
|
|
23987
|
+
} & {
|
|
23988
|
+
access_code_id: z.ZodString;
|
|
23989
|
+
device_id: z.ZodString;
|
|
23990
|
+
connected_account_id: z.ZodString;
|
|
23991
|
+
device_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
23992
|
+
connected_account_custom_metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
|
|
23935
23993
|
} & {
|
|
23936
23994
|
event_type: z.ZodLiteral<"access_code.scheduled_on_device">;
|
|
23937
23995
|
code: z.ZodString;
|
|
@@ -74862,6 +74920,43 @@ type Routes = {
|
|
|
74862
74920
|
};
|
|
74863
74921
|
/** Human-readable description of the change and its source. */
|
|
74864
74922
|
description: string;
|
|
74923
|
+
} | {
|
|
74924
|
+
/** ID of the event. */
|
|
74925
|
+
event_id: string;
|
|
74926
|
+
/** ID of the workspace associated with the event. */
|
|
74927
|
+
workspace_id: string;
|
|
74928
|
+
/** Date and time at which the event was created. */
|
|
74929
|
+
created_at: string;
|
|
74930
|
+
/** Date and time at which the event occurred. */
|
|
74931
|
+
occurred_at: string;
|
|
74932
|
+
/** ID of the affected access code. */
|
|
74933
|
+
access_code_id: string;
|
|
74934
|
+
/** ID of the device associated with the affected access code. */
|
|
74935
|
+
device_id: string;
|
|
74936
|
+
/** ID of the connected account associated with the affected access code. */
|
|
74937
|
+
connected_account_id: string;
|
|
74938
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
74939
|
+
device_custom_metadata?: {
|
|
74940
|
+
[x: string]: string | boolean;
|
|
74941
|
+
} | undefined;
|
|
74942
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
74943
|
+
connected_account_custom_metadata?: {
|
|
74944
|
+
[x: string]: string | boolean;
|
|
74945
|
+
} | undefined;
|
|
74946
|
+
event_type: 'access_code.mutations_requested';
|
|
74947
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
74948
|
+
requested_mutations: {
|
|
74949
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
74950
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
74951
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
74952
|
+
from?: {
|
|
74953
|
+
[x: string]: unknown;
|
|
74954
|
+
} | undefined;
|
|
74955
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
74956
|
+
to?: {
|
|
74957
|
+
[x: string]: unknown;
|
|
74958
|
+
} | undefined;
|
|
74959
|
+
}[];
|
|
74865
74960
|
} | {
|
|
74866
74961
|
/** ID of the event. */
|
|
74867
74962
|
event_id: string;
|
|
@@ -77653,9 +77748,9 @@ type Routes = {
|
|
|
77653
77748
|
/** IDs of the access codes for which you want to list events. */
|
|
77654
77749
|
access_code_ids?: string[] | undefined;
|
|
77655
77750
|
/** Type of the events that you want to list. */
|
|
77656
|
-
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;
|
|
77751
|
+
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;
|
|
77657
77752
|
/** Types of the events that you want to list. */
|
|
77658
|
-
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;
|
|
77753
|
+
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;
|
|
77659
77754
|
/** ID of the connected account for which you want to list events. */
|
|
77660
77755
|
connected_account_id?: string | undefined;
|
|
77661
77756
|
/** ID of the Connect Webview for which you want to list events. */
|
|
@@ -77862,6 +77957,43 @@ type Routes = {
|
|
|
77862
77957
|
};
|
|
77863
77958
|
/** Human-readable description of the change and its source. */
|
|
77864
77959
|
description: string;
|
|
77960
|
+
} | {
|
|
77961
|
+
/** ID of the event. */
|
|
77962
|
+
event_id: string;
|
|
77963
|
+
/** ID of the workspace associated with the event. */
|
|
77964
|
+
workspace_id: string;
|
|
77965
|
+
/** Date and time at which the event was created. */
|
|
77966
|
+
created_at: string;
|
|
77967
|
+
/** Date and time at which the event occurred. */
|
|
77968
|
+
occurred_at: string;
|
|
77969
|
+
/** ID of the affected access code. */
|
|
77970
|
+
access_code_id: string;
|
|
77971
|
+
/** ID of the device associated with the affected access code. */
|
|
77972
|
+
device_id: string;
|
|
77973
|
+
/** ID of the connected account associated with the affected access code. */
|
|
77974
|
+
connected_account_id: string;
|
|
77975
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
77976
|
+
device_custom_metadata?: {
|
|
77977
|
+
[x: string]: string | boolean;
|
|
77978
|
+
} | undefined;
|
|
77979
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
77980
|
+
connected_account_custom_metadata?: {
|
|
77981
|
+
[x: string]: string | boolean;
|
|
77982
|
+
} | undefined;
|
|
77983
|
+
event_type: 'access_code.mutations_requested';
|
|
77984
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
77985
|
+
requested_mutations: {
|
|
77986
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
77987
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
77988
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
77989
|
+
from?: {
|
|
77990
|
+
[x: string]: unknown;
|
|
77991
|
+
} | undefined;
|
|
77992
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
77993
|
+
to?: {
|
|
77994
|
+
[x: string]: unknown;
|
|
77995
|
+
} | undefined;
|
|
77996
|
+
}[];
|
|
77865
77997
|
} | {
|
|
77866
77998
|
/** ID of the event. */
|
|
77867
77999
|
event_id: string;
|
|
@@ -106519,9 +106651,9 @@ type Routes = {
|
|
|
106519
106651
|
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
|
|
106520
106652
|
between?: (string | Date)[] | undefined;
|
|
106521
106653
|
/** Type of the events that you want to list. */
|
|
106522
|
-
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;
|
|
106654
|
+
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;
|
|
106523
106655
|
/** Types of the events that you want to list. */
|
|
106524
|
-
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;
|
|
106656
|
+
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;
|
|
106525
106657
|
/** Numerical limit on the number of events to return. */
|
|
106526
106658
|
limit?: number;
|
|
106527
106659
|
};
|
|
@@ -106698,6 +106830,43 @@ type Routes = {
|
|
|
106698
106830
|
};
|
|
106699
106831
|
/** Human-readable description of the change and its source. */
|
|
106700
106832
|
description: string;
|
|
106833
|
+
} | {
|
|
106834
|
+
/** ID of the event. */
|
|
106835
|
+
event_id: string;
|
|
106836
|
+
/** ID of the workspace associated with the event. */
|
|
106837
|
+
workspace_id: string;
|
|
106838
|
+
/** Date and time at which the event was created. */
|
|
106839
|
+
created_at: string;
|
|
106840
|
+
/** Date and time at which the event occurred. */
|
|
106841
|
+
occurred_at: string;
|
|
106842
|
+
/** ID of the affected access code. */
|
|
106843
|
+
access_code_id: string;
|
|
106844
|
+
/** ID of the device associated with the affected access code. */
|
|
106845
|
+
device_id: string;
|
|
106846
|
+
/** ID of the connected account associated with the affected access code. */
|
|
106847
|
+
connected_account_id: string;
|
|
106848
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
106849
|
+
device_custom_metadata?: {
|
|
106850
|
+
[x: string]: string | boolean;
|
|
106851
|
+
} | undefined;
|
|
106852
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
106853
|
+
connected_account_custom_metadata?: {
|
|
106854
|
+
[x: string]: string | boolean;
|
|
106855
|
+
} | undefined;
|
|
106856
|
+
event_type: 'access_code.mutations_requested';
|
|
106857
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
106858
|
+
requested_mutations: {
|
|
106859
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
106860
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
106861
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
106862
|
+
from?: {
|
|
106863
|
+
[x: string]: unknown;
|
|
106864
|
+
} | undefined;
|
|
106865
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
106866
|
+
to?: {
|
|
106867
|
+
[x: string]: unknown;
|
|
106868
|
+
} | undefined;
|
|
106869
|
+
}[];
|
|
106701
106870
|
} | {
|
|
106702
106871
|
/** ID of the event. */
|
|
106703
106872
|
event_id: string;
|
|
@@ -143855,6 +144024,43 @@ type Routes = {
|
|
|
143855
144024
|
};
|
|
143856
144025
|
/** Human-readable description of the change and its source. */
|
|
143857
144026
|
description: string;
|
|
144027
|
+
} | {
|
|
144028
|
+
/** ID of the event. */
|
|
144029
|
+
event_id: string;
|
|
144030
|
+
/** ID of the workspace associated with the event. */
|
|
144031
|
+
workspace_id: string;
|
|
144032
|
+
/** Date and time at which the event was created. */
|
|
144033
|
+
created_at: string;
|
|
144034
|
+
/** Date and time at which the event occurred. */
|
|
144035
|
+
occurred_at: string;
|
|
144036
|
+
/** ID of the affected access code. */
|
|
144037
|
+
access_code_id: string;
|
|
144038
|
+
/** ID of the device associated with the affected access code. */
|
|
144039
|
+
device_id: string;
|
|
144040
|
+
/** ID of the connected account associated with the affected access code. */
|
|
144041
|
+
connected_account_id: string;
|
|
144042
|
+
/** Custom metadata of the device, present when device_id is provided. */
|
|
144043
|
+
device_custom_metadata?: {
|
|
144044
|
+
[x: string]: string | boolean;
|
|
144045
|
+
} | undefined;
|
|
144046
|
+
/** Custom metadata of the connected account, present when connected_account_id is provided. */
|
|
144047
|
+
connected_account_custom_metadata?: {
|
|
144048
|
+
[x: string]: string | boolean;
|
|
144049
|
+
} | undefined;
|
|
144050
|
+
event_type: 'access_code.mutations_requested';
|
|
144051
|
+
/** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
|
|
144052
|
+
requested_mutations: {
|
|
144053
|
+
/** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
|
|
144054
|
+
mutation_code: 'updating_name' | 'updating_code' | 'updating_time_frame' | 'deleting' | 'creating' | 'deferring_creation';
|
|
144055
|
+
/** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
144056
|
+
from?: {
|
|
144057
|
+
[x: string]: unknown;
|
|
144058
|
+
} | undefined;
|
|
144059
|
+
/** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
|
|
144060
|
+
to?: {
|
|
144061
|
+
[x: string]: unknown;
|
|
144062
|
+
} | undefined;
|
|
144063
|
+
}[];
|
|
143858
144064
|
} | {
|
|
143859
144065
|
/** ID of the event. */
|
|
143860
144066
|
event_id: string;
|
package/dist/index.cjs
CHANGED
|
@@ -5623,6 +5623,35 @@ var access_code_time_frame_changed_event = access_code_event.extend({
|
|
|
5623
5623
|
---
|
|
5624
5624
|
The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.
|
|
5625
5625
|
`);
|
|
5626
|
+
var requested_mutation = zod.z.object({
|
|
5627
|
+
mutation_code: zod.z.enum([
|
|
5628
|
+
"updating_name",
|
|
5629
|
+
"updating_code",
|
|
5630
|
+
"updating_time_frame",
|
|
5631
|
+
"deleting",
|
|
5632
|
+
"creating",
|
|
5633
|
+
"deferring_creation"
|
|
5634
|
+
]).describe(
|
|
5635
|
+
"Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`."
|
|
5636
|
+
),
|
|
5637
|
+
from: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe(
|
|
5638
|
+
"Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`."
|
|
5639
|
+
),
|
|
5640
|
+
to: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe(
|
|
5641
|
+
"New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`."
|
|
5642
|
+
)
|
|
5643
|
+
}).describe("Record describing a single requested mutation.");
|
|
5644
|
+
var access_code_mutations_requested_event = access_code_event.extend({
|
|
5645
|
+
event_type: zod.z.literal("access_code.mutations_requested"),
|
|
5646
|
+
requested_mutations: zod.z.array(requested_mutation).describe(
|
|
5647
|
+
"Array of mutations requested on the access code, each containing the mutation type and from/to values."
|
|
5648
|
+
)
|
|
5649
|
+
}).describe(`
|
|
5650
|
+
---
|
|
5651
|
+
route_path: /access_codes
|
|
5652
|
+
---
|
|
5653
|
+
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.
|
|
5654
|
+
`);
|
|
5626
5655
|
var access_code_scheduled_on_device_event = access_code_event.extend({
|
|
5627
5656
|
event_type: zod.z.literal("access_code.scheduled_on_device"),
|
|
5628
5657
|
code
|
|
@@ -5755,6 +5784,7 @@ var access_code_events = [
|
|
|
5755
5784
|
access_code_name_changed_event,
|
|
5756
5785
|
access_code_code_changed_event,
|
|
5757
5786
|
access_code_time_frame_changed_event,
|
|
5787
|
+
access_code_mutations_requested_event,
|
|
5758
5788
|
access_code_scheduled_on_device_event,
|
|
5759
5789
|
access_code_set_on_device_event,
|
|
5760
5790
|
access_code_removed_from_device_event,
|
|
@@ -23378,6 +23408,110 @@ var openapi = {
|
|
|
23378
23408
|
type: "object",
|
|
23379
23409
|
"x-route-path": "/access_codes"
|
|
23380
23410
|
},
|
|
23411
|
+
{
|
|
23412
|
+
description: "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.",
|
|
23413
|
+
properties: {
|
|
23414
|
+
access_code_id: {
|
|
23415
|
+
description: "ID of the affected access code.",
|
|
23416
|
+
format: "uuid",
|
|
23417
|
+
type: "string"
|
|
23418
|
+
},
|
|
23419
|
+
connected_account_custom_metadata: {
|
|
23420
|
+
additionalProperties: {
|
|
23421
|
+
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
23422
|
+
},
|
|
23423
|
+
description: "Custom metadata of the connected account, present when connected_account_id is provided.",
|
|
23424
|
+
type: "object"
|
|
23425
|
+
},
|
|
23426
|
+
connected_account_id: {
|
|
23427
|
+
description: "ID of the connected account associated with the affected access code.",
|
|
23428
|
+
format: "uuid",
|
|
23429
|
+
type: "string"
|
|
23430
|
+
},
|
|
23431
|
+
created_at: {
|
|
23432
|
+
description: "Date and time at which the event was created.",
|
|
23433
|
+
format: "date-time",
|
|
23434
|
+
type: "string"
|
|
23435
|
+
},
|
|
23436
|
+
device_custom_metadata: {
|
|
23437
|
+
additionalProperties: {
|
|
23438
|
+
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
23439
|
+
},
|
|
23440
|
+
description: "Custom metadata of the device, present when device_id is provided.",
|
|
23441
|
+
type: "object"
|
|
23442
|
+
},
|
|
23443
|
+
device_id: {
|
|
23444
|
+
description: "ID of the device associated with the affected access code.",
|
|
23445
|
+
format: "uuid",
|
|
23446
|
+
type: "string"
|
|
23447
|
+
},
|
|
23448
|
+
event_id: {
|
|
23449
|
+
description: "ID of the event.",
|
|
23450
|
+
format: "uuid",
|
|
23451
|
+
type: "string"
|
|
23452
|
+
},
|
|
23453
|
+
event_type: {
|
|
23454
|
+
enum: ["access_code.mutations_requested"],
|
|
23455
|
+
type: "string"
|
|
23456
|
+
},
|
|
23457
|
+
occurred_at: {
|
|
23458
|
+
description: "Date and time at which the event occurred.",
|
|
23459
|
+
format: "date-time",
|
|
23460
|
+
type: "string"
|
|
23461
|
+
},
|
|
23462
|
+
requested_mutations: {
|
|
23463
|
+
description: "Array of mutations requested on the access code, each containing the mutation type and from/to values.",
|
|
23464
|
+
items: {
|
|
23465
|
+
description: "Record describing a single requested mutation.",
|
|
23466
|
+
properties: {
|
|
23467
|
+
from: {
|
|
23468
|
+
additionalProperties: {},
|
|
23469
|
+
description: "Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.",
|
|
23470
|
+
type: "object"
|
|
23471
|
+
},
|
|
23472
|
+
mutation_code: {
|
|
23473
|
+
description: "Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`.",
|
|
23474
|
+
enum: [
|
|
23475
|
+
"updating_name",
|
|
23476
|
+
"updating_code",
|
|
23477
|
+
"updating_time_frame",
|
|
23478
|
+
"deleting",
|
|
23479
|
+
"creating",
|
|
23480
|
+
"deferring_creation"
|
|
23481
|
+
],
|
|
23482
|
+
type: "string"
|
|
23483
|
+
},
|
|
23484
|
+
to: {
|
|
23485
|
+
additionalProperties: {},
|
|
23486
|
+
description: "New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.",
|
|
23487
|
+
type: "object"
|
|
23488
|
+
}
|
|
23489
|
+
},
|
|
23490
|
+
required: ["mutation_code"],
|
|
23491
|
+
type: "object"
|
|
23492
|
+
},
|
|
23493
|
+
type: "array"
|
|
23494
|
+
},
|
|
23495
|
+
workspace_id: {
|
|
23496
|
+
description: "ID of the workspace associated with the event.",
|
|
23497
|
+
format: "uuid",
|
|
23498
|
+
type: "string"
|
|
23499
|
+
}
|
|
23500
|
+
},
|
|
23501
|
+
required: [
|
|
23502
|
+
"event_id",
|
|
23503
|
+
"workspace_id",
|
|
23504
|
+
"created_at",
|
|
23505
|
+
"occurred_at",
|
|
23506
|
+
"access_code_id",
|
|
23507
|
+
"device_id",
|
|
23508
|
+
"connected_account_id",
|
|
23509
|
+
"event_type",
|
|
23510
|
+
"requested_mutations"
|
|
23511
|
+
],
|
|
23512
|
+
type: "object",
|
|
23513
|
+
"x-route-path": "/access_codes"
|
|
23514
|
+
},
|
|
23381
23515
|
{
|
|
23382
23516
|
description: "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.",
|
|
23383
23517
|
properties: {
|
|
@@ -62763,6 +62897,7 @@ var openapi = {
|
|
|
62763
62897
|
"access_code.name_changed",
|
|
62764
62898
|
"access_code.code_changed",
|
|
62765
62899
|
"access_code.time_frame_changed",
|
|
62900
|
+
"access_code.mutations_requested",
|
|
62766
62901
|
"access_code.scheduled_on_device",
|
|
62767
62902
|
"access_code.set_on_device",
|
|
62768
62903
|
"access_code.removed_from_device",
|
|
@@ -62880,6 +63015,7 @@ var openapi = {
|
|
|
62880
63015
|
"access_code.name_changed",
|
|
62881
63016
|
"access_code.code_changed",
|
|
62882
63017
|
"access_code.time_frame_changed",
|
|
63018
|
+
"access_code.mutations_requested",
|
|
62883
63019
|
"access_code.scheduled_on_device",
|
|
62884
63020
|
"access_code.set_on_device",
|
|
62885
63021
|
"access_code.removed_from_device",
|
|
@@ -63297,6 +63433,7 @@ var openapi = {
|
|
|
63297
63433
|
"access_code.name_changed",
|
|
63298
63434
|
"access_code.code_changed",
|
|
63299
63435
|
"access_code.time_frame_changed",
|
|
63436
|
+
"access_code.mutations_requested",
|
|
63300
63437
|
"access_code.scheduled_on_device",
|
|
63301
63438
|
"access_code.set_on_device",
|
|
63302
63439
|
"access_code.removed_from_device",
|
|
@@ -63410,6 +63547,7 @@ var openapi = {
|
|
|
63410
63547
|
"access_code.name_changed",
|
|
63411
63548
|
"access_code.code_changed",
|
|
63412
63549
|
"access_code.time_frame_changed",
|
|
63550
|
+
"access_code.mutations_requested",
|
|
63413
63551
|
"access_code.scheduled_on_device",
|
|
63414
63552
|
"access_code.set_on_device",
|
|
63415
63553
|
"access_code.removed_from_device",
|
|
@@ -73364,6 +73502,7 @@ var openapi = {
|
|
|
73364
73502
|
"access_code.name_changed",
|
|
73365
73503
|
"access_code.code_changed",
|
|
73366
73504
|
"access_code.time_frame_changed",
|
|
73505
|
+
"access_code.mutations_requested",
|
|
73367
73506
|
"access_code.scheduled_on_device",
|
|
73368
73507
|
"access_code.set_on_device",
|
|
73369
73508
|
"access_code.removed_from_device",
|
|
@@ -73482,6 +73621,7 @@ var openapi = {
|
|
|
73482
73621
|
"access_code.name_changed",
|
|
73483
73622
|
"access_code.code_changed",
|
|
73484
73623
|
"access_code.time_frame_changed",
|
|
73624
|
+
"access_code.mutations_requested",
|
|
73485
73625
|
"access_code.scheduled_on_device",
|
|
73486
73626
|
"access_code.set_on_device",
|
|
73487
73627
|
"access_code.removed_from_device",
|
|
@@ -73661,6 +73801,7 @@ var openapi = {
|
|
|
73661
73801
|
"access_code.name_changed",
|
|
73662
73802
|
"access_code.code_changed",
|
|
73663
73803
|
"access_code.time_frame_changed",
|
|
73804
|
+
"access_code.mutations_requested",
|
|
73664
73805
|
"access_code.scheduled_on_device",
|
|
73665
73806
|
"access_code.set_on_device",
|
|
73666
73807
|
"access_code.removed_from_device",
|
|
@@ -73774,6 +73915,7 @@ var openapi = {
|
|
|
73774
73915
|
"access_code.name_changed",
|
|
73775
73916
|
"access_code.code_changed",
|
|
73776
73917
|
"access_code.time_frame_changed",
|
|
73918
|
+
"access_code.mutations_requested",
|
|
73777
73919
|
"access_code.scheduled_on_device",
|
|
73778
73920
|
"access_code.set_on_device",
|
|
73779
73921
|
"access_code.removed_from_device",
|