@seamapi/types 1.695.0 → 1.697.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 +388 -27
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +617 -4
- package/dist/index.cjs +388 -27
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +92 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +24 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +138 -0
- package/lib/seam/connect/models/events/seam-event.d.ts +65 -1
- package/lib/seam/connect/models/events/spaces.d.ts +130 -0
- package/lib/seam/connect/models/events/spaces.js +41 -1
- package/lib/seam/connect/models/events/spaces.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +145 -0
- package/lib/seam/connect/openapi.js +312 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +246 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +40 -0
- package/src/lib/seam/connect/models/events/spaces.ts +47 -1
- package/src/lib/seam/connect/openapi.ts +338 -0
- package/src/lib/seam/connect/route-types.ts +258 -0
|
@@ -10166,6 +10166,15 @@ export type Routes = {
|
|
|
10166
10166
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
10167
10167
|
warning_code: 'being_deleted';
|
|
10168
10168
|
}[];
|
|
10169
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
10170
|
+
errors: {
|
|
10171
|
+
/** Date and time at which Seam created the error. */
|
|
10172
|
+
created_at: string;
|
|
10173
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
10174
|
+
message: string;
|
|
10175
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
10176
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
10177
|
+
}[];
|
|
10169
10178
|
/** ID of the customization profile associated with the Access Grant. */
|
|
10170
10179
|
customization_profile_id?: string | undefined;
|
|
10171
10180
|
};
|
|
@@ -10254,6 +10263,15 @@ export type Routes = {
|
|
|
10254
10263
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
10255
10264
|
warning_code: 'being_deleted';
|
|
10256
10265
|
}[];
|
|
10266
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
10267
|
+
errors: {
|
|
10268
|
+
/** Date and time at which Seam created the error. */
|
|
10269
|
+
created_at: string;
|
|
10270
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
10271
|
+
message: string;
|
|
10272
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
10273
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
10274
|
+
}[];
|
|
10257
10275
|
/** ID of the customization profile associated with the Access Grant. */
|
|
10258
10276
|
customization_profile_id?: string | undefined;
|
|
10259
10277
|
};
|
|
@@ -12082,6 +12100,15 @@ export type Routes = {
|
|
|
12082
12100
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
12083
12101
|
warning_code: 'being_deleted';
|
|
12084
12102
|
}[];
|
|
12103
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
12104
|
+
errors: {
|
|
12105
|
+
/** Date and time at which Seam created the error. */
|
|
12106
|
+
created_at: string;
|
|
12107
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
12108
|
+
message: string;
|
|
12109
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
12110
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
12111
|
+
}[];
|
|
12085
12112
|
/** ID of the customization profile associated with the Access Grant. */
|
|
12086
12113
|
customization_profile_id?: string | undefined;
|
|
12087
12114
|
}[];
|
|
@@ -12161,6 +12188,15 @@ export type Routes = {
|
|
|
12161
12188
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
12162
12189
|
warning_code: 'being_deleted';
|
|
12163
12190
|
}[];
|
|
12191
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
12192
|
+
errors: {
|
|
12193
|
+
/** Date and time at which Seam created the error. */
|
|
12194
|
+
created_at: string;
|
|
12195
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
12196
|
+
message: string;
|
|
12197
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
12198
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
12199
|
+
}[];
|
|
12164
12200
|
/** ID of the customization profile associated with the Access Grant. */
|
|
12165
12201
|
customization_profile_id?: string | undefined;
|
|
12166
12202
|
};
|
|
@@ -12225,6 +12261,15 @@ export type Routes = {
|
|
|
12225
12261
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
12226
12262
|
warning_code: 'being_deleted';
|
|
12227
12263
|
}[];
|
|
12264
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
12265
|
+
errors: {
|
|
12266
|
+
/** Date and time at which Seam created the error. */
|
|
12267
|
+
created_at: string;
|
|
12268
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
12269
|
+
message: string;
|
|
12270
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
12271
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
12272
|
+
}[];
|
|
12228
12273
|
/** ID of user identity to which the Access Grant gives access. */
|
|
12229
12274
|
user_identity_id?: string | undefined;
|
|
12230
12275
|
};
|
|
@@ -12294,6 +12339,15 @@ export type Routes = {
|
|
|
12294
12339
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
12295
12340
|
warning_code: 'being_deleted';
|
|
12296
12341
|
}[];
|
|
12342
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
12343
|
+
errors: {
|
|
12344
|
+
/** Date and time at which Seam created the error. */
|
|
12345
|
+
created_at: string;
|
|
12346
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
12347
|
+
message: string;
|
|
12348
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
12349
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
12350
|
+
}[];
|
|
12297
12351
|
/** ID of user identity to which the Access Grant gives access. */
|
|
12298
12352
|
user_identity_id?: string | undefined;
|
|
12299
12353
|
}[];
|
|
@@ -15126,6 +15180,15 @@ export type Routes = {
|
|
|
15126
15180
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
15127
15181
|
warning_code: 'being_deleted';
|
|
15128
15182
|
}[];
|
|
15183
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
15184
|
+
errors: {
|
|
15185
|
+
/** Date and time at which Seam created the error. */
|
|
15186
|
+
created_at: string;
|
|
15187
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
15188
|
+
message: string;
|
|
15189
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
15190
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
15191
|
+
}[];
|
|
15129
15192
|
/** ID of the customization profile associated with the Access Grant. */
|
|
15130
15193
|
customization_profile_id?: string | undefined;
|
|
15131
15194
|
}[] | undefined;
|
|
@@ -33004,6 +33067,44 @@ export type Routes = {
|
|
|
33004
33067
|
device_ids: string[];
|
|
33005
33068
|
/** IDs of all ACS entrances currently attached to the space. */
|
|
33006
33069
|
acs_entrance_ids: string[];
|
|
33070
|
+
} | {
|
|
33071
|
+
/** ID of the event. */
|
|
33072
|
+
event_id: string;
|
|
33073
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
33074
|
+
workspace_id: string;
|
|
33075
|
+
/** Date and time at which the event was created. */
|
|
33076
|
+
created_at: string;
|
|
33077
|
+
/** Date and time at which the event occurred. */
|
|
33078
|
+
occurred_at: string;
|
|
33079
|
+
/** ID of the affected space. */
|
|
33080
|
+
space_id: string;
|
|
33081
|
+
/** Type of the event. */
|
|
33082
|
+
event_type: 'space.created';
|
|
33083
|
+
/** Unique key for the space within the workspace. */
|
|
33084
|
+
space_key?: string | undefined;
|
|
33085
|
+
/** IDs of all devices attached to the space when it was created. */
|
|
33086
|
+
device_ids: string[];
|
|
33087
|
+
/** IDs of all ACS entrances attached to the space when it was created. */
|
|
33088
|
+
acs_entrance_ids: string[];
|
|
33089
|
+
} | {
|
|
33090
|
+
/** ID of the event. */
|
|
33091
|
+
event_id: string;
|
|
33092
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
33093
|
+
workspace_id: string;
|
|
33094
|
+
/** Date and time at which the event was created. */
|
|
33095
|
+
created_at: string;
|
|
33096
|
+
/** Date and time at which the event occurred. */
|
|
33097
|
+
occurred_at: string;
|
|
33098
|
+
/** ID of the affected space. */
|
|
33099
|
+
space_id: string;
|
|
33100
|
+
/** Type of the event. */
|
|
33101
|
+
event_type: 'space.deleted';
|
|
33102
|
+
/** Unique key for the space within the workspace. */
|
|
33103
|
+
space_key?: string | undefined;
|
|
33104
|
+
/** IDs of all devices attached to the space when it was deleted. */
|
|
33105
|
+
device_ids: string[];
|
|
33106
|
+
/** IDs of all ACS entrances currently attached to the space when it was deleted. */
|
|
33107
|
+
acs_entrance_ids: string[];
|
|
33007
33108
|
}) | undefined;
|
|
33008
33109
|
message?: string | undefined;
|
|
33009
33110
|
};
|
|
@@ -33036,9 +33137,9 @@ export type Routes = {
|
|
|
33036
33137
|
/** IDs of the access codes for which you want to list events. */
|
|
33037
33138
|
access_code_ids?: string[] | undefined;
|
|
33038
33139
|
/** Type of the events that you want to list. */
|
|
33039
|
-
event_type?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed') | undefined;
|
|
33140
|
+
event_type?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
|
|
33040
33141
|
/** Types of the events that you want to list. */
|
|
33041
|
-
event_types?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed')[] | undefined;
|
|
33142
|
+
event_types?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted')[] | undefined;
|
|
33042
33143
|
/** ID of the connected account for which you want to list events. */
|
|
33043
33144
|
connected_account_id?: string | undefined;
|
|
33044
33145
|
/** ID of the Connect Webview for which you want to list events. */
|
|
@@ -35002,6 +35103,44 @@ export type Routes = {
|
|
|
35002
35103
|
device_ids: string[];
|
|
35003
35104
|
/** IDs of all ACS entrances currently attached to the space. */
|
|
35004
35105
|
acs_entrance_ids: string[];
|
|
35106
|
+
} | {
|
|
35107
|
+
/** ID of the event. */
|
|
35108
|
+
event_id: string;
|
|
35109
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
35110
|
+
workspace_id: string;
|
|
35111
|
+
/** Date and time at which the event was created. */
|
|
35112
|
+
created_at: string;
|
|
35113
|
+
/** Date and time at which the event occurred. */
|
|
35114
|
+
occurred_at: string;
|
|
35115
|
+
/** ID of the affected space. */
|
|
35116
|
+
space_id: string;
|
|
35117
|
+
/** Type of the event. */
|
|
35118
|
+
event_type: 'space.created';
|
|
35119
|
+
/** Unique key for the space within the workspace. */
|
|
35120
|
+
space_key?: string | undefined;
|
|
35121
|
+
/** IDs of all devices attached to the space when it was created. */
|
|
35122
|
+
device_ids: string[];
|
|
35123
|
+
/** IDs of all ACS entrances attached to the space when it was created. */
|
|
35124
|
+
acs_entrance_ids: string[];
|
|
35125
|
+
} | {
|
|
35126
|
+
/** ID of the event. */
|
|
35127
|
+
event_id: string;
|
|
35128
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
35129
|
+
workspace_id: string;
|
|
35130
|
+
/** Date and time at which the event was created. */
|
|
35131
|
+
created_at: string;
|
|
35132
|
+
/** Date and time at which the event occurred. */
|
|
35133
|
+
occurred_at: string;
|
|
35134
|
+
/** ID of the affected space. */
|
|
35135
|
+
space_id: string;
|
|
35136
|
+
/** Type of the event. */
|
|
35137
|
+
event_type: 'space.deleted';
|
|
35138
|
+
/** Unique key for the space within the workspace. */
|
|
35139
|
+
space_key?: string | undefined;
|
|
35140
|
+
/** IDs of all devices attached to the space when it was deleted. */
|
|
35141
|
+
device_ids: string[];
|
|
35142
|
+
/** IDs of all ACS entrances currently attached to the space when it was deleted. */
|
|
35143
|
+
acs_entrance_ids: string[];
|
|
35005
35144
|
})[];
|
|
35006
35145
|
};
|
|
35007
35146
|
maxDuration: undefined;
|
|
@@ -52424,6 +52563,15 @@ export type Routes = {
|
|
|
52424
52563
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
52425
52564
|
warning_code: 'being_deleted';
|
|
52426
52565
|
}[];
|
|
52566
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
52567
|
+
errors: {
|
|
52568
|
+
/** Date and time at which Seam created the error. */
|
|
52569
|
+
created_at: string;
|
|
52570
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
52571
|
+
message: string;
|
|
52572
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
52573
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
52574
|
+
}[];
|
|
52427
52575
|
/** ID of the customization profile associated with the Access Grant. */
|
|
52428
52576
|
customization_profile_id?: string | undefined;
|
|
52429
52577
|
}[];
|
|
@@ -52936,9 +53084,9 @@ export type Routes = {
|
|
|
52936
53084
|
/** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
|
|
52937
53085
|
between?: (string | Date)[] | undefined;
|
|
52938
53086
|
/** Type of the events that you want to list. */
|
|
52939
|
-
event_type?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed') | undefined;
|
|
53087
|
+
event_type?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
|
|
52940
53088
|
/** Types of the events that you want to list. */
|
|
52941
|
-
event_types?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed')[] | undefined;
|
|
53089
|
+
event_types?: ('access_code.created' | 'access_code.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_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | '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' | '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' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted')[] | undefined;
|
|
52942
53090
|
/** Numerical limit on the number of events to return. */
|
|
52943
53091
|
limit?: number;
|
|
52944
53092
|
};
|
|
@@ -54890,6 +55038,44 @@ export type Routes = {
|
|
|
54890
55038
|
device_ids: string[];
|
|
54891
55039
|
/** IDs of all ACS entrances currently attached to the space. */
|
|
54892
55040
|
acs_entrance_ids: string[];
|
|
55041
|
+
} | {
|
|
55042
|
+
/** ID of the event. */
|
|
55043
|
+
event_id: string;
|
|
55044
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
55045
|
+
workspace_id: string;
|
|
55046
|
+
/** Date and time at which the event was created. */
|
|
55047
|
+
created_at: string;
|
|
55048
|
+
/** Date and time at which the event occurred. */
|
|
55049
|
+
occurred_at: string;
|
|
55050
|
+
/** ID of the affected space. */
|
|
55051
|
+
space_id: string;
|
|
55052
|
+
/** Type of the event. */
|
|
55053
|
+
event_type: 'space.created';
|
|
55054
|
+
/** Unique key for the space within the workspace. */
|
|
55055
|
+
space_key?: string | undefined;
|
|
55056
|
+
/** IDs of all devices attached to the space when it was created. */
|
|
55057
|
+
device_ids: string[];
|
|
55058
|
+
/** IDs of all ACS entrances attached to the space when it was created. */
|
|
55059
|
+
acs_entrance_ids: string[];
|
|
55060
|
+
} | {
|
|
55061
|
+
/** ID of the event. */
|
|
55062
|
+
event_id: string;
|
|
55063
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
55064
|
+
workspace_id: string;
|
|
55065
|
+
/** Date and time at which the event was created. */
|
|
55066
|
+
created_at: string;
|
|
55067
|
+
/** Date and time at which the event occurred. */
|
|
55068
|
+
occurred_at: string;
|
|
55069
|
+
/** ID of the affected space. */
|
|
55070
|
+
space_id: string;
|
|
55071
|
+
/** Type of the event. */
|
|
55072
|
+
event_type: 'space.deleted';
|
|
55073
|
+
/** Unique key for the space within the workspace. */
|
|
55074
|
+
space_key?: string | undefined;
|
|
55075
|
+
/** IDs of all devices attached to the space when it was deleted. */
|
|
55076
|
+
device_ids: string[];
|
|
55077
|
+
/** IDs of all ACS entrances currently attached to the space when it was deleted. */
|
|
55078
|
+
acs_entrance_ids: string[];
|
|
54893
55079
|
})[];
|
|
54894
55080
|
};
|
|
54895
55081
|
maxDuration: undefined;
|
|
@@ -55298,6 +55484,15 @@ export type Routes = {
|
|
|
55298
55484
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
55299
55485
|
warning_code: 'being_deleted';
|
|
55300
55486
|
}[];
|
|
55487
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
55488
|
+
errors: {
|
|
55489
|
+
/** Date and time at which Seam created the error. */
|
|
55490
|
+
created_at: string;
|
|
55491
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
55492
|
+
message: string;
|
|
55493
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
55494
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
55495
|
+
}[];
|
|
55301
55496
|
/** ID of the customization profile associated with the Access Grant. */
|
|
55302
55497
|
customization_profile_id?: string | undefined;
|
|
55303
55498
|
};
|
|
@@ -81539,6 +81734,15 @@ export type Routes = {
|
|
|
81539
81734
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
81540
81735
|
warning_code: 'being_deleted';
|
|
81541
81736
|
}[];
|
|
81737
|
+
/** Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
|
|
81738
|
+
errors: {
|
|
81739
|
+
/** Date and time at which Seam created the error. */
|
|
81740
|
+
created_at: string;
|
|
81741
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
81742
|
+
message: string;
|
|
81743
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
81744
|
+
error_code: 'cannot_create_requested_access_methods';
|
|
81745
|
+
}[];
|
|
81542
81746
|
/** ID of the customization profile associated with the Access Grant. */
|
|
81543
81747
|
customization_profile_id?: string | undefined;
|
|
81544
81748
|
}[] | undefined;
|
|
@@ -83617,6 +83821,44 @@ export type Routes = {
|
|
|
83617
83821
|
device_ids: string[];
|
|
83618
83822
|
/** IDs of all ACS entrances currently attached to the space. */
|
|
83619
83823
|
acs_entrance_ids: string[];
|
|
83824
|
+
} | {
|
|
83825
|
+
/** ID of the event. */
|
|
83826
|
+
event_id: string;
|
|
83827
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
83828
|
+
workspace_id: string;
|
|
83829
|
+
/** Date and time at which the event was created. */
|
|
83830
|
+
created_at: string;
|
|
83831
|
+
/** Date and time at which the event occurred. */
|
|
83832
|
+
occurred_at: string;
|
|
83833
|
+
/** ID of the affected space. */
|
|
83834
|
+
space_id: string;
|
|
83835
|
+
/** Type of the event. */
|
|
83836
|
+
event_type: 'space.created';
|
|
83837
|
+
/** Unique key for the space within the workspace. */
|
|
83838
|
+
space_key?: string | undefined;
|
|
83839
|
+
/** IDs of all devices attached to the space when it was created. */
|
|
83840
|
+
device_ids: string[];
|
|
83841
|
+
/** IDs of all ACS entrances attached to the space when it was created. */
|
|
83842
|
+
acs_entrance_ids: string[];
|
|
83843
|
+
} | {
|
|
83844
|
+
/** ID of the event. */
|
|
83845
|
+
event_id: string;
|
|
83846
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
|
|
83847
|
+
workspace_id: string;
|
|
83848
|
+
/** Date and time at which the event was created. */
|
|
83849
|
+
created_at: string;
|
|
83850
|
+
/** Date and time at which the event occurred. */
|
|
83851
|
+
occurred_at: string;
|
|
83852
|
+
/** ID of the affected space. */
|
|
83853
|
+
space_id: string;
|
|
83854
|
+
/** Type of the event. */
|
|
83855
|
+
event_type: 'space.deleted';
|
|
83856
|
+
/** Unique key for the space within the workspace. */
|
|
83857
|
+
space_key?: string | undefined;
|
|
83858
|
+
/** IDs of all devices attached to the space when it was deleted. */
|
|
83859
|
+
device_ids: string[];
|
|
83860
|
+
/** IDs of all ACS entrances currently attached to the space when it was deleted. */
|
|
83861
|
+
acs_entrance_ids: string[];
|
|
83620
83862
|
})[] | undefined;
|
|
83621
83863
|
instant_keys?: {
|
|
83622
83864
|
/** ID of the Instant Key. */
|
package/package.json
CHANGED
|
@@ -2,6 +2,28 @@ import { z } from 'zod'
|
|
|
2
2
|
|
|
3
3
|
import { requested_access_method } from './requested-access-method.js'
|
|
4
4
|
|
|
5
|
+
const common_access_grant_error = z.object({
|
|
6
|
+
created_at: z
|
|
7
|
+
.string()
|
|
8
|
+
.datetime()
|
|
9
|
+
.describe('Date and time at which Seam created the error.'),
|
|
10
|
+
message: z
|
|
11
|
+
.string()
|
|
12
|
+
.describe(
|
|
13
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14
|
+
),
|
|
15
|
+
})
|
|
16
|
+
|
|
17
|
+
const error_code_description =
|
|
18
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
|
|
19
|
+
|
|
20
|
+
const cannot_create_requested_access_methods_error =
|
|
21
|
+
common_access_grant_error.extend({
|
|
22
|
+
error_code: z
|
|
23
|
+
.literal('cannot_create_requested_access_methods')
|
|
24
|
+
.describe(error_code_description),
|
|
25
|
+
})
|
|
26
|
+
|
|
5
27
|
const common_access_grant_warning = z.object({
|
|
6
28
|
created_at: z
|
|
7
29
|
.string()
|
|
@@ -17,6 +39,19 @@ const common_access_grant_warning = z.object({
|
|
|
17
39
|
const warning_code_description =
|
|
18
40
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
|
|
19
41
|
|
|
42
|
+
const access_grant_error = z.discriminatedUnion('error_code', [
|
|
43
|
+
cannot_create_requested_access_methods_error,
|
|
44
|
+
])
|
|
45
|
+
|
|
46
|
+
export type AccessGrantError = z.infer<typeof access_grant_error>
|
|
47
|
+
|
|
48
|
+
export const _access_grant_error_map = z.object({
|
|
49
|
+
cannot_create_requested_access_methods:
|
|
50
|
+
cannot_create_requested_access_methods_error.optional().nullable(),
|
|
51
|
+
})
|
|
52
|
+
|
|
53
|
+
export type AccessGrantErrorMap = z.infer<typeof _access_grant_error_map>
|
|
54
|
+
|
|
20
55
|
const being_deleted = common_access_grant_warning
|
|
21
56
|
.extend({
|
|
22
57
|
warning_code: z.literal('being_deleted').describe(warning_code_description),
|
|
@@ -107,6 +142,11 @@ export const access_grant = z.object({
|
|
|
107
142
|
.describe(
|
|
108
143
|
'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
109
144
|
),
|
|
145
|
+
errors: z
|
|
146
|
+
.array(access_grant_error)
|
|
147
|
+
.describe(
|
|
148
|
+
'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
149
|
+
),
|
|
110
150
|
customization_profile_id: z
|
|
111
151
|
.string()
|
|
112
152
|
.uuid()
|
|
@@ -27,8 +27,54 @@ export const space_device_membership_changed_event = space_event.extend({
|
|
|
27
27
|
A device was added or removed from a space.
|
|
28
28
|
`)
|
|
29
29
|
|
|
30
|
+
export const space_created_event = space_event.extend({
|
|
31
|
+
event_type: z.literal('space.created').describe('Type of the event.'),
|
|
32
|
+
space_key: z
|
|
33
|
+
.string()
|
|
34
|
+
.optional()
|
|
35
|
+
.describe('Unique key for the space within the workspace.'),
|
|
36
|
+
device_ids: z
|
|
37
|
+
.array(z.string().uuid())
|
|
38
|
+
.describe('IDs of all devices attached to the space when it was created.'),
|
|
39
|
+
acs_entrance_ids: z
|
|
40
|
+
.array(z.string().uuid())
|
|
41
|
+
.describe(
|
|
42
|
+
'IDs of all ACS entrances attached to the space when it was created.',
|
|
43
|
+
),
|
|
44
|
+
}).describe(`
|
|
45
|
+
---
|
|
46
|
+
route_path: /spaces
|
|
47
|
+
---
|
|
48
|
+
A space was created.
|
|
49
|
+
`)
|
|
50
|
+
|
|
51
|
+
export const space_deleted_event = space_event.extend({
|
|
52
|
+
event_type: z.literal('space.deleted').describe('Type of the event.'),
|
|
53
|
+
space_key: z
|
|
54
|
+
.string()
|
|
55
|
+
.optional()
|
|
56
|
+
.describe('Unique key for the space within the workspace.'),
|
|
57
|
+
device_ids: z
|
|
58
|
+
.array(z.string().uuid())
|
|
59
|
+
.describe('IDs of all devices attached to the space when it was deleted.'),
|
|
60
|
+
acs_entrance_ids: z
|
|
61
|
+
.array(z.string().uuid())
|
|
62
|
+
.describe(
|
|
63
|
+
'IDs of all ACS entrances currently attached to the space when it was deleted.',
|
|
64
|
+
),
|
|
65
|
+
}).describe(`
|
|
66
|
+
---
|
|
67
|
+
route_path: /spaces
|
|
68
|
+
---
|
|
69
|
+
A space was deleted.
|
|
70
|
+
`)
|
|
71
|
+
|
|
30
72
|
export type SpaceDeviceMembershipChangedEvent = z.infer<
|
|
31
73
|
typeof space_device_membership_changed_event
|
|
32
74
|
>
|
|
33
75
|
|
|
34
|
-
export const space_events = [
|
|
76
|
+
export const space_events = [
|
|
77
|
+
space_device_membership_changed_event,
|
|
78
|
+
space_created_event,
|
|
79
|
+
space_deleted_event,
|
|
80
|
+
] as const
|