diff --git a/package-lock.json b/package-lock.json index eafad3b7..4e28d4fa 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,15 +1,15 @@ { "name": "@seamapi/types", - "version": "1.908.0", + "version": "1.923.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@seamapi/types", - "version": "1.908.0", + "version": "1.923.0", "license": "MIT", "devDependencies": { - "@seamapi/blueprint": "^0.55.0", + "@seamapi/blueprint": "^0.56.0", "@swc/core": "^1.11.29", "@types/node": "^24.10.9", "concurrently": "^9.2.0", @@ -1217,9 +1217,9 @@ "license": "MIT" }, "node_modules/@seamapi/blueprint": { - "version": "0.55.0", - "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.55.0.tgz", - "integrity": "sha512-2Xk3XQ486WufuZ4ar7aP1XWQXaadg04x1VVjHGWrI1lMpSfWAeOTs8ol3EdRzI/NK6pUdIfgED86aH62KsyQ9w==", + "version": "0.56.0", + "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.56.0.tgz", + "integrity": "sha512-6trN/T2hGnoWE8l1tmHYv+QHexF1NzeG+hiGUm6nfTBIqCsndl457p10VCtfB7ew0CqSUzNkjfhrb7hww3SZPQ==", "dev": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index d99228c1..15f46b11 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@seamapi/types", - "version": "1.908.0", + "version": "1.923.0", "description": "TypeScript types for the Seam API.", "type": "module", "main": "index.js", @@ -91,7 +91,7 @@ "zod": "^3.24.0" }, "devDependencies": { - "@seamapi/blueprint": "^0.55.0", + "@seamapi/blueprint": "^0.56.0", "@swc/core": "^1.11.29", "@types/node": "^24.10.9", "concurrently": "^9.2.0", diff --git a/src/lib/seam/connect/internal/schemas.ts b/src/lib/seam/connect/internal/schemas.ts index 01c9c357..a531376a 100644 --- a/src/lib/seam/connect/internal/schemas.ts +++ b/src/lib/seam/connect/internal/schemas.ts @@ -59,6 +59,7 @@ export { magic_link, access_code as managed_access_code, device as managed_device, + message_overrides, neutral_resource, noise_sensor_device_type, noise_threshold, diff --git a/src/lib/seam/connect/models/access-codes/managed-access-code.ts b/src/lib/seam/connect/models/access-codes/managed-access-code.ts index 11695f77..0d861ada 100644 --- a/src/lib/seam/connect/models/access-codes/managed-access-code.ts +++ b/src/lib/seam/connect/models/access-codes/managed-access-code.ts @@ -22,44 +22,14 @@ const common_access_code_error = z.object({ const error_code_description = 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.' -const provider_issue = common_access_code_error - .extend({ - error_code: z.literal('provider_issue').describe(error_code_description), - }) - .describe( - 'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.', - ) - -const smartthings_failed_to_set_access_code_error = common_access_code_error - .extend({ - error_code: z - .literal('smartthings_failed_to_set_access_code') - .describe(error_code_description), - }) - .describe( - ` - --- - deprecated: Handled by the generic \`failed_to_set_on_device\` system. - --- - Failed to set code on SmartThings device. - `, - ) - -const smartthings_failed_to_set_after_multiple_retries = - common_access_code_error - .extend({ - error_code: z - .literal('smartthings_failed_to_set_after_multiple_retries') - .describe(error_code_description), - }) - .describe( - ` +const provider_issue = common_access_code_error.extend({ + error_code: z.literal('provider_issue').describe(error_code_description), +}).describe(` --- - deprecated: Handled by the generic \`failed_to_set_on_device\` system. + resource_type: access_code --- - Failed to set code after multiple retries. - `, - ) + Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details. + `) const modified_field = z.object({ field: z @@ -71,297 +41,171 @@ const modified_field = z.object({ to: z.string().nullable().describe('The new value of the field.'), }) -const code_modified_external_to_seam_error = common_access_code_error - .extend({ - error_code: z - .literal('code_modified_external_to_seam') - .describe(error_code_description), - change_type: z - .enum(['modified', 'removed']) - .optional() - .describe( - "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.", - ), - modified_fields: z - .array(modified_field) - .optional() - .describe( - 'List of fields that were changed externally, with their previous and new values.', - ), - }) - .describe( - 'Code was modified or removed externally after Seam successfully set it on the device.', - ) - -const failed_to_set_on_device = common_access_code_error - .extend({ - error_code: z - .literal('failed_to_set_on_device') - .describe(error_code_description), - }) - .describe('Failed to set code on device.') - -const failed_to_remove_from_device = common_access_code_error - .extend({ - error_code: z - .literal('failed_to_remove_from_device') - .describe(error_code_description), - }) - .describe('Failed to remove code from device.') - -const duplicate_code_on_device = common_access_code_error - .extend({ - error_code: z - .literal('duplicate_code_on_device') - .describe(error_code_description), - unmanaged_access_code_id: z - .string() - .uuid() - .optional() - .describe( - 'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.', - ), - managed_access_code_id: z - .string() - .uuid() - .optional() - .describe( - 'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.', - ), - }) - .describe('Duplicate access code detected on device.') - -const duplicate_code_attempt_prevented = common_access_code_error - .extend({ - error_code: z - .literal('duplicate_code_attempt_prevented') - .describe(error_code_description), - }) - .describe('An attempt to modify this access code was prevented.') - -const no_space_for_access_code_on_device = common_access_code_error - .extend({ - error_code: z - .literal('no_space_for_access_code_on_device') - .describe(error_code_description), - }) - .describe('No space for access code on device.') - -const access_code_state_unconfirmed = common_access_code_error - .extend({ - error_code: z - .literal('access_code_state_unconfirmed') - .describe(error_code_description), - }) - .describe( - 'Indicates that the provider cannot confirm whether the access code was set or removed on the device.', - ) - -const kwikset_unable_to_confirm_code = common_access_code_error - .extend({ - error_code: z - .literal('kwikset_unable_to_confirm_code') - .describe(error_code_description), - }) - .describe( - ` +const code_modified_external_to_seam_error = common_access_code_error.extend({ + error_code: z + .literal('code_modified_external_to_seam') + .describe(error_code_description), + change_type: z + .enum(['modified', 'removed']) + .optional() + .describe( + "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.", + ), + modified_fields: z + .array(modified_field) + .optional() + .describe( + 'List of fields that were changed externally, with their previous and new values.', + ), +}).describe(` --- - deprecated: Use \`access_code_state_unconfirmed\` instead. + resource_type: access_code --- - Unable to confirm that the access code is set on Kwikset device. - `, - ) + Code was modified or removed externally after Seam successfully set it on the device. + `) -const kwikset_unable_to_confirm_deletion = common_access_code_error - .extend({ - error_code: z - .literal('kwikset_unable_to_confirm_deletion') - .describe(error_code_description), - }) - .describe( - ` +const failed_to_set_on_device = common_access_code_error.extend({ + error_code: z + .literal('failed_to_set_on_device') + .describe(error_code_description), +}).describe(` --- - deprecated: Use \`access_code_state_unconfirmed\` instead. + resource_type: access_code --- - Unable to confirm the deletion of the access code on Kwikset device. - `, - ) + Failed to set code on device. + `) -const insufficient_permissions = common_access_code_error - .extend({ - error_code: z - .literal('insufficient_permissions') - .describe(error_code_description), - }) - .describe( - 'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.', - ) - -const august_lock_invalid_code_length = common_access_code_error - .extend({ - error_code: z - .literal('august_lock_invalid_code_length') - .describe(error_code_description), - }) - .describe( - ` +const failed_to_remove_from_device = common_access_code_error.extend({ + error_code: z + .literal('failed_to_remove_from_device') + .describe(error_code_description), +}).describe(` --- - deprecated: Use \`provider_issue\` instead. + resource_type: access_code --- - Invalid code length for August lock. - `, - ) - -const august_lock_temporarily_offline_error = common_access_code_error - .extend({ - error_code: z - .literal('august_lock_temporarily_offline') - .describe(error_code_description), - }) - .describe( - ` + Failed to remove code from device. + `) + +const duplicate_code_on_device = common_access_code_error.extend({ + error_code: z + .literal('duplicate_code_on_device') + .describe(error_code_description), + unmanaged_access_code_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.', + ), + managed_access_code_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.', + ), +}).describe(` --- - deprecated: Use \`provider_issue\` instead. + resource_type: access_code --- - August lock is temporarily offline. - `, - ) + Duplicate access code detected on device. + `) -const august_lock_missing_keypad = common_access_code_error - .extend({ - error_code: z - .literal('august_lock_missing_keypad') - .describe(error_code_description), - }) - .describe( - ` +const duplicate_code_attempt_prevented = common_access_code_error.extend({ + error_code: z + .literal('duplicate_code_attempt_prevented') + .describe(error_code_description), +}).describe(` --- - deprecated: Use \`provider_issue\` instead. + resource_type: access_code --- - August lock is missing a keypad. - `, - ) - -const access_code_inactive_error = common_access_code_error - .extend({ - error_code: z - .literal('access_code_inactive') - .describe(error_code_description), - }) - .describe( - 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.', - ) + An attempt to modify this access code was prevented. + `) -const salto_ks_user_not_subscribed = common_access_code_error - .extend({ - error_code: z - .literal('salto_ks_user_not_subscribed') - .describe(error_code_description), - }) - .describe( - ` +const no_space_for_access_code_on_device = common_access_code_error.extend({ + error_code: z + .literal('no_space_for_access_code_on_device') + .describe(error_code_description), +}).describe(` --- - deprecated: Use \`access_code_inactive\` instead. + resource_type: access_code --- - Salto site user is not subscribed. - `, - ) + No space for access code on device. + `) -const wyze_duplicate_code_name = common_access_code_error - .extend({ - error_code: z - .literal('wyze_duplicate_code_name') - .describe(error_code_description), - }) - .describe( - ` +const access_code_state_unconfirmed = common_access_code_error.extend({ + error_code: z + .literal('access_code_state_unconfirmed') + .describe(error_code_description), +}).describe(` --- - deprecated: Use \`duplicate_code_on_device\` instead. + resource_type: access_code --- - Duplicate access code name detected. - `, - ) + Indicates that the provider cannot confirm whether the access code was set or removed on the device. + `) -const wyze_potential_duplicate_code = common_access_code_error - .extend({ - error_code: z - .literal('wyze_potential_duplicate_code') - .describe(error_code_description), - }) - .describe( - ` +const insufficient_permissions = common_access_code_error.extend({ + error_code: z + .literal('insufficient_permissions') + .describe(error_code_description), +}).describe(` --- - deprecated: Use \`duplicate_code_on_device\` instead. + resource_type: access_code --- - Potential duplicate access code detected. - `, - ) + Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN. + `) -const dormakaba_oracode_invalid_time_range = common_access_code_error - .extend({ - error_code: z - .literal('dormakaba_oracode_invalid_time_range') - .describe(error_code_description), - }) - .describe( - ` +const access_code_inactive_error = common_access_code_error.extend({ + error_code: z + .literal('access_code_inactive') + .describe(error_code_description), +}).describe(` --- - deprecated: Use \`provider_issue\` instead. + resource_type: access_code --- - No Dormakaba Oracode user levels configured for the requested time range. - `, - ) + Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. + `) -const keynest_unsupported_third_party_locker = common_access_code_error +const salto_ks_user_not_subscribed = common_access_code_error .extend({ error_code: z - .literal('keynest_unsupported_third_party_locker') + .literal('salto_ks_user_not_subscribed') .describe(error_code_description), }) .describe( ` --- - deprecated: Use \`provider_issue\` instead. + resource_type: access_code + deprecated: Use \`access_code_inactive\` instead. --- - KeyNest locker is not supported. + Salto site user is not subscribed. `, ) -const replaced_by_newer_access_code = common_access_code_error - .extend({ - error_code: z - .literal('replaced_by_newer_access_code') - .describe(error_code_description), - }) - .describe( - 'This access code was overridden on the device by a newer access code programmed to the same slot.', - ) +const replaced_by_newer_access_code = common_access_code_error.extend({ + error_code: z + .literal('replaced_by_newer_access_code') + .describe(error_code_description), +}).describe(` + --- + resource_type: access_code + --- + This access code was overridden on the device by a newer access code programmed to the same slot. + `) const access_code_error = z .discriminatedUnion('error_code', [ provider_issue, - smartthings_failed_to_set_access_code_error, - smartthings_failed_to_set_after_multiple_retries, failed_to_set_on_device, failed_to_remove_from_device, duplicate_code_on_device, duplicate_code_attempt_prevented, no_space_for_access_code_on_device, access_code_state_unconfirmed, - kwikset_unable_to_confirm_code, - - kwikset_unable_to_confirm_deletion, code_modified_external_to_seam_error, - august_lock_invalid_code_length, - august_lock_missing_keypad, - august_lock_temporarily_offline_error, access_code_inactive_error, salto_ks_user_not_subscribed, - wyze_duplicate_code_name, - wyze_potential_duplicate_code, - dormakaba_oracode_invalid_time_range, insufficient_permissions, - keynest_unsupported_third_party_locker, replaced_by_newer_access_code, ]) .describe( @@ -372,10 +216,6 @@ export type AccessCodeError = z.infer const _access_code_error_map = z.object({ provider_issue: provider_issue.optional().nullable(), - smartthings_failed_to_set_access_code: - smartthings_failed_to_set_access_code_error.optional().nullable(), - smartthings_failed_to_set_after_multiple_retries: - smartthings_failed_to_set_after_multiple_retries.optional().nullable(), failed_to_set_on_device: failed_to_set_on_device.optional().nullable(), failed_to_remove_from_device: failed_to_remove_from_device .optional() @@ -390,37 +230,14 @@ const _access_code_error_map = z.object({ access_code_state_unconfirmed: access_code_state_unconfirmed .optional() .nullable(), - kwikset_unable_to_confirm_code: kwikset_unable_to_confirm_code - .optional() - .nullable(), - kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion - .optional() - .nullable(), insufficient_permissions: insufficient_permissions.optional().nullable(), code_modified_external_to_seam_error: code_modified_external_to_seam_error .optional() .nullable(), - august_lock_invalid_code_length: august_lock_invalid_code_length - .optional() - .nullable(), - august_lock_temporarily_offline: august_lock_temporarily_offline_error - .optional() - .nullable(), - august_lock_missing_keypad: august_lock_missing_keypad.optional().nullable(), access_code_inactive: access_code_inactive_error.optional().nullable(), salto_ks_user_not_subscribed: salto_ks_user_not_subscribed .optional() .nullable(), - wyze_duplicate_code_name: wyze_duplicate_code_name.optional().nullable(), - wyze_potential_duplicate_code: wyze_potential_duplicate_code - .optional() - .nullable(), - dormakaba_oracode_invalid_time_range: dormakaba_oracode_invalid_time_range - .optional() - .nullable(), - keynest_unsupported_third_party_locker: keynest_unsupported_third_party_locker - .optional() - .nullable(), replaced_by_newer_access_code: replaced_by_newer_access_code .optional() .nullable(), @@ -444,22 +261,6 @@ const common_access_code_warning = z.object({ const warning_code_description = 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.' -const smartthings_failed_to_set_access_code_warning = common_access_code_warning - .extend({ - warning_code: z - .literal('smartthings_failed_to_set_access_code') - .describe(warning_code_description), - }) - .describe('Failed to set code on SmartThings device.') - -const august_lock_temporarily_offline_warning = common_access_code_warning - .extend({ - warning_code: z - .literal('august_lock_temporarily_offline') - .describe(error_code_description), - }) - .describe('August lock is temporarily offline.') - const code_modified_external_to_seam_warning = common_access_code_warning .extend({ warning_code: z @@ -507,21 +308,6 @@ const provider_issue_warning = common_access_code_warning 'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.', ) -const schlage_creation_outage = common_access_code_warning - .extend({ - warning_code: z - .literal('schlage_creation_outage') - .describe(warning_code_description), - }) - .describe( - ` - --- - deprecated: Use \`provider_issue\` instead. - --- - Received an error when attempting to create this code. - `, - ) - const schlage_access_code_ambiguous_timezone_dst_risk = common_access_code_warning .extend({ @@ -575,14 +361,6 @@ const management_transferred = common_access_code_warning }) .describe('Management was transferred to another workspace.') -const kwikset_unable_to_confirm_code_warning = common_access_code_warning - .extend({ - warning_code: z - .literal('kwikset_unable_to_confirm_code') - .describe(warning_code_description), - }) - .describe('Unable to confirm that the access code is set on Kwikset device.') - const access_code_inactive = common_access_code_warning .extend({ warning_code: z @@ -593,21 +371,6 @@ const access_code_inactive = common_access_code_warning 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.', ) -const ultraloq_access_code_disabled = common_access_code_warning - .extend({ - warning_code: z - .literal('ultraloq_access_code_disabled') - .describe(warning_code_description), - }) - .describe( - ` - --- - deprecated: Use \`access_code_inactive\` instead. - --- - Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app. - `, - ) - const using_backup_access_code = common_access_code_warning .extend({ warning_code: z @@ -627,20 +390,15 @@ const being_deleted = common_access_code_warning const access_code_warning = z .discriminatedUnion('warning_code', [ provider_issue_warning, - smartthings_failed_to_set_access_code_warning, schlage_detected_duplicate, - schlage_creation_outage, schlage_access_code_ambiguous_timezone_dst_risk, code_modified_external_to_seam_warning, delay_in_setting_on_device, delay_in_removing_from_device, third_party_integration_detected, - august_lock_temporarily_offline_warning, igloo_algopin_must_be_used_within_24_hours, management_transferred, - kwikset_unable_to_confirm_code_warning, access_code_inactive, - ultraloq_access_code_disabled, using_backup_access_code, being_deleted, ]) @@ -652,10 +410,7 @@ export type AccessCodeWarning = z.infer const _access_code_warning_map = z.object({ provider_issue: provider_issue_warning.optional().nullable(), - smartthings_failed_to_set_access_code: - smartthings_failed_to_set_access_code_warning.optional().nullable(), schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(), - schlage_creation_outage: schlage_creation_outage.optional().nullable(), schlage_access_code_ambiguous_timezone_dst_risk: schlage_access_code_ambiguous_timezone_dst_risk.optional().nullable(), code_modified_external_to_seam_warning: code_modified_external_to_seam_warning @@ -668,19 +423,10 @@ const _access_code_warning_map = z.object({ third_party_integration_detected: third_party_integration_detected .optional() .nullable(), - august_lock_temporarily_offline: august_lock_temporarily_offline_warning - .optional() - .nullable(), igloo_algopin_must_be_used_within_24_hours: igloo_algopin_must_be_used_within_24_hours.optional().nullable(), management_transferred: management_transferred.optional().nullable(), - kwikset_unable_to_confirm_code_warning: kwikset_unable_to_confirm_code_warning - .optional() - .nullable(), access_code_inactive: access_code_inactive.optional().nullable(), - ultraloq_access_code_disabled: ultraloq_access_code_disabled - .optional() - .nullable(), using_backup_access_code: using_backup_access_code.optional().nullable(), being_deleted: being_deleted.optional().nullable(), }) diff --git a/src/lib/seam/connect/models/access-grants/access-grant.ts b/src/lib/seam/connect/models/access-grants/access-grant.ts index 496ad992..d3946780 100644 --- a/src/lib/seam/connect/models/access-grants/access-grant.ts +++ b/src/lib/seam/connect/models/access-grants/access-grant.ts @@ -29,7 +29,12 @@ const cannot_create_requested_access_methods_error = .describe( 'IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.', ), - }) + }).describe(` + --- + resource_type: access_grant + --- + Indicates that Seam could not create one or more of the requested access methods for the access grant. + `) const common_access_grant_warning = z.object({ created_at: z diff --git a/src/lib/seam/connect/models/acs/acs-access-group.ts b/src/lib/seam/connect/models/acs/acs-access-group.ts index 28ae97f5..6ebca408 100644 --- a/src/lib/seam/connect/models/acs/acs-access-group.ts +++ b/src/lib/seam/connect/models/acs/acs-access-group.ts @@ -35,15 +35,16 @@ const error_code_description = 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.' const acs_access_groups_failed_to_create_on_acs_system = - common_acs_access_group_error - .extend({ - error_code: z - .literal('failed_to_create_on_acs_system') - .describe(error_code_description), - }) - .describe( - `Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`, - ) + common_acs_access_group_error.extend({ + error_code: z + .literal('failed_to_create_on_acs_system') + .describe(error_code_description), + }).describe(` + --- + resource_type: acs_access_group + --- + Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + `) const acs_access_group_errors = z .discriminatedUnion('error_code', [ @@ -118,15 +119,11 @@ const common_acs_access_group = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group.', - ), + .describe('ID of the workspace that contains the access group.'), connected_account_id: z .string() .uuid() - .describe( - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group.', - ), + .describe('ID of the connected account that contains the access group.'), name: z.string().describe('Name of the access group.'), access_group_type: acs_access_group_external_type.describe(` --- @@ -138,7 +135,7 @@ const common_acs_access_group = z.object({ deprecated: Use \`external_type_display_name\`. --- `), - display_name: z.string(), + display_name: z.string().describe('Display name for the access group.'), external_type: acs_access_group_external_type.describe( 'Brand-specific terminology for the access group type.', ), @@ -170,7 +167,9 @@ const common_acs_access_group = z.object({ }) export const acs_access_group = common_acs_access_group.extend({ - is_managed: z.literal(true), + is_managed: z + .literal(true) + .describe('Indicates whether Seam manages the access group.'), }).describe(` --- route_path: /acs/access_groups diff --git a/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts b/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts index bb8490dd..4a4d61a6 100644 --- a/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +++ b/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts @@ -38,9 +38,7 @@ export const enrollment_automation = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the enrollment automation.', - ), + .describe('ID of the workspace that contains the enrollment automation.'), }).describe(` --- route_path: /user_identities/enrollment_automations diff --git a/src/lib/seam/connect/models/acs/acs-credential.ts b/src/lib/seam/connect/models/acs/acs-credential.ts index 79e9ce9d..e1242651 100644 --- a/src/lib/seam/connect/models/acs/acs-credential.ts +++ b/src/lib/seam/connect/models/acs/acs-credential.ts @@ -162,7 +162,11 @@ const common_acs_credential = z.object({ .describe( 'ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.', ), - acs_credential_pool_id: z.string().uuid().optional(), + acs_credential_pool_id: z + .string() + .uuid() + .optional() + .describe('ID of the credential pool to which the credential belongs.'), acs_system_id: z .string() .uuid() @@ -240,7 +244,7 @@ const common_acs_credential = z.object({ .string() .uuid() .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', ), starts_at: z .string() @@ -304,7 +308,9 @@ const common_acs_credential = z.object({ export const acs_credential = common_acs_credential.merge( z.object({ - is_managed: z.literal(true), + is_managed: z + .literal(true) + .describe('Indicates whether Seam manages the credential.'), }), ).describe(` --- @@ -340,7 +346,12 @@ export const acs_credential_on_encoder = z.object({ 'Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.', ), - is_issued: z.boolean().nullable(), + is_issued: z + .boolean() + .nullable() + .describe( + 'Indicates whether the credential has been issued (encoded onto a card).', + ), starts_at: z .string() diff --git a/src/lib/seam/connect/models/acs/acs-encoder.ts b/src/lib/seam/connect/models/acs/acs-encoder.ts index 4879d6b0..d80acf90 100644 --- a/src/lib/seam/connect/models/acs/acs-encoder.ts +++ b/src/lib/seam/connect/models/acs/acs-encoder.ts @@ -21,11 +21,13 @@ const acs_encoder_removed = common_acs_encoder_error.extend({ const acs_encoder_error = // z.union([ - acs_encoder_removed - // ]) - .describe( - 'Error associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', - ) + // ]) + acs_encoder_removed.describe(` + --- + resource_type: acs_encoder + --- + Error associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + `) const _acs_encoder_error_map = z.object({ acs_encoder_removed: acs_encoder_removed.optional().nullable(), @@ -50,13 +52,13 @@ export const acs_encoder = z.object({ .string() .uuid() .describe( - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', + 'ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', ), workspace_id: z .string() .uuid() .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', + 'ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', ), errors: z .array(acs_encoder_error) diff --git a/src/lib/seam/connect/models/acs/acs-system.ts b/src/lib/seam/connect/models/acs/acs-system.ts index af89dd0f..ed3cc419 100644 --- a/src/lib/seam/connect/models/acs/acs-system.ts +++ b/src/lib/seam/connect/models/acs/acs-system.ts @@ -56,75 +56,97 @@ const seam_bridge_disconnected = common_acs_system_error.extend({ error_code: z .literal('seam_bridge_disconnected') .describe(error_code_description), -}) - .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. - This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces). - See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`) +}).describe(` + --- + resource_type: acs_system + --- + Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces). + See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + `) const bridge_disconnected = common_acs_system_error.extend({ error_code: z.literal('bridge_disconnected').describe(error_code_description), - is_bridge_error: z.boolean().optional(), -}) - .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. - See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`) + is_bridge_error: z + .boolean() + .optional() + .describe( + 'Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).', + ), +}).describe(` + --- + resource_type: acs_system + --- + Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + `) const visionline_instance_unreachable = common_acs_system_error.extend({ error_code: z .literal('visionline_instance_unreachable') .describe(error_code_description), -}) - .describe(`Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). - For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces). - See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`) +}).describe(` + --- + resource_type: acs_system + --- + Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). + For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces). + See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). + `) -const salto_ks_subscription_limit_exceeded = common_acs_system_error - .extend({ - error_code: z - .literal('salto_ks_subscription_limit_exceeded') - .describe(error_code_description), - }) - .describe( - 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.', - ) +const salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({ + error_code: z + .literal('salto_ks_subscription_limit_exceeded') + .describe(error_code_description), +}).describe(` + --- + resource_type: acs_system + --- + Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. + `) -const acs_system_disconnected = common_acs_system_error - .extend({ - error_code: z - .literal('acs_system_disconnected') - .describe(error_code_description), - }) - .describe( - 'Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue.', - ) +const acs_system_disconnected = common_acs_system_error.extend({ + error_code: z + .literal('acs_system_disconnected') + .describe(error_code_description), +}).describe(` + --- + resource_type: acs_system + --- + Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. + `) -const account_disconnected = common_acs_system_error - .extend({ - error_code: z - .literal('account_disconnected') - .describe(error_code_description), - }) - .describe( - 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access.', - ) +const account_disconnected = common_acs_system_error.extend({ + error_code: z + .literal('account_disconnected') + .describe(error_code_description), +}).describe(` + --- + resource_type: acs_system + --- + Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access. + `) -const salto_ks_certification_expired = common_acs_system_error - .extend({ - error_code: z - .literal('salto_ks_certification_expired') - .describe(error_code_description), - }) - .describe( - 'Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.', - ) -const provider_service_unavailable = common_acs_system_error - .extend({ - error_code: z - .literal('provider_service_unavailable') - .describe(error_code_description), - }) - .describe( - "Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.", - ) +const salto_ks_certification_expired = common_acs_system_error.extend({ + error_code: z + .literal('salto_ks_certification_expired') + .describe(error_code_description), +}).describe(` + --- + resource_type: acs_system + --- + Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. + `) +const provider_service_unavailable = common_acs_system_error.extend({ + error_code: z + .literal('provider_service_unavailable') + .describe(error_code_description), +}).describe(` + --- + resource_type: acs_system + --- + Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again. + `) const acs_system_error = z .discriminatedUnion('error_code', [ @@ -251,8 +273,18 @@ export const acs_system = z .describe( 'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).', ), - acs_user_count: z.number().optional(), - acs_access_group_count: z.number().optional(), + acs_user_count: z + .number() + .optional() + .describe( + 'Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + ), + acs_access_group_count: z + .number() + .optional() + .describe( + 'Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + ), external_type: acs_system_external_type .describe( 'Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type.', @@ -285,7 +317,10 @@ export const acs_system = z 'IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network.', ), }) - .optional(), + .optional() + .describe( + 'Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + ), system_type: acs_system_external_type .describe( ` @@ -300,7 +335,9 @@ export const acs_system = z deprecated: Use \`external_type_display_name\`. --- `), - location: acs_location, + location: acs_location.describe( + 'Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + ), name: z .string() .describe( @@ -316,7 +353,7 @@ export const acs_system = z .string() .uuid() .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + 'ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).', ), connected_account_ids: z.array(z.string().uuid()).describe(` --- @@ -328,7 +365,7 @@ export const acs_system = z .string() .uuid() .describe( - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + 'ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).', ), image_url: z .string() diff --git a/src/lib/seam/connect/models/acs/acs-users/acs-user.ts b/src/lib/seam/connect/models/acs/acs-users/acs-user.ts index 0993f496..332fd9bb 100644 --- a/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +++ b/src/lib/seam/connect/models/acs/acs-users/acs-user.ts @@ -30,53 +30,61 @@ const common_acs_user_error = z.object({ ), }) -const acs_users_deleted_externally = common_acs_user_error - .extend({ - error_code: z.literal('deleted_externally'), - }) - .describe( - `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.`, - ) +const acs_users_deleted_externally = common_acs_user_error.extend({ + error_code: z.literal('deleted_externally'), +}).describe(` + --- + resource_type: acs_user + --- + Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam. + `) -const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error - .extend({ +const acs_users_salto_ks_subscription_limit_exceeded = + common_acs_user_error.extend({ error_code: z.literal('salto_ks_subscription_limit_exceeded'), - }) - .describe( - `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.`, - ) + }).describe(` + --- + resource_type: acs_user + --- + Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. + `) -const acs_users_failed_to_create_on_acs_system = common_acs_user_error - .extend({ - error_code: z.literal('failed_to_create_on_acs_system'), - }) - .describe( - `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`, - ) +const acs_users_failed_to_create_on_acs_system = common_acs_user_error.extend({ + error_code: z.literal('failed_to_create_on_acs_system'), +}).describe(` + --- + resource_type: acs_user + --- + Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + `) -const acs_users_failed_to_update_on_acs_system = common_acs_user_error - .extend({ - error_code: z.literal('failed_to_update_on_acs_system'), - }) - .describe( - `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`, - ) +const acs_users_failed_to_update_on_acs_system = common_acs_user_error.extend({ + error_code: z.literal('failed_to_update_on_acs_system'), +}).describe(` + --- + resource_type: acs_user + --- + Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + `) -const acs_users_failed_to_delete_on_acs_system = common_acs_user_error - .extend({ - error_code: z.literal('failed_to_delete_on_acs_system'), - }) - .describe( - `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`, - ) +const acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({ + error_code: z.literal('failed_to_delete_on_acs_system'), +}).describe(` + --- + resource_type: acs_user + --- + Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + `) -const acs_users_latch_conflict_with_resident_user = common_acs_user_error - .extend({ +const acs_users_latch_conflict_with_resident_user = + common_acs_user_error.extend({ error_code: z.literal('latch_conflict_with_resident_user'), - }) - .describe( - `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).`, - ) + }).describe(` + --- + resource_type: acs_user + --- + Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). + `) const acs_user_errors = z .discriminatedUnion('error_code', [ @@ -221,12 +229,18 @@ const common_acs_user = z .describe( 'ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).', ), - hid_acs_system_id: z.string().uuid().optional(), + hid_acs_system_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the HID access control system associated with the user.', + ), workspace_id: z .string() .uuid() .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).', + 'ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).', ), created_at: z .string() @@ -311,7 +325,7 @@ const common_acs_user = z The last time an internal sync job completed for this access system user. `), connected_account_id: z.string().uuid().describe(` - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). `), salto_space_metadata: acs_user_salto_space_metadata .optional() @@ -323,7 +337,9 @@ const common_acs_user = z export const acs_user = common_acs_user.merge( z.object({ - is_managed: z.literal(true), + is_managed: z + .literal(true) + .describe('Indicates whether Seam manages the access system user.'), }), ).describe(` --- diff --git a/src/lib/seam/connect/models/bridges/bridge-client-session.ts b/src/lib/seam/connect/models/bridges/bridge-client-session.ts index 26231ce0..26172824 100644 --- a/src/lib/seam/connect/models/bridges/bridge-client-session.ts +++ b/src/lib/seam/connect/models/bridges/bridge-client-session.ts @@ -15,8 +15,8 @@ const common_bridge_client_session_error = z.object({ const error_code_description = 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.' -export const bridge_lan_unreachable = common_bridge_client_session_error - .extend({ +export const bridge_lan_unreachable = common_bridge_client_session_error.extend( + { error_code: z .literal('bridge_lan_unreachable') .describe(error_code_description), @@ -44,16 +44,25 @@ export const bridge_lan_unreachable = common_bridge_client_session_error .boolean() .nullable() .describe("Indicates whether Seam Bridge's SOCKS server is healthy."), - }) - .describe("Indicates that Seam cannot reach Seam Bridge's LAN.") + }, +).describe(` + --- + resource_type: bridge_client_session + --- + Indicates that Seam cannot reach Seam Bridge's LAN. + `) -export const no_communication_from_bridge = common_bridge_client_session_error - .extend({ +export const no_communication_from_bridge = + common_bridge_client_session_error.extend({ error_code: z .literal('no_communication_from_bridge') .describe(error_code_description), - }) - .describe('Indicates that Seam Bridge has stopped communicating with Seam.') + }).describe(` + --- + resource_type: bridge_client_session + --- + Indicates that Seam Bridge has stopped communicating with Seam. + `) export const bridge_client_session_error = z .discriminatedUnion('error_code', [ diff --git a/src/lib/seam/connect/models/bridges/bridge-connected-system.ts b/src/lib/seam/connect/models/bridges/bridge-connected-system.ts index 6795e704..49bfb099 100644 --- a/src/lib/seam/connect/models/bridges/bridge-connected-system.ts +++ b/src/lib/seam/connect/models/bridges/bridge-connected-system.ts @@ -33,9 +33,7 @@ export const bridge_connected_system = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) with which Seam Bridge is paired.', - ), + .describe('ID of the workspace with which Seam Bridge is paired.'), workspace_display_name: z .string() .describe( diff --git a/src/lib/seam/connect/models/bridges/bridge.ts b/src/lib/seam/connect/models/bridges/bridge.ts index 9d189824..c7beb002 100644 --- a/src/lib/seam/connect/models/bridges/bridge.ts +++ b/src/lib/seam/connect/models/bridges/bridge.ts @@ -5,9 +5,7 @@ export const bridge = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge.', - ), + .describe('ID of the workspace that contains Seam Bridge.'), created_at: z .string() .datetime() diff --git a/src/lib/seam/connect/models/client-sessions/client-session.ts b/src/lib/seam/connect/models/client-sessions/client-session.ts index fafc9aa5..5b369e8f 100644 --- a/src/lib/seam/connect/models/client-sessions/client-session.ts +++ b/src/lib/seam/connect/models/client-sessions/client-session.ts @@ -1,18 +1,11 @@ import { z } from 'zod' export const client_session = z.object({ - client_session_id: z - .string() - .uuid() - .describe( - 'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).', - ), + client_session_id: z.string().uuid().describe('ID of the client session.'), workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).', - ), + .describe('ID of the workspace associated with the client session.'), created_at: z .string() .datetime() diff --git a/src/lib/seam/connect/models/connect-webviews/connect-webview.ts b/src/lib/seam/connect/models/connect-webviews/connect-webview.ts index 293f436b..88f70848 100644 --- a/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +++ b/src/lib/seam/connect/models/connect-webviews/connect-webview.ts @@ -14,9 +14,7 @@ export const connect_webview = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview.', - ), + .describe('ID of the workspace that contains the Connect Webview.'), created_at: z .string() .datetime() @@ -26,7 +24,7 @@ export const connect_webview = z.object({ .uuid() .nullable() .describe( - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview.', + 'ID of the connected account associated with the Connect Webview.', ), url: z .string() @@ -34,7 +32,9 @@ export const connect_webview = z.object({ .describe( 'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.', ), - device_selection_mode: connect_webview_device_selection_mode, + device_selection_mode: connect_webview_device_selection_mode.describe( + 'Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.', + ), // TODO: Use enum value. accepted_providers: z diff --git a/src/lib/seam/connect/models/connected-accounts/connected-account.ts b/src/lib/seam/connect/models/connected-accounts/connected-account.ts index 87e017ed..efe3e64e 100644 --- a/src/lib/seam/connect/models/connected-accounts/connected-account.ts +++ b/src/lib/seam/connect/models/connected-accounts/connected-account.ts @@ -45,86 +45,91 @@ const common_connected_account_warning = z.object({ ), }) -export const account_disconnected = common_connected_account_error - .extend({ - error_code: z - .literal('account_disconnected') - .describe(error_code_description), - }) - .describe('Indicates that the account is disconnected.') +export const account_disconnected = common_connected_account_error.extend({ + error_code: z + .literal('account_disconnected') + .describe(error_code_description), +}).describe(` + --- + resource_type: connected_account + --- + Indicates that the account is disconnected. + `) -export const bridge_disconnected = common_connected_account_error - .extend({ - error_code: z - .literal('bridge_disconnected') - .describe(error_code_description), - }) - .describe( - 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', - ) +export const bridge_disconnected = common_connected_account_error.extend({ + error_code: z.literal('bridge_disconnected').describe(error_code_description), +}).describe(` + --- + resource_type: connected_account + --- + Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + `) export const salto_ks_subscription_limit_exceeded = - common_connected_account_error - .extend({ - error_code: z - .literal('salto_ks_subscription_limit_exceeded') - .describe(error_code_description), - salto_ks_metadata: z - .object({ - sites: z - .array( - z - .object({ - site_id: z - .string() - .describe( - 'ID of a Salto site associated with the connected account that has an error.', - ), - site_name: z - .string() - .describe( - 'Name of a Salto site associated with the connected account that has an error.', - ), - subscribed_site_user_count: z - .number() - .int() - .min(0) - .describe( - 'Count of subscribed site users for a Salto site associated with the connected account that has an error.', - ), - site_user_subscription_limit: z - .number() - .int() - .min(0) - .describe( - 'Subscription limit of site users for a Salto site associated with the connected account that has an error.', - ), - }) - .describe( - 'Salto site associated with the connected account that has an error.', - ), - ) - .describe( - 'Salto sites associated with the connected account that has an error.', - ), - }) - .describe( - 'Salto KS metadata associated with the connected account that has an error.', - ), - }) - .describe( - 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.', - ) + common_connected_account_error.extend({ + error_code: z + .literal('salto_ks_subscription_limit_exceeded') + .describe(error_code_description), + salto_ks_metadata: z + .object({ + sites: z + .array( + z + .object({ + site_id: z + .string() + .describe( + 'ID of a Salto site associated with the connected account that has an error.', + ), + site_name: z + .string() + .describe( + 'Name of a Salto site associated with the connected account that has an error.', + ), + subscribed_site_user_count: z + .number() + .int() + .min(0) + .describe( + 'Count of subscribed site users for a Salto site associated with the connected account that has an error.', + ), + site_user_subscription_limit: z + .number() + .int() + .min(0) + .describe( + 'Subscription limit of site users for a Salto site associated with the connected account that has an error.', + ), + }) + .describe( + 'Salto site associated with the connected account that has an error.', + ), + ) + .describe( + 'Salto sites associated with the connected account that has an error.', + ), + }) + .describe( + 'Salto KS metadata associated with the connected account that has an error.', + ), + }).describe(` + --- + resource_type: connected_account + --- + Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. + `) -export const dormakaba_sites_disconnected = common_connected_account_error - .extend({ +export const dormakaba_sites_disconnected = + common_connected_account_error.extend({ error_code: z .literal('dormakaba_sites_disconnected') .describe(error_code_description), - }) - .describe( - 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', - ) + }).describe(` + --- + resource_type: connected_account + --- + Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + `) export const connected_account_error = z.discriminatedUnion('error_code', [ account_disconnected, diff --git a/src/lib/seam/connect/models/customer/customer.ts b/src/lib/seam/connect/models/customer/customer.ts index 321fb911..156baeb6 100644 --- a/src/lib/seam/connect/models/customer/customer.ts +++ b/src/lib/seam/connect/models/customer/customer.ts @@ -7,9 +7,7 @@ export const customer = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer.', - ), + .describe('ID of the workspace associated with the customer.'), created_at: z .string() .datetime() diff --git a/src/lib/seam/connect/models/customization-profiles/customization-profile.ts b/src/lib/seam/connect/models/customization-profiles/customization-profile.ts index 38adf1ef..e50d3266 100644 --- a/src/lib/seam/connect/models/customization-profiles/customization-profile.ts +++ b/src/lib/seam/connect/models/customization-profiles/customization-profile.ts @@ -11,6 +11,14 @@ export const customer_portal_theme = z.object({ mono_font_family: z.string().optional(), }) +// Per-locale portal label/terminology overrides: +// { [locale]: { ["Namespace.key"]: "Override string" } } +// e.g. { "en-US": { "Reservations.reservation": "Booking" } } +export const message_overrides = z.record( + z.string(), + z.record(z.string(), z.string()), +) + export const customization_profile = z.object({ workspace_id: z.string().uuid(), name: z.string().nullable(), @@ -20,6 +28,7 @@ export const customization_profile = z.object({ primary_color: z.string().optional(), secondary_color: z.string().optional(), customer_portal_theme: customer_portal_theme.optional(), + message_overrides: message_overrides.optional(), }).describe(` --- title: Customization Profile diff --git a/src/lib/seam/connect/models/devices/device-provider.ts b/src/lib/seam/connect/models/devices/device-provider.ts index 7e927fc8..4bae2c6c 100644 --- a/src/lib/seam/connect/models/devices/device-provider.ts +++ b/src/lib/seam/connect/models/devices/device-provider.ts @@ -175,10 +175,16 @@ export const PUBLIC_PROVIDER_CATEGORIES: typeof PROVIDER_CATEGORIES = export const device_provider = z .object({ - device_provider_name: z.enum(ALL_DEVICE_PROVIDERS), - display_name: z.string(), - image_url: z.string(), - provider_categories: z.array(z.enum(PUBLIC_PROVIDER_CATEGORIES)), + device_provider_name: z + .enum(ALL_DEVICE_PROVIDERS) + .describe('Name of the device provider.'), + display_name: z.string().describe('Display name for the device provider.'), + image_url: z.string().describe('Image URL for the device provider.'), + provider_categories: z + .array(z.enum(PUBLIC_PROVIDER_CATEGORIES)) + .describe( + 'List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.', + ), }) .extend(device_capability_flags.shape).describe(` --- diff --git a/src/lib/seam/connect/models/devices/device.ts b/src/lib/seam/connect/models/devices/device.ts index 7859f74f..2b34ed86 100644 --- a/src/lib/seam/connect/models/devices/device.ts +++ b/src/lib/seam/connect/models/devices/device.ts @@ -10,26 +10,96 @@ import { phone_specific_properties } from './phone-properties.js' export const device_capability_flags = z .object({ - can_remotely_unlock: z.boolean(), - can_remotely_lock: z.boolean(), - can_program_offline_access_codes: z.boolean(), - can_program_online_access_codes: z.boolean(), - can_hvac_heat: z.boolean(), - can_hvac_cool: z.boolean(), - can_hvac_heat_cool: z.boolean(), - can_turn_off_hvac: z.boolean(), - can_simulate_removal: z.boolean(), - can_simulate_connection: z.boolean(), - can_simulate_disconnection: z.boolean(), - can_unlock_with_code: z.boolean(), - can_run_thermostat_programs: z.boolean(), - can_program_thermostat_programs_as_weekday_weekend: z.boolean(), - can_program_thermostat_programs_as_different_each_day: z.boolean(), - can_program_thermostat_programs_as_same_each_day: z.boolean(), - can_simulate_hub_connection: z.boolean(), - can_simulate_hub_disconnection: z.boolean(), - can_simulate_paid_subscription: z.boolean(), - can_configure_auto_lock: z.boolean(), + can_remotely_unlock: z + .boolean() + .describe('Indicates whether the device supports remote unlocking.'), + can_remotely_lock: z + .boolean() + .describe('Indicates whether the device supports remote locking.'), + can_program_offline_access_codes: z + .boolean() + .describe( + 'Indicates whether the device supports programming offline access codes.', + ), + can_program_online_access_codes: z + .boolean() + .describe( + 'Indicates whether the device supports programming online access codes.', + ), + can_hvac_heat: z + .boolean() + .describe('Indicates whether the thermostat supports heating.'), + can_hvac_cool: z + .boolean() + .describe('Indicates whether the thermostat supports cooling.'), + can_hvac_heat_cool: z + .boolean() + .describe( + 'Indicates whether the thermostat supports simultaneous heating and cooling.', + ), + can_turn_off_hvac: z + .boolean() + .describe('Indicates whether the thermostat can be turned off.'), + can_simulate_removal: z + .boolean() + .describe( + 'Indicates whether the device supports simulating removal in a sandbox.', + ), + can_simulate_connection: z + .boolean() + .describe( + 'Indicates whether the device supports simulating connection in a sandbox.', + ), + can_simulate_disconnection: z + .boolean() + .describe( + 'Indicates whether the device supports simulating disconnection in a sandbox.', + ), + can_unlock_with_code: z + .boolean() + .describe( + 'Indicates whether the lock supports unlocking with an access code.', + ), + can_run_thermostat_programs: z + .boolean() + .describe( + 'Indicates whether the thermostat supports running climate programs.', + ), + can_program_thermostat_programs_as_weekday_weekend: z + .boolean() + .describe( + 'Indicates whether the thermostat supports weekday/weekend climate programs.', + ), + can_program_thermostat_programs_as_different_each_day: z + .boolean() + .describe( + 'Indicates whether the thermostat supports different climate programs for each day of the week.', + ), + can_program_thermostat_programs_as_same_each_day: z + .boolean() + .describe( + 'Indicates whether the thermostat supports a single climate program applied to every day.', + ), + can_simulate_hub_connection: z + .boolean() + .describe( + 'Indicates whether the hub supports simulating connection in a sandbox.', + ), + can_simulate_hub_disconnection: z + .boolean() + .describe( + 'Indicates whether the hub supports simulating disconnection in a sandbox.', + ), + can_simulate_paid_subscription: z + .boolean() + .describe( + 'Indicates whether the device supports simulating a paid subscription in a sandbox.', + ), + can_configure_auto_lock: z + .boolean() + .describe( + 'Indicates whether the lock supports configuring automatic locking.', + ), }) .partial() @@ -64,47 +134,58 @@ const device_offline = common_device_error .describe( ` --- + resource_type: device deprecated: Use \`device_disconnected\` instead. --- Indicates that the device is offline. `, ) -const device_removed = common_device_error - .extend({ - error_code: z.literal('device_removed').describe(error_code_description), - }) - .describe('Indicates that the device has been removed.') +const device_removed = common_device_error.extend({ + error_code: z.literal('device_removed').describe(error_code_description), +}).describe(` + --- + resource_type: device + --- + Indicates that the device has been removed. + `) -const hub_disconnected = common_device_error - .extend({ - error_code: z.literal('hub_disconnected').describe(error_code_description), - }) - .describe('Indicates that the hub is disconnected.') +const hub_disconnected = common_device_error.extend({ + error_code: z.literal('hub_disconnected').describe(error_code_description), +}).describe(` + --- + resource_type: device + --- + Indicates that the hub is disconnected. + `) -const device_disconnected = common_device_error - .extend({ - error_code: z - .literal('device_disconnected') - .describe(error_code_description), - }) - .describe('Indicates that the device is disconnected.') +const device_disconnected = common_device_error.extend({ + error_code: z.literal('device_disconnected').describe(error_code_description), +}).describe(` + --- + resource_type: device + --- + Indicates that the device is disconnected. + `) -const account_disconnected = common_device_error - .extend({ - error_code: z - .literal('account_disconnected') - .describe(error_code_description), - is_connected_account_error: z - .literal(true) - .describe( - 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', - ), - is_device_error: z - .literal(false) - .describe('Indicates that the error is not a device error.'), - }) - .describe('Indicates that the account is disconnected.') +const account_disconnected = common_device_error.extend({ + error_code: z + .literal('account_disconnected') + .describe(error_code_description), + is_connected_account_error: z + .literal(true) + .describe( + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', + ), + is_device_error: z + .literal(false) + .describe('Indicates that the error is not a device error.'), +}).describe(` + --- + resource_type: connected_account + --- + Indicates that the account is disconnected. + `) const empty_backup_access_code_pool = common_device_error.extend({ error_code: z @@ -112,6 +193,7 @@ const empty_backup_access_code_pool = common_device_error.extend({ .describe(error_code_description), }).describe(` --- + resource_type: device variant_group_key: access_codes --- Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. @@ -123,6 +205,7 @@ const august_lock_not_authorized = common_device_error.extend({ .describe(error_code_description), }).describe(` --- + resource_type: device variant_group_key: locks --- Indicates that the user is not authorized to use the August lock. @@ -134,6 +217,7 @@ const august_lock_missing_bridge = common_device_error.extend({ .describe(error_code_description), }).describe(` --- + resource_type: device deprecated: Use \`hub_disconnected\` instead. variant_group_key: locks --- @@ -154,29 +238,55 @@ const salto_ks_subscription_limit_exceeded = common_device_error.extend({ .describe('Indicates that the error is not a device error.'), }).describe(` --- + resource_type: connected_account variant_group_key: locks --- Indicates that the Salto site user limit has been reached. `) +const dormakaba_sites_disconnected = common_device_error.extend({ + error_code: z + .literal('dormakaba_sites_disconnected') + .describe(error_code_description), + is_connected_account_error: z + .literal(true) + .describe( + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', + ), + is_device_error: z + .literal(false) + .describe('Indicates that the error is not a device error.'), +}).describe(` + --- + resource_type: connected_account + variant_group_key: locks + --- + Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + `) + const ttlock_lock_not_paired_to_gateway = common_device_error.extend({ error_code: z .literal('ttlock_lock_not_paired_to_gateway') .describe(error_code_description), }).describe(` --- + resource_type: device deprecated: Use \`hub_disconnected\` instead. + variant_group_key: locks --- Indicates that the lock is not paired with a gateway. `) -const missing_device_credentials = common_device_error - .extend({ - error_code: z - .literal('missing_device_credentials') - .describe(error_code_description), - }) - .describe('Indicates that device credentials are missing.') +const missing_device_credentials = common_device_error.extend({ + error_code: z + .literal('missing_device_credentials') + .describe(error_code_description), +}).describe(` + --- + resource_type: device + --- + Indicates that device credentials are missing. + `) const auxiliary_heat_running = common_device_error.extend({ error_code: z @@ -184,18 +294,22 @@ const auxiliary_heat_running = common_device_error.extend({ .describe(error_code_description), }).describe(` --- + resource_type: device variant_group_key: thermostats --- Indicates that the auxiliary heat is running. `) -const subscription_required = common_device_error - .extend({ - error_code: z - .literal('subscription_required') - .describe(error_code_description), - }) - .describe('Indicates that a subscription is required to connect.') +const subscription_required = common_device_error.extend({ + error_code: z + .literal('subscription_required') + .describe(error_code_description), +}).describe(` + --- + resource_type: device + --- + Indicates that a subscription is required to connect. + `) const lockly_missing_wifi_bridge = common_device_error.extend({ error_code: z @@ -203,7 +317,9 @@ const lockly_missing_wifi_bridge = common_device_error.extend({ .describe(error_code_description), }).describe(` --- + resource_type: device deprecated: Use \`hub_disconnected\` instead. + variant_group_key: locks --- Indicates that the Lockly lock is not connected to a Wi-Fi bridge. `) @@ -212,6 +328,7 @@ export const device_error = z .discriminatedUnion('error_code', [ account_disconnected, salto_ks_subscription_limit_exceeded, + dormakaba_sites_disconnected, device_offline, device_removed, hub_disconnected, @@ -243,6 +360,9 @@ export const device_error_map = z.object({ salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded .optional() .nullable(), + dormakaba_sites_disconnected: dormakaba_sites_disconnected + .optional() + .nullable(), ttlock_lock_not_paired_to_gateway: ttlock_lock_not_paired_to_gateway .optional() .nullable(), @@ -313,15 +433,18 @@ const salto_ks_privacy_mode = common_device_warning.extend({ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors. `) -const salto_ks_subscription_limit_almost_reached = common_device_warning - .extend({ +const salto_ks_subscription_limit_almost_reached = common_device_warning.extend( + { warning_code: z .literal('salto_ks_subscription_limit_almost_reached') .describe(warning_code_description), - }) - .describe( - 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.', - ) + }, +).describe(` + --- + variant_group_key: locks + --- + Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + `) const salto_ks_lock_access_code_support_removed = common_device_warning.extend({ warning_code: z @@ -341,6 +464,7 @@ const wyze_device_missing_gateway = common_device_warning.extend({ }).describe(` --- deprecated: Use \`hub_disconnected\` device error instead. + variant_group_key: locks --- Indicates that the Wyze Lock is not connected to a gateway. `) @@ -369,6 +493,9 @@ const ttlock_weak_gateway_signal = common_device_warning.extend({ .literal('ttlock_weak_gateway_signal') .describe(warning_code_description), }).describe(` + --- + variant_group_key: locks + --- Indicates that the gateway signal is weak. `) @@ -418,35 +545,38 @@ const device_has_flaky_connection = common_device_warning }) .describe('Indicates that the device has a flaky connection.') -const lockly_time_zone_not_configured = common_device_warning - .extend({ - warning_code: z - .literal('lockly_time_zone_not_configured') - .describe(warning_code_description), - }) - .describe( - 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.', - ) +const lockly_time_zone_not_configured = common_device_warning.extend({ + warning_code: z + .literal('lockly_time_zone_not_configured') + .describe(warning_code_description), +}).describe(` + --- + variant_group_key: locks + --- + Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + `) -const ultraloq_time_zone_unknown = common_device_warning - .extend({ - warning_code: z - .literal('ultraloq_time_zone_unknown') - .describe(warning_code_description), - }) - .describe( - 'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.', - ) +const ultraloq_time_zone_unknown = common_device_warning.extend({ + warning_code: z + .literal('ultraloq_time_zone_unknown') + .describe(warning_code_description), +}).describe(` + --- + variant_group_key: locks + --- + Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + `) -const two_n_device_missing_timezone = common_device_warning - .extend({ - warning_code: z - .literal('two_n_device_missing_timezone') - .describe(warning_code_description), - }) - .describe( - 'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.', - ) +const two_n_device_missing_timezone = common_device_warning.extend({ + warning_code: z + .literal('two_n_device_missing_timezone') + .describe(warning_code_description), +}).describe(` + --- + variant_group_key: locks + --- + Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + `) export const unknown_issue_with_phone = common_device_warning.extend({ warning_code: z diff --git a/src/lib/seam/connect/models/devices/phone.ts b/src/lib/seam/connect/models/devices/phone.ts index 2d8584a1..958ed1f3 100644 --- a/src/lib/seam/connect/models/devices/phone.ts +++ b/src/lib/seam/connect/models/devices/phone.ts @@ -25,7 +25,7 @@ export const phone = z.object({ .describe(`Display name of the phone. Defaults to \`nickname\` (if it is set) or \`properties.appearance.name\`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. `), workspace_id: basePhoneDeviceSchema.shape.workspace_id - .describe(`ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone. + .describe(`ID of the workspace that contains the phone. `), created_at: basePhoneDeviceSchema.shape.created_at .describe(`Date and time at which the phone was created. @@ -37,21 +37,27 @@ export const phone = z.object({ errors: z .array( z.object({ - error_code: z.string(), - message: z.string(), + error_code: z + .string() + .describe('Unique identifier of the type of error.'), + message: z.string().describe('Detailed description of the error.'), }), ) .describe('Errors associated with the phone.'), warnings: z .array( z.object({ - warning_code: z.string(), - message: z.string(), + warning_code: z + .string() + .describe('Unique identifier of the type of warning.'), + message: z.string().describe('Detailed description of the warning.'), }), ) .describe('Warnings associated with the phone.'), - device_type: phone_device_type, - properties: phone_specific_properties, + device_type: phone_device_type.describe( + 'Type of the phone device, such as `ios_phone` or `android_phone`.', + ), + properties: phone_specific_properties.describe('Properties of the phone.'), }).describe(` --- route_path: /phones diff --git a/src/lib/seam/connect/models/devices/unmanaged-device.ts b/src/lib/seam/connect/models/devices/unmanaged-device.ts index 96c1bad9..3a4eb34a 100644 --- a/src/lib/seam/connect/models/devices/unmanaged-device.ts +++ b/src/lib/seam/connect/models/devices/unmanaged-device.ts @@ -20,7 +20,9 @@ export const unmanaged_device = device custom_metadata: true, }) .extend({ - is_managed: z.literal(false), + is_managed: z + .literal(false) + .describe('Indicates that Seam does not manage the device.'), properties: common_device_properties.pick({ accessory_keypad: true, name: true, diff --git a/src/lib/seam/connect/models/events/access-codes.ts b/src/lib/seam/connect/models/events/access-codes.ts index 02b23747..df10762a 100644 --- a/src/lib/seam/connect/models/events/access-codes.ts +++ b/src/lib/seam/connect/models/events/access-codes.ts @@ -17,7 +17,7 @@ const access_code_event = common_event.extend({ .string() .uuid() .describe( - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', ), device_custom_metadata: custom_metadata .optional() @@ -69,19 +69,21 @@ export const access_code_changed_event = access_code_event.extend({ event_type: z.literal('access_code.changed'), changed_properties: z .array( - z.object({ - property: z - .string() - .describe('Name of the property that changed (e.g. `code`).'), - from: z - .string() - .nullable() - .describe('Previous value of the property, or null if not set.'), - to: z - .string() - .nullable() - .describe('New value of the property, or null if cleared.'), - }), + z + .object({ + property: z + .string() + .describe('Name of the property that changed (e.g. `code`).'), + from: z + .string() + .nullable() + .describe('Previous value of the property, or null if not set.'), + to: z + .string() + .nullable() + .describe('New value of the property, or null if cleared.'), + }) + .describe('Record describing a single changed property.'), ) .optional() .describe('List of properties that changed on the access code.'), @@ -100,6 +102,133 @@ export const access_code_changed_event = access_code_event.extend({ export type AccessCodeChangedEvent = z.infer +export const access_code_name_changed_event = access_code_event.extend({ + event_type: z.literal('access_code.name_changed'), + from: z + .object({ + name: z.string().nullable().describe('Previous name of the access code.'), + }) + .describe('Previous access code name configuration.'), + to: z + .object({ + name: z.string().nullable().describe('New name of the access code.'), + }) + .describe('New access code name configuration.'), + description: z + .string() + .describe('Human-readable description of the change and its source.'), +}).describe(` + --- + route_path: /access_codes + --- + The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device. + `) + +export type AccessCodeNameChangedEvent = z.infer< + typeof access_code_name_changed_event +> + +export const access_code_code_changed_event = access_code_event.extend({ + event_type: z.literal('access_code.code_changed'), + from: z + .object({ + code: z.string().nullable().describe('Previous pin code.'), + }) + .describe('Previous pin code configuration.'), + to: z + .object({ + code: z.string().nullable().describe('New pin code.'), + }) + .describe('New pin code configuration.'), + description: z + .string() + .describe('Human-readable description of the change and its source.'), +}).describe(` + --- + route_path: /access_codes + --- + The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device. + `) + +export type AccessCodeCodeChangedEvent = z.infer< + typeof access_code_code_changed_event +> + +export const access_code_time_frame_changed_event = access_code_event.extend({ + event_type: z.literal('access_code.time_frame_changed'), + from: z + .object({ + starts_at: z.string().nullable().describe('Previous start time.'), + ends_at: z.string().nullable().describe('Previous end time.'), + }) + .describe('Previous time frame configuration.'), + to: z + .object({ + starts_at: z.string().nullable().describe('New start time.'), + ends_at: z.string().nullable().describe('New end time.'), + }) + .describe('New time frame configuration.'), + description: z + .string() + .describe('Human-readable description of the change and its source.'), +}).describe(` + --- + route_path: /access_codes + --- + The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device. + `) + +export type AccessCodeTimeFrameChangedEvent = z.infer< + typeof access_code_time_frame_changed_event +> + +const requested_mutation = z + .object({ + mutation_code: z + .enum([ + 'updating_name', + 'updating_code', + 'updating_time_frame', + 'deleting', + 'creating', + 'deferring_creation', + ]) + .describe( + 'Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`.', + ), + from: z + .record(z.string(), z.unknown()) + .optional() + .describe( + 'Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.', + ), + to: z + .record(z.string(), z.unknown()) + .optional() + .describe( + 'New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.', + ), + }) + .describe('Record describing a single requested mutation.') + +export const access_code_mutations_requested_event = access_code_event.extend({ + event_type: z.literal('access_code.mutations_requested'), + requested_mutations: z + .array(requested_mutation) + .describe( + 'Array of mutations requested on the access code, each containing the mutation type and from/to values.', + ), +}).describe(` + --- + route_path: /access_codes + --- + 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. + `) + +export type AccessCodeMutationsRequestedEvent = z.infer< + typeof access_code_mutations_requested_event +> + export const access_code_scheduled_on_device_event = access_code_event.extend({ event_type: z.literal('access_code.scheduled_on_device'), code, @@ -244,7 +373,9 @@ export type AccessCodeDeletedExternalToSeamEvent = z.infer< export const access_code_backup_access_code_pulled_event = access_code_event.extend({ event_type: z.literal('access_code.backup_access_code_pulled'), - backup_access_code_id: z.string(), + backup_access_code_id: z + .string() + .describe('ID of the backup access code that was pulled from the pool.'), }).describe(` --- route_path: /access_codes @@ -317,6 +448,10 @@ export type UnmanagedAccessCodeRemovedEvent = z.infer< export const access_code_events = [ access_code_created_event, access_code_changed_event, + access_code_name_changed_event, + access_code_code_changed_event, + access_code_time_frame_changed_event, + access_code_mutations_requested_event, access_code_scheduled_on_device_event, access_code_set_on_device_event, access_code_removed_from_device_event, diff --git a/src/lib/seam/connect/models/events/acs/entrances.ts b/src/lib/seam/connect/models/events/acs/entrances.ts index a7d90eb9..ea7aa134 100644 --- a/src/lib/seam/connect/models/events/acs/entrances.ts +++ b/src/lib/seam/connect/models/events/acs/entrances.ts @@ -2,11 +2,9 @@ import { z } from 'zod' import { common_acs_event } from './common.js' -const acs_entrance_event = common_acs_event - .extend({ - acs_entrance_id: z.string().uuid(), - }) - .describe('ID of the affected entrance.') +const acs_entrance_event = common_acs_event.extend({ + acs_entrance_id: z.string().uuid().describe('ID of the affected entrance.'), +}) export const acs_entrance_added_event = acs_entrance_event.extend({ event_type: z.literal('acs_entrance.added'), diff --git a/src/lib/seam/connect/models/events/acs/users.ts b/src/lib/seam/connect/models/events/acs/users.ts index b317c04d..5b0a823d 100644 --- a/src/lib/seam/connect/models/events/acs/users.ts +++ b/src/lib/seam/connect/models/events/acs/users.ts @@ -2,11 +2,12 @@ import { z } from 'zod' import { common_acs_event } from './common.js' -const acs_user_event = common_acs_event - .extend({ - acs_user_id: z.string().uuid(), - }) - .describe('ID of the affected access system user.') +const acs_user_event = common_acs_event.extend({ + acs_user_id: z + .string() + .uuid() + .describe('ID of the affected access system user.'), +}) export const acs_user_deleted_event = acs_user_event.extend({ event_type: z.literal('acs_user.deleted'), diff --git a/src/lib/seam/connect/models/events/action-attempts.ts b/src/lib/seam/connect/models/events/action-attempts.ts index 2f7836ee..731ab76b 100644 --- a/src/lib/seam/connect/models/events/action-attempts.ts +++ b/src/lib/seam/connect/models/events/action-attempts.ts @@ -32,7 +32,7 @@ export const action_attempt_lock_door_succeeded_event = --- route_path: /action_attempts --- - A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded. + A lock door action attempt succeeded. `) export const action_attempt_lock_door_failed_event = @@ -42,7 +42,7 @@ export const action_attempt_lock_door_failed_event = --- route_path: /action_attempts --- - A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed. + A lock door action attempt failed. `) export const action_attempt_unlock_door_succeeded_event = @@ -52,7 +52,7 @@ export const action_attempt_unlock_door_succeeded_event = --- route_path: /action_attempts --- - An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded. + An unlock door action attempt succeeded. `) export const action_attempt_unlock_door_failed_event = @@ -62,7 +62,7 @@ export const action_attempt_unlock_door_failed_event = --- route_path: /action_attempts --- - An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed. + An unlock door action attempt failed. `) export const action_attempt_simulate_keypad_code_entry_succeeded_event = @@ -74,7 +74,7 @@ export const action_attempt_simulate_keypad_code_entry_succeeded_event = --- route_path: /action_attempts --- - A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded. + A simulate keypad code entry action attempt succeeded. `) export const action_attempt_simulate_keypad_code_entry_failed_event = @@ -84,7 +84,7 @@ export const action_attempt_simulate_keypad_code_entry_failed_event = --- route_path: /action_attempts --- - A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed. + A simulate keypad code entry action attempt failed. `) export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event = @@ -96,7 +96,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_succeeded_event = --- route_path: /action_attempts --- - A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded. + A simulate manual lock via keypad action attempt succeeded. `) export const action_attempt_simulate_manual_lock_via_keypad_failed_event = @@ -108,7 +108,7 @@ export const action_attempt_simulate_manual_lock_via_keypad_failed_event = --- route_path: /action_attempts --- - A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed. + A simulate manual lock via keypad action attempt failed. `) export const action_attempt_events = [ diff --git a/src/lib/seam/connect/models/events/client-sessions.ts b/src/lib/seam/connect/models/events/client-sessions.ts index 45bee913..c82f0bf8 100644 --- a/src/lib/seam/connect/models/events/client-sessions.ts +++ b/src/lib/seam/connect/models/events/client-sessions.ts @@ -15,7 +15,7 @@ export const client_session_deleted_event = client_session_event.extend({ --- route_path: /client_sessions --- - A [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was deleted. + A client session was deleted. `) export type ClientSessionDeletedEvent = z.infer< diff --git a/src/lib/seam/connect/models/events/common.ts b/src/lib/seam/connect/models/events/common.ts index 3737bd47..9c870627 100644 --- a/src/lib/seam/connect/models/events/common.ts +++ b/src/lib/seam/connect/models/events/common.ts @@ -5,9 +5,7 @@ export const common_event = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', - ), + .describe('ID of the workspace associated with the event.'), created_at: z .string() .datetime() @@ -23,28 +21,36 @@ const error_code_description = const warning_code_description = 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.' -export const common_event_error = z.object({ - created_at: z - .string() - .datetime() - .describe('Date and time at which Seam created the error.'), - message: z - .string() - .describe( - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - ), - error_code: z.string().describe(error_code_description), -}) +export const common_event_error = z + .object({ + created_at: z + .string() + .datetime() + .describe('Date and time at which Seam created the error.'), + message: z + .string() + .describe( + 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + ), + error_code: z.string().describe(error_code_description), + }) + .describe( + 'Error associated with the resource, including the error code, message, and creation timestamp.', + ) -export const common_event_warning = z.object({ - created_at: z - .string() - .datetime() - .describe('Date and time at which Seam created the warning.'), - message: z - .string() - .describe( - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - ), - warning_code: z.string().describe(warning_code_description), -}) +export const common_event_warning = z + .object({ + created_at: z + .string() + .datetime() + .describe('Date and time at which Seam created the warning.'), + message: z + .string() + .describe( + 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + ), + warning_code: z.string().describe(warning_code_description), + }) + .describe( + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', + ) diff --git a/src/lib/seam/connect/models/events/connect-webviews.ts b/src/lib/seam/connect/models/events/connect-webviews.ts index 9f8a51bc..031edc61 100644 --- a/src/lib/seam/connect/models/events/connect-webviews.ts +++ b/src/lib/seam/connect/models/events/connect-webviews.ts @@ -7,17 +7,13 @@ const connect_webview_event = common_event.extend({ connect_webview_id: z .string() .uuid() - .describe( - 'ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).', - ), + .describe('ID of the affected Connect Webview.'), }) const connected_account_id = z .string() .uuid() - .describe( - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', - ) + .describe('ID of the connected account associated with the event.') const connected_account_custom_metadata = custom_metadata .optional() @@ -40,7 +36,7 @@ export const connect_webview_login_succeeded_event = --- route_path: /connect_webviews --- - A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login succeeded. + A Connect Webview login succeeded. `) export type ConnectWebviewLoginSucceededEvent = z.infer< @@ -53,7 +49,7 @@ export const connect_webview_login_failed_event = connect_webview_event.extend({ --- route_path: /connect_webviews --- - A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login failed. + A Connect Webview login failed. `) export type ConnectWebviewLoginFailedEvent = z.infer< diff --git a/src/lib/seam/connect/models/events/connected-accounts.ts b/src/lib/seam/connect/models/events/connected-accounts.ts index 64d6ca64..ad46d924 100644 --- a/src/lib/seam/connect/models/events/connected-accounts.ts +++ b/src/lib/seam/connect/models/events/connected-accounts.ts @@ -11,9 +11,7 @@ const connected_account_event = common_event.extend({ connected_account_id: z .string() .uuid() - .describe( - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', - ), + .describe('ID of the affected connected account.'), connected_account_custom_metadata: custom_metadata .optional() .describe( @@ -24,9 +22,7 @@ const connected_account_event = common_event.extend({ const connect_webview_id = z .string() .uuid() - .describe( - 'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event.', - ) + .describe('ID of the Connect Webview associated with the event.') const connected_account_event_issue_properties = { connected_account_errors: z @@ -52,7 +48,7 @@ export const connected_account_connected_event = connected_account_event.extend( --- route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected. + A connected account was connected for the first time or was reconnected after being disconnected. `) export type ConnectedAccountConnectedEvent = z.infer< @@ -66,7 +62,7 @@ export const connected_account_created_event = connected_account_event.extend({ --- route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was created. + A connected account was created. `) export type ConnectedAccountCreatedEvent = z.infer< @@ -82,7 +78,7 @@ export const connected_account_successful_login_event = deprecated: Use \`connect_webview.login_succeeded\`. route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + A connected account had a successful login using a Connect Webview. `) /** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */ @@ -98,7 +94,7 @@ export const connected_account_disconnected_event = connected_account_event --- route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was disconnected. + A connected account was disconnected. `) export type ConnectedAccountDisconnectedEvent = z.infer< @@ -112,7 +108,7 @@ export const connected_account_completed_first_sync_event = --- route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available. + A connected account completed the first sync with Seam, and the corresponding devices or systems are now available. `) export type ConnectedAccountCompletedFirstSyncEvent = z.infer< @@ -135,7 +131,7 @@ export const connected_account_deleted_event = connected_account_event.extend({ --- route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was deleted. + A connected account was deleted. `) export type ConnectedAccountDeletedEvent = z.infer< @@ -151,7 +147,7 @@ export const connected_account_completed_first_sync_after_reconnection_event = --- route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available. + A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available. `) export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer< @@ -167,7 +163,7 @@ export const connected_account_reauthorization_requested_event = --- route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected. + A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected. `) export type ConnectedAccountReauthorizationRequestedEvent = z.infer< diff --git a/src/lib/seam/connect/models/events/devices.ts b/src/lib/seam/connect/models/events/devices.ts index f5981fb4..c9cdaf93 100644 --- a/src/lib/seam/connect/models/events/devices.ts +++ b/src/lib/seam/connect/models/events/devices.ts @@ -13,9 +13,7 @@ const device_event = common_event.extend({ connected_account_id: z .string() .uuid() - .describe( - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', - ), + .describe('ID of the connected account associated with the event.'), customer_key: z .string() .optional() @@ -78,7 +76,7 @@ export const device_connected_event = device_event.extend({ --- route_path: /devices --- - The status of a [device](https://docs.seam.co/core-concepts/devices) changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices. + The status of a device changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices. `) export type DeviceConnectedEvent = z.infer @@ -89,7 +87,7 @@ export const device_added_event = device_event.extend({ --- route_path: /devices --- - A [device](https://docs.seam.co/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed. + A device was added to Seam or was re-added to Seam after having been removed. `) export type DeviceAddedEvent = z.infer @@ -142,7 +140,7 @@ export const device_disconnected_event = device_event --- route_path: /devices --- - The status of a [device](https://docs.seam.co/core-concepts/devices) changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`. + The status of a device changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`. `) export type DeviceDisconnectedEvent = z.infer @@ -169,7 +167,7 @@ export const device_tampered_event = device_event.extend({ --- route_path: /devices --- - A [device](https://docs.seam.co/core-concepts/devices) detected that it was tampered with, for example, opened or moved. + A device detected that it was tampered with, for example, opened or moved. `) export type DeviceTamperedEvent = z.infer @@ -181,7 +179,7 @@ export const device_low_battery_event = device_event.extend({ --- route_path: /devices --- - A [device](https://docs.seam.co/core-concepts/devices) battery level dropped below the low threshold. + A device battery level dropped below the low threshold. `) export type DeviceLowBatteryEvent = z.infer @@ -194,7 +192,7 @@ export const device_battery_status_changed_event = device_event.extend({ --- route_path: /devices --- - A [device](https://docs.seam.co/core-concepts/devices) battery status changed since the last \`battery_status_changed\` event. + A device battery status changed since the last \`battery_status_changed\` event. `) export type DeviceBatteryStatusChangedEvent = z.infer< @@ -207,7 +205,7 @@ export const device_removed_event = device_event.extend({ --- route_path: /devices --- - A [device](https://docs.seam.co/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/core-concepts/connected-accounts). + A device was removed externally from the connected account. `) export type DeviceRemovedEvent = z.infer @@ -225,7 +223,7 @@ export const device_deleted_event = device_event.extend({ --- route_path: /devices --- - A [device](https://docs.seam.co/core-concepts/devices) was deleted. + A device was deleted. `) export type DeviceDeletedEvent = z.infer @@ -237,7 +235,7 @@ export const device_third_party_integration_detected_event = --- route_path: /devices --- - Seam detected that a [device](https://docs.seam.co/core-concepts/devices) is using a third-party integration that will interfere with Seam device management. + Seam detected that a device is using a third-party integration that will interfere with Seam device management. `) export type DeviceThirdPartyIntegrationDetectedEvent = z.infer< @@ -251,7 +249,7 @@ export const device_third_party_integration_no_longer_detected_event = --- route_path: /devices --- - Seam detected that a [device](https://docs.seam.co/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management. + Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management. `) export type DeviceThirdPartyIntegrationNoLongerDetectedEvent = z.infer< @@ -292,7 +290,7 @@ export const device_connection_became_flaky_event = device_event --- route_path: /devices --- - Seam detected a flaky [device](https://docs.seam.co/core-concepts/devices) connection. + Seam detected a flaky device connection. `) export type DeviceConnectionBecameFlakyEvent = z.infer< @@ -305,7 +303,7 @@ export const device_connection_stabilized_event = device_event.extend({ --- route_path: /devices --- - Seam detected that a previously-flaky [device](https://docs.seam.co/core-concepts/devices) connection stabilized. + Seam detected that a previously-flaky device connection stabilized. `) export type DeviceConnectionStabilizedEvent = z.infer< @@ -320,7 +318,7 @@ export const device_error_subscription_required_event = device_event --- route_path: /devices --- - A third-party subscription is required to use all [device](https://docs.seam.co/core-concepts/devices) features. + A third-party subscription is required to use all device features. `) export type DeviceErrorSubscriptionRequiredEvent = z.infer< @@ -334,7 +332,7 @@ export const device_error_subscription_required_resolved_event = --- route_path: /devices --- - A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/core-concepts/devices) features. + A third-party subscription is active or no longer required to use all device features. `) export type DeviceErrorSubscriptionRequiredResolvedEvent = z.infer< @@ -347,7 +345,7 @@ export const device_accessory_keypad_connected_event = device_event.extend({ --- route_path: /devices --- - An accessory keypad was connected to a [device](https://docs.seam.co/core-concepts/devices). + An accessory keypad was connected to a device. `) export type DeviceAccessoryKeypadConnectedEvent = z.infer< @@ -362,7 +360,7 @@ export const device_accessory_keypad_disconnected_event = device_event --- route_path: /devices --- - An accessory keypad was disconnected from a [device](https://docs.seam.co/core-concepts/devices). + An accessory keypad was disconnected from a device. `) export type DeviceAccessoryKeypadDisconnectedEvent = z.infer< @@ -520,6 +518,31 @@ export const lock_access_denied_event = device_event.extend({ .uuid() .optional() .describe('ID of the access code that was used in the unlock attempts.'), + user_identity_id: z.string().uuid().optional().describe(` + undocumented: Unreleased. + --- + ID of the user identity associated with the access-denied event. + `), + acs_system_id: z.string().uuid().optional().describe(` + undocumented: Unreleased. + --- + ID of the ACS system associated with the access-denied event. + `), + acs_user_id: z.string().uuid().optional().describe(` + undocumented: Unreleased. + --- + ID of the ACS user associated with the access-denied event. + `), + acs_entrance_id: z.string().uuid().optional().describe(` + undocumented: Unreleased. + --- + ID of the ACS entrance associated with the access-denied event. + `), + device_id: z + .string() + .uuid() + .optional() + .describe('ID of the affected device.'), }).describe(` --- route_path: /locks @@ -724,7 +747,7 @@ export const device_name_changed_event = device_event.extend({ --- route_path: /devices --- - The name of a [device](https://docs.seam.co/core-concepts/devices) was changed. + The name of a device was changed. `) export type DeviceNameChangedEvent = z.infer @@ -752,7 +775,7 @@ export const camera_activated_event = device_event.extend({ --- route_path: /devices --- - A [camera](https://docs.seam.co/core-concepts/devices) was activated, for example, by motion detection. + A camera was activated, for example, by motion detection. `) export type CameraActivatedEvent = z.infer @@ -777,7 +800,7 @@ export const device_doorbell_rang_event = device_event.extend({ --- route_path: /devices --- - A doorbell button was pressed on a [device](https://docs.seam.co/core-concepts/devices). + A doorbell button was pressed on a device. `) export type DeviceDoorbellRangEvent = z.infer diff --git a/src/lib/seam/connect/models/events/seam-event.ts b/src/lib/seam/connect/models/events/seam-event.ts index 4203b7dd..fdc64fbd 100644 --- a/src/lib/seam/connect/models/events/seam-event.ts +++ b/src/lib/seam/connect/models/events/seam-event.ts @@ -32,7 +32,7 @@ export const seam_event = z.discriminatedUnion('event_type', [ --- Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event. - As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. + As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. `) export type SeamEvent = z.infer diff --git a/src/lib/seam/connect/models/instant-keys/instant-key.ts b/src/lib/seam/connect/models/instant-keys/instant-key.ts index e1b30aa5..e0da2cf7 100644 --- a/src/lib/seam/connect/models/instant-keys/instant-key.ts +++ b/src/lib/seam/connect/models/instant-keys/instant-key.ts @@ -5,9 +5,7 @@ export const instant_key = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key.', - ), + .describe('ID of the workspace that contains the Instant Key.'), created_at: z .string() .datetime() @@ -21,9 +19,7 @@ export const instant_key = z.object({ client_session_id: z .string() .uuid() - .describe( - 'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key.', - ), + .describe('ID of the client session associated with the Instant Key.'), user_identity_id: z .string() .uuid() diff --git a/src/lib/seam/connect/models/partner/customer-portal.ts b/src/lib/seam/connect/models/partner/customer-portal.ts index 7aa4e7ae..822e5f0e 100644 --- a/src/lib/seam/connect/models/partner/customer-portal.ts +++ b/src/lib/seam/connect/models/partner/customer-portal.ts @@ -11,9 +11,7 @@ export const customer_portal = z workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer portal.', - ), + .describe('ID of the workspace associated with the customer portal.'), created_at: z .string() .datetime() diff --git a/src/lib/seam/connect/models/partner/magic-link.ts b/src/lib/seam/connect/models/partner/magic-link.ts index 794d0335..c95bd41c 100644 --- a/src/lib/seam/connect/models/partner/magic-link.ts +++ b/src/lib/seam/connect/models/partner/magic-link.ts @@ -10,9 +10,7 @@ export const magic_link = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link.', - ), + .describe('ID of the workspace associated with the magic link.'), created_at: z .string() .datetime() diff --git a/src/lib/seam/connect/models/spaces/space.ts b/src/lib/seam/connect/models/spaces/space.ts index ad75848f..9cdf9c7c 100644 --- a/src/lib/seam/connect/models/spaces/space.ts +++ b/src/lib/seam/connect/models/spaces/space.ts @@ -40,9 +40,7 @@ export const space = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space.', - ), + .describe('ID of the workspace associated with the space.'), space_key: z .string() .optional() diff --git a/src/lib/seam/connect/models/thermostats/modes.ts b/src/lib/seam/connect/models/thermostats/modes.ts index 7e56a349..2796e53c 100644 --- a/src/lib/seam/connect/models/thermostats/modes.ts +++ b/src/lib/seam/connect/models/thermostats/modes.ts @@ -1,16 +1,18 @@ import { z } from 'zod' -export const hvac_mode_setting = z.enum([ - 'off', - 'heat', - 'cool', - 'heat_cool', - 'eco', -]) +export const hvac_mode_setting = z + .enum(['off', 'heat', 'cool', 'heat_cool', 'eco']) + .describe( + 'HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.', + ) export type HvacModeSetting = z.infer -export const fan_mode_setting = z.enum(['auto', 'on', 'circulate']) +export const fan_mode_setting = z + .enum(['auto', 'on', 'circulate']) + .describe( + 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.', + ) export type FanModeSetting = z.infer @@ -20,13 +22,10 @@ export type AvailableFanModeSettings = z.infer< typeof available_fan_mode_settings > -export const climate_preset_mode = z.enum([ - 'home', - 'away', - 'wake', - 'sleep', - 'occupied', - 'unoccupied', -]) +export const climate_preset_mode = z + .enum(['home', 'away', 'wake', 'sleep', 'occupied', 'unoccupied']) + .describe( + 'Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.', + ) export type ClimatePresetMode = z.infer diff --git a/src/lib/seam/connect/models/thermostats/thermostat-program.ts b/src/lib/seam/connect/models/thermostats/thermostat-program.ts index 20eeeff7..888f0050 100644 --- a/src/lib/seam/connect/models/thermostats/thermostat-program.ts +++ b/src/lib/seam/connect/models/thermostats/thermostat-program.ts @@ -40,7 +40,7 @@ export const thermostat_daily_program = z.object({ .string() .uuid() .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program.', + 'ID of the workspace that contains the thermostat daily program.', ), created_at: z .string() diff --git a/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts b/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts index 89bfffe9..0e1b2655 100644 --- a/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +++ b/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts @@ -54,9 +54,7 @@ export const thermostat_schedule = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule.', - ), + .describe('ID of the workspace that contains the thermostat schedule.'), created_at: z .string() .datetime() diff --git a/src/lib/seam/connect/models/user-identities/user-identity.ts b/src/lib/seam/connect/models/user-identities/user-identity.ts index f690177e..b39a14ae 100644 --- a/src/lib/seam/connect/models/user-identities/user-identity.ts +++ b/src/lib/seam/connect/models/user-identities/user-identity.ts @@ -49,27 +49,28 @@ const acs_user_profile_does_not_match_user_identity = "Indicates that the ACS user's profile does not match the user identity's profile", ) -const user_identity_issue_with_acs_user = common_user_identity_error - .extend({ - error_code: z - .literal('issue_with_acs_user') - .describe( - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - ), - acs_user_id: z - .string() - .uuid() - .describe('ID of the access system user that has an issue.'), - acs_system_id: z - .string() - .uuid() - .describe( - 'ID of the access system that the user identity is associated with.', - ), - }) - .describe( - 'Indicates that there is an issue with an access system user associated with this user identity.', - ) +const user_identity_issue_with_acs_user = common_user_identity_error.extend({ + error_code: z + .literal('issue_with_acs_user') + .describe( + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + ), + acs_user_id: z + .string() + .uuid() + .describe('ID of the access system user that has an issue.'), + acs_system_id: z + .string() + .uuid() + .describe( + 'ID of the access system that the user identity is associated with.', + ), +}).describe(` + --- + resource_type: user_identity + --- + Indicates that there is an issue with an access system user associated with this user identity. + `) const _user_identity_error_map = z.object({ issue_with_acs_user: z @@ -119,8 +120,15 @@ export const user_identity = z.object({ .describe( 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).', ), - display_name: z.string().min(1), - full_name: z.string().min(1).nullable(), + display_name: z + .string() + .min(1) + .describe('Display name for the user identity.'), + full_name: z + .string() + .min(1) + .nullable() + .describe('Full name of the user associated with the user identity.'), created_at: z .string() .datetime() @@ -128,9 +136,7 @@ export const user_identity = z.object({ workspace_id: z .string() .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.', - ), + .describe('ID of the workspace that contains the user identity.'), errors: z .array(user_identity_errors) .describe( diff --git a/src/lib/seam/connect/models/webhooks/webhook.ts b/src/lib/seam/connect/models/webhooks/webhook.ts index 6a011ba5..55226482 100644 --- a/src/lib/seam/connect/models/webhooks/webhook.ts +++ b/src/lib/seam/connect/models/webhooks/webhook.ts @@ -1,11 +1,7 @@ import { z } from 'zod' export const webhook = z.object({ - webhook_id: z - .string() - .describe( - 'ID of the [webhook](https://docs.seam.co/developer-tools/webhooks).', - ), + webhook_id: z.string().describe('ID of the webhook.'), url: z .string() .describe( diff --git a/src/lib/seam/connect/models/workspaces/workspace.ts b/src/lib/seam/connect/models/workspaces/workspace.ts index f63e1f58..29936269 100644 --- a/src/lib/seam/connect/models/workspaces/workspace.ts +++ b/src/lib/seam/connect/models/workspaces/workspace.ts @@ -3,12 +3,7 @@ import { z } from 'zod' import { hex_color_code } from '../colors.js' export const workspace = z.object({ - workspace_id: z - .string() - .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces).', - ), + workspace_id: z.string().uuid().describe('ID of the workspace.'), name: z .string() .describe( @@ -81,6 +76,13 @@ export const workspace = z.object({ .describe( 'Indicates whether publishable key authentication is enabled for this workspace.', ), + organization_id: z + .string() + .uuid() + .nullable() + .describe( + 'ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.', + ), }).describe(` --- route_path: /workspaces diff --git a/src/lib/seam/connect/openapi.ts b/src/lib/seam/connect/openapi.ts index 6b9f01f0..60000105 100644 --- a/src/lib/seam/connect/openapi.ts +++ b/src/lib/seam/connect/openapi.ts @@ -134,74 +134,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - }, - { - deprecated: true, - description: 'Failed to set code on SmartThings device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['smartthings_failed_to_set_access_code'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Handled by the generic `failed_to_set_on_device` system.', - }, - { - deprecated: true, - description: 'Failed to set code after multiple retries.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: [ - 'smartthings_failed_to_set_after_multiple_retries', - ], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Handled by the generic `failed_to_set_on_device` system.', + 'x-resource-type': 'access_code', }, { description: 'Failed to set code on device.', @@ -232,6 +165,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: 'Failed to remove code from device.', @@ -262,6 +196,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: 'Duplicate access code detected on device.', @@ -304,6 +239,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: @@ -335,6 +271,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: 'No space for access code on device.', @@ -365,6 +302,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: @@ -396,74 +334,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - }, - { - deprecated: true, - description: - 'Unable to confirm that the access code is set on Kwikset device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['kwikset_unable_to_confirm_code'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Use `access_code_state_unconfirmed` instead.', - }, - { - deprecated: true, - description: - 'Unable to confirm the deletion of the access code on Kwikset device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['kwikset_unable_to_confirm_deletion'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Use `access_code_state_unconfirmed` instead.', + 'x-resource-type': 'access_code', }, { description: @@ -527,10 +398,11 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { - deprecated: true, - description: 'Invalid code length for August lock.', + description: + 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.', properties: { created_at: { description: @@ -541,7 +413,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_invalid_code_length'], + enum: ['access_code_inactive'], type: 'string', }, is_access_code_error: { @@ -558,11 +430,11 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-resource-type': 'access_code', }, { deprecated: true, - description: 'August lock is missing a keypad.', + description: 'Salto site user is not subscribed.', properties: { created_at: { description: @@ -573,7 +445,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_missing_keypad'], + enum: ['salto_ks_user_not_subscribed'], type: 'string', }, is_access_code_error: { @@ -590,11 +462,12 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-deprecated': 'Use `access_code_inactive` instead.', + 'x-resource-type': 'access_code', }, { - deprecated: true, - description: 'August lock is temporarily offline.', + description: + 'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.', properties: { created_at: { description: @@ -605,7 +478,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_temporarily_offline'], + enum: ['insufficient_permissions'], type: 'string', }, is_access_code_error: { @@ -622,11 +495,11 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-resource-type': 'access_code', }, { description: - 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.', + 'This access code was overridden on the device by a newer access code programmed to the same slot.', properties: { created_at: { description: @@ -637,7 +510,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['access_code_inactive'], + enum: ['replaced_by_newer_access_code'], type: 'string', }, is_access_code_error: { @@ -654,10 +527,10 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { - deprecated: true, - description: 'Salto site user is not subscribed.', + description: 'Indicates that the account is disconnected.', properties: { created_at: { description: @@ -668,28 +541,40 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['salto_ks_user_not_subscribed'], + enum: ['account_disconnected'], type: 'string', }, - is_access_code_error: { + is_connected_account_error: { description: - 'Indicates that this is an access code error.', + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', enum: [true], type: 'boolean', }, + is_device_error: { + description: + 'Indicates that the error is not a device error.', + enum: [false], + type: 'boolean', + }, message: { description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', type: 'string', }, }, - required: ['message', 'is_access_code_error', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + 'is_connected_account_error', + ], type: 'object', - 'x-deprecated': 'Use `access_code_inactive` instead.', + 'x-resource-type': 'connected_account', }, { - deprecated: true, - description: 'Duplicate access code name detected.', + description: + 'Indicates that the Salto site user limit has been reached.', properties: { created_at: { description: @@ -700,28 +585,41 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['wyze_duplicate_code_name'], + enum: ['salto_ks_subscription_limit_exceeded'], type: 'string', }, - is_access_code_error: { + is_connected_account_error: { description: - 'Indicates that this is an access code error.', + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', enum: [true], type: 'boolean', }, + is_device_error: { + description: + 'Indicates that the error is not a device error.', + enum: [false], + type: 'boolean', + }, message: { description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', type: 'string', }, }, - required: ['message', 'is_access_code_error', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + 'is_connected_account_error', + ], type: 'object', - 'x-deprecated': 'Use `duplicate_code_on_device` instead.', + 'x-resource-type': 'connected_account', + 'x-variant-group-key': 'locks', }, { - deprecated: true, - description: 'Potential duplicate access code detected.', + description: + 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', properties: { created_at: { description: @@ -732,29 +630,41 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['wyze_potential_duplicate_code'], + enum: ['dormakaba_sites_disconnected'], type: 'string', }, - is_access_code_error: { + is_connected_account_error: { description: - 'Indicates that this is an access code error.', + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', enum: [true], type: 'boolean', }, + is_device_error: { + description: + 'Indicates that the error is not a device error.', + enum: [false], + type: 'boolean', + }, message: { description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', type: 'string', }, }, - required: ['message', 'is_access_code_error', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + 'is_connected_account_error', + ], type: 'object', - 'x-deprecated': 'Use `duplicate_code_on_device` instead.', + 'x-resource-type': 'connected_account', + 'x-variant-group-key': 'locks', }, { deprecated: true, - description: - 'No Dormakaba Oracode user levels configured for the requested time range.', + description: 'Indicates that the device is offline.', properties: { created_at: { description: @@ -765,12 +675,12 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['dormakaba_oracode_invalid_time_range'], + enum: ['device_offline'], type: 'string', }, - is_access_code_error: { + is_device_error: { description: - 'Indicates that this is an access code error.', + 'Indicates that the error is a device error.', enum: [true], type: 'boolean', }, @@ -780,13 +690,18 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['message', 'is_access_code_error', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-deprecated': 'Use `device_disconnected` instead.', + 'x-resource-type': 'device', }, { - description: - 'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.', + description: 'Indicates that the device has been removed.', properties: { created_at: { description: @@ -797,12 +712,12 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['insufficient_permissions'], + enum: ['device_removed'], type: 'string', }, - is_access_code_error: { + is_device_error: { description: - 'Indicates that this is an access code error.', + 'Indicates that the error is a device error.', enum: [true], type: 'boolean', }, @@ -812,12 +727,17 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['message', 'is_access_code_error', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], type: 'object', + 'x-resource-type': 'device', }, { - deprecated: true, - description: 'KeyNest locker is not supported.', + description: 'Indicates that the hub is disconnected.', properties: { created_at: { description: @@ -828,12 +748,12 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['keynest_unsupported_third_party_locker'], + enum: ['hub_disconnected'], type: 'string', }, - is_access_code_error: { + is_device_error: { description: - 'Indicates that this is an access code error.', + 'Indicates that the error is a device error.', enum: [true], type: 'boolean', }, @@ -843,13 +763,17 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['message', 'is_access_code_error', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-resource-type': 'device', }, { - description: - 'This access code was overridden on the device by a newer access code programmed to the same slot.', + description: 'Indicates that the device is disconnected.', properties: { created_at: { description: @@ -860,12 +784,12 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['replaced_by_newer_access_code'], + enum: ['device_disconnected'], type: 'string', }, - is_access_code_error: { + is_device_error: { description: - 'Indicates that this is an access code error.', + 'Indicates that the error is a device error.', enum: [true], type: 'boolean', }, @@ -875,11 +799,18 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['message', 'is_access_code_error', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], type: 'object', + 'x-resource-type': 'device', }, { - description: 'Indicates that the account is disconnected.', + description: + 'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.', properties: { created_at: { description: @@ -890,19 +821,13 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['account_disconnected'], + enum: ['empty_backup_access_code_pool'], type: 'string', }, - is_connected_account_error: { - description: - 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', - enum: [true], - type: 'boolean', - }, is_device_error: { description: - 'Indicates that the error is not a device error.', - enum: [false], + 'Indicates that the error is a device error.', + enum: [true], type: 'boolean', }, message: { @@ -916,13 +841,14 @@ const openapi: OpenAPISpec = { 'is_device_error', 'created_at', 'error_code', - 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'device', + 'x-variant-group-key': 'access_codes', }, { description: - 'Indicates that the Salto site user limit has been reached.', + 'Indicates that the user is not authorized to use the August lock.', properties: { created_at: { description: @@ -933,19 +859,13 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['salto_ks_subscription_limit_exceeded'], + enum: ['august_lock_not_authorized'], type: 'string', }, - is_connected_account_error: { - description: - 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', - enum: [true], - type: 'boolean', - }, is_device_error: { description: - 'Indicates that the error is not a device error.', - enum: [false], + 'Indicates that the error is a device error.', + enum: [true], type: 'boolean', }, message: { @@ -959,14 +879,15 @@ const openapi: OpenAPISpec = { 'is_device_error', 'created_at', 'error_code', - 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'device', 'x-variant-group-key': 'locks', }, { deprecated: true, - description: 'Indicates that the device is offline.', + description: + 'Indicates that the lock is not connected to a bridge.', properties: { created_at: { description: @@ -977,224 +898,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_offline'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - 'x-deprecated': 'Use `device_disconnected` instead.', - }, - { - description: 'Indicates that the device has been removed.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_removed'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - }, - { - description: 'Indicates that the hub is disconnected.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['hub_disconnected'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - }, - { - description: 'Indicates that the device is disconnected.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_disconnected'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - }, - { - description: - 'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['empty_backup_access_code_pool'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - 'x-variant-group-key': 'access_codes', - }, - { - description: - 'Indicates that the user is not authorized to use the August lock.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_not_authorized'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - 'x-variant-group-key': 'locks', - }, - { - deprecated: true, - description: - 'Indicates that the lock is not connected to a bridge.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_missing_bridge'], + enum: ['august_lock_missing_bridge'], type: 'string', }, is_device_error: { @@ -1217,6 +921,7 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', 'x-variant-group-key': 'locks', }, { @@ -1256,6 +961,8 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { description: 'Indicates that device credentials are missing.', @@ -1291,6 +998,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { description: 'Indicates that the auxiliary heat is running.', @@ -1326,6 +1034,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', 'x-variant-group-key': 'thermostats', }, { @@ -1363,6 +1072,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { deprecated: true, @@ -1401,6 +1111,8 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { description: @@ -1436,41 +1148,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', - }, - { - description: - 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['dormakaba_sites_disconnected'], - type: 'string', - }, - is_bridge_error: { - description: - 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).', - type: 'boolean', - }, - is_connected_account_error: { - description: - 'Indicates whether the error is related specifically to the connected account.', - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['created_at', 'message', 'error_code'], - type: 'object', + 'x-resource-type': 'connected_account', }, ], }, @@ -1859,30 +1537,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - description: 'Failed to set code on SmartThings device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['smartthings_failed_to_set_access_code'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - }, { deprecated: true, description: 'Duplicate access code detected.', @@ -1910,33 +1564,6 @@ const openapi: OpenAPISpec = { 'x-deprecated': 'Use `duplicate_code_on_device` error instead.', }, - { - deprecated: true, - description: - 'Received an error when attempting to create this code.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['schlage_creation_outage'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', - }, { description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.", @@ -2092,30 +1719,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - description: 'August lock is temporarily offline.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_temporarily_offline'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - }, { description: 'Algopins must be used within 24 hours.', properties: { @@ -2165,31 +1768,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - description: - 'Unable to confirm that the access code is set on Kwikset device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['kwikset_unable_to_confirm_code'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - }, { description: 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.', @@ -2215,33 +1793,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - deprecated: true, - description: - 'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['ultraloq_access_code_disabled'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - 'x-deprecated': 'Use `access_code_inactive` instead.', - }, { description: 'A backup access code has been pulled and is being used in place of this access code.', @@ -2386,6 +1937,8 @@ const openapi: OpenAPISpec = { discriminator: { propertyName: 'error_code' }, oneOf: [ { + description: + 'Indicates that Seam could not create one or more of the requested access methods for the access grant.', properties: { created_at: { description: @@ -2413,6 +1966,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'access_grant', }, ], }, @@ -3403,7 +2957,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group.', + 'ID of the connected account that contains the access group.', format: 'uuid', type: 'string', }, @@ -3412,7 +2966,10 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { type: 'string' }, + display_name: { + description: 'Display name for the access group.', + type: 'string', + }, errors: { description: 'Errors associated with the `acs_access_group`.', items: { @@ -3443,6 +3000,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_access_group', }, ], }, @@ -3468,7 +3026,11 @@ const openapi: OpenAPISpec = { 'Display name that corresponds to the brand-specific terminology for the access group type.', type: 'string', }, - is_managed: { enum: [true], type: 'boolean' }, + is_managed: { + description: 'Indicates whether Seam manages the access group.', + enum: [true], + type: 'boolean', + }, name: { description: 'Name of the access group.', type: 'string' }, pending_mutations: { description: @@ -3886,8 +3448,7 @@ const openapi: OpenAPISpec = { type: 'array', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group.', + description: 'ID of the workspace that contains the access group.', format: 'uuid', type: 'string', }, @@ -3928,7 +3489,12 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - acs_credential_pool_id: { format: 'uuid', type: 'string' }, + acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', + format: 'uuid', + type: 'string', + }, acs_system_id: { description: 'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', @@ -4061,7 +3627,11 @@ const openapi: OpenAPISpec = { nullable: true, type: 'boolean', }, - is_managed: { enum: [true], type: 'boolean' }, + is_managed: { + description: 'Indicates whether Seam manages the credential.', + enum: [true], + type: 'boolean', + }, is_multi_phone_sync_credential: { description: 'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', @@ -4317,7 +3887,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -4404,7 +3974,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', + 'ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', format: 'uuid', type: 'string', }, @@ -4445,12 +4015,13 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_encoder', }, type: 'array', }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', + 'ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).', format: 'uuid', type: 'string', }, @@ -4997,17 +4568,27 @@ const openapi: OpenAPISpec = { description: 'Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).', properties: { - acs_access_group_count: { format: 'float', type: 'number' }, + acs_access_group_count: { + description: + 'Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + format: 'float', + type: 'number', + }, acs_system_id: { description: 'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).', format: 'uuid', type: 'string', }, - acs_user_count: { format: 'float', type: 'number' }, + acs_user_count: { + description: + 'Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + format: 'float', + type: 'number', + }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + 'ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).', format: 'uuid', type: 'string', }, @@ -5042,7 +4623,7 @@ const openapi: OpenAPISpec = { oneOf: [ { description: - 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', + 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\nThis error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', properties: { created_at: { description: @@ -5064,10 +4645,11 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, { description: - 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', + 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', properties: { created_at: { description: @@ -5081,7 +4663,11 @@ const openapi: OpenAPISpec = { enum: ['bridge_disconnected'], type: 'string', }, - is_bridge_error: { type: 'boolean' }, + is_bridge_error: { + description: + 'Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).', + type: 'boolean', + }, message: { description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', @@ -5090,10 +4676,11 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, { description: - 'Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).', + 'Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\nFor example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).\nSee also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).', properties: { created_at: { description: @@ -5115,6 +4702,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, { description: @@ -5140,6 +4728,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, { description: @@ -5165,6 +4754,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, { description: @@ -5190,6 +4780,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, { description: @@ -5215,6 +4806,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, { description: @@ -5240,6 +4832,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_system', }, ], }, @@ -5288,6 +4881,8 @@ const openapi: OpenAPISpec = { type: 'boolean', }, location: { + description: + 'Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).', properties: { time_zone: { description: @@ -5332,6 +4927,8 @@ const openapi: OpenAPISpec = { 'x-deprecated': 'Use `external_type_display_name`.', }, visionline_metadata: { + description: + 'Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).', properties: { lan_address: { description: @@ -5447,7 +5044,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).', + 'ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).', format: 'uuid', type: 'string', }, @@ -5508,7 +5105,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - '\n The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).\n ', + '\n The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).\n ', format: 'uuid', type: 'string', }, @@ -5565,6 +5162,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -5588,6 +5186,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -5611,6 +5210,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -5634,6 +5234,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -5657,6 +5258,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -5680,6 +5282,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, ], }, @@ -5711,8 +5314,18 @@ const openapi: OpenAPISpec = { minLength: 1, type: 'string', }, - hid_acs_system_id: { format: 'uuid', type: 'string' }, - is_managed: { enum: [true], type: 'boolean' }, + hid_acs_system_id: { + description: + 'ID of the HID access control system associated with the user.', + format: 'uuid', + type: 'string', + }, + is_managed: { + description: + 'Indicates whether Seam manages the access system user.', + enum: [true], + type: 'boolean', + }, is_suspended: { description: 'Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).', @@ -6302,7 +5915,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).', + 'ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).', format: 'uuid', type: 'string', }, @@ -6649,7 +6262,12 @@ const openapi: OpenAPISpec = { nullable: true, type: 'string', }, - is_issued: { nullable: true, type: 'boolean' }, + is_issued: { + description: + 'Indicates whether the credential has been issued (encoded onto a card).', + nullable: true, + type: 'boolean', + }, starts_at: { description: 'Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable.', @@ -6770,6 +6388,8 @@ const openapi: OpenAPISpec = { type: 'string', }, acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', format: 'uuid', type: 'string', }, @@ -6907,7 +6527,12 @@ const openapi: OpenAPISpec = { nullable: true, type: 'boolean', }, - is_managed: { enum: [true], type: 'boolean' }, + is_managed: { + description: + 'Indicates whether Seam manages the credential.', + enum: [true], + type: 'boolean', + }, is_multi_phone_sync_credential: { description: 'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', @@ -7191,7 +6816,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -7228,6 +6853,8 @@ const openapi: OpenAPISpec = { type: 'string', }, acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', format: 'uuid', type: 'string', }, @@ -7649,7 +7276,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -7943,6 +7570,8 @@ const openapi: OpenAPISpec = { type: 'string', }, acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', format: 'uuid', type: 'string', }, @@ -8079,7 +7708,12 @@ const openapi: OpenAPISpec = { nullable: true, type: 'boolean', }, - is_managed: { enum: [true], type: 'boolean' }, + is_managed: { + description: + 'Indicates whether Seam manages the credential.', + enum: [true], + type: 'boolean', + }, is_multi_phone_sync_credential: { description: 'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', @@ -8361,7 +7995,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -8398,6 +8032,8 @@ const openapi: OpenAPISpec = { type: 'string', }, acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', format: 'uuid', type: 'string', }, @@ -8816,7 +8452,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -9146,7 +8782,12 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - acs_credential_pool_id: { format: 'uuid', type: 'string' }, + acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', + format: 'uuid', + type: 'string', + }, acs_system_id: { description: 'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', @@ -9279,7 +8920,12 @@ const openapi: OpenAPISpec = { nullable: true, type: 'boolean', }, - is_managed: { enum: [true], type: 'boolean' }, + is_managed: { + description: + 'Indicates whether Seam manages the credential.', + enum: [true], + type: 'boolean', + }, is_multi_phone_sync_credential: { description: 'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', @@ -9537,7 +9183,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -12092,6 +11738,7 @@ const openapi: OpenAPISpec = { 'is_bridge_socks_server_healthy', ], type: 'object', + 'x-resource-type': 'bridge_client_session', }, { description: @@ -12117,6 +11764,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'error_code'], type: 'object', + 'x-resource-type': 'bridge_client_session', }, ], }, @@ -12225,7 +11873,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) with which Seam Bridge is paired.', + 'ID of the workspace with which Seam Bridge is paired.', format: 'uuid', type: 'string', }, @@ -12249,8 +11897,7 @@ const openapi: OpenAPISpec = { "Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).", properties: { client_session_id: { - description: - 'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).', + description: 'ID of the client session.', format: 'uuid', type: 'string', }, @@ -12316,7 +11963,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).', + 'ID of the workspace associated with the client session.', format: 'uuid', type: 'string', }, @@ -12399,7 +12046,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview.', + 'ID of the connected account associated with the Connect Webview.', format: 'uuid', nullable: true, type: 'string', @@ -12438,6 +12085,8 @@ const openapi: OpenAPISpec = { type: 'string', }, device_selection_mode: { + description: + 'Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.', enum: ['none', 'single', 'multiple'], type: 'string', }, @@ -12471,7 +12120,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview.', + 'ID of the workspace that contains the Connect Webview.', format: 'uuid', type: 'string', }, @@ -12611,6 +12260,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'connected_account', }, { description: @@ -12646,6 +12296,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'connected_account', }, { description: @@ -12734,6 +12385,7 @@ const openapi: OpenAPISpec = { 'salto_ks_metadata', ], type: 'object', + 'x-resource-type': 'connected_account', }, { description: @@ -12769,6 +12421,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'connected_account', }, ], }, @@ -13119,8 +12772,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer.', + description: 'ID of the workspace associated with the customer.', format: 'uuid', type: 'string', }, @@ -13157,7 +12809,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer portal.', + 'ID of the workspace associated with the customer portal.', format: 'uuid', type: 'string', }, @@ -13189,6 +12841,13 @@ const openapi: OpenAPISpec = { }, customization_profile_id: { format: 'uuid', type: 'string' }, logo_url: { format: 'uri', type: 'string' }, + message_overrides: { + additionalProperties: { + additionalProperties: { type: 'string' }, + type: 'object', + }, + type: 'object', + }, name: { nullable: true, type: 'string' }, primary_color: { type: 'string' }, secondary_color: { type: 'string' }, @@ -13209,30 +12868,103 @@ const openapi: OpenAPISpec = { description: 'Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.', properties: { - can_configure_auto_lock: { type: 'boolean' }, - can_hvac_cool: { type: 'boolean' }, - can_hvac_heat: { type: 'boolean' }, - can_hvac_heat_cool: { type: 'boolean' }, - can_program_offline_access_codes: { type: 'boolean' }, - can_program_online_access_codes: { type: 'boolean' }, + can_configure_auto_lock: { + description: + 'Indicates whether the lock supports configuring automatic locking.', + type: 'boolean', + }, + can_hvac_cool: { + description: 'Indicates whether the thermostat supports cooling.', + type: 'boolean', + }, + can_hvac_heat: { + description: 'Indicates whether the thermostat supports heating.', + type: 'boolean', + }, + can_hvac_heat_cool: { + description: + 'Indicates whether the thermostat supports simultaneous heating and cooling.', + type: 'boolean', + }, + can_program_offline_access_codes: { + description: + 'Indicates whether the device supports programming offline access codes.', + type: 'boolean', + }, + can_program_online_access_codes: { + description: + 'Indicates whether the device supports programming online access codes.', + type: 'boolean', + }, can_program_thermostat_programs_as_different_each_day: { + description: + 'Indicates whether the thermostat supports different climate programs for each day of the week.', + type: 'boolean', + }, + can_program_thermostat_programs_as_same_each_day: { + description: + 'Indicates whether the thermostat supports a single climate program applied to every day.', type: 'boolean', }, - can_program_thermostat_programs_as_same_each_day: { type: 'boolean' }, can_program_thermostat_programs_as_weekday_weekend: { + description: + 'Indicates whether the thermostat supports weekday/weekend climate programs.', + type: 'boolean', + }, + can_remotely_lock: { + description: + 'Indicates whether the device supports remote locking.', + type: 'boolean', + }, + can_remotely_unlock: { + description: + 'Indicates whether the device supports remote unlocking.', + type: 'boolean', + }, + can_run_thermostat_programs: { + description: + 'Indicates whether the thermostat supports running climate programs.', + type: 'boolean', + }, + can_simulate_connection: { + description: + 'Indicates whether the device supports simulating connection in a sandbox.', + type: 'boolean', + }, + can_simulate_disconnection: { + description: + 'Indicates whether the device supports simulating disconnection in a sandbox.', + type: 'boolean', + }, + can_simulate_hub_connection: { + description: + 'Indicates whether the hub supports simulating connection in a sandbox.', + type: 'boolean', + }, + can_simulate_hub_disconnection: { + description: + 'Indicates whether the hub supports simulating disconnection in a sandbox.', + type: 'boolean', + }, + can_simulate_paid_subscription: { + description: + 'Indicates whether the device supports simulating a paid subscription in a sandbox.', + type: 'boolean', + }, + can_simulate_removal: { + description: + 'Indicates whether the device supports simulating removal in a sandbox.', + type: 'boolean', + }, + can_turn_off_hvac: { + description: 'Indicates whether the thermostat can be turned off.', + type: 'boolean', + }, + can_unlock_with_code: { + description: + 'Indicates whether the lock supports unlocking with an access code.', type: 'boolean', }, - can_remotely_lock: { type: 'boolean' }, - can_remotely_unlock: { type: 'boolean' }, - can_run_thermostat_programs: { type: 'boolean' }, - can_simulate_connection: { type: 'boolean' }, - can_simulate_disconnection: { type: 'boolean' }, - can_simulate_hub_connection: { type: 'boolean' }, - can_simulate_hub_disconnection: { type: 'boolean' }, - can_simulate_paid_subscription: { type: 'boolean' }, - can_simulate_removal: { type: 'boolean' }, - can_turn_off_hvac: { type: 'boolean' }, - can_unlock_with_code: { type: 'boolean' }, capabilities_supported: { description: '\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ', @@ -13455,6 +13187,7 @@ const openapi: OpenAPISpec = { 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'connected_account', }, { description: @@ -13498,11 +13231,12 @@ const openapi: OpenAPISpec = { 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'connected_account', 'x-variant-group-key': 'locks', }, { - deprecated: true, - description: 'Indicates that the device is offline.', + description: + 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', properties: { created_at: { description: @@ -13513,15 +13247,21 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_offline'], + enum: ['dormakaba_sites_disconnected'], type: 'string', }, - is_device_error: { + is_connected_account_error: { description: - 'Indicates that the error is a device error.', + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', enum: [true], type: 'boolean', }, + is_device_error: { + description: + 'Indicates that the error is not a device error.', + enum: [false], + type: 'boolean', + }, message: { description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', @@ -13533,12 +13273,15 @@ const openapi: OpenAPISpec = { 'is_device_error', 'created_at', 'error_code', + 'is_connected_account_error', ], type: 'object', - 'x-deprecated': 'Use `device_disconnected` instead.', + 'x-resource-type': 'connected_account', + 'x-variant-group-key': 'locks', }, { - description: 'Indicates that the device has been removed.', + deprecated: true, + description: 'Indicates that the device is offline.', properties: { created_at: { description: @@ -13549,7 +13292,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_removed'], + enum: ['device_offline'], type: 'string', }, is_device_error: { @@ -13571,9 +13314,11 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-deprecated': 'Use `device_disconnected` instead.', + 'x-resource-type': 'device', }, { - description: 'Indicates that the hub is disconnected.', + description: 'Indicates that the device has been removed.', properties: { created_at: { description: @@ -13584,7 +13329,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['hub_disconnected'], + enum: ['device_removed'], type: 'string', }, is_device_error: { @@ -13606,9 +13351,10 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { - description: 'Indicates that the device is disconnected.', + description: 'Indicates that the hub is disconnected.', properties: { created_at: { description: @@ -13619,7 +13365,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_disconnected'], + enum: ['hub_disconnected'], type: 'string', }, is_device_error: { @@ -13641,10 +13387,10 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { - description: - 'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.', + description: 'Indicates that the device is disconnected.', properties: { created_at: { description: @@ -13655,7 +13401,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['empty_backup_access_code_pool'], + enum: ['device_disconnected'], type: 'string', }, is_device_error: { @@ -13677,11 +13423,11 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-variant-group-key': 'access_codes', + 'x-resource-type': 'device', }, { description: - 'Indicates that the user is not authorized to use the August lock.', + 'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.', properties: { created_at: { description: @@ -13692,7 +13438,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_not_authorized'], + enum: ['empty_backup_access_code_pool'], type: 'string', }, is_device_error: { @@ -13714,12 +13460,12 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-variant-group-key': 'locks', + 'x-resource-type': 'device', + 'x-variant-group-key': 'access_codes', }, { - deprecated: true, description: - 'Indicates that the lock is not connected to a bridge.', + 'Indicates that the user is not authorized to use the August lock.', properties: { created_at: { description: @@ -13730,7 +13476,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_missing_bridge'], + enum: ['august_lock_not_authorized'], type: 'string', }, is_device_error: { @@ -13752,13 +13498,13 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', 'x-variant-group-key': 'locks', }, { deprecated: true, description: - 'Indicates that the lock is not paired with a gateway.', + 'Indicates that the lock is not connected to a bridge.', properties: { created_at: { description: @@ -13769,7 +13515,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['ttlock_lock_not_paired_to_gateway'], + enum: ['august_lock_missing_bridge'], type: 'string', }, is_device_error: { @@ -13792,9 +13538,13 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { - description: 'Indicates that device credentials are missing.', + deprecated: true, + description: + 'Indicates that the lock is not paired with a gateway.', properties: { created_at: { description: @@ -13805,7 +13555,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['missing_device_credentials'], + enum: ['ttlock_lock_not_paired_to_gateway'], type: 'string', }, is_device_error: { @@ -13827,9 +13577,12 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { - description: 'Indicates that the auxiliary heat is running.', + description: 'Indicates that device credentials are missing.', properties: { created_at: { description: @@ -13840,7 +13593,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['auxiliary_heat_running'], + enum: ['missing_device_credentials'], type: 'string', }, is_device_error: { @@ -13862,11 +13615,10 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-variant-group-key': 'thermostats', + 'x-resource-type': 'device', }, { - description: - 'Indicates that a subscription is required to connect.', + description: 'Indicates that the auxiliary heat is running.', properties: { created_at: { description: @@ -13877,7 +13629,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['subscription_required'], + enum: ['auxiliary_heat_running'], type: 'string', }, is_device_error: { @@ -13899,11 +13651,12 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', + 'x-variant-group-key': 'thermostats', }, { - deprecated: true, description: - 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.', + 'Indicates that a subscription is required to connect.', properties: { created_at: { description: @@ -13914,7 +13667,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['lockly_missing_wifi_bridge'], + enum: ['subscription_required'], type: 'string', }, is_device_error: { @@ -13936,11 +13689,12 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', }, { + deprecated: true, description: - 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', + 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.', properties: { created_at: { description: @@ -13951,17 +13705,13 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['bridge_disconnected'], + enum: ['lockly_missing_wifi_bridge'], type: 'string', }, - is_bridge_error: { - description: - 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).', - type: 'boolean', - }, - is_connected_account_error: { + is_device_error: { description: - 'Indicates whether the error is related specifically to the connected account.', + 'Indicates that the error is a device error.', + enum: [true], type: 'boolean', }, message: { @@ -13970,12 +13720,20 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['created_at', 'message', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], type: 'object', + 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { description: - 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', + 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', properties: { created_at: { description: @@ -13986,7 +13744,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['dormakaba_sites_disconnected'], + enum: ['bridge_disconnected'], type: 'string', }, is_bridge_error: { @@ -14007,6 +13765,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'connected_account', }, ], }, @@ -15932,7 +15691,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule.', + 'ID of the workspace that contains the thermostat schedule.', format: 'uuid', type: 'string', }, @@ -15966,6 +15725,8 @@ const openapi: OpenAPISpec = { description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".', items: { + description: + 'Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.', enum: [ 'home', 'away', @@ -16120,6 +15881,8 @@ const openapi: OpenAPISpec = { description: 'Fan mode settings that the thermostat supports.', items: { + description: + 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.', enum: ['auto', 'on', 'circulate'], type: 'string', }, @@ -16130,6 +15893,8 @@ const openapi: OpenAPISpec = { description: 'HVAC mode settings that the thermostat supports.', items: { + description: + 'HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.', enum: ['off', 'heat', 'cool', 'heat_cool', 'eco'], type: 'string', }, @@ -16634,7 +16399,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program.', + 'ID of the workspace that contains the thermostat daily program.', format: 'uuid', type: 'string', }, @@ -16834,6 +16599,7 @@ const openapi: OpenAPISpec = { type: 'object', 'x-deprecated': 'Use `hub_disconnected` device error instead.', + 'x-variant-group-key': 'locks', }, { description: @@ -16887,8 +16653,7 @@ const openapi: OpenAPISpec = { 'x-variant-group-key': 'locks', }, { - description: - '\n Indicates that the gateway signal is weak.\n ', + description: 'Indicates that the gateway signal is weak.', properties: { created_at: { description: @@ -16910,6 +16675,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -17114,6 +16880,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -17191,6 +16958,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -17216,6 +16984,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -17241,6 +17010,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -17489,31 +17259,105 @@ const openapi: OpenAPISpec = { }, device_provider: { properties: { - can_configure_auto_lock: { type: 'boolean' }, - can_hvac_cool: { type: 'boolean' }, - can_hvac_heat: { type: 'boolean' }, - can_hvac_heat_cool: { type: 'boolean' }, - can_program_offline_access_codes: { type: 'boolean' }, - can_program_online_access_codes: { type: 'boolean' }, + can_configure_auto_lock: { + description: + 'Indicates whether the lock supports configuring automatic locking.', + type: 'boolean', + }, + can_hvac_cool: { + description: 'Indicates whether the thermostat supports cooling.', + type: 'boolean', + }, + can_hvac_heat: { + description: 'Indicates whether the thermostat supports heating.', + type: 'boolean', + }, + can_hvac_heat_cool: { + description: + 'Indicates whether the thermostat supports simultaneous heating and cooling.', + type: 'boolean', + }, + can_program_offline_access_codes: { + description: + 'Indicates whether the device supports programming offline access codes.', + type: 'boolean', + }, + can_program_online_access_codes: { + description: + 'Indicates whether the device supports programming online access codes.', + type: 'boolean', + }, can_program_thermostat_programs_as_different_each_day: { + description: + 'Indicates whether the thermostat supports different climate programs for each day of the week.', + type: 'boolean', + }, + can_program_thermostat_programs_as_same_each_day: { + description: + 'Indicates whether the thermostat supports a single climate program applied to every day.', type: 'boolean', }, - can_program_thermostat_programs_as_same_each_day: { type: 'boolean' }, can_program_thermostat_programs_as_weekday_weekend: { + description: + 'Indicates whether the thermostat supports weekday/weekend climate programs.', + type: 'boolean', + }, + can_remotely_lock: { + description: + 'Indicates whether the device supports remote locking.', + type: 'boolean', + }, + can_remotely_unlock: { + description: + 'Indicates whether the device supports remote unlocking.', + type: 'boolean', + }, + can_run_thermostat_programs: { + description: + 'Indicates whether the thermostat supports running climate programs.', + type: 'boolean', + }, + can_simulate_connection: { + description: + 'Indicates whether the device supports simulating connection in a sandbox.', + type: 'boolean', + }, + can_simulate_disconnection: { + description: + 'Indicates whether the device supports simulating disconnection in a sandbox.', + type: 'boolean', + }, + can_simulate_hub_connection: { + description: + 'Indicates whether the hub supports simulating connection in a sandbox.', + type: 'boolean', + }, + can_simulate_hub_disconnection: { + description: + 'Indicates whether the hub supports simulating disconnection in a sandbox.', + type: 'boolean', + }, + can_simulate_paid_subscription: { + description: + 'Indicates whether the device supports simulating a paid subscription in a sandbox.', + type: 'boolean', + }, + can_simulate_removal: { + description: + 'Indicates whether the device supports simulating removal in a sandbox.', + type: 'boolean', + }, + can_turn_off_hvac: { + description: 'Indicates whether the thermostat can be turned off.', + type: 'boolean', + }, + can_unlock_with_code: { + description: + 'Indicates whether the lock supports unlocking with an access code.', type: 'boolean', }, - can_remotely_lock: { type: 'boolean' }, - can_remotely_unlock: { type: 'boolean' }, - can_run_thermostat_programs: { type: 'boolean' }, - can_simulate_connection: { type: 'boolean' }, - can_simulate_disconnection: { type: 'boolean' }, - can_simulate_hub_connection: { type: 'boolean' }, - can_simulate_hub_disconnection: { type: 'boolean' }, - can_simulate_paid_subscription: { type: 'boolean' }, - can_simulate_removal: { type: 'boolean' }, - can_turn_off_hvac: { type: 'boolean' }, - can_unlock_with_code: { type: 'boolean' }, device_provider_name: { + description: 'Name of the device provider.', enum: [ 'hotek', 'dormakaba_community', @@ -17578,9 +17422,17 @@ const openapi: OpenAPISpec = { ], type: 'string', }, - display_name: { type: 'string' }, - image_url: { type: 'string' }, + display_name: { + description: 'Display name for the device provider.', + type: 'string', + }, + image_url: { + description: 'Image URL for the device provider.', + type: 'string', + }, provider_categories: { + description: + 'List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.', items: { enum: [ 'stable', @@ -17635,7 +17487,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the enrollment automation.', + 'ID of the workspace that contains the enrollment automation.', format: 'uuid', type: 'string', }, @@ -17653,7 +17505,7 @@ const openapi: OpenAPISpec = { }, event: { description: - "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.", + "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.", discriminator: { propertyName: 'event_type' }, oneOf: [ { @@ -17675,7 +17527,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -17710,8 +17562,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -17747,6 +17598,7 @@ const openapi: OpenAPISpec = { description: 'List of properties that changed on the access code.', items: { + description: 'Record describing a single changed property.', properties: { from: { description: @@ -17781,7 +17633,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -17816,8 +17668,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -17837,17 +17688,13 @@ const openapi: OpenAPISpec = { }, { 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.', + 'The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.', properties: { access_code_id: { description: 'ID of the affected access code.', format: 'uuid', type: 'string', }, - code: { - description: 'Code for the affected access code.', - type: 'string', - }, connected_account_custom_metadata: { additionalProperties: { oneOf: [{ type: 'string' }, { type: 'boolean' }], @@ -17858,7 +17705,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -17867,6 +17714,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, + description: { + description: + 'Human-readable description of the change and its source.', + type: 'string', + }, device_custom_metadata: { additionalProperties: { oneOf: [{ type: 'string' }, { type: 'boolean' }], @@ -17887,17 +17739,40 @@ const openapi: OpenAPISpec = { type: 'string', }, event_type: { - enum: ['access_code.scheduled_on_device'], + enum: ['access_code.name_changed'], type: 'string', }, + from: { + description: 'Previous access code name configuration.', + properties: { + name: { + description: 'Previous name of the access code.', + nullable: true, + type: 'string', + }, + }, + required: ['name'], + type: 'object', + }, occurred_at: { description: 'Date and time at which the event occurred.', format: 'date-time', type: 'string', }, + to: { + description: 'New access code name configuration.', + properties: { + name: { + description: 'New name of the access code.', + nullable: true, + type: 'string', + }, + }, + required: ['name'], + type: 'object', + }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -17911,22 +17786,127 @@ const openapi: OpenAPISpec = { 'device_id', 'connected_account_id', 'event_type', - 'code', + 'from', + 'to', + 'description', ], type: 'object', 'x-route-path': '/access_codes', }, { description: - 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was set on a device.', + 'The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.', properties: { access_code_id: { description: 'ID of the affected access code.', format: 'uuid', type: 'string', }, - code: { - description: 'Code for the affected access code.', + connected_account_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the connected account, present when connected_account_id is provided.', + type: 'object', + }, + connected_account_id: { + description: + 'ID of the connected account associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + created_at: { + description: 'Date and time at which the event was created.', + format: 'date-time', + type: 'string', + }, + description: { + description: + 'Human-readable description of the change and its source.', + type: 'string', + }, + device_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the device, present when device_id is provided.', + type: 'object', + }, + device_id: { + description: + 'ID of the device associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + event_id: { + description: 'ID of the event.', + format: 'uuid', + type: 'string', + }, + event_type: { + enum: ['access_code.code_changed'], + type: 'string', + }, + from: { + description: 'Previous pin code configuration.', + properties: { + code: { + description: 'Previous pin code.', + nullable: true, + type: 'string', + }, + }, + required: ['code'], + type: 'object', + }, + occurred_at: { + description: 'Date and time at which the event occurred.', + format: 'date-time', + type: 'string', + }, + to: { + description: 'New pin code configuration.', + properties: { + code: { + description: 'New pin code.', + nullable: true, + type: 'string', + }, + }, + required: ['code'], + type: 'object', + }, + workspace_id: { + description: 'ID of the workspace associated with the event.', + format: 'uuid', + type: 'string', + }, + }, + required: [ + 'event_id', + 'workspace_id', + 'created_at', + 'occurred_at', + 'access_code_id', + 'device_id', + 'connected_account_id', + 'event_type', + 'from', + 'to', + 'description', + ], + type: 'object', + 'x-route-path': '/access_codes', + }, + { + description: + 'The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.', + properties: { + access_code_id: { + description: 'ID of the affected access code.', + format: 'uuid', type: 'string', }, connected_account_custom_metadata: { @@ -17939,7 +17919,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -17948,6 +17928,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, + description: { + description: + 'Human-readable description of the change and its source.', + type: 'string', + }, device_custom_metadata: { additionalProperties: { oneOf: [{ type: 'string' }, { type: 'boolean' }], @@ -17968,17 +17953,50 @@ const openapi: OpenAPISpec = { type: 'string', }, event_type: { - enum: ['access_code.set_on_device'], + enum: ['access_code.time_frame_changed'], type: 'string', }, + from: { + description: 'Previous time frame configuration.', + properties: { + ends_at: { + description: 'Previous end time.', + nullable: true, + type: 'string', + }, + starts_at: { + description: 'Previous start time.', + nullable: true, + type: 'string', + }, + }, + required: ['starts_at', 'ends_at'], + type: 'object', + }, occurred_at: { description: 'Date and time at which the event occurred.', format: 'date-time', type: 'string', }, + to: { + description: 'New time frame configuration.', + properties: { + ends_at: { + description: 'New end time.', + nullable: true, + type: 'string', + }, + starts_at: { + description: 'New start time.', + nullable: true, + type: 'string', + }, + }, + required: ['starts_at', 'ends_at'], + type: 'object', + }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -17992,14 +18010,16 @@ const openapi: OpenAPISpec = { 'device_id', 'connected_account_id', 'event_type', - 'code', + 'from', + 'to', + 'description', ], type: 'object', 'x-route-path': '/access_codes', }, { description: - 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was removed from a device.', + '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.', properties: { access_code_id: { description: 'ID of the affected access code.', @@ -18016,7 +18036,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -18045,7 +18065,7 @@ const openapi: OpenAPISpec = { type: 'string', }, event_type: { - enum: ['access_code.removed_from_device'], + enum: ['access_code.mutations_requested'], type: 'string', }, occurred_at: { @@ -18053,9 +18073,281 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, + requested_mutations: { + description: + 'Array of mutations requested on the access code, each containing the mutation type and from/to values.', + items: { + description: 'Record describing a single requested mutation.', + properties: { + from: { + additionalProperties: {}, + description: + 'Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.', + type: 'object', + }, + mutation_code: { + description: + 'Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`.', + enum: [ + 'updating_name', + 'updating_code', + 'updating_time_frame', + 'deleting', + 'creating', + 'deferring_creation', + ], + type: 'string', + }, + to: { + additionalProperties: {}, + description: + 'New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`.', + type: 'object', + }, + }, + required: ['mutation_code'], + type: 'object', + }, + type: 'array', + }, workspace_id: { + description: 'ID of the workspace associated with the event.', + format: 'uuid', + type: 'string', + }, + }, + required: [ + 'event_id', + 'workspace_id', + 'created_at', + 'occurred_at', + 'access_code_id', + 'device_id', + 'connected_account_id', + 'event_type', + 'requested_mutations', + ], + type: 'object', + 'x-route-path': '/access_codes', + }, + { + 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.', + properties: { + access_code_id: { + description: 'ID of the affected access code.', + format: 'uuid', + type: 'string', + }, + code: { + description: 'Code for the affected access code.', + type: 'string', + }, + connected_account_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the connected account, present when connected_account_id is provided.', + type: 'object', + }, + connected_account_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + 'ID of the connected account associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + created_at: { + description: 'Date and time at which the event was created.', + format: 'date-time', + type: 'string', + }, + device_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the device, present when device_id is provided.', + type: 'object', + }, + device_id: { + description: + 'ID of the device associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + event_id: { + description: 'ID of the event.', + format: 'uuid', + type: 'string', + }, + event_type: { + enum: ['access_code.scheduled_on_device'], + type: 'string', + }, + occurred_at: { + description: 'Date and time at which the event occurred.', + format: 'date-time', + type: 'string', + }, + workspace_id: { + description: 'ID of the workspace associated with the event.', + format: 'uuid', + type: 'string', + }, + }, + required: [ + 'event_id', + 'workspace_id', + 'created_at', + 'occurred_at', + 'access_code_id', + 'device_id', + 'connected_account_id', + 'event_type', + 'code', + ], + type: 'object', + 'x-route-path': '/access_codes', + }, + { + description: + 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was set on a device.', + properties: { + access_code_id: { + description: 'ID of the affected access code.', + format: 'uuid', + type: 'string', + }, + code: { + description: 'Code for the affected access code.', + type: 'string', + }, + connected_account_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the connected account, present when connected_account_id is provided.', + type: 'object', + }, + connected_account_id: { + description: + 'ID of the connected account associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + created_at: { + description: 'Date and time at which the event was created.', + format: 'date-time', + type: 'string', + }, + device_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the device, present when device_id is provided.', + type: 'object', + }, + device_id: { + description: + 'ID of the device associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + event_id: { + description: 'ID of the event.', + format: 'uuid', + type: 'string', + }, + event_type: { + enum: ['access_code.set_on_device'], + type: 'string', + }, + occurred_at: { + description: 'Date and time at which the event occurred.', + format: 'date-time', + type: 'string', + }, + workspace_id: { + description: 'ID of the workspace associated with the event.', + format: 'uuid', + type: 'string', + }, + }, + required: [ + 'event_id', + 'workspace_id', + 'created_at', + 'occurred_at', + 'access_code_id', + 'device_id', + 'connected_account_id', + 'event_type', + 'code', + ], + type: 'object', + 'x-route-path': '/access_codes', + }, + { + description: + 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was removed from a device.', + properties: { + access_code_id: { + description: 'ID of the affected access code.', + format: 'uuid', + type: 'string', + }, + connected_account_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the connected account, present when connected_account_id is provided.', + type: 'object', + }, + connected_account_id: { + description: + 'ID of the connected account associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + created_at: { + description: 'Date and time at which the event was created.', + format: 'date-time', + type: 'string', + }, + device_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the device, present when device_id is provided.', + type: 'object', + }, + device_id: { + description: + 'ID of the device associated with the affected access code.', + format: 'uuid', + type: 'string', + }, + event_id: { + description: 'ID of the event.', + format: 'uuid', + type: 'string', + }, + event_type: { + enum: ['access_code.removed_from_device'], + type: 'string', + }, + occurred_at: { + description: 'Date and time at which the event occurred.', + format: 'date-time', + type: 'string', + }, + workspace_id: { + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -18080,6 +18372,8 @@ const openapi: OpenAPISpec = { access_code_errors: { description: 'Errors associated with the access code.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18111,6 +18405,8 @@ const openapi: OpenAPISpec = { access_code_warnings: { description: 'Warnings associated with the access code.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18145,6 +18441,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18170,13 +18468,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18216,6 +18516,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18248,6 +18550,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18286,8 +18590,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -18318,6 +18621,8 @@ const openapi: OpenAPISpec = { access_code_errors: { description: 'Errors associated with the access code.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18349,6 +18654,8 @@ const openapi: OpenAPISpec = { access_code_warnings: { description: 'Warnings associated with the access code.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18383,6 +18690,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18408,13 +18717,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18454,6 +18765,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18486,6 +18799,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18524,8 +18839,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -18573,7 +18887,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -18608,8 +18922,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -18635,6 +18948,8 @@ const openapi: OpenAPISpec = { access_code_errors: { description: 'Errors associated with the access code.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18666,6 +18981,8 @@ const openapi: OpenAPISpec = { access_code_warnings: { description: 'Warnings associated with the access code.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18700,6 +19017,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18725,13 +19044,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18771,6 +19092,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18803,6 +19126,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18841,8 +19166,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -18873,6 +19197,8 @@ const openapi: OpenAPISpec = { access_code_errors: { description: 'Errors associated with the access code.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18904,6 +19230,8 @@ const openapi: OpenAPISpec = { access_code_warnings: { description: 'Warnings associated with the access code.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -18938,6 +19266,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -18963,13 +19293,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -19009,6 +19341,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -19041,6 +19375,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -19079,8 +19415,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19123,7 +19458,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -19161,8 +19496,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19199,7 +19533,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -19237,8 +19571,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19265,7 +19598,11 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - backup_access_code_id: { type: 'string' }, + backup_access_code_id: { + description: + 'ID of the backup access code that was pulled from the pool.', + type: 'string', + }, connected_account_custom_metadata: { additionalProperties: { oneOf: [{ type: 'string' }, { type: 'boolean' }], @@ -19276,7 +19613,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -19314,8 +19651,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19353,7 +19689,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -19391,8 +19727,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19417,6 +19752,8 @@ const openapi: OpenAPISpec = { access_code_errors: { description: 'Errors associated with the access code.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -19448,6 +19785,8 @@ const openapi: OpenAPISpec = { access_code_warnings: { description: 'Warnings associated with the access code.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -19482,6 +19821,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -19507,13 +19848,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -19553,6 +19896,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -19585,6 +19930,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -19623,8 +19970,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19667,7 +20013,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -19705,8 +20051,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19743,7 +20088,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.', + 'ID of the connected account associated with the affected access code.', format: 'uuid', type: 'string', }, @@ -19781,8 +20126,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19825,8 +20169,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19867,8 +20210,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19913,8 +20255,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -19965,8 +20306,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20018,8 +20358,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20076,8 +20415,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20135,8 +20473,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20200,8 +20537,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20255,8 +20591,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20314,8 +20649,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20369,8 +20703,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20434,8 +20767,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20489,8 +20821,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20538,8 +20869,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20586,8 +20916,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20611,6 +20940,8 @@ const openapi: OpenAPISpec = { description: 'Errors associated with the access control system.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -20643,6 +20974,8 @@ const openapi: OpenAPISpec = { description: 'Warnings associated with the access control system.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -20669,6 +21002,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -20700,6 +21035,8 @@ const openapi: OpenAPISpec = { connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -20740,8 +21077,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20797,8 +21133,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20851,8 +21186,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20905,8 +21239,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20962,8 +21295,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -20989,7 +21321,11 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - acs_user_id: { format: 'uuid', type: 'string' }, + acs_user_id: { + description: 'ID of the affected access system user.', + format: 'uuid', + type: 'string', + }, connected_account_id: { description: 'ID of the connected account.', format: 'uuid', @@ -21012,8 +21348,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21039,7 +21374,11 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - acs_user_id: { format: 'uuid', type: 'string' }, + acs_user_id: { + description: 'ID of the affected access system user.', + format: 'uuid', + type: 'string', + }, connected_account_id: { description: 'ID of the connected account.', format: 'uuid', @@ -21062,8 +21401,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21116,8 +21454,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21170,8 +21507,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21226,8 +21562,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21248,7 +21583,11 @@ const openapi: OpenAPISpec = { description: 'An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was added.', properties: { - acs_entrance_id: { format: 'uuid', type: 'string' }, + acs_entrance_id: { + description: 'ID of the affected entrance.', + format: 'uuid', + type: 'string', + }, acs_system_id: { description: 'ID of the access system.', format: 'uuid', @@ -21276,8 +21615,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21298,7 +21636,11 @@ const openapi: OpenAPISpec = { description: 'An [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was removed.', properties: { - acs_entrance_id: { format: 'uuid', type: 'string' }, + acs_entrance_id: { + description: 'ID of the affected entrance.', + format: 'uuid', + type: 'string', + }, acs_system_id: { description: 'ID of the access system.', format: 'uuid', @@ -21326,8 +21668,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21345,8 +21686,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/acs/entrances', }, { - description: - 'A [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was deleted.', + description: 'A client session was deleted.', properties: { client_session_id: { description: 'ID of the affected client session.', @@ -21370,8 +21710,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21389,11 +21728,11 @@ const openapi: OpenAPISpec = { }, { description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.', + 'A connected account was connected for the first time or was reconnected after being disconnected.', properties: { connect_webview_id: { description: - 'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event.', + 'ID of the Connect Webview associated with the event.', format: 'uuid', type: 'string', }, @@ -21406,8 +21745,7 @@ const openapi: OpenAPISpec = { type: 'object', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, @@ -21436,8 +21774,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21454,12 +21791,11 @@ const openapi: OpenAPISpec = { 'x-route-path': '/connected_accounts', }, { - description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was created.', + description: 'A connected account was created.', properties: { connect_webview_id: { description: - 'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event.', + 'ID of the Connect Webview associated with the event.', format: 'uuid', type: 'string', }, @@ -21472,8 +21808,7 @@ const openapi: OpenAPISpec = { type: 'object', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, @@ -21497,8 +21832,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21518,11 +21852,11 @@ const openapi: OpenAPISpec = { { deprecated: true, description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).', + 'A connected account had a successful login using a Connect Webview.', properties: { connect_webview_id: { description: - 'ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event.', + 'ID of the Connect Webview associated with the event.', format: 'uuid', type: 'string', }, @@ -21535,8 +21869,7 @@ const openapi: OpenAPISpec = { type: 'object', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, @@ -21560,8 +21893,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21580,8 +21912,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/connected_accounts', }, { - description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was disconnected.', + description: 'A connected account was disconnected.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -21594,6 +21925,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -21618,14 +21951,15 @@ const openapi: OpenAPISpec = { type: 'array', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -21669,8 +22003,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21690,7 +22023,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available.', + 'A connected account completed the first sync with Seam, and the corresponding devices or systems are now available.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -21701,8 +22034,7 @@ const openapi: OpenAPISpec = { type: 'object', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, @@ -21726,8 +22058,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21744,8 +22075,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/connected_accounts', }, { - description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) was deleted.', + description: 'A connected account was deleted.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -21756,8 +22086,7 @@ const openapi: OpenAPISpec = { type: 'object', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, @@ -21790,8 +22119,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21809,7 +22137,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.', + 'A connected account completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -21820,8 +22148,7 @@ const openapi: OpenAPISpec = { type: 'object', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, @@ -21847,8 +22174,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21866,7 +22192,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [connected account](https://docs.seam.co/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.', + 'A connected account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -21879,6 +22205,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -21903,14 +22231,15 @@ const openapi: OpenAPISpec = { type: 'array', }, connected_account_id: { - description: - 'ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + description: 'ID of the affected connected account.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -21954,8 +22283,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -21974,8 +22302,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/connected_accounts', }, { - description: - 'A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.', + description: 'A lock door action attempt succeeded.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22019,8 +22346,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22039,8 +22365,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/action_attempts', }, { - description: - 'A lock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.', + description: 'A lock door action attempt failed.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22084,8 +22409,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22104,8 +22428,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/action_attempts', }, { - description: - 'An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.', + description: 'An unlock door action attempt succeeded.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22149,8 +22472,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22169,8 +22491,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/action_attempts', }, { - description: - 'An unlock door [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.', + description: 'An unlock door action attempt failed.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22214,8 +22535,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22235,7 +22555,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.', + 'A simulate keypad code entry action attempt succeeded.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22279,8 +22599,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22299,8 +22618,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/action_attempts', }, { - description: - 'A simulate keypad code entry [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.', + description: 'A simulate keypad code entry action attempt failed.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22344,8 +22662,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22365,7 +22682,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) succeeded.', + 'A simulate manual lock via keypad action attempt succeeded.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22411,8 +22728,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22432,7 +22748,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A simulate manual lock via keypad [action attempt](https://docs.seam.co/core-concepts/action-attempts) failed.', + 'A simulate manual lock via keypad action attempt failed.', properties: { action_attempt_id: { description: 'ID of the affected action attempt.', @@ -22476,8 +22792,7 @@ const openapi: OpenAPISpec = { }, status: { description: 'Status of the action.', type: 'string' }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22496,12 +22811,10 @@ const openapi: OpenAPISpec = { 'x-route-path': '/action_attempts', }, { - description: - 'A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login succeeded.', + description: 'A Connect Webview login succeeded.', properties: { connect_webview_id: { - description: - 'ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).', + description: 'ID of the affected Connect Webview.', format: 'uuid', type: 'string', }, @@ -22515,7 +22828,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -22544,8 +22857,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22563,12 +22875,10 @@ const openapi: OpenAPISpec = { 'x-route-path': '/connect_webviews', }, { - description: - 'A [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) login failed.', + description: 'A Connect Webview login failed.', properties: { connect_webview_id: { - description: - 'ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).', + description: 'ID of the affected Connect Webview.', format: 'uuid', type: 'string', }, @@ -22592,8 +22902,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22611,7 +22920,7 @@ const openapi: OpenAPISpec = { }, { description: - 'The status of a [device](https://docs.seam.co/core-concepts/devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.', + 'The status of a device changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -22623,7 +22932,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -22662,8 +22971,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22682,7 +22990,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [device](https://docs.seam.co/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.', + 'A device was added to Seam or was re-added to Seam after having been removed.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -22694,7 +23002,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -22733,8 +23041,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22765,7 +23072,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -22807,8 +23114,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22839,7 +23145,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -22881,8 +23187,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22913,7 +23218,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -22955,8 +23260,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -22975,7 +23279,7 @@ const openapi: OpenAPISpec = { }, { description: - 'The status of a [device](https://docs.seam.co/core-concepts/devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.', + 'The status of a device changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -22988,6 +23292,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -23013,13 +23319,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -23064,6 +23372,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -23095,6 +23405,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -23140,8 +23452,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23178,6 +23489,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -23203,13 +23516,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -23254,6 +23569,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -23285,6 +23602,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -23333,8 +23652,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23358,7 +23676,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [device](https://docs.seam.co/core-concepts/devices) detected that it was tampered with, for example, opened or moved.', + 'A device detected that it was tampered with, for example, opened or moved.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -23370,7 +23688,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23409,8 +23727,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23429,7 +23746,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [device](https://docs.seam.co/core-concepts/devices) battery level dropped below the low threshold.', + 'A device battery level dropped below the low threshold.', properties: { battery_level: { description: @@ -23449,7 +23766,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23488,8 +23805,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23509,7 +23825,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [device](https://docs.seam.co/core-concepts/devices) battery status changed since the last `battery_status_changed` event.', + 'A device battery status changed since the last `battery_status_changed` event.', properties: { battery_level: { description: @@ -23535,7 +23851,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23577,8 +23893,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23599,7 +23914,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [device](https://docs.seam.co/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/core-concepts/connected-accounts).', + 'A device was removed externally from the connected account.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -23611,7 +23926,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23650,8 +23965,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23669,8 +23983,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/devices', }, { - description: - 'A [device](https://docs.seam.co/core-concepts/devices) was deleted.', + description: 'A device was deleted.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -23682,7 +23995,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23727,8 +24040,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23747,7 +24059,7 @@ const openapi: OpenAPISpec = { }, { description: - 'Seam detected that a [device](https://docs.seam.co/core-concepts/devices) is using a third-party integration that will interfere with Seam device management.', + 'Seam detected that a device is using a third-party integration that will interfere with Seam device management.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -23759,7 +24071,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23801,8 +24113,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23821,7 +24132,7 @@ const openapi: OpenAPISpec = { }, { description: - 'Seam detected that a [device](https://docs.seam.co/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management.', + 'Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -23833,7 +24144,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23875,8 +24186,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23907,7 +24217,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -23949,8 +24259,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -23981,7 +24290,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -24023,8 +24332,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24042,8 +24350,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/devices', }, { - description: - 'Seam detected a flaky [device](https://docs.seam.co/core-concepts/devices) connection.', + description: 'Seam detected a flaky device connection.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -24056,6 +24363,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -24081,13 +24390,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -24132,6 +24443,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -24163,6 +24476,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -24201,8 +24516,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24225,7 +24539,7 @@ const openapi: OpenAPISpec = { }, { description: - 'Seam detected that a previously-flaky [device](https://docs.seam.co/core-concepts/devices) connection stabilized.', + 'Seam detected that a previously-flaky device connection stabilized.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -24237,7 +24551,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -24279,8 +24593,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24299,7 +24612,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A third-party subscription is required to use all [device](https://docs.seam.co/core-concepts/devices) features.', + 'A third-party subscription is required to use all device features.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -24312,6 +24625,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -24337,13 +24652,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -24388,6 +24705,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -24419,6 +24738,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -24457,8 +24778,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24481,7 +24801,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/core-concepts/devices) features.', + 'A third-party subscription is active or no longer required to use all device features.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -24493,7 +24813,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -24535,8 +24855,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24554,8 +24873,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/devices', }, { - description: - 'An accessory keypad was connected to a [device](https://docs.seam.co/core-concepts/devices).', + description: 'An accessory keypad was connected to a device.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -24567,7 +24885,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -24609,8 +24927,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24628,8 +24945,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/devices', }, { - description: - 'An accessory keypad was disconnected from a [device](https://docs.seam.co/core-concepts/devices).', + description: 'An accessory keypad was disconnected from a device.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -24642,6 +24958,8 @@ const openapi: OpenAPISpec = { connected_account_errors: { description: 'Errors associated with the connected account.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -24667,13 +24985,15 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, connected_account_warnings: { description: 'Warnings associated with the connected account.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -24718,6 +25038,8 @@ const openapi: OpenAPISpec = { device_errors: { description: 'Errors associated with the device.', items: { + description: + 'Error associated with the resource, including the error code, message, and creation timestamp.', properties: { created_at: { description: @@ -24749,6 +25071,8 @@ const openapi: OpenAPISpec = { device_warnings: { description: 'Warnings associated with the device.', items: { + description: + 'Warning associated with the resource, including the warning code, message, and creation timestamp.', properties: { created_at: { description: @@ -24787,8 +25111,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24823,7 +25146,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -24895,8 +25218,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -24944,7 +25266,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -24999,8 +25321,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25067,7 +25388,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -25128,8 +25449,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25156,81 +25476,24 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - connected_account_custom_metadata: { - additionalProperties: { - oneOf: [{ type: 'string' }, { type: 'boolean' }], - }, - description: - 'Custom metadata of the connected account, present when connected_account_id is provided.', - type: 'object', - }, - connected_account_id: { + acs_entrance_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + '\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the access-denied event.\n ', format: 'uuid', type: 'string', }, - created_at: { - description: 'Date and time at which the event was created.', - format: 'date-time', - type: 'string', - }, - customer_key: { - description: - 'The customer key associated with the device, if any.', - type: 'string', - }, - device_custom_metadata: { - additionalProperties: { - oneOf: [{ type: 'string' }, { type: 'boolean' }], - }, + acs_system_id: { description: - 'Custom metadata of the device, present when device_id is provided.', - type: 'object', - }, - device_id: { - description: 'ID of the affected device.', - format: 'uuid', - type: 'string', - }, - event_id: { - description: 'ID of the event.', + '\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the access-denied event.\n ', format: 'uuid', type: 'string', }, - event_type: { enum: ['lock.access_denied'], type: 'string' }, - occurred_at: { - description: 'Date and time at which the event occurred.', - format: 'date-time', - type: 'string', - }, - workspace_id: { + acs_user_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + '\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the access-denied event.\n ', format: 'uuid', type: 'string', }, - }, - required: [ - 'event_id', - 'workspace_id', - 'created_at', - 'occurred_at', - 'device_id', - 'connected_account_id', - 'event_type', - ], - type: 'object', - 'x-route-path': '/locks', - }, - { - description: - 'A thermostat [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.', - properties: { - climate_preset_key: { - description: 'Key of the climate preset that was activated.', - type: 'string', - }, connected_account_custom_metadata: { additionalProperties: { oneOf: [{ type: 'string' }, { type: 'boolean' }], @@ -25241,7 +25504,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -25273,30 +25536,20 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - event_type: { - enum: ['thermostat.climate_preset_activated'], - type: 'string', - }, - is_fallback_climate_preset: { - description: - 'Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat.', - type: 'boolean', - }, + event_type: { enum: ['lock.access_denied'], type: 'string' }, occurred_at: { description: 'Date and time at which the event occurred.', format: 'date-time', type: 'string', }, - thermostat_schedule_id: { + user_identity_id: { description: - 'ID of the thermostat schedule that prompted the affected climate preset to be activated.', + '\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the access-denied event.\n ', format: 'uuid', - nullable: true, type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25306,20 +25559,20 @@ const openapi: OpenAPISpec = { 'workspace_id', 'created_at', 'occurred_at', - 'device_id', 'connected_account_id', 'event_type', - 'thermostat_schedule_id', - 'climate_preset_key', - 'is_fallback_climate_preset', ], type: 'object', - 'x-route-path': '/thermostats', + 'x-route-path': '/locks', }, { description: - 'A [thermostat](https://docs.seam.co/capability-guides/thermostats) was adjusted manually.', + 'A thermostat [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.', properties: { + climate_preset_key: { + description: 'Key of the climate preset that was activated.', + type: 'string', + }, connected_account_custom_metadata: { additionalProperties: { oneOf: [{ type: 'string' }, { type: 'boolean' }], @@ -25330,22 +25583,110 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, - cooling_set_point_celsius: { - description: - 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', - format: 'float', - type: 'number', - }, - cooling_set_point_fahrenheit: { - description: - 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', - format: 'float', - type: 'number', - }, + created_at: { + description: 'Date and time at which the event was created.', + format: 'date-time', + type: 'string', + }, + customer_key: { + description: + 'The customer key associated with the device, if any.', + type: 'string', + }, + device_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the device, present when device_id is provided.', + type: 'object', + }, + device_id: { + description: 'ID of the affected device.', + format: 'uuid', + type: 'string', + }, + event_id: { + description: 'ID of the event.', + format: 'uuid', + type: 'string', + }, + event_type: { + enum: ['thermostat.climate_preset_activated'], + type: 'string', + }, + is_fallback_climate_preset: { + description: + 'Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat.', + type: 'boolean', + }, + occurred_at: { + description: 'Date and time at which the event occurred.', + format: 'date-time', + type: 'string', + }, + thermostat_schedule_id: { + description: + 'ID of the thermostat schedule that prompted the affected climate preset to be activated.', + format: 'uuid', + nullable: true, + type: 'string', + }, + workspace_id: { + description: 'ID of the workspace associated with the event.', + format: 'uuid', + type: 'string', + }, + }, + required: [ + 'event_id', + 'workspace_id', + 'created_at', + 'occurred_at', + 'device_id', + 'connected_account_id', + 'event_type', + 'thermostat_schedule_id', + 'climate_preset_key', + 'is_fallback_climate_preset', + ], + type: 'object', + 'x-route-path': '/thermostats', + }, + { + description: + 'A [thermostat](https://docs.seam.co/capability-guides/thermostats) was adjusted manually.', + properties: { + connected_account_custom_metadata: { + additionalProperties: { + oneOf: [{ type: 'string' }, { type: 'boolean' }], + }, + description: + 'Custom metadata of the connected account, present when connected_account_id is provided.', + type: 'object', + }, + connected_account_id: { + description: + 'ID of the connected account associated with the event.', + format: 'uuid', + type: 'string', + }, + cooling_set_point_celsius: { + description: + 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + format: 'float', + type: 'number', + }, + cooling_set_point_fahrenheit: { + description: + 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + format: 'float', + type: 'number', + }, created_at: { description: 'Date and time at which the event was created.', format: 'date-time', @@ -25414,8 +25755,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25447,7 +25787,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -25529,8 +25869,7 @@ const openapi: OpenAPISpec = { type: 'number', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25567,7 +25906,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -25649,8 +25988,7 @@ const openapi: OpenAPISpec = { type: 'number', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25687,7 +26025,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -25753,8 +26091,7 @@ const openapi: OpenAPISpec = { type: 'number', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25787,7 +26124,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -25841,8 +26178,7 @@ const openapi: OpenAPISpec = { type: 'number', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25862,8 +26198,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/thermostats', }, { - description: - 'The name of a [device](https://docs.seam.co/core-concepts/devices) was changed.', + description: 'The name of a device was changed.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -25875,7 +26210,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -25918,8 +26253,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -25939,7 +26273,7 @@ const openapi: OpenAPISpec = { }, { description: - 'A [camera](https://docs.seam.co/core-concepts/devices) was activated, for example, by motion detection.', + 'A camera was activated, for example, by motion detection.', properties: { activation_reason: { description: 'The reason the camera was activated.', @@ -25956,7 +26290,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -26012,8 +26346,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -26032,8 +26365,7 @@ const openapi: OpenAPISpec = { 'x-route-path': '/devices', }, { - description: - 'A doorbell button was pressed on a [device](https://docs.seam.co/core-concepts/devices).', + description: 'A doorbell button was pressed on a device.', properties: { connected_account_custom_metadata: { additionalProperties: { @@ -26045,7 +26377,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event.', + 'ID of the connected account associated with the event.', format: 'uuid', type: 'string', }, @@ -26096,8 +26428,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -26143,8 +26474,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -26193,8 +26523,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -26255,8 +26584,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -26319,8 +26647,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -26383,8 +26710,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.', + description: 'ID of the workspace associated with the event.', format: 'uuid', type: 'string', }, @@ -26411,7 +26737,7 @@ const openapi: OpenAPISpec = { properties: { client_session_id: { description: - 'ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key.', + 'ID of the client session associated with the Instant Key.', format: 'uuid', type: 'string', }, @@ -26468,8 +26794,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key.', + description: 'ID of the workspace that contains the Instant Key.', format: 'uuid', type: 'string', }, @@ -26510,8 +26835,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link.', + description: 'ID of the workspace associated with the magic link.', format: 'uuid', type: 'string', }, @@ -26622,7 +26946,8 @@ const openapi: OpenAPISpec = { type: 'string', }, device_type: { - description: 'Device type for phones.\n ', + description: + 'Type of the phone device, such as `ios_phone` or `android_phone`.', enum: ['ios_phone', 'android_phone'], type: 'string', }, @@ -26635,8 +26960,14 @@ const openapi: OpenAPISpec = { description: 'Errors associated with the phone.', items: { properties: { - error_code: { type: 'string' }, - message: { type: 'string' }, + error_code: { + description: 'Unique identifier of the type of error.', + type: 'string', + }, + message: { + description: 'Detailed description of the error.', + type: 'string', + }, }, required: ['error_code', 'message'], type: 'object', @@ -26649,7 +26980,7 @@ const openapi: OpenAPISpec = { type: 'string', }, properties: { - description: '\n Properties of the phone.\n ', + description: 'Properties of the phone.', properties: { assa_abloy_credential_service_metadata: { description: @@ -26703,8 +27034,14 @@ const openapi: OpenAPISpec = { description: 'Warnings associated with the phone.', items: { properties: { - message: { type: 'string' }, - warning_code: { type: 'string' }, + message: { + description: 'Detailed description of the warning.', + type: 'string', + }, + warning_code: { + description: 'Unique identifier of the type of warning.', + type: 'string', + }, }, required: ['warning_code', 'message'], type: 'object', @@ -26712,8 +27049,7 @@ const openapi: OpenAPISpec = { type: 'array', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone.\n ', + description: 'ID of the workspace that contains the phone.\n ', format: 'uuid', type: 'string', }, @@ -26787,6 +27123,8 @@ const openapi: OpenAPISpec = { }, acs_credential_id: { nullable: true, type: 'string' }, acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', format: 'uuid', type: 'string', }, @@ -27500,7 +27838,12 @@ const openapi: OpenAPISpec = { nullable: true, type: 'boolean', }, - is_managed: { enum: [true], type: 'boolean' }, + is_managed: { + description: + 'Indicates whether Seam manages the credential.', + enum: [true], + type: 'boolean', + }, is_multi_phone_sync_credential: { description: 'Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', @@ -27782,7 +28125,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -27856,7 +28199,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { minLength: 1, type: 'string' }, + display_name: { + description: 'Display name for the user identity.', + minLength: 1, + type: 'string', + }, email_address: { description: 'Unique email address for the user identity.', format: 'email', @@ -27912,12 +28259,19 @@ const openapi: OpenAPISpec = { 'acs_system_id', ], type: 'object', + 'x-resource-type': 'user_identity', }, ], }, type: 'array', }, - full_name: { minLength: 1, nullable: true, type: 'string' }, + full_name: { + description: + 'Full name of the user associated with the user identity.', + minLength: 1, + nullable: true, + type: 'string', + }, phone_number: { description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).', @@ -28000,7 +28354,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.', + 'ID of the workspace that contains the user identity.', format: 'uuid', type: 'string', }, @@ -28129,8 +28483,7 @@ const openapi: OpenAPISpec = { type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space.', + description: 'ID of the workspace associated with the space.', format: 'uuid', type: 'string', }, @@ -28285,7 +28638,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program.', + 'ID of the workspace that contains the thermostat daily program.', format: 'uuid', type: 'string', }, @@ -28382,7 +28735,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule.', + 'ID of the workspace that contains the thermostat schedule.', format: 'uuid', type: 'string', }, @@ -28533,74 +28886,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - }, - { - deprecated: true, - description: 'Failed to set code on SmartThings device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['smartthings_failed_to_set_access_code'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Handled by the generic `failed_to_set_on_device` system.', - }, - { - deprecated: true, - description: 'Failed to set code after multiple retries.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: [ - 'smartthings_failed_to_set_after_multiple_retries', - ], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Handled by the generic `failed_to_set_on_device` system.', + 'x-resource-type': 'access_code', }, { description: 'Failed to set code on device.', @@ -28631,6 +28917,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: 'Failed to remove code from device.', @@ -28661,6 +28948,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: 'Duplicate access code detected on device.', @@ -28703,6 +28991,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: @@ -28734,6 +29023,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: 'No space for access code on device.', @@ -28764,6 +29054,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: @@ -28795,74 +29086,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - }, - { - deprecated: true, - description: - 'Unable to confirm that the access code is set on Kwikset device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['kwikset_unable_to_confirm_code'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Use `access_code_state_unconfirmed` instead.', - }, - { - deprecated: true, - description: - 'Unable to confirm the deletion of the access code on Kwikset device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['kwikset_unable_to_confirm_deletion'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': - 'Use `access_code_state_unconfirmed` instead.', + 'x-resource-type': 'access_code', }, { description: @@ -28926,102 +29150,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - }, - { - deprecated: true, - description: 'Invalid code length for August lock.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_invalid_code_length'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', - }, - { - deprecated: true, - description: 'August lock is missing a keypad.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_missing_keypad'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', - }, - { - deprecated: true, - description: 'August lock is temporarily offline.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_temporarily_offline'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-resource-type': 'access_code', }, { description: @@ -29053,6 +29182,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { deprecated: true, @@ -29085,103 +29215,7 @@ const openapi: OpenAPISpec = { required: ['message', 'is_access_code_error', 'error_code'], type: 'object', 'x-deprecated': 'Use `access_code_inactive` instead.', - }, - { - deprecated: true, - description: 'Duplicate access code name detected.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['wyze_duplicate_code_name'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': 'Use `duplicate_code_on_device` instead.', - }, - { - deprecated: true, - description: 'Potential duplicate access code detected.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['wyze_potential_duplicate_code'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': 'Use `duplicate_code_on_device` instead.', - }, - { - deprecated: true, - description: - 'No Dormakaba Oracode user levels configured for the requested time range.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['dormakaba_oracode_invalid_time_range'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-resource-type': 'access_code', }, { description: @@ -29213,38 +29247,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', - }, - { - deprecated: true, - description: 'KeyNest locker is not supported.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['keynest_unsupported_third_party_locker'], - type: 'string', - }, - is_access_code_error: { - description: - 'Indicates that this is an access code error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['message', 'is_access_code_error', 'error_code'], - type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', + 'x-resource-type': 'access_code', }, { description: @@ -29276,6 +29279,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'is_access_code_error', 'error_code'], type: 'object', + 'x-resource-type': 'access_code', }, { description: 'Indicates that the account is disconnected.', @@ -29318,6 +29322,7 @@ const openapi: OpenAPISpec = { 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'connected_account', }, { description: @@ -29361,11 +29366,12 @@ const openapi: OpenAPISpec = { 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'connected_account', 'x-variant-group-key': 'locks', }, { - deprecated: true, - description: 'Indicates that the device is offline.', + description: + 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', properties: { created_at: { description: @@ -29376,49 +29382,19 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_offline'], + enum: ['dormakaba_sites_disconnected'], type: 'string', }, - is_device_error: { + is_connected_account_error: { description: - 'Indicates that the error is a device error.', + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', enum: [true], type: 'boolean', }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - 'x-deprecated': 'Use `device_disconnected` instead.', - }, - { - description: 'Indicates that the device has been removed.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_removed'], - type: 'string', - }, is_device_error: { description: - 'Indicates that the error is a device error.', - enum: [true], + 'Indicates that the error is not a device error.', + enum: [false], type: 'boolean', }, message: { @@ -29432,11 +29408,15 @@ const openapi: OpenAPISpec = { 'is_device_error', 'created_at', 'error_code', + 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'connected_account', + 'x-variant-group-key': 'locks', }, { - description: 'Indicates that the hub is disconnected.', + deprecated: true, + description: 'Indicates that the device is offline.', properties: { created_at: { description: @@ -29447,7 +29427,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['hub_disconnected'], + enum: ['device_offline'], type: 'string', }, is_device_error: { @@ -29469,9 +29449,11 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-deprecated': 'Use `device_disconnected` instead.', + 'x-resource-type': 'device', }, { - description: 'Indicates that the device is disconnected.', + description: 'Indicates that the device has been removed.', properties: { created_at: { description: @@ -29482,7 +29464,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['device_disconnected'], + enum: ['device_removed'], type: 'string', }, is_device_error: { @@ -29504,10 +29486,10 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { - description: - 'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.', + description: 'Indicates that the hub is disconnected.', properties: { created_at: { description: @@ -29518,7 +29500,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['empty_backup_access_code_pool'], + enum: ['hub_disconnected'], type: 'string', }, is_device_error: { @@ -29540,11 +29522,10 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-variant-group-key': 'access_codes', + 'x-resource-type': 'device', }, { - description: - 'Indicates that the user is not authorized to use the August lock.', + description: 'Indicates that the device is disconnected.', properties: { created_at: { description: @@ -29555,7 +29536,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_not_authorized'], + enum: ['device_disconnected'], type: 'string', }, is_device_error: { @@ -29577,12 +29558,11 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-variant-group-key': 'locks', + 'x-resource-type': 'device', }, { - deprecated: true, description: - 'Indicates that the lock is not connected to a bridge.', + 'Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.', properties: { created_at: { description: @@ -29593,7 +29573,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_missing_bridge'], + enum: ['empty_backup_access_code_pool'], type: 'string', }, is_device_error: { @@ -29615,84 +29595,12 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-deprecated': 'Use `hub_disconnected` instead.', - 'x-variant-group-key': 'locks', + 'x-resource-type': 'device', + 'x-variant-group-key': 'access_codes', }, { - deprecated: true, description: - 'Indicates that the lock is not paired with a gateway.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['ttlock_lock_not_paired_to_gateway'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - 'x-deprecated': 'Use `hub_disconnected` instead.', - }, - { - description: 'Indicates that device credentials are missing.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['missing_device_credentials'], - type: 'string', - }, - is_device_error: { - description: - 'Indicates that the error is a device error.', - enum: [true], - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: [ - 'message', - 'is_device_error', - 'created_at', - 'error_code', - ], - type: 'object', - }, - { - description: 'Indicates that the auxiliary heat is running.', + 'Indicates that the user is not authorized to use the August lock.', properties: { created_at: { description: @@ -29703,7 +29611,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['auxiliary_heat_running'], + enum: ['august_lock_not_authorized'], type: 'string', }, is_device_error: { @@ -29725,11 +29633,13 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', - 'x-variant-group-key': 'thermostats', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { + deprecated: true, description: - 'Indicates that a subscription is required to connect.', + 'Indicates that the lock is not connected to a bridge.', properties: { created_at: { description: @@ -29740,7 +29650,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['subscription_required'], + enum: ['august_lock_missing_bridge'], type: 'string', }, is_device_error: { @@ -29762,11 +29672,14 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { deprecated: true, description: - 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.', + 'Indicates that the lock is not paired with a gateway.', properties: { created_at: { description: @@ -29777,7 +29690,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['lockly_missing_wifi_bridge'], + enum: ['ttlock_lock_not_paired_to_gateway'], type: 'string', }, is_device_error: { @@ -29800,10 +29713,85 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', + }, + { + description: 'Indicates that device credentials are missing.', + properties: { + created_at: { + description: + 'Date and time at which Seam created the error.', + format: 'date-time', + type: 'string', + }, + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['missing_device_credentials'], + type: 'string', + }, + is_device_error: { + description: + 'Indicates that the error is a device error.', + enum: [true], + type: 'boolean', + }, + message: { + description: + 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + type: 'string', + }, + }, + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], + type: 'object', + 'x-resource-type': 'device', + }, + { + description: 'Indicates that the auxiliary heat is running.', + properties: { + created_at: { + description: + 'Date and time at which Seam created the error.', + format: 'date-time', + type: 'string', + }, + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['auxiliary_heat_running'], + type: 'string', + }, + is_device_error: { + description: + 'Indicates that the error is a device error.', + enum: [true], + type: 'boolean', + }, + message: { + description: + 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + type: 'string', + }, + }, + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], + type: 'object', + 'x-resource-type': 'device', + 'x-variant-group-key': 'thermostats', }, { description: - 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', + 'Indicates that a subscription is required to connect.', properties: { created_at: { description: @@ -29814,17 +29802,51 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['bridge_disconnected'], + enum: ['subscription_required'], type: 'string', }, - is_bridge_error: { + is_device_error: { description: - 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).', + 'Indicates that the error is a device error.', + enum: [true], type: 'boolean', }, - is_connected_account_error: { + message: { description: - 'Indicates whether the error is related specifically to the connected account.', + 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + type: 'string', + }, + }, + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], + type: 'object', + 'x-resource-type': 'device', + }, + { + deprecated: true, + description: + 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.', + properties: { + created_at: { + description: + 'Date and time at which Seam created the error.', + format: 'date-time', + type: 'string', + }, + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['lockly_missing_wifi_bridge'], + type: 'string', + }, + is_device_error: { + description: + 'Indicates that the error is a device error.', + enum: [true], type: 'boolean', }, message: { @@ -29833,12 +29855,20 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['created_at', 'message', 'error_code'], + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + ], type: 'object', + 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { description: - 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', + 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', properties: { created_at: { description: @@ -29849,7 +29879,7 @@ const openapi: OpenAPISpec = { error_code: { description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['dormakaba_sites_disconnected'], + enum: ['bridge_disconnected'], type: 'string', }, is_bridge_error: { @@ -29870,6 +29900,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'connected_account', }, ], }, @@ -29947,30 +29978,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - description: 'Failed to set code on SmartThings device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['smartthings_failed_to_set_access_code'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - }, { deprecated: true, description: 'Duplicate access code detected.', @@ -29998,33 +30005,6 @@ const openapi: OpenAPISpec = { 'x-deprecated': 'Use `duplicate_code_on_device` error instead.', }, - { - deprecated: true, - description: - 'Received an error when attempting to create this code.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['schlage_creation_outage'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - 'x-deprecated': 'Use `provider_issue` instead.', - }, { description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.", @@ -30180,30 +30160,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - description: 'August lock is temporarily offline.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['august_lock_temporarily_offline'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - }, { description: 'Algopins must be used within 24 hours.', properties: { @@ -30253,31 +30209,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - description: - 'Unable to confirm that the access code is set on Kwikset device.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['kwikset_unable_to_confirm_code'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - }, { description: 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.', @@ -30303,33 +30234,6 @@ const openapi: OpenAPISpec = { required: ['message', 'warning_code'], type: 'object', }, - { - deprecated: true, - description: - 'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the warning.', - format: 'date-time', - type: 'string', - }, - message: { - description: - 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - warning_code: { - description: - 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - enum: ['ultraloq_access_code_disabled'], - type: 'string', - }, - }, - required: ['message', 'warning_code'], - type: 'object', - 'x-deprecated': 'Use `access_code_inactive` instead.', - }, { description: 'A backup access code has been pulled and is being used in place of this access code.', @@ -30471,7 +30375,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group.', + 'ID of the connected account that contains the access group.', format: 'uuid', type: 'string', }, @@ -30480,7 +30384,10 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { type: 'string' }, + display_name: { + description: 'Display name for the access group.', + type: 'string', + }, errors: { description: 'Errors associated with the `acs_access_group`.', items: { @@ -30511,6 +30418,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_access_group', }, ], }, @@ -30954,8 +30862,7 @@ const openapi: OpenAPISpec = { type: 'array', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group.', + description: 'ID of the workspace that contains the access group.', format: 'uuid', type: 'string', }, @@ -30997,7 +30904,12 @@ const openapi: OpenAPISpec = { format: 'uuid', type: 'string', }, - acs_credential_pool_id: { format: 'uuid', type: 'string' }, + acs_credential_pool_id: { + description: + 'ID of the credential pool to which the credential belongs.', + format: 'uuid', + type: 'string', + }, acs_system_id: { description: 'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', @@ -31386,7 +31298,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', + 'ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).', format: 'uuid', type: 'string', }, @@ -31446,7 +31358,7 @@ const openapi: OpenAPISpec = { }, connected_account_id: { description: - '\n The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).\n ', + '\n The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).\n ', format: 'uuid', type: 'string', }, @@ -31503,6 +31415,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -31526,6 +31439,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -31549,6 +31463,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -31572,6 +31487,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -31595,6 +31511,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, { description: @@ -31618,6 +31535,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', + 'x-resource-type': 'acs_user', }, ], }, @@ -31649,7 +31567,12 @@ const openapi: OpenAPISpec = { minLength: 1, type: 'string', }, - hid_acs_system_id: { format: 'uuid', type: 'string' }, + hid_acs_system_id: { + description: + 'ID of the HID access control system associated with the user.', + format: 'uuid', + type: 'string', + }, is_managed: { enum: [false], type: 'boolean' }, is_suspended: { description: @@ -32240,7 +32163,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).', + 'ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).', format: 'uuid', type: 'string', }, @@ -32265,30 +32188,103 @@ const openapi: OpenAPISpec = { description: 'Represents an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).', properties: { - can_configure_auto_lock: { type: 'boolean' }, - can_hvac_cool: { type: 'boolean' }, - can_hvac_heat: { type: 'boolean' }, - can_hvac_heat_cool: { type: 'boolean' }, - can_program_offline_access_codes: { type: 'boolean' }, - can_program_online_access_codes: { type: 'boolean' }, + can_configure_auto_lock: { + description: + 'Indicates whether the lock supports configuring automatic locking.', + type: 'boolean', + }, + can_hvac_cool: { + description: 'Indicates whether the thermostat supports cooling.', + type: 'boolean', + }, + can_hvac_heat: { + description: 'Indicates whether the thermostat supports heating.', + type: 'boolean', + }, + can_hvac_heat_cool: { + description: + 'Indicates whether the thermostat supports simultaneous heating and cooling.', + type: 'boolean', + }, + can_program_offline_access_codes: { + description: + 'Indicates whether the device supports programming offline access codes.', + type: 'boolean', + }, + can_program_online_access_codes: { + description: + 'Indicates whether the device supports programming online access codes.', + type: 'boolean', + }, can_program_thermostat_programs_as_different_each_day: { + description: + 'Indicates whether the thermostat supports different climate programs for each day of the week.', + type: 'boolean', + }, + can_program_thermostat_programs_as_same_each_day: { + description: + 'Indicates whether the thermostat supports a single climate program applied to every day.', type: 'boolean', }, - can_program_thermostat_programs_as_same_each_day: { type: 'boolean' }, can_program_thermostat_programs_as_weekday_weekend: { + description: + 'Indicates whether the thermostat supports weekday/weekend climate programs.', + type: 'boolean', + }, + can_remotely_lock: { + description: + 'Indicates whether the device supports remote locking.', + type: 'boolean', + }, + can_remotely_unlock: { + description: + 'Indicates whether the device supports remote unlocking.', + type: 'boolean', + }, + can_run_thermostat_programs: { + description: + 'Indicates whether the thermostat supports running climate programs.', + type: 'boolean', + }, + can_simulate_connection: { + description: + 'Indicates whether the device supports simulating connection in a sandbox.', + type: 'boolean', + }, + can_simulate_disconnection: { + description: + 'Indicates whether the device supports simulating disconnection in a sandbox.', + type: 'boolean', + }, + can_simulate_hub_connection: { + description: + 'Indicates whether the hub supports simulating connection in a sandbox.', + type: 'boolean', + }, + can_simulate_hub_disconnection: { + description: + 'Indicates whether the hub supports simulating disconnection in a sandbox.', + type: 'boolean', + }, + can_simulate_paid_subscription: { + description: + 'Indicates whether the device supports simulating a paid subscription in a sandbox.', + type: 'boolean', + }, + can_simulate_removal: { + description: + 'Indicates whether the device supports simulating removal in a sandbox.', + type: 'boolean', + }, + can_turn_off_hvac: { + description: 'Indicates whether the thermostat can be turned off.', + type: 'boolean', + }, + can_unlock_with_code: { + description: + 'Indicates whether the lock supports unlocking with an access code.', type: 'boolean', }, - can_remotely_lock: { type: 'boolean' }, - can_remotely_unlock: { type: 'boolean' }, - can_run_thermostat_programs: { type: 'boolean' }, - can_simulate_connection: { type: 'boolean' }, - can_simulate_disconnection: { type: 'boolean' }, - can_simulate_hub_connection: { type: 'boolean' }, - can_simulate_hub_disconnection: { type: 'boolean' }, - can_simulate_paid_subscription: { type: 'boolean' }, - can_simulate_removal: { type: 'boolean' }, - can_turn_off_hvac: { type: 'boolean' }, - can_unlock_with_code: { type: 'boolean' }, capabilities_supported: { description: '\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).\n ', @@ -32450,6 +32446,7 @@ const openapi: OpenAPISpec = { 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'connected_account', }, { description: @@ -32493,6 +32490,52 @@ const openapi: OpenAPISpec = { 'is_connected_account_error', ], type: 'object', + 'x-resource-type': 'connected_account', + 'x-variant-group-key': 'locks', + }, + { + description: + 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', + properties: { + created_at: { + description: + 'Date and time at which Seam created the error.', + format: 'date-time', + type: 'string', + }, + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['dormakaba_sites_disconnected'], + type: 'string', + }, + is_connected_account_error: { + description: + 'Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.', + enum: [true], + type: 'boolean', + }, + is_device_error: { + description: + 'Indicates that the error is not a device error.', + enum: [false], + type: 'boolean', + }, + message: { + description: + 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + type: 'string', + }, + }, + required: [ + 'message', + 'is_device_error', + 'created_at', + 'error_code', + 'is_connected_account_error', + ], + type: 'object', + 'x-resource-type': 'connected_account', 'x-variant-group-key': 'locks', }, { @@ -32531,6 +32574,7 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `device_disconnected` instead.', + 'x-resource-type': 'device', }, { description: 'Indicates that the device has been removed.', @@ -32566,6 +32610,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { description: 'Indicates that the hub is disconnected.', @@ -32601,6 +32646,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { description: 'Indicates that the device is disconnected.', @@ -32636,6 +32682,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { description: @@ -32672,6 +32719,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', 'x-variant-group-key': 'access_codes', }, { @@ -32709,6 +32757,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', 'x-variant-group-key': 'locks', }, { @@ -32748,6 +32797,7 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', 'x-variant-group-key': 'locks', }, { @@ -32787,6 +32837,8 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { description: 'Indicates that device credentials are missing.', @@ -32822,6 +32874,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { description: 'Indicates that the auxiliary heat is running.', @@ -32857,6 +32910,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', 'x-variant-group-key': 'thermostats', }, { @@ -32894,6 +32948,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'device', }, { deprecated: true, @@ -32932,6 +32987,8 @@ const openapi: OpenAPISpec = { ], type: 'object', 'x-deprecated': 'Use `hub_disconnected` instead.', + 'x-resource-type': 'device', + 'x-variant-group-key': 'locks', }, { description: @@ -32967,41 +33024,7 @@ const openapi: OpenAPISpec = { }, required: ['created_at', 'message', 'error_code'], type: 'object', - }, - { - description: - 'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.', - properties: { - created_at: { - description: - 'Date and time at which Seam created the error.', - format: 'date-time', - type: 'string', - }, - error_code: { - description: - 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - enum: ['dormakaba_sites_disconnected'], - type: 'string', - }, - is_bridge_error: { - description: - 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).', - type: 'boolean', - }, - is_connected_account_error: { - description: - 'Indicates whether the error is related specifically to the connected account.', - type: 'boolean', - }, - message: { - description: - 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - type: 'string', - }, - }, - required: ['created_at', 'message', 'error_code'], - type: 'object', + 'x-resource-type': 'connected_account', }, ], }, @@ -33016,7 +33039,11 @@ const openapi: OpenAPISpec = { thermostats: { name: 'Thermostats' }, }, }, - is_managed: { enum: [false], type: 'boolean' }, + is_managed: { + description: 'Indicates that Seam does not manage the device.', + enum: [false], + type: 'boolean', + }, location: { description: 'Location information for the device.', properties: { @@ -33285,6 +33312,7 @@ const openapi: OpenAPISpec = { type: 'object', 'x-deprecated': 'Use `hub_disconnected` device error instead.', + 'x-variant-group-key': 'locks', }, { description: @@ -33338,8 +33366,7 @@ const openapi: OpenAPISpec = { 'x-variant-group-key': 'locks', }, { - description: - '\n Indicates that the gateway signal is weak.\n ', + description: 'Indicates that the gateway signal is weak.', properties: { created_at: { description: @@ -33361,6 +33388,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -33565,6 +33593,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -33642,6 +33671,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -33667,6 +33697,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -33692,6 +33723,7 @@ const openapi: OpenAPISpec = { }, required: ['message', 'created_at', 'warning_code'], type: 'object', + 'x-variant-group-key': 'locks', }, { description: @@ -33952,7 +33984,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { minLength: 1, type: 'string' }, + display_name: { + description: 'Display name for the user identity.', + minLength: 1, + type: 'string', + }, email_address: { description: 'Unique email address for the user identity.', format: 'email', @@ -34008,12 +34044,19 @@ const openapi: OpenAPISpec = { 'acs_system_id', ], type: 'object', + 'x-resource-type': 'user_identity', }, ], }, type: 'array', }, - full_name: { minLength: 1, nullable: true, type: 'string' }, + full_name: { + description: + 'Full name of the user associated with the user identity.', + minLength: 1, + nullable: true, + type: 'string', + }, phone_number: { description: 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).', @@ -34093,8 +34136,7 @@ const openapi: OpenAPISpec = { type: 'array', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.', + description: 'ID of the workspace that contains the user identity.', format: 'uuid', type: 'string', }, @@ -34135,11 +34177,7 @@ const openapi: OpenAPISpec = { 'URL for the [webhook](https://docs.seam.co/developer-tools/webhooks).', type: 'string', }, - webhook_id: { - description: - 'ID of the [webhook](https://docs.seam.co/developer-tools/webhooks).', - type: 'string', - }, + webhook_id: { description: 'ID of the webhook.', type: 'string' }, }, required: ['webhook_id', 'url'], type: 'object', @@ -34211,14 +34249,20 @@ const openapi: OpenAPISpec = { 'Name of the [workspace](https://docs.seam.co/core-concepts/workspaces).', type: 'string', }, + organization_id: { + description: + 'ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.', + format: 'uuid', + nullable: true, + type: 'string', + }, publishable_key: { description: 'Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.', type: 'string', }, workspace_id: { - description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces).', + description: 'ID of the workspace.', format: 'uuid', type: 'string', }, @@ -34232,6 +34276,7 @@ const openapi: OpenAPISpec = { 'is_suspended', 'connect_partner_name', 'is_publishable_key_auth_enabled', + 'organization_id', ], type: 'object', 'x-route-path': '/workspaces', @@ -34358,7 +34403,6 @@ const openapi: OpenAPISpec = { type: 'boolean', }, max_time_rounding: { - default: '1hour', description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.', enum: ['1hour', '1day', '1h', '1d'], @@ -36797,7 +36841,6 @@ const openapi: OpenAPISpec = { type: 'boolean', }, max_time_rounding: { - default: '1hour', description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.', enum: ['1hour', '1day', '1h', '1d'], @@ -36951,7 +36994,6 @@ const openapi: OpenAPISpec = { type: 'boolean', }, max_time_rounding: { - default: '1hour', description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.', enum: ['1hour', '1day', '1h', '1d'], @@ -37105,7 +37147,6 @@ const openapi: OpenAPISpec = { type: 'boolean', }, max_time_rounding: { - default: '1hour', description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.', enum: ['1hour', '1day', '1h', '1d'], @@ -37369,6 +37410,8 @@ const openapi: OpenAPISpec = { type: 'string', }, full_name: { + description: + 'Full name of the user associated with the user identity.', minLength: 1, nullable: true, type: 'string', @@ -38505,6 +38548,8 @@ const openapi: OpenAPISpec = { discriminator: { propertyName: 'error_code' }, oneOf: [ { + description: + 'Indicates that Seam could not create one or more of the requested access methods for the access grant.', properties: { created_at: { description: @@ -38538,6 +38583,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'access_grant', }, ], }, @@ -39214,6 +39260,8 @@ const openapi: OpenAPISpec = { discriminator: { propertyName: 'error_code' }, oneOf: [ { + description: + 'Indicates that Seam could not create one or more of the requested access methods for the access grant.', properties: { created_at: { description: @@ -39247,6 +39295,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'access_grant', }, ], }, @@ -39969,6 +40018,8 @@ const openapi: OpenAPISpec = { discriminator: { propertyName: 'error_code' }, oneOf: [ { + description: + 'Indicates that Seam could not create one or more of the requested access methods for the access grant.', properties: { created_at: { description: @@ -40002,6 +40053,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'access_grant', }, ], }, @@ -40716,6 +40768,8 @@ const openapi: OpenAPISpec = { discriminator: { propertyName: 'error_code' }, oneOf: [ { + description: + 'Indicates that Seam could not create one or more of the requested access methods for the access grant.', properties: { created_at: { description: @@ -40749,6 +40803,7 @@ const openapi: OpenAPISpec = { 'error_code', ], type: 'object', + 'x-resource-type': 'access_grant', }, ], }, @@ -41502,10 +41557,17 @@ const openapi: OpenAPISpec = { schema: { properties: { access_grant_id: { - description: 'ID of the Access Grant to update.', + description: + 'ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.', format: 'uuid', type: 'string', }, + access_grant_key: { + description: + 'Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.', + minLength: 1, + type: 'string', + }, ends_at: { description: 'Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.', @@ -41525,7 +41587,6 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['access_grant_id'], type: 'object', }, }, @@ -41569,10 +41630,17 @@ const openapi: OpenAPISpec = { schema: { properties: { access_grant_id: { - description: 'ID of the Access Grant to update.', + description: + 'ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.', format: 'uuid', type: 'string', }, + access_grant_key: { + description: + 'Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.', + minLength: 1, + type: 'string', + }, ends_at: { description: 'Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.', @@ -41592,7 +41660,6 @@ const openapi: OpenAPISpec = { type: 'string', }, }, - required: ['access_grant_id'], type: 'object', }, }, @@ -50618,7 +50685,12 @@ const openapi: OpenAPISpec = { minLength: 1, type: 'string', }, - hid_acs_system_id: { format: 'uuid', type: 'string' }, + hid_acs_system_id: { + description: + 'ID of the HID access control system associated with the user.', + format: 'uuid', + type: 'string', + }, phone_number: { description: 'Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).', @@ -50724,7 +50796,12 @@ const openapi: OpenAPISpec = { minLength: 1, type: 'string', }, - hid_acs_system_id: { format: 'uuid', type: 'string' }, + hid_acs_system_id: { + description: + 'ID of the HID access control system associated with the user.', + format: 'uuid', + type: 'string', + }, phone_number: { description: 'Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).', @@ -51084,7 +51161,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge.', + 'ID of the workspace that contains Seam Bridge.', format: 'uuid', type: 'string', }, @@ -51164,7 +51241,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge.', + 'ID of the workspace that contains Seam Bridge.', format: 'uuid', type: 'string', }, @@ -51231,7 +51308,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge.', + 'ID of the workspace that contains Seam Bridge.', format: 'uuid', type: 'string', }, @@ -51302,7 +51379,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge.', + 'ID of the workspace that contains Seam Bridge.', format: 'uuid', type: 'string', }, @@ -60792,6 +60869,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -60906,6 +60987,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -61353,6 +61438,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -61463,6 +61552,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -71731,6 +71824,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -71846,6 +71943,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -72024,6 +72125,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -72134,6 +72239,10 @@ const openapi: OpenAPISpec = { enum: [ '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', @@ -72398,7 +72507,7 @@ const openapi: OpenAPISpec = { MANAGE_DEVICES_CONFIRMATION_MODAL: { type: 'boolean', }, - RESERVATION_UI_V2: { type: 'boolean' }, + RESERVATION_LEGACY: { type: 'boolean' }, SALTO_KS_ENTRANCES_ONLY_FOR_SPACES: { type: 'boolean', }, @@ -72855,7 +72964,7 @@ const openapi: OpenAPISpec = { MANAGE_DEVICES_CONFIRMATION_MODAL: { type: 'boolean', }, - RESERVATION_UI_V2: { type: 'boolean' }, + RESERVATION_LEGACY: { type: 'boolean' }, SALTO_KS_ENTRANCES_ONLY_FOR_SPACES: { type: 'boolean', }, @@ -81946,6 +82055,8 @@ const openapi: OpenAPISpec = { }, fan_mode: { deprecated: true, + description: + 'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.', enum: ['auto', 'on', 'circulate'], type: 'string', 'x-deprecated': 'Use `fan_mode_setting` instead.', @@ -85458,7 +85569,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { minLength: 1, type: 'string' }, + display_name: { + description: 'Display name for the user identity.', + minLength: 1, + type: 'string', + }, email_address: { description: 'Unique email address for the user identity.', @@ -85516,12 +85631,15 @@ const openapi: OpenAPISpec = { 'acs_system_id', ], type: 'object', + 'x-resource-type': 'user_identity', }, ], }, type: 'array', }, full_name: { + description: + 'Full name of the user associated with the user identity.', minLength: 1, nullable: true, type: 'string', @@ -85611,7 +85729,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.', + 'ID of the workspace that contains the user identity.', format: 'uuid', type: 'string', }, @@ -85701,7 +85819,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { minLength: 1, type: 'string' }, + display_name: { + description: 'Display name for the user identity.', + minLength: 1, + type: 'string', + }, email_address: { description: 'Unique email address for the user identity.', @@ -85759,12 +85881,15 @@ const openapi: OpenAPISpec = { 'acs_system_id', ], type: 'object', + 'x-resource-type': 'user_identity', }, ], }, type: 'array', }, full_name: { + description: + 'Full name of the user associated with the user identity.', minLength: 1, nullable: true, type: 'string', @@ -85854,7 +85979,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.', + 'ID of the workspace that contains the user identity.', format: 'uuid', type: 'string', }, @@ -85972,7 +86097,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { minLength: 1, type: 'string' }, + display_name: { + description: 'Display name for the user identity.', + minLength: 1, + type: 'string', + }, email_address: { description: 'Unique email address for the user identity.', @@ -86030,12 +86159,15 @@ const openapi: OpenAPISpec = { 'acs_system_id', ], type: 'object', + 'x-resource-type': 'user_identity', }, ], }, type: 'array', }, full_name: { + description: + 'Full name of the user associated with the user identity.', minLength: 1, nullable: true, type: 'string', @@ -86125,7 +86257,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.', + 'ID of the workspace that contains the user identity.', format: 'uuid', type: 'string', }, @@ -86238,7 +86370,11 @@ const openapi: OpenAPISpec = { format: 'date-time', type: 'string', }, - display_name: { minLength: 1, type: 'string' }, + display_name: { + description: 'Display name for the user identity.', + minLength: 1, + type: 'string', + }, email_address: { description: 'Unique email address for the user identity.', @@ -86296,12 +86432,15 @@ const openapi: OpenAPISpec = { 'acs_system_id', ], type: 'object', + 'x-resource-type': 'user_identity', }, ], }, type: 'array', }, full_name: { + description: + 'Full name of the user associated with the user identity.', minLength: 1, nullable: true, type: 'string', @@ -86391,7 +86530,7 @@ const openapi: OpenAPISpec = { }, workspace_id: { description: - 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity.', + 'ID of the workspace that contains the user identity.', format: 'uuid', type: 'string', }, @@ -87316,6 +87455,13 @@ const openapi: OpenAPISpec = { }, type: 'object', }, + message_overrides: { + additionalProperties: { + additionalProperties: { type: 'string' }, + type: 'object', + }, + type: 'object', + }, name: { default: null, nullable: true, type: 'string' }, primary_color: { type: 'string' }, secondary_color: { type: 'string' }, @@ -87598,6 +87744,14 @@ const openapi: OpenAPISpec = { type: 'object', }, customization_profile_id: { format: 'uuid', type: 'string' }, + message_overrides: { + additionalProperties: { + additionalProperties: { type: 'string' }, + type: 'object', + }, + nullable: true, + type: 'object', + }, name: { nullable: true, type: 'string' }, primary_color: { type: 'string' }, secondary_color: { type: 'string' }, @@ -87659,6 +87813,14 @@ const openapi: OpenAPISpec = { type: 'object', }, customization_profile_id: { format: 'uuid', type: 'string' }, + message_overrides: { + additionalProperties: { + additionalProperties: { type: 'string' }, + type: 'object', + }, + nullable: true, + type: 'object', + }, name: { nullable: true, type: 'string' }, primary_color: { type: 'string' }, secondary_color: { type: 'string' }, @@ -88450,6 +88612,12 @@ const openapi: OpenAPISpec = { description: 'Name of the workspace.', type: 'string', }, + organization_id: { + description: + 'ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.', + format: 'uuid', + type: 'string', + }, }, type: 'object', }, @@ -88532,6 +88700,12 @@ const openapi: OpenAPISpec = { description: 'Name of the workspace.', type: 'string', }, + organization_id: { + description: + 'ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.', + format: 'uuid', + type: 'string', + }, }, type: 'object', }, diff --git a/src/lib/seam/connect/route-types.ts b/src/lib/seam/connect/route-types.ts index 4ce68403..2e1a59cd 100644 --- a/src/lib/seam/connect/route-types.ts +++ b/src/lib/seam/connect/route-types.ts @@ -43,7 +43,7 @@ export type Routes = { /** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */ is_one_time_use?: boolean | undefined /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */ - max_time_rounding?: '1hour' | '1day' | '1h' | '1d' + max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined } commonParams: {} formData: {} @@ -161,6 +161,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -210,6 +211,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -254,7 +256,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -366,6 +368,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -377,6 +380,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -421,7 +425,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -624,6 +628,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -664,7 +669,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -774,6 +779,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -785,6 +791,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -825,7 +832,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -1037,6 +1044,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -1077,7 +1085,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -1187,6 +1195,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -2013,26 +2022,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2097,26 +2086,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2140,36 +2109,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2190,36 +2129,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2238,17 +2147,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -2258,7 +2169,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -2270,7 +2181,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -2406,18 +2317,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -2429,14 +2328,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2445,14 +2336,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2506,14 +2389,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2530,14 +2405,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2546,14 +2413,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2774,26 +2633,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2858,26 +2697,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2901,36 +2720,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2951,36 +2740,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -2999,17 +2758,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -3019,7 +2780,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -3031,7 +2792,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -3167,18 +2928,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -3190,14 +2939,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -3206,14 +2947,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -3267,14 +3000,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -3291,14 +3016,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -3307,14 +3024,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -3592,6 +3301,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -3641,6 +3351,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -3685,7 +3396,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -3797,6 +3508,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -3808,6 +3520,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -3852,7 +3565,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -4055,6 +3768,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -4095,7 +3809,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -4205,6 +3919,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -4216,6 +3931,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -4256,7 +3972,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -4468,6 +4184,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -4508,7 +4225,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -4618,6 +4335,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -5480,26 +5198,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -5564,26 +5262,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -5607,36 +5285,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -5657,36 +5305,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -5705,17 +5323,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -5725,7 +5345,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -5737,7 +5357,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -5873,18 +5493,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -5896,14 +5504,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -5912,14 +5512,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -5973,14 +5565,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -5997,14 +5581,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6013,14 +5589,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6328,26 +5896,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6412,26 +5960,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6455,36 +5983,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6505,36 +6003,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6545,16 +6013,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'insufficient_permissions' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6589,6 +6047,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6721,18 +6191,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -6744,14 +6202,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6760,14 +6210,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6821,14 +6263,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6845,14 +6279,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -6861,14 +6287,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7080,26 +6498,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7164,26 +6562,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7207,36 +6585,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7257,36 +6605,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7305,17 +6623,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -7325,7 +6645,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -7337,7 +6657,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -7473,18 +6793,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -7496,14 +6804,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7512,14 +6812,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7573,14 +6865,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7597,14 +6881,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7613,14 +6889,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7809,26 +7077,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7893,26 +7141,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7936,36 +7164,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -7986,36 +7184,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8034,17 +7202,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -8054,7 +7224,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -8066,7 +7236,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -8202,18 +7372,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -8225,14 +7383,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8241,14 +7391,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8302,14 +7444,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8326,14 +7460,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8342,14 +7468,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8571,26 +7689,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8655,26 +7753,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8698,36 +7776,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8748,36 +7796,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -8796,17 +7814,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -8816,7 +7836,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -8828,7 +7848,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -8964,18 +7984,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -8987,14 +7995,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -9003,14 +8003,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -9064,14 +8056,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -9088,14 +8072,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -9104,14 +8080,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -9313,6 +8281,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -9362,6 +8331,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -9406,7 +8376,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -9518,6 +8488,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -9529,6 +8500,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -9573,7 +8545,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -9776,6 +8748,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -9816,7 +8789,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -9926,6 +8899,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -9937,6 +8911,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -9977,7 +8952,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -10189,6 +9164,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -10229,7 +9205,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -10339,6 +9315,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -11179,26 +10156,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11263,26 +10220,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11306,36 +10243,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11356,36 +10263,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11404,17 +10281,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -11424,7 +10303,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -11436,7 +10315,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -11572,18 +10451,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -11595,14 +10462,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11611,14 +10470,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11672,14 +10523,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11696,14 +10539,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11712,14 +10547,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11820,26 +10647,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11904,26 +10711,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11947,36 +10734,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -11997,36 +10754,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -12045,17 +10772,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -12065,7 +10794,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -12077,7 +10806,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -12213,18 +10942,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -12236,14 +10953,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -12252,14 +10961,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -12313,14 +11014,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -12337,14 +11030,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -12353,14 +11038,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -12484,7 +11161,9 @@ export type Routes = { /** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */ is_one_time_use?: boolean | undefined /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */ - max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined + max_time_rounding?: + | (('1hour' | '1day' | '1h' | '1d') | undefined) + | undefined /** ID of the access code that you want to update. */ access_code_id: string /** ID of the device containing the access code that you want to update. */ @@ -12610,6 +11289,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -12659,6 +11339,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -12703,7 +11384,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -12815,6 +11496,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -12826,6 +11508,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -12870,7 +11553,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -13073,6 +11756,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -13113,7 +11797,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -13223,6 +11907,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -13234,6 +11919,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -13274,7 +11960,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -13486,6 +12172,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -13526,7 +12213,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -13636,6 +12323,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -14465,6 +13153,7 @@ export type Routes = { email_address?: (string | null) | undefined /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number?: (string | null) | undefined + /** Full name of the user associated with the user identity. */ full_name?: (string | null) | undefined /** Unique key for the user identity. */ user_identity_key?: (string | null) | undefined @@ -14989,7 +13678,7 @@ export type Routes = { | { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -16183,7 +14872,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -16215,7 +14904,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -16344,6 +15033,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -16476,18 +15177,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -16736,31 +15425,51 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: | boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: | boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] | undefined @@ -17197,7 +15906,9 @@ export type Routes = { | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_system_id: string + /** Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_user_count?: number | undefined + /** Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. */ external_type?: @@ -17223,6 +15934,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Indicates whether the `acs_system` is a credential manager. */ is_credential_manager: boolean + /** Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ visionline_metadata?: | { /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */ @@ -17257,6 +15969,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ system_type_display_name?: string | undefined + /** Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ location: { /** Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. */ time_zone: string | null @@ -17265,12 +15978,12 @@ export type Routes = { name: string /** Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ workspace_id: string /** IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). * @deprecated Use `connected_account_id`.*/ connected_account_ids: string[] - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ connected_account_id: string /** URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ image_url: string @@ -17293,6 +16006,7 @@ export type Routes = { message: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' + /** Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined } | { @@ -17386,11 +16100,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -17434,9 +16150,9 @@ export type Routes = { acs_access_group_id: string /** ID of the access control system that contains the access group. */ acs_system_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. */ + /** ID of the workspace that contains the access group. */ workspace_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. */ + /** ID of the connected account that contains the access group. */ connected_account_id: string /** Name of the access group. */ name: string @@ -17454,6 +16170,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ access_group_type_display_name: string + /** Display name for the access group. */ display_name: string /** Brand-specific terminology for the access group type. */ external_type: @@ -17621,6 +16338,7 @@ export type Routes = { variant: 'adding' | 'removing' } )[] + /** Indicates whether Seam manages the access group. */ is_managed: true }[] | undefined @@ -18661,8 +17379,10 @@ export type Routes = { commonParams: { /** Display name for the access grant. */ name?: (string | null) | undefined - /** ID of the Access Grant to update. */ - access_grant_id: string + /** ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`. */ + access_grant_id?: string | undefined + /** Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`. */ + access_grant_key?: string | undefined /** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined /** Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */ @@ -18798,6 +17518,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -18847,6 +17568,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -18891,7 +17613,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -19003,6 +17725,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -19014,6 +17737,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -19058,7 +17782,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -19261,6 +17985,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -19301,7 +18026,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -19411,6 +18136,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -19422,6 +18148,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -19462,7 +18189,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -19674,6 +18401,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -19714,7 +18442,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -19824,6 +18552,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -20759,6 +19488,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -20808,6 +19538,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -20852,7 +19583,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -20964,6 +19695,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -20975,6 +19707,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -21019,7 +19752,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -21222,6 +19955,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -21262,7 +19996,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -21372,6 +20106,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -21383,6 +20118,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -21423,7 +20159,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -21635,6 +20371,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -21675,7 +20412,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -21785,6 +20522,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -22750,7 +21488,7 @@ export type Routes = { | { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -23944,7 +22682,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -23976,7 +22714,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -24105,6 +22843,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -24237,18 +22987,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -24497,31 +23235,51 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: | boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: | boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] | undefined @@ -25071,13 +23829,13 @@ export type Routes = { | { /** ID of the Instant Key. */ instant_key_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key. */ + /** ID of the workspace that contains the Instant Key. */ workspace_id: string /** Date and time at which the Instant Key was created. */ created_at: string /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */ instant_key_url: string - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */ + /** ID of the client session associated with the Instant Key. */ client_session_id: string /** ID of the user identity associated with the Instant Key. */ user_identity_id: string @@ -25100,9 +23858,9 @@ export type Routes = { | undefined client_sessions?: | { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -25137,6 +23895,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -25177,7 +23936,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -25287,6 +24046,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true }[] | undefined @@ -25566,6 +24326,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -25615,6 +24376,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -25659,7 +24421,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -25771,6 +24533,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -25782,6 +24545,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -25826,7 +24590,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -26029,6 +24793,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -26069,7 +24834,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -26179,6 +24944,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -26190,6 +24956,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -26230,7 +24997,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -26442,6 +25209,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -26482,7 +25250,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -26592,6 +25360,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -27697,9 +26466,9 @@ export type Routes = { acs_access_group_id: string /** ID of the access control system that contains the access group. */ acs_system_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. */ + /** ID of the workspace that contains the access group. */ workspace_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. */ + /** ID of the connected account that contains the access group. */ connected_account_id: string /** Name of the access group. */ name: string @@ -27717,6 +26486,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ access_group_type_display_name: string + /** Display name for the access group. */ display_name: string /** Brand-specific terminology for the access group type. */ external_type: @@ -27884,6 +26654,7 @@ export type Routes = { variant: 'adding' | 'removing' } )[] + /** Indicates whether Seam manages the access group. */ is_managed: true } } @@ -27911,9 +26682,9 @@ export type Routes = { acs_access_group_id: string /** ID of the access control system that contains the access group. */ acs_system_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. */ + /** ID of the workspace that contains the access group. */ workspace_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. */ + /** ID of the connected account that contains the access group. */ connected_account_id: string /** Name of the access group. */ name: string @@ -27931,6 +26702,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ access_group_type_display_name: string + /** Display name for the access group. */ display_name: string /** Brand-specific terminology for the access group type. */ external_type: @@ -28098,6 +26870,7 @@ export type Routes = { variant: 'adding' | 'removing' } )[] + /** Indicates whether Seam manages the access group. */ is_managed: true }[] } @@ -28349,8 +27122,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -28612,7 +27386,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -28633,6 +27407,7 @@ export type Routes = { email_address?: string | undefined /** Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined + /** Indicates whether Seam manages the access system user. */ is_managed: true }[] } @@ -28672,9 +27447,9 @@ export type Routes = { acs_access_group_id: string /** ID of the access control system that contains the access group. */ acs_system_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. */ + /** ID of the workspace that contains the access group. */ workspace_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. */ + /** ID of the connected account that contains the access group. */ connected_account_id: string /** Name of the access group. */ name: string @@ -28692,6 +27467,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ access_group_type_display_name: string + /** Display name for the access group. */ display_name: string /** Brand-specific terminology for the access group type. */ external_type: @@ -28884,9 +27660,9 @@ export type Routes = { acs_access_group_id: string /** ID of the access control system that contains the access group. */ acs_system_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. */ + /** ID of the workspace that contains the access group. */ workspace_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. */ + /** ID of the connected account that contains the access group. */ connected_account_id: string /** Name of the access group. */ name: string @@ -28904,6 +27680,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ access_group_type_display_name: string + /** Display name for the access group. */ display_name: string /** Brand-specific terminology for the access group type. */ external_type: @@ -29161,6 +27938,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -29201,7 +27979,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -29311,6 +28089,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -29404,6 +28183,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -29444,7 +28224,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -29554,6 +28334,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -29594,6 +28375,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -29634,7 +28416,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -29744,6 +28526,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -29789,6 +28572,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -29829,7 +28613,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -29939,6 +28723,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -29992,6 +28777,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -30032,7 +28818,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -30142,6 +28928,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true }[] /** Information about the current page of results. */ @@ -30417,6 +29204,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -30457,7 +29245,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -30567,6 +29355,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -30593,6 +29382,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -30633,7 +29423,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -30787,6 +29577,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -30827,7 +29618,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -30973,6 +29764,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -31013,7 +29805,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -31123,6 +29915,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -31256,6 +30049,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -31305,6 +30099,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -31349,7 +30144,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -31461,6 +30256,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -31472,6 +30268,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -31516,7 +30313,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -31719,6 +30516,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -31759,7 +30557,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -31869,6 +30667,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -31880,6 +30679,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -31920,7 +30720,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -32132,6 +30932,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -32172,7 +30973,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -32282,6 +31083,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -33099,9 +31901,9 @@ export type Routes = { acs_encoder_id: string /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ acs_system_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ + /** ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ connected_account_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ + /** ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ workspace_id: string /** Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ errors: { @@ -33151,9 +31953,9 @@ export type Routes = { acs_encoder_id: string /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ acs_system_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ + /** ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ connected_account_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ + /** ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ workspace_id: string /** Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ errors: { @@ -33312,6 +32114,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -33361,6 +32164,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -33405,7 +32209,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -33517,6 +32321,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -33528,6 +32333,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -33572,7 +32378,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -33775,6 +32581,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -33815,7 +32622,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -33925,6 +32732,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -33936,6 +32744,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -33976,7 +32785,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -34188,6 +32997,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -34228,7 +33038,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -34338,6 +33148,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -35260,6 +34071,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -35309,6 +34121,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -35353,7 +34166,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -35465,6 +34278,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -35476,6 +34290,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -35520,7 +34335,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -35723,6 +34538,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -35763,7 +34579,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -35873,6 +34689,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -35884,6 +34701,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -35924,7 +34742,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -36136,6 +34954,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -36176,7 +34995,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -36286,6 +35105,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -37695,6 +36515,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -37735,7 +36556,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -37845,6 +36666,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true }[] } @@ -37976,6 +36798,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -38025,6 +36848,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -38069,7 +36893,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -38181,6 +37005,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -38192,6 +37017,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -38236,7 +37062,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -38439,6 +37265,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -38479,7 +37306,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -38589,6 +37416,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -38600,6 +37428,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -38640,7 +37469,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -38852,6 +37681,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -38892,7 +37722,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -39002,6 +37832,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -39810,7 +38641,9 @@ export type Routes = { default_credential_manager_acs_system_id?: (string | null) | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_system_id: string + /** Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_user_count?: number | undefined + /** Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. */ external_type?: @@ -39836,6 +38669,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Indicates whether the `acs_system` is a credential manager. */ is_credential_manager: boolean + /** Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ visionline_metadata?: | { /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */ @@ -39870,6 +38704,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ system_type_display_name?: string | undefined + /** Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ location: { /** Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. */ time_zone: string | null @@ -39878,12 +38713,12 @@ export type Routes = { name: string /** Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ workspace_id: string /** IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). * @deprecated Use `connected_account_id`.*/ connected_account_ids: string[] - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ connected_account_id: string /** URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ image_url: string @@ -39906,6 +38741,7 @@ export type Routes = { message: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' + /** Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined } | { @@ -40011,7 +38847,9 @@ export type Routes = { default_credential_manager_acs_system_id?: (string | null) | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_system_id: string + /** Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_user_count?: number | undefined + /** Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. */ external_type?: @@ -40037,6 +38875,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Indicates whether the `acs_system` is a credential manager. */ is_credential_manager: boolean + /** Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ visionline_metadata?: | { /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */ @@ -40071,6 +38910,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ system_type_display_name?: string | undefined + /** Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ location: { /** Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. */ time_zone: string | null @@ -40079,12 +38919,12 @@ export type Routes = { name: string /** Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ workspace_id: string /** IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). * @deprecated Use `connected_account_id`.*/ connected_account_ids: string[] - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ connected_account_id: string /** URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ image_url: string @@ -40107,6 +38947,7 @@ export type Routes = { message: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' + /** Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined } | { @@ -40208,7 +39049,9 @@ export type Routes = { default_credential_manager_acs_system_id?: (string | null) | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_system_id: string + /** Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_user_count?: number | undefined + /** Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. */ external_type?: @@ -40234,6 +39077,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Indicates whether the `acs_system` is a credential manager. */ is_credential_manager: boolean + /** Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ visionline_metadata?: | { /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */ @@ -40268,6 +39112,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ system_type_display_name?: string | undefined + /** Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ location: { /** Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. */ time_zone: string | null @@ -40276,12 +39121,12 @@ export type Routes = { name: string /** Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ workspace_id: string /** IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). * @deprecated Use `connected_account_id`.*/ connected_account_ids: string[] - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ connected_account_id: string /** URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ image_url: string @@ -40304,6 +39149,7 @@ export type Routes = { message: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' + /** Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined } | { @@ -40487,8 +39333,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -40750,7 +39597,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -40771,6 +39618,7 @@ export type Routes = { email_address?: string | undefined /** Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined + /** Indicates whether Seam manages the access system user. */ is_managed: true } } @@ -40818,8 +39666,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -41081,7 +39930,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -41102,6 +39951,7 @@ export type Routes = { email_address?: string | undefined /** Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined + /** Indicates whether Seam manages the access system user. */ is_managed: true } } @@ -41137,8 +39987,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -41400,7 +40251,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -41421,6 +40272,7 @@ export type Routes = { email_address?: string | undefined /** Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined + /** Indicates whether Seam manages the access system user. */ is_managed: true }[] /** Information about the current page of results. */ @@ -41737,8 +40589,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -42000,7 +40853,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -42052,8 +40905,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -42315,7 +41169,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -42387,6 +41241,7 @@ export type Routes = { phone_number?: string | undefined /** Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ email_address?: string | undefined + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined } commonParams: {} @@ -42518,6 +41373,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -42567,6 +41423,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -42611,7 +41468,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -42723,6 +41580,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -42734,6 +41592,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -42778,7 +41637,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -42981,6 +41840,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -43021,7 +41881,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -43131,6 +41991,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -43142,6 +42003,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -43182,7 +42044,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -43394,6 +42256,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -43434,7 +42297,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -43544,6 +42407,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -44456,6 +43320,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -44505,6 +43370,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -44549,7 +43415,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -44661,6 +43527,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -44672,6 +43539,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -44716,7 +43584,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -44919,6 +43787,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -44959,7 +43828,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -45069,6 +43938,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -45080,6 +43950,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -45120,7 +43991,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -45332,6 +44203,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -45372,7 +44244,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -45482,6 +44354,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -46294,7 +45167,7 @@ export type Routes = { bridge: { /** ID of Seam Bridge. */ bridge_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge. */ + /** ID of the workspace that contains Seam Bridge. */ workspace_id: string /** Date and time at which Seam Bridge was created. */ created_at: string @@ -46313,7 +45186,7 @@ export type Routes = { bridges: { /** ID of Seam Bridge. */ bridge_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains Seam Bridge. */ + /** ID of the workspace that contains Seam Bridge. */ workspace_id: string /** Date and time at which Seam Bridge was created. */ created_at: string @@ -46357,9 +45230,9 @@ export type Routes = { See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ client_session: { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -46422,9 +45295,9 @@ export type Routes = { See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ client_session: { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -46483,9 +45356,9 @@ export type Routes = { See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ client_session: { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -46544,9 +45417,9 @@ export type Routes = { See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ client_session: { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -46593,9 +45466,9 @@ export type Routes = { formData: {} jsonResponse: { client_sessions: { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -46771,14 +45644,15 @@ export type Routes = { connect_webview: { /** ID of the Connect Webview. */ connect_webview_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview. */ + /** ID of the workspace that contains the Connect Webview. */ workspace_id: string /** Date and time at which the Connect Webview was created. */ created_at: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview. */ + /** ID of the connected account associated with the Connect Webview. */ connected_account_id: string | null /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */ url: string + /** Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`. */ device_selection_mode: 'none' | 'single' | 'multiple' /** List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ accepted_providers: string[] @@ -46862,14 +45736,15 @@ export type Routes = { connect_webview: { /** ID of the Connect Webview. */ connect_webview_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview. */ + /** ID of the workspace that contains the Connect Webview. */ workspace_id: string /** Date and time at which the Connect Webview was created. */ created_at: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview. */ + /** ID of the connected account associated with the Connect Webview. */ connected_account_id: string | null /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */ url: string + /** Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`. */ device_selection_mode: 'none' | 'single' | 'multiple' /** List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ accepted_providers: string[] @@ -46943,14 +45818,15 @@ export type Routes = { connect_webviews: { /** ID of the Connect Webview. */ connect_webview_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview. */ + /** ID of the workspace that contains the Connect Webview. */ workspace_id: string /** Date and time at which the Connect Webview was created. */ created_at: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview. */ + /** ID of the connected account associated with the Connect Webview. */ connected_account_id: string | null /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */ url: string + /** Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`. */ device_selection_mode: 'none' | 'single' | 'multiple' /** List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ accepted_providers: string[] @@ -48296,7 +47172,7 @@ export type Routes = { customer_key: string /** Date and time at which the customer portal link expires. */ expires_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer portal. */ + /** ID of the workspace associated with the customer portal. */ workspace_id: string /** Date and time at which the customer portal link was created. */ created_at: string @@ -48313,7 +47189,7 @@ export type Routes = { customer_key: string /** Date and time at which the magic link expires. */ expires_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link. */ + /** ID of the workspace associated with the magic link. */ workspace_id: string /** Date and time at which the magic link was created. */ created_at: string @@ -49916,7 +48792,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -49948,7 +48824,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -50077,6 +48953,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -50209,18 +49097,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -50469,27 +49345,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined } } @@ -51860,7 +50756,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -51892,7 +50788,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -52021,6 +50917,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -52153,18 +51061,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -52413,27 +51309,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] /** Information about the current page of results. */ @@ -52471,6 +51387,7 @@ export type Routes = { formData: {} jsonResponse: { device_providers: { + /** Name of the device provider. */ device_provider_name: | 'hotek' | 'dormakaba_community' @@ -52532,8 +51449,11 @@ export type Routes = { | 'guesty' | 'acuity_scheduling' | 'omnitec' + /** Display name for the device provider. */ display_name: string + /** Image URL for the device provider. */ image_url: string + /** List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on. */ provider_categories: ( | 'stable' | 'consumer_smartlocks' @@ -52544,27 +51464,47 @@ export type Routes = { | 'cameras' | 'connectors' )[] + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] } @@ -54088,6 +53028,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -54220,18 +53172,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -54454,6 +53394,7 @@ export type Routes = { custom_metadata: { [x: string]: string | boolean } + /** Indicates that Seam does not manage the device. */ is_managed: false /** properties of the device. */ properties: { @@ -54531,27 +53472,47 @@ export type Routes = { accessory_keypad_supported?: boolean | undefined } } + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined } } @@ -54897,6 +53858,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -55029,18 +54002,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -55263,6 +54224,7 @@ export type Routes = { custom_metadata: { [x: string]: string | boolean } + /** Indicates that Seam does not manage the device. */ is_managed: false /** properties of the device. */ properties: { @@ -55340,27 +54302,47 @@ export type Routes = { accessory_keypad_supported?: boolean | undefined } } + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] /** Information about the current page of results. */ @@ -55442,13 +54424,13 @@ export type Routes = { jsonResponse: { /** Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event. - As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. */ + As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. */ event?: | ( | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55458,7 +54440,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55477,7 +54459,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55487,7 +54469,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55519,7 +54501,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55529,7 +54511,186 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.name_changed' + /** Previous access code name configuration. */ + from: { + /** Previous name of the access code. */ + name: string | null + } + /** New access code name configuration. */ + to: { + /** New name of the access code. */ + name: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.code_changed' + /** Previous pin code configuration. */ + from: { + /** Previous pin code. */ + code: string | null + } + /** New pin code configuration. */ + to: { + /** New pin code. */ + code: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.time_frame_changed' + /** Previous time frame configuration. */ + from: { + /** Previous start time. */ + starts_at: string | null + /** Previous end time. */ + ends_at: string | null + } + /** New time frame configuration. */ + to: { + /** New start time. */ + starts_at: string | null + /** New end time. */ + ends_at: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.mutations_requested' + /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */ + requested_mutations: { + /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */ + mutation_code: + | 'updating_name' + | 'updating_code' + | 'updating_time_frame' + | 'deleting' + | 'creating' + | 'deferring_creation' + /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + from?: + | { + [x: string]: unknown + } + | undefined + /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + to?: + | { + [x: string]: unknown + } + | undefined + }[] + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55550,7 +54711,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55560,7 +54721,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55581,7 +54742,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55591,7 +54752,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55610,7 +54771,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55620,7 +54781,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55693,7 +54854,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55703,7 +54864,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55776,7 +54937,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55786,7 +54947,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55807,7 +54968,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55817,7 +54978,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55890,7 +55051,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55900,7 +55061,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -55973,7 +55134,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -55983,7 +55144,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -56002,7 +55163,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56012,7 +55173,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -56031,7 +55192,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56041,7 +55202,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -56056,12 +55217,13 @@ export type Routes = { } | undefined event_type: 'access_code.backup_access_code_pulled' + /** ID of the backup access code that was pulled from the pool. */ backup_access_code_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56071,7 +55233,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -56090,7 +55252,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56100,7 +55262,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -56173,7 +55335,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56183,7 +55345,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -56202,7 +55364,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56212,7 +55374,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -56231,7 +55393,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56244,7 +55406,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56257,7 +55419,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56270,7 +55432,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56285,7 +55447,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56300,7 +55462,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56319,7 +55481,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56336,7 +55498,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56357,7 +55519,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56374,7 +55536,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56391,7 +55553,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56408,7 +55570,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56429,7 +55591,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56446,7 +55608,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56461,7 +55623,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56476,7 +55638,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56527,7 +55689,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56544,7 +55706,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56561,7 +55723,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56578,7 +55740,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56595,7 +55757,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56605,13 +55767,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.created' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56621,13 +55784,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.deleted' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56644,7 +55808,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56661,7 +55825,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56678,7 +55842,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56688,13 +55852,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.added' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56704,13 +55869,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.removed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56723,13 +55889,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56738,7 +55904,7 @@ export type Routes = { } | undefined event_type: 'connected_account.connected' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id?: string | undefined /** The customer key associated with this connected account, if any. */ customer_key?: string | undefined @@ -56746,13 +55912,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56761,19 +55927,19 @@ export type Routes = { } | undefined event_type: 'connected_account.created' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56782,19 +55948,19 @@ export type Routes = { } | undefined event_type: 'connected_account.successful_login' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56825,13 +55991,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56844,13 +56010,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56867,13 +56033,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56886,13 +56052,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -56923,7 +56089,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56944,7 +56110,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56965,7 +56131,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -56986,7 +56152,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57007,7 +56173,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57028,7 +56194,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57049,7 +56215,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57070,7 +56236,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57091,16 +56257,16 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_succeeded' - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** Custom metadata of the connected account; present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -57114,20 +56280,20 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_failed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57135,7 +56301,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57156,7 +56322,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57164,7 +56330,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57185,7 +56351,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57193,7 +56359,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57214,7 +56380,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57222,7 +56388,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57243,7 +56409,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57251,7 +56417,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57272,7 +56438,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57280,7 +56446,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57342,7 +56508,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57350,7 +56516,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57412,7 +56578,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57420,7 +56586,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57441,7 +56607,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57449,7 +56615,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57472,7 +56638,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57480,7 +56646,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57505,7 +56671,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57513,7 +56679,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57534,7 +56700,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57542,7 +56708,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57565,7 +56731,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57573,7 +56739,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57594,7 +56760,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57602,7 +56768,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57623,7 +56789,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57631,7 +56797,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57652,7 +56818,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57660,7 +56826,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57681,7 +56847,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57689,7 +56855,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57746,7 +56912,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57754,7 +56920,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57775,7 +56941,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57783,7 +56949,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57840,7 +57006,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57848,7 +57014,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57869,7 +57035,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57877,7 +57043,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57898,7 +57064,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57906,7 +57072,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -57963,7 +57129,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -57971,7 +57137,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58012,7 +57178,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58020,7 +57186,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58062,7 +57228,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58070,7 +57236,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id?: string | undefined - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58136,15 +57302,15 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string /** ID of the affected device. */ - device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + device_id?: string | undefined + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58163,11 +57329,35 @@ export type Routes = { event_type: 'lock.access_denied' /** ID of the access code that was used in the unlock attempts. */ access_code_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the user identity associated with the access-denied event. + */ + user_identity_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS system associated with the access-denied event. + */ + acs_system_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS user associated with the access-denied event. + */ + acs_user_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS entrance associated with the access-denied event. + */ + acs_entrance_id?: string | undefined } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58175,7 +57365,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58202,7 +57392,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58210,7 +57400,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58252,7 +57442,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58260,7 +57450,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58293,7 +57483,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58301,7 +57491,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58334,7 +57524,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58342,7 +57532,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58371,7 +57561,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58379,7 +57569,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58404,7 +57594,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58412,7 +57602,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58435,7 +57625,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58443,7 +57633,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58474,7 +57664,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58482,7 +57672,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -58507,7 +57697,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58520,7 +57710,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58539,7 +57729,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58559,7 +57749,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58579,7 +57769,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58633,6 +57823,10 @@ export type Routes = { | ( | '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' @@ -58741,6 +57935,10 @@ export type Routes = { | ( | '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' @@ -58883,7 +58081,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58893,7 +58091,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -58912,7 +58110,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58922,7 +58120,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -58954,7 +58152,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58964,7 +58162,186 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.name_changed' + /** Previous access code name configuration. */ + from: { + /** Previous name of the access code. */ + name: string | null + } + /** New access code name configuration. */ + to: { + /** New name of the access code. */ + name: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.code_changed' + /** Previous pin code configuration. */ + from: { + /** Previous pin code. */ + code: string | null + } + /** New pin code configuration. */ + to: { + /** New pin code. */ + code: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.time_frame_changed' + /** Previous time frame configuration. */ + from: { + /** Previous start time. */ + starts_at: string | null + /** Previous end time. */ + ends_at: string | null + } + /** New time frame configuration. */ + to: { + /** New start time. */ + starts_at: string | null + /** New end time. */ + ends_at: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.mutations_requested' + /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */ + requested_mutations: { + /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */ + mutation_code: + | 'updating_name' + | 'updating_code' + | 'updating_time_frame' + | 'deleting' + | 'creating' + | 'deferring_creation' + /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + from?: + | { + [x: string]: unknown + } + | undefined + /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + to?: + | { + [x: string]: unknown + } + | undefined + }[] + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -58985,7 +58362,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -58995,7 +58372,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59016,7 +58393,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59026,7 +58403,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59045,7 +58422,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59055,7 +58432,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59128,7 +58505,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59138,7 +58515,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59211,7 +58588,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59221,7 +58598,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59242,7 +58619,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59252,7 +58629,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59325,7 +58702,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59335,7 +58712,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59408,7 +58785,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59418,7 +58795,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59437,7 +58814,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59447,7 +58824,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59466,7 +58843,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59476,7 +58853,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59491,12 +58868,13 @@ export type Routes = { } | undefined event_type: 'access_code.backup_access_code_pulled' + /** ID of the backup access code that was pulled from the pool. */ backup_access_code_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59506,7 +58884,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59525,7 +58903,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59535,7 +58913,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59608,7 +58986,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59618,7 +58996,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59637,7 +59015,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59647,7 +59025,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -59666,7 +59044,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59679,7 +59057,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59692,7 +59070,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59705,7 +59083,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59720,7 +59098,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59735,7 +59113,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59754,7 +59132,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59771,7 +59149,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59792,7 +59170,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59809,7 +59187,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59826,7 +59204,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59843,7 +59221,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59864,7 +59242,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59881,7 +59259,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59896,7 +59274,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59911,7 +59289,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59962,7 +59340,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59979,7 +59357,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -59996,7 +59374,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60013,7 +59391,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60030,7 +59408,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60040,13 +59418,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.created' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60056,13 +59435,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.deleted' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60079,7 +59459,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60096,7 +59476,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60113,7 +59493,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60123,13 +59503,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.added' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60139,13 +59520,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.removed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60158,13 +59540,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60173,7 +59555,7 @@ export type Routes = { } | undefined event_type: 'connected_account.connected' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id?: string | undefined /** The customer key associated with this connected account, if any. */ customer_key?: string | undefined @@ -60181,13 +59563,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60196,19 +59578,19 @@ export type Routes = { } | undefined event_type: 'connected_account.created' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60217,19 +59599,19 @@ export type Routes = { } | undefined event_type: 'connected_account.successful_login' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60260,13 +59642,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60279,13 +59661,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60302,13 +59684,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60321,13 +59703,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60358,7 +59740,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60379,7 +59761,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60400,7 +59782,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60421,7 +59803,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60442,7 +59824,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60463,7 +59845,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60484,7 +59866,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60505,7 +59887,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60526,16 +59908,16 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_succeeded' - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** Custom metadata of the connected account; present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -60549,20 +59931,20 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_failed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60570,7 +59952,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60591,7 +59973,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60599,7 +59981,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60620,7 +60002,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60628,7 +60010,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60649,7 +60031,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60657,7 +60039,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60678,7 +60060,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60686,7 +60068,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60707,7 +60089,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60715,7 +60097,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60777,7 +60159,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60785,7 +60167,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60847,7 +60229,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60855,7 +60237,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60876,7 +60258,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60884,7 +60266,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60907,7 +60289,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60915,7 +60297,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60940,7 +60322,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60948,7 +60330,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -60969,7 +60351,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -60977,7 +60359,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61000,7 +60382,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61008,7 +60390,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61029,7 +60411,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61037,7 +60419,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61058,7 +60440,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61066,7 +60448,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61087,7 +60469,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61095,7 +60477,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61116,7 +60498,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61124,7 +60506,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61181,7 +60563,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61189,7 +60571,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61210,7 +60592,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61218,7 +60600,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61275,7 +60657,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61283,7 +60665,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61304,7 +60686,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61312,7 +60694,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61333,7 +60715,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61341,7 +60723,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61398,7 +60780,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61406,7 +60788,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61447,7 +60829,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61455,7 +60837,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61492,7 +60874,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61500,7 +60882,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id?: string | undefined - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61561,15 +60943,15 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string /** ID of the affected device. */ - device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + device_id?: string | undefined + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61588,11 +60970,35 @@ export type Routes = { event_type: 'lock.access_denied' /** ID of the access code that was used in the unlock attempts. */ access_code_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the user identity associated with the access-denied event. + */ + user_identity_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS system associated with the access-denied event. + */ + acs_system_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS user associated with the access-denied event. + */ + acs_user_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS entrance associated with the access-denied event. + */ + acs_entrance_id?: string | undefined } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61600,7 +61006,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61627,7 +61033,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61635,7 +61041,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61674,7 +61080,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61682,7 +61088,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61715,7 +61121,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61723,7 +61129,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61756,7 +61162,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61764,7 +61170,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61793,7 +61199,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61801,7 +61207,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61826,7 +61232,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61834,7 +61240,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61857,7 +61263,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61865,7 +61271,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61896,7 +61302,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61904,7 +61310,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -61929,7 +61335,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61942,7 +61348,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61961,7 +61367,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -61981,7 +61387,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -62001,7 +61407,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -62054,13 +61460,13 @@ export type Routes = { instant_key: { /** ID of the Instant Key. */ instant_key_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key. */ + /** ID of the workspace that contains the Instant Key. */ workspace_id: string /** Date and time at which the Instant Key was created. */ created_at: string /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */ instant_key_url: string - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */ + /** ID of the client session associated with the Instant Key. */ client_session_id: string /** ID of the user identity associated with the Instant Key. */ user_identity_id: string @@ -62097,13 +61503,13 @@ export type Routes = { instant_keys: { /** ID of the Instant Key. */ instant_key_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key. */ + /** ID of the workspace that contains the Instant Key. */ workspace_id: string /** Date and time at which the Instant Key was created. */ created_at: string /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */ instant_key_url: string - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */ + /** ID of the client session associated with the Instant Key. */ client_session_id: string /** ID of the user identity associated with the Instant Key. */ user_identity_id: string @@ -62254,6 +61660,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -62303,6 +61710,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -62347,7 +61755,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -62459,6 +61867,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -62470,6 +61879,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -62514,7 +61924,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -62717,6 +62127,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -62757,7 +62168,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -62867,6 +62278,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -62878,6 +62290,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -62918,7 +62331,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -63130,6 +62543,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -63170,7 +62584,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -63280,6 +62694,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -65208,7 +64623,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -65240,7 +64655,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -65369,6 +64784,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -65501,18 +64928,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -65761,27 +65176,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined } /** Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam. */ @@ -66912,7 +66347,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -66944,7 +66379,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -67073,6 +66508,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -67205,18 +66652,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -67465,27 +66900,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined } } @@ -68809,7 +68264,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -68841,7 +68296,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -68970,6 +68425,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -69102,18 +68569,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -69362,27 +68817,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] devices: { @@ -70512,7 +69987,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -70544,7 +70019,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -70673,6 +70148,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -70805,18 +70292,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -71065,27 +70540,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] } @@ -71217,6 +70712,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -71266,6 +70762,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -71310,7 +70807,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -71422,6 +70919,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -71433,6 +70931,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -71477,7 +70976,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -71680,6 +71179,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -71720,7 +71220,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -71830,6 +71330,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -71841,6 +71342,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -71881,7 +71383,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -72093,6 +71595,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -72133,7 +71636,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -72243,6 +71746,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -73156,6 +72660,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -73205,6 +72710,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -73249,7 +72755,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -73361,6 +72867,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -73372,6 +72879,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -73416,7 +72924,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -73619,6 +73127,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -73659,7 +73168,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -73769,6 +73278,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -73780,6 +73290,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -73820,7 +73331,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -74032,6 +73543,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -74072,7 +73584,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -74182,6 +73694,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -75093,6 +74606,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -75142,6 +74656,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -75186,7 +74701,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -75298,6 +74813,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -75309,6 +74825,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -75353,7 +74870,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -75556,6 +75073,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -75596,7 +75114,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -75706,6 +75224,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -75717,6 +75236,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -75757,7 +75277,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -75969,6 +75489,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -76009,7 +75530,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -76119,6 +75640,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -77032,6 +76554,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -77081,6 +76604,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -77125,7 +76649,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -77237,6 +76761,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -77248,6 +76773,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -77292,7 +76818,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -77495,6 +77021,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -77535,7 +77062,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -77645,6 +77172,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -77656,6 +77184,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -77696,7 +77225,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -77908,6 +77437,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -77948,7 +77478,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -78058,6 +77588,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -80068,7 +79599,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -80100,7 +79631,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -80229,6 +79760,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -80361,18 +79904,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -80621,27 +80152,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] devices: { @@ -81771,7 +81322,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -81803,7 +81354,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -81932,6 +81483,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -82064,18 +81627,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -82324,27 +81875,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] } @@ -82486,6 +82057,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -82535,6 +82107,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -82579,7 +82152,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -82691,6 +82264,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -82702,6 +82276,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -82746,7 +82321,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -82949,6 +82524,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -82989,7 +82565,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -83099,6 +82675,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -83110,6 +82687,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -83150,7 +82728,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -83362,6 +82940,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -83402,7 +82981,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -83512,6 +83091,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -84444,6 +84024,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -84493,6 +84074,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -84537,7 +84119,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -84649,6 +84231,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -84660,6 +84243,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -84704,7 +84288,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -84907,6 +84491,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -84947,7 +84532,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -85057,6 +84642,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -85068,6 +84654,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -85108,7 +84695,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -85320,6 +84907,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -85360,7 +84948,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -85470,6 +85058,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -86458,6 +86047,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -86507,6 +86097,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -86551,7 +86142,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -86663,6 +86254,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -86674,6 +86266,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -86718,7 +86311,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -86921,6 +86514,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -86961,7 +86555,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -87071,6 +86665,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -87082,6 +86677,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -87122,7 +86718,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -87334,6 +86930,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -87374,7 +86971,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -87484,6 +87081,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -88319,7 +87917,7 @@ export type Routes = { /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */ display_name: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone. + /** ID of the workspace that contains the phone. */ workspace_id: string /** Date and time at which the phone was created. @@ -88332,20 +87930,21 @@ export type Routes = { } /** Errors associated with the phone. */ errors: { + /** Unique identifier of the type of error. */ error_code: string + /** Detailed description of the error. */ message: string }[] /** Warnings associated with the phone. */ warnings: { + /** Unique identifier of the type of warning. */ warning_code: string + /** Detailed description of the warning. */ message: string }[] - /** Device type for phones. - */ + /** Type of the phone device, such as `ios_phone` or `android_phone`. */ device_type: 'ios_phone' | 'android_phone' - /** - Properties of the phone. - */ + /** Properties of the phone. */ properties: { /** ASSA ABLOY Credential Service metadata for the phone. */ assa_abloy_credential_service_metadata?: @@ -88396,7 +87995,7 @@ export type Routes = { /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */ display_name: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone. + /** ID of the workspace that contains the phone. */ workspace_id: string /** Date and time at which the phone was created. @@ -88409,20 +88008,21 @@ export type Routes = { } /** Errors associated with the phone. */ errors: { + /** Unique identifier of the type of error. */ error_code: string + /** Detailed description of the error. */ message: string }[] /** Warnings associated with the phone. */ warnings: { + /** Unique identifier of the type of warning. */ warning_code: string + /** Detailed description of the warning. */ message: string }[] - /** Device type for phones. - */ + /** Type of the phone device, such as `ios_phone` or `android_phone`. */ device_type: 'ios_phone' | 'android_phone' - /** - Properties of the phone. - */ + /** Properties of the phone. */ properties: { /** ASSA ABLOY Credential Service metadata for the phone. */ assa_abloy_credential_service_metadata?: @@ -88500,7 +88100,7 @@ export type Routes = { /** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */ display_name: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone. + /** ID of the workspace that contains the phone. */ workspace_id: string /** Date and time at which the phone was created. @@ -88513,20 +88113,21 @@ export type Routes = { } /** Errors associated with the phone. */ errors: { + /** Unique identifier of the type of error. */ error_code: string + /** Detailed description of the error. */ message: string }[] /** Warnings associated with the phone. */ warnings: { + /** Unique identifier of the type of warning. */ warning_code: string + /** Detailed description of the warning. */ message: string }[] - /** Device type for phones. - */ + /** Type of the phone device, such as `ios_phone` or `android_phone`. */ device_type: 'ios_phone' | 'android_phone' - /** - Properties of the phone. - */ + /** Properties of the phone. */ properties: { /** ASSA ABLOY Credential Service metadata for the phone. */ assa_abloy_credential_service_metadata?: @@ -88942,7 +88543,7 @@ export type Routes = { acs_system_id: string /** Display name for the [access system](https://docs.seam.co/low-level-apis/access-systems) associated with Seam Bridge. */ acs_system_display_name: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) with which Seam Bridge is paired. */ + /** ID of the workspace with which Seam Bridge is paired. */ workspace_id: string /** Display name for the [workspace](https://docs.seam.co/core-concepts/workspaces) with which Seam Bridge is paired. */ workspace_display_name: string @@ -89028,7 +88629,7 @@ export type Routes = { site: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -89101,7 +88702,7 @@ export type Routes = { sites: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -89166,7 +88767,7 @@ export type Routes = { site: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -89718,6 +89319,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -89767,6 +89369,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -89811,7 +89414,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -89923,6 +89526,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -89934,6 +89538,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -89978,7 +89583,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -90181,6 +89786,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -90221,7 +89827,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -90331,6 +89937,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -90342,6 +89949,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -90382,7 +89990,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -90594,6 +90202,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -90634,7 +90243,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -90744,6 +90353,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -92451,7 +92061,7 @@ export type Routes = { customers: { /** Unique key for the customer within the workspace. */ customer_key: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer. */ + /** ID of the workspace associated with the customer. */ workspace_id: string /** Date and time at which the customer was created. */ created_at: string @@ -92510,7 +92120,7 @@ export type Routes = { customer_key: string /** Date and time at which the magic link expires. */ expires_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link. */ + /** ID of the workspace associated with the magic link. */ workspace_id: string /** Date and time at which the magic link was created. */ created_at: string @@ -92554,6 +92164,10 @@ export type Routes = { | ( | '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' @@ -92662,6 +92276,10 @@ export type Routes = { | ( | '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' @@ -92774,7 +92392,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -92784,7 +92402,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -92803,7 +92421,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -92813,7 +92431,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -92845,7 +92463,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -92855,7 +92473,186 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.name_changed' + /** Previous access code name configuration. */ + from: { + /** Previous name of the access code. */ + name: string | null + } + /** New access code name configuration. */ + to: { + /** New name of the access code. */ + name: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.code_changed' + /** Previous pin code configuration. */ + from: { + /** Previous pin code. */ + code: string | null + } + /** New pin code configuration. */ + to: { + /** New pin code. */ + code: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.time_frame_changed' + /** Previous time frame configuration. */ + from: { + /** Previous start time. */ + starts_at: string | null + /** Previous end time. */ + ends_at: string | null + } + /** New time frame configuration. */ + to: { + /** New start time. */ + starts_at: string | null + /** New end time. */ + ends_at: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.mutations_requested' + /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */ + requested_mutations: { + /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */ + mutation_code: + | 'updating_name' + | 'updating_code' + | 'updating_time_frame' + | 'deleting' + | 'creating' + | 'deferring_creation' + /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + from?: + | { + [x: string]: unknown + } + | undefined + /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + to?: + | { + [x: string]: unknown + } + | undefined + }[] + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -92876,7 +92673,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -92886,7 +92683,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -92907,7 +92704,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -92917,7 +92714,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -92936,7 +92733,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -92946,7 +92743,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93019,7 +92816,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93029,7 +92826,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93102,7 +92899,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93112,7 +92909,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93133,7 +92930,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93143,7 +92940,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93216,7 +93013,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93226,7 +93023,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93299,7 +93096,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93309,7 +93106,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93328,7 +93125,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93338,7 +93135,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93357,7 +93154,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93367,7 +93164,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93382,12 +93179,13 @@ export type Routes = { } | undefined event_type: 'access_code.backup_access_code_pulled' + /** ID of the backup access code that was pulled from the pool. */ backup_access_code_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93397,7 +93195,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93416,7 +93214,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93426,7 +93224,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93499,7 +93297,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93509,7 +93307,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93528,7 +93326,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93538,7 +93336,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -93557,7 +93355,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93570,7 +93368,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93583,7 +93381,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93596,7 +93394,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93611,7 +93409,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93626,7 +93424,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93645,7 +93443,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93662,7 +93460,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93683,7 +93481,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93700,7 +93498,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93717,7 +93515,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93734,7 +93532,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93755,7 +93553,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93772,7 +93570,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93787,7 +93585,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93802,7 +93600,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93853,7 +93651,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93870,7 +93668,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93887,7 +93685,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93904,7 +93702,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93921,7 +93719,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93931,13 +93729,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.created' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93947,13 +93746,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.deleted' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93970,7 +93770,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -93987,7 +93787,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94004,7 +93804,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94014,13 +93814,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.added' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94030,13 +93831,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.removed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94049,13 +93851,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94064,7 +93866,7 @@ export type Routes = { } | undefined event_type: 'connected_account.connected' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id?: string | undefined /** The customer key associated with this connected account, if any. */ customer_key?: string | undefined @@ -94072,13 +93874,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94087,19 +93889,19 @@ export type Routes = { } | undefined event_type: 'connected_account.created' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94108,19 +93910,19 @@ export type Routes = { } | undefined event_type: 'connected_account.successful_login' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94151,13 +93953,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94170,13 +93972,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94193,13 +93995,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94212,13 +94014,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94249,7 +94051,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94270,7 +94072,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94291,7 +94093,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94312,7 +94114,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94333,7 +94135,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94354,7 +94156,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94375,7 +94177,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94396,7 +94198,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94417,16 +94219,16 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_succeeded' - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** Custom metadata of the connected account; present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -94440,20 +94242,20 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_failed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94461,7 +94263,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94482,7 +94284,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94490,7 +94292,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94511,7 +94313,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94519,7 +94321,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94540,7 +94342,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94548,7 +94350,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94569,7 +94371,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94577,7 +94379,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94598,7 +94400,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94606,7 +94408,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94668,7 +94470,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94676,7 +94478,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94738,7 +94540,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94746,7 +94548,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94767,7 +94569,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94775,7 +94577,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94798,7 +94600,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94806,7 +94608,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94831,7 +94633,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94839,7 +94641,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94860,7 +94662,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94868,7 +94670,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94891,7 +94693,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94899,7 +94701,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94920,7 +94722,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94928,7 +94730,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94949,7 +94751,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94957,7 +94759,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -94978,7 +94780,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -94986,7 +94788,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95007,7 +94809,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95015,7 +94817,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95072,7 +94874,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95080,7 +94882,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95101,7 +94903,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95109,7 +94911,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95166,7 +94968,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95174,7 +94976,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95195,7 +94997,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95203,7 +95005,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95224,7 +95026,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95232,7 +95034,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95289,7 +95091,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95297,7 +95099,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95338,7 +95140,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95346,7 +95148,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95383,7 +95185,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95391,7 +95193,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id?: string | undefined - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95452,15 +95254,15 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string /** ID of the affected device. */ - device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + device_id?: string | undefined + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95479,11 +95281,35 @@ export type Routes = { event_type: 'lock.access_denied' /** ID of the access code that was used in the unlock attempts. */ access_code_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the user identity associated with the access-denied event. + */ + user_identity_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS system associated with the access-denied event. + */ + acs_system_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS user associated with the access-denied event. + */ + acs_user_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS entrance associated with the access-denied event. + */ + acs_entrance_id?: string | undefined } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95491,7 +95317,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95518,7 +95344,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95526,7 +95352,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95565,7 +95391,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95573,7 +95399,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95606,7 +95432,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95614,7 +95440,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95647,7 +95473,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95655,7 +95481,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95684,7 +95510,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95692,7 +95518,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95717,7 +95543,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95725,7 +95551,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95748,7 +95574,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95756,7 +95582,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95787,7 +95613,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95795,7 +95621,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -95820,7 +95646,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95833,7 +95659,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95852,7 +95678,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95872,7 +95698,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -95892,7 +95718,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -96101,7 +95927,7 @@ export type Routes = { | undefined feature_flags?: | { - RESERVATION_UI_V2?: boolean | undefined + RESERVATION_LEGACY?: boolean | undefined SALTO_KS_ENTRANCES_ONLY_FOR_SPACES?: boolean | undefined MANAGE_DEVICES_CONFIRMATION_MODAL?: boolean | undefined } @@ -96841,7 +96667,7 @@ export type Routes = { space: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -96909,7 +96735,7 @@ export type Routes = { spaces: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -97317,9 +97143,9 @@ export type Routes = { See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ client_session: { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -97415,6 +97241,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -97455,7 +97282,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -97565,6 +97392,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true }[] } @@ -97614,6 +97442,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -97654,7 +97483,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -97764,6 +97593,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true acs_credential_id: string | null acs_entrances: { @@ -97997,11 +97827,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -98182,7 +98014,7 @@ export type Routes = { space: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -98261,7 +98093,7 @@ export type Routes = { space: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -98346,7 +98178,7 @@ export type Routes = { | { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -99540,7 +99372,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -99572,7 +99404,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -99701,6 +99533,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -99833,18 +99677,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -100093,31 +99925,51 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: | boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: | boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] | undefined @@ -100554,7 +100406,9 @@ export type Routes = { | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_system_id: string + /** Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_user_count?: number | undefined + /** Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. */ external_type?: @@ -100580,6 +100434,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Indicates whether the `acs_system` is a credential manager. */ is_credential_manager: boolean + /** Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ visionline_metadata?: | { /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */ @@ -100614,6 +100469,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ system_type_display_name?: string | undefined + /** Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ location: { /** Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. */ time_zone: string | null @@ -100622,12 +100478,12 @@ export type Routes = { name: string /** Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ workspace_id: string /** IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). * @deprecated Use `connected_account_id`.*/ connected_account_ids: string[] - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ connected_account_id: string /** URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ image_url: string @@ -100650,6 +100506,7 @@ export type Routes = { message: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' + /** Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined } | { @@ -100889,7 +100746,7 @@ export type Routes = { spaces: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -101029,7 +100886,7 @@ export type Routes = { space: { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -101201,6 +101058,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -101250,6 +101108,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -101294,7 +101153,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -101406,6 +101265,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -101417,6 +101277,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -101461,7 +101322,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -101664,6 +101525,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -101704,7 +101566,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -101814,6 +101676,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -101825,6 +101688,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -101865,7 +101729,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -102077,6 +101941,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -102117,7 +101982,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -102227,6 +102092,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -103144,6 +103010,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -103193,6 +103060,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -103237,7 +103105,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -103349,6 +103217,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -103360,6 +103229,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -103404,7 +103274,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -103607,6 +103477,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -103647,7 +103518,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -103757,6 +103628,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -103768,6 +103640,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -103808,7 +103681,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -104020,6 +103893,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -104060,7 +103934,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -104170,6 +104044,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -105045,7 +104920,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -105199,6 +105074,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -105248,6 +105124,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -105292,7 +105169,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -105404,6 +105281,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -105415,6 +105293,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -105459,7 +105338,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -105662,6 +105541,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -105702,7 +105582,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -105812,6 +105692,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -105823,6 +105704,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -105863,7 +105745,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -106075,6 +105957,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -106115,7 +105998,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -106225,6 +106108,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -108168,7 +108052,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -108200,7 +108084,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -108329,6 +108213,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -108461,18 +108357,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -108721,27 +108605,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined } } @@ -108877,6 +108781,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -108926,6 +108831,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -108970,7 +108876,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -109082,6 +108988,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -109093,6 +109000,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -109137,7 +109045,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -109340,6 +109248,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -109380,7 +109289,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -109490,6 +109399,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -109501,6 +109411,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -109541,7 +109452,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -109753,6 +109664,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -109793,7 +109705,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -109903,6 +109815,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -110824,6 +110737,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -110873,6 +110787,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -110917,7 +110832,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -111029,6 +110944,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -111040,6 +110956,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -111084,7 +111001,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -111287,6 +111204,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -111327,7 +111245,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -111437,6 +111355,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -111448,6 +111367,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -111488,7 +111408,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -111700,6 +111620,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -111740,7 +111661,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -111850,6 +111771,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -113887,7 +113809,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -113919,7 +113841,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -114048,6 +113970,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -114180,18 +114114,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -114440,27 +114362,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] devices: { @@ -115590,7 +115532,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -115622,7 +115564,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -115751,6 +115693,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -115883,18 +115837,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -116143,27 +116085,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] } @@ -116295,6 +116257,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -116344,6 +116307,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -116388,7 +116352,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -116500,6 +116464,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -116511,6 +116476,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -116555,7 +116521,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -116758,6 +116724,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -116798,7 +116765,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -116908,6 +116875,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -116919,6 +116887,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -116959,7 +116928,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -117171,6 +117140,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -117211,7 +117181,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -117321,6 +117291,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -118149,7 +118120,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -118206,7 +118177,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -118251,7 +118222,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -118437,6 +118408,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -118486,6 +118458,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -118530,7 +118503,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -118642,6 +118615,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -118653,6 +118627,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -118697,7 +118672,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -118900,6 +118875,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -118940,7 +118916,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -119050,6 +119026,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -119061,6 +119038,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -119101,7 +119079,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -119313,6 +119291,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -119353,7 +119332,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -119463,6 +119442,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -120412,6 +120392,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -120461,6 +120442,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -120505,7 +120487,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -120617,6 +120599,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -120628,6 +120611,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -120672,7 +120656,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -120875,6 +120859,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -120915,7 +120900,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -121025,6 +121010,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -121036,6 +121022,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -121076,7 +121063,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -121288,6 +121275,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -121328,7 +121316,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -121438,6 +121426,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -122504,6 +122493,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -122553,6 +122543,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -122597,7 +122588,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -122709,6 +122700,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -122720,6 +122712,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -122764,7 +122757,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -122967,6 +122960,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -123007,7 +123001,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -123117,6 +123111,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -123128,6 +123123,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -123168,7 +123164,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -123380,6 +123376,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -123420,7 +123417,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -123530,6 +123527,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -124340,7 +124338,7 @@ export type Routes = { customer_key: string /** Date and time at which the magic link expires. */ expires_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link. */ + /** ID of the workspace associated with the magic link. */ workspace_id: string /** Date and time at which the magic link was created. */ created_at: string @@ -124412,7 +124410,7 @@ export type Routes = { customer_key: string /** Date and time at which the magic link expires. */ expires_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link. */ + /** ID of the workspace associated with the magic link. */ workspace_id: string /** Date and time at which the magic link was created. */ created_at: string @@ -124443,7 +124441,7 @@ export type Routes = { customer_key: string /** Date and time at which the magic link expires. */ expires_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link. */ + /** ID of the workspace associated with the magic link. */ workspace_id: string /** Date and time at which the magic link was created. */ created_at: string @@ -124509,7 +124507,7 @@ export type Routes = { customer_key: string /** Date and time at which the magic link expires. */ expires_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the magic link. */ + /** ID of the workspace associated with the magic link. */ workspace_id: string /** Date and time at which the magic link was created. */ created_at: string @@ -124563,11 +124561,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -124654,7 +124654,7 @@ export type Routes = { user_identity_id: string /** Date and time at which the enrollment automation was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the enrollment automation. */ + /** ID of the workspace that contains the enrollment automation. */ workspace_id: string } } @@ -124689,7 +124689,7 @@ export type Routes = { user_identity_id: string /** Date and time at which the enrollment automation was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the enrollment automation. */ + /** ID of the workspace that contains the enrollment automation. */ workspace_id: string } } @@ -124715,7 +124715,7 @@ export type Routes = { user_identity_id: string /** Date and time at which the enrollment automation was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the enrollment automation. */ + /** ID of the workspace that contains the enrollment automation. */ workspace_id: string }[] } @@ -124741,13 +124741,13 @@ export type Routes = { instant_key: { /** ID of the Instant Key. */ instant_key_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key. */ + /** ID of the workspace that contains the Instant Key. */ workspace_id: string /** Date and time at which the Instant Key was created. */ created_at: string /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */ instant_key_url: string - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */ + /** ID of the client session associated with the Instant Key. */ client_session_id: string /** ID of the user identity associated with the Instant Key. */ user_identity_id: string @@ -124795,11 +124795,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -124884,11 +124886,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -126075,7 +126079,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -126107,7 +126111,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -126236,6 +126240,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -126368,18 +126384,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -126628,27 +126632,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] /** @@ -127780,7 +127804,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -127812,7 +127836,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -127941,6 +127965,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -128073,18 +128109,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -128333,27 +128357,47 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] } @@ -128605,7 +128649,9 @@ export type Routes = { default_credential_manager_acs_system_id?: (string | null) | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_system_id: string + /** Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_user_count?: number | undefined + /** Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. */ external_type?: @@ -128631,6 +128677,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Indicates whether the `acs_system` is a credential manager. */ is_credential_manager: boolean + /** Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ visionline_metadata?: | { /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */ @@ -128665,6 +128712,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ system_type_display_name?: string | undefined + /** Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ location: { /** Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. */ time_zone: string | null @@ -128673,12 +128721,12 @@ export type Routes = { name: string /** Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ workspace_id: string /** IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). * @deprecated Use `connected_account_id`.*/ connected_account_ids: string[] - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ connected_account_id: string /** URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ image_url: string @@ -128701,6 +128749,7 @@ export type Routes = { message: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' + /** Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined } | { @@ -128802,8 +128851,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -129065,7 +129115,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -129086,6 +129136,7 @@ export type Routes = { email_address?: string | undefined /** Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined + /** Indicates whether Seam manages the access system user. */ is_managed: true }[] } @@ -129140,11 +129191,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -129208,11 +129261,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -129314,7 +129369,7 @@ export type Routes = { jsonResponse: { /** Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive. */ webhook: { - /** ID of the [webhook](https://docs.seam.co/developer-tools/webhooks). */ + /** ID of the webhook. */ webhook_id: string /** URL for the [webhook](https://docs.seam.co/developer-tools/webhooks). */ url: string @@ -129352,7 +129407,7 @@ export type Routes = { jsonResponse: { /** Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive. */ webhook: { - /** ID of the [webhook](https://docs.seam.co/developer-tools/webhooks). */ + /** ID of the webhook. */ webhook_id: string /** URL for the [webhook](https://docs.seam.co/developer-tools/webhooks). */ url: string @@ -129373,7 +129428,7 @@ export type Routes = { formData: {} jsonResponse: { webhooks: { - /** ID of the [webhook](https://docs.seam.co/developer-tools/webhooks). */ + /** ID of the webhook. */ webhook_id: string /** URL for the [webhook](https://docs.seam.co/developer-tools/webhooks). */ url: string @@ -129446,7 +129501,7 @@ export type Routes = { jsonResponse: { /** Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces). */ workspace: { - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ + /** ID of the workspace. */ workspace_id: string /** Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ name: string @@ -129475,6 +129530,8 @@ export type Routes = { publishable_key?: string | undefined /** Indicates whether publishable key authentication is enabled for this workspace. */ is_publishable_key_auth_enabled: boolean + /** ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization. */ + organization_id: string | null } } maxDuration: undefined @@ -129497,6 +129554,13 @@ export type Routes = { mono_font_family?: string | undefined } | undefined + message_overrides?: + | { + [x: string]: { + [x: string]: string + } + } + | undefined } commonParams: {} formData: {} @@ -129520,6 +129584,13 @@ export type Routes = { mono_font_family?: string | undefined } | undefined + message_overrides?: + | { + [x: string]: { + [x: string]: string + } + } + | undefined } } maxDuration: undefined @@ -129553,6 +129624,13 @@ export type Routes = { mono_font_family?: string | undefined } | undefined + message_overrides?: + | { + [x: string]: { + [x: string]: string + } + } + | undefined } } maxDuration: undefined @@ -129586,6 +129664,13 @@ export type Routes = { mono_font_family?: string | undefined } | undefined + message_overrides?: + | { + [x: string]: { + [x: string]: string + } + } + | undefined }[] } maxDuration: undefined @@ -129612,6 +129697,16 @@ export type Routes = { | undefined ) | null + message_overrides?: + | ( + | { + [x: string]: { + [x: string]: string + } + } + | undefined + ) + | null } commonParams: {} formData: {} @@ -129650,11 +129745,13 @@ export type Routes = { email_address: string | null /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */ phone_number: string | null + /** Display name for the user identity. */ display_name: string + /** Full name of the user associated with the user identity. */ full_name: string | null /** Date and time at which the user identity was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. */ + /** ID of the workspace that contains the user identity. */ workspace_id: string /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */ errors: { @@ -129694,7 +129791,7 @@ export type Routes = { | undefined workspaces?: | { - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ + /** ID of the workspace. */ workspace_id: string /** Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ name: string @@ -129723,6 +129820,8 @@ export type Routes = { publishable_key?: string | undefined /** Indicates whether publishable key authentication is enabled for this workspace. */ is_publishable_key_auth_enabled: boolean + /** ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization. */ + organization_id: string | null }[] | undefined devices?: @@ -130875,7 +130974,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -130907,7 +131006,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -131036,6 +131135,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -131168,18 +131279,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -131428,31 +131527,51 @@ export type Routes = { image_url?: string | undefined } | undefined + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: | boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: | boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] | undefined @@ -131685,7 +131804,9 @@ export type Routes = { | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_system_id: string + /** Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_user_count?: number | undefined + /** Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. */ external_type?: @@ -131711,6 +131832,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Indicates whether the `acs_system` is a credential manager. */ is_credential_manager: boolean + /** Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ visionline_metadata?: | { /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */ @@ -131745,6 +131867,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ system_type_display_name?: string | undefined + /** Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ location: { /** Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. */ time_zone: string | null @@ -131753,12 +131876,12 @@ export type Routes = { name: string /** Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ workspace_id: string /** IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). * @deprecated Use `connected_account_id`.*/ connected_account_ids: string[] - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ + /** ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ connected_account_id: string /** URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). */ image_url: string @@ -131781,6 +131904,7 @@ export type Routes = { message: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' + /** Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined } | { @@ -131870,8 +131994,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -132137,7 +132262,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -132158,6 +132283,7 @@ export type Routes = { email_address?: string | undefined /** Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined + /** Indicates whether Seam manages the access system user. */ is_managed: true }[] | undefined @@ -132167,9 +132293,9 @@ export type Routes = { acs_access_group_id: string /** ID of the access control system that contains the access group. */ acs_system_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. */ + /** ID of the workspace that contains the access group. */ workspace_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. */ + /** ID of the connected account that contains the access group. */ connected_account_id: string /** Name of the access group. */ name: string @@ -132187,6 +132313,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ access_group_type_display_name: string + /** Display name for the access group. */ display_name: string /** Brand-specific terminology for the access group type. */ external_type: @@ -132354,6 +132481,7 @@ export type Routes = { variant: 'adding' | 'removing' } )[] + /** Indicates whether Seam manages the access group. */ is_managed: true }[] | undefined @@ -132363,9 +132491,9 @@ export type Routes = { acs_encoder_id: string /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ acs_system_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ + /** ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ connected_account_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ + /** ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ workspace_id: string /** Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ errors: { @@ -132491,6 +132619,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -132540,6 +132669,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -132584,7 +132714,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -132704,6 +132834,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -132715,6 +132846,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -132759,7 +132891,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -132970,6 +133102,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -133014,7 +133147,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -133126,6 +133259,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -133137,6 +133271,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -133181,7 +133316,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -133395,6 +133530,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -133435,7 +133571,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -133545,6 +133681,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -134333,9 +134470,9 @@ export type Routes = { | undefined client_sessions?: | { - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the client session. */ client_session_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). */ + /** ID of the workspace associated with the client session. */ workspace_id: string /** Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. */ created_at: string @@ -134366,8 +134503,9 @@ export type Routes = { acs_user_id: string /** ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ acs_system_id: string + /** ID of the HID access control system associated with the user. */ hid_acs_system_id?: string | undefined - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ + /** ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ workspace_id: string /** Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. */ created_at: string @@ -134633,7 +134771,7 @@ export type Routes = { /** The last time an internal sync job completed for this access system user. */ last_successful_sync_at: string | null /** - The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ connected_account_id: string /** Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */ @@ -134663,9 +134801,9 @@ export type Routes = { acs_access_group_id: string /** ID of the access control system that contains the access group. */ acs_system_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. */ + /** ID of the workspace that contains the access group. */ workspace_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. */ + /** ID of the connected account that contains the access group. */ connected_account_id: string /** Name of the access group. */ name: string @@ -134683,6 +134821,7 @@ export type Routes = { /** * @deprecated Use `external_type_display_name`.*/ access_group_type_display_name: string + /** Display name for the access group. */ display_name: string /** Brand-specific terminology for the access group type. */ external_type: @@ -134956,6 +135095,18 @@ export type Routes = { /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } + | { + /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ + message: string + /** Indicates that the error is not a device error. */ + is_device_error: false + /** Date and time at which Seam created the error. */ + created_at: string + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'dormakaba_sites_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true + } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -135088,18 +135239,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */ warnings: ( @@ -135322,6 +135461,7 @@ export type Routes = { custom_metadata: { [x: string]: string | boolean } + /** Indicates that Seam does not manage the device. */ is_managed: false /** properties of the device. */ properties: { @@ -135399,31 +135539,51 @@ export type Routes = { accessory_keypad_supported?: boolean | undefined } } + /** Indicates whether the device supports remote unlocking. */ can_remotely_unlock?: boolean | undefined + /** Indicates whether the device supports remote locking. */ can_remotely_lock?: boolean | undefined + /** Indicates whether the device supports programming offline access codes. */ can_program_offline_access_codes?: boolean | undefined + /** Indicates whether the device supports programming online access codes. */ can_program_online_access_codes?: boolean | undefined + /** Indicates whether the thermostat supports heating. */ can_hvac_heat?: boolean | undefined + /** Indicates whether the thermostat supports cooling. */ can_hvac_cool?: boolean | undefined + /** Indicates whether the thermostat supports simultaneous heating and cooling. */ can_hvac_heat_cool?: boolean | undefined + /** Indicates whether the thermostat can be turned off. */ can_turn_off_hvac?: boolean | undefined + /** Indicates whether the device supports simulating removal in a sandbox. */ can_simulate_removal?: boolean | undefined + /** Indicates whether the device supports simulating connection in a sandbox. */ can_simulate_connection?: boolean | undefined + /** Indicates whether the device supports simulating disconnection in a sandbox. */ can_simulate_disconnection?: boolean | undefined + /** Indicates whether the lock supports unlocking with an access code. */ can_unlock_with_code?: boolean | undefined + /** Indicates whether the thermostat supports running climate programs. */ can_run_thermostat_programs?: boolean | undefined + /** Indicates whether the thermostat supports weekday/weekend climate programs. */ can_program_thermostat_programs_as_weekday_weekend?: | boolean | undefined + /** Indicates whether the thermostat supports different climate programs for each day of the week. */ can_program_thermostat_programs_as_different_each_day?: | boolean | undefined + /** Indicates whether the thermostat supports a single climate program applied to every day. */ can_program_thermostat_programs_as_same_each_day?: | boolean | undefined + /** Indicates whether the hub supports simulating connection in a sandbox. */ can_simulate_hub_connection?: boolean | undefined + /** Indicates whether the hub supports simulating disconnection in a sandbox. */ can_simulate_hub_disconnection?: boolean | undefined + /** Indicates whether the device supports simulating a paid subscription in a sandbox. */ can_simulate_paid_subscription?: boolean | undefined + /** Indicates whether the lock supports configuring automatic locking. */ can_configure_auto_lock?: boolean | undefined }[] | undefined @@ -135431,14 +135591,15 @@ export type Routes = { | { /** ID of the Connect Webview. */ connect_webview_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview. */ + /** ID of the workspace that contains the Connect Webview. */ workspace_id: string /** Date and time at which the Connect Webview was created. */ created_at: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview. */ + /** ID of the connected account associated with the Connect Webview. */ connected_account_id: string | null /** URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user. */ url: string + /** Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`. */ device_selection_mode: 'none' | 'single' | 'multiple' /** List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ accepted_providers: string[] @@ -135486,7 +135647,7 @@ export type Routes = { | { /** ID of the space. */ space_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. */ + /** ID of the workspace associated with the space. */ workspace_id: string /** Unique key for the space within the workspace. */ space_key?: string | undefined @@ -136060,7 +136221,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136070,7 +136231,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136089,7 +136250,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136099,7 +136260,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136131,7 +136292,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136141,7 +136302,186 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.name_changed' + /** Previous access code name configuration. */ + from: { + /** Previous name of the access code. */ + name: string | null + } + /** New access code name configuration. */ + to: { + /** New name of the access code. */ + name: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.code_changed' + /** Previous pin code configuration. */ + from: { + /** Previous pin code. */ + code: string | null + } + /** New pin code configuration. */ + to: { + /** New pin code. */ + code: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.time_frame_changed' + /** Previous time frame configuration. */ + from: { + /** Previous start time. */ + starts_at: string | null + /** Previous end time. */ + ends_at: string | null + } + /** New time frame configuration. */ + to: { + /** New start time. */ + starts_at: string | null + /** New end time. */ + ends_at: string | null + } + /** Human-readable description of the change and its source. */ + description: string + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ + connected_account_id: string + /** Custom metadata of the device, present when device_id is provided. */ + device_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + /** Custom metadata of the connected account, present when connected_account_id is provided. */ + connected_account_custom_metadata?: + | { + [x: string]: string | boolean + } + | undefined + event_type: 'access_code.mutations_requested' + /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */ + requested_mutations: { + /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */ + mutation_code: + | 'updating_name' + | 'updating_code' + | 'updating_time_frame' + | 'deleting' + | 'creating' + | 'deferring_creation' + /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + from?: + | { + [x: string]: unknown + } + | undefined + /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */ + to?: + | { + [x: string]: unknown + } + | undefined + }[] + } + | { + /** ID of the event. */ + event_id: string + /** ID of the workspace associated with the event. */ + workspace_id: string + /** Date and time at which the event was created. */ + created_at: string + /** Date and time at which the event occurred. */ + occurred_at: string + /** ID of the affected access code. */ + access_code_id: string + /** ID of the device associated with the affected access code. */ + device_id: string + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136162,7 +136502,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136172,7 +136512,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136193,7 +136533,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136203,7 +136543,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136222,7 +136562,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136232,7 +136572,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136305,7 +136645,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136315,7 +136655,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136388,7 +136728,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136398,7 +136738,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136419,7 +136759,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136429,7 +136769,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136502,7 +136842,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136512,7 +136852,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136585,7 +136925,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136595,7 +136935,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136614,7 +136954,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136624,7 +136964,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136643,7 +136983,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136653,7 +136993,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136668,12 +137008,13 @@ export type Routes = { } | undefined event_type: 'access_code.backup_access_code_pulled' + /** ID of the backup access code that was pulled from the pool. */ backup_access_code_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136683,7 +137024,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136702,7 +137043,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136712,7 +137053,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136785,7 +137126,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136795,7 +137136,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136814,7 +137155,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136824,7 +137165,7 @@ export type Routes = { access_code_id: string /** ID of the device associated with the affected access code. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code. */ + /** ID of the connected account associated with the affected access code. */ connected_account_id: string /** Custom metadata of the device, present when device_id is provided. */ device_custom_metadata?: @@ -136843,7 +137184,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136856,7 +137197,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136869,7 +137210,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136882,7 +137223,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136897,7 +137238,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136912,7 +137253,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136931,7 +137272,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136948,7 +137289,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136969,7 +137310,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -136986,7 +137327,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137003,7 +137344,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137020,7 +137361,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137041,7 +137382,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137058,7 +137399,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137073,7 +137414,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137088,7 +137429,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137139,7 +137480,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137156,7 +137497,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137173,7 +137514,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137190,7 +137531,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137207,7 +137548,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137217,13 +137558,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.created' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137233,13 +137575,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected access system user. */ acs_user_id: string event_type: 'acs_user.deleted' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137256,7 +137599,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137273,7 +137616,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137290,7 +137633,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137300,13 +137643,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.added' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137316,13 +137660,14 @@ export type Routes = { connected_account_id?: string | undefined /** ID of the access system. */ acs_system_id: string + /** ID of the affected entrance. */ acs_entrance_id: string event_type: 'acs_entrance.removed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137335,13 +137680,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137350,7 +137695,7 @@ export type Routes = { } | undefined event_type: 'connected_account.connected' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id?: string | undefined /** The customer key associated with this connected account, if any. */ customer_key?: string | undefined @@ -137358,13 +137703,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137373,19 +137718,19 @@ export type Routes = { } | undefined event_type: 'connected_account.created' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137394,19 +137739,19 @@ export type Routes = { } | undefined event_type: 'connected_account.successful_login' - /** ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) associated with the event. */ + /** ID of the Connect Webview associated with the event. */ connect_webview_id: string } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137437,13 +137782,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137456,13 +137801,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137479,13 +137824,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137498,13 +137843,13 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [connected account](https://docs.seam.co/core-concepts/connected-accounts). */ + /** ID of the affected connected account. */ connected_account_id: string /** Custom metadata of the connected account, present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137535,7 +137880,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137556,7 +137901,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137577,7 +137922,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137598,7 +137943,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137619,7 +137964,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137640,7 +137985,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137661,7 +138006,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137682,7 +138027,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137703,16 +138048,16 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_succeeded' - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** Custom metadata of the connected account; present when connected_account_id is provided. */ connected_account_custom_metadata?: @@ -137726,20 +138071,20 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string - /** ID of the affected [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). */ + /** ID of the affected Connect Webview. */ connect_webview_id: string event_type: 'connect_webview.login_failed' } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137747,7 +138092,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -137768,7 +138113,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137776,7 +138121,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -137797,7 +138142,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137805,7 +138150,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -137826,7 +138171,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137834,7 +138179,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -137855,7 +138200,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137863,7 +138208,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -137884,7 +138229,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137892,7 +138237,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -137954,7 +138299,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -137962,7 +138307,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138024,7 +138369,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138032,7 +138377,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138053,7 +138398,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138061,7 +138406,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138084,7 +138429,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138092,7 +138437,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138117,7 +138462,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138125,7 +138470,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138146,7 +138491,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138154,7 +138499,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138177,7 +138522,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138185,7 +138530,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138206,7 +138551,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138214,7 +138559,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138235,7 +138580,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138243,7 +138588,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138264,7 +138609,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138272,7 +138617,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138293,7 +138638,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138301,7 +138646,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138358,7 +138703,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138366,7 +138711,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138387,7 +138732,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138395,7 +138740,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138452,7 +138797,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138460,7 +138805,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138481,7 +138826,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138489,7 +138834,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138510,7 +138855,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138518,7 +138863,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138575,7 +138920,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138583,7 +138928,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138624,7 +138969,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138632,7 +138977,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138674,7 +139019,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138682,7 +139027,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id?: string | undefined - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138748,15 +139093,15 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string /** Date and time at which the event occurred. */ occurred_at: string /** ID of the affected device. */ - device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + device_id?: string | undefined + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138775,11 +139120,35 @@ export type Routes = { event_type: 'lock.access_denied' /** ID of the access code that was used in the unlock attempts. */ access_code_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the user identity associated with the access-denied event. + */ + user_identity_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS system associated with the access-denied event. + */ + acs_system_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS user associated with the access-denied event. + */ + acs_user_id?: string | undefined + /** + undocumented: Unreleased. + --- + ID of the ACS entrance associated with the access-denied event. + */ + acs_entrance_id?: string | undefined } | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138787,7 +139156,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138814,7 +139183,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138822,7 +139191,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138868,7 +139237,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138876,7 +139245,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138909,7 +139278,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138917,7 +139286,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138950,7 +139319,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138958,7 +139327,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -138987,7 +139356,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -138995,7 +139364,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -139020,7 +139389,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139028,7 +139397,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -139051,7 +139420,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139059,7 +139428,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -139090,7 +139459,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139098,7 +139467,7 @@ export type Routes = { occurred_at: string /** ID of the affected device. */ device_id: string - /** ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the event. */ + /** ID of the connected account associated with the event. */ connected_account_id: string /** The customer key associated with the device, if any. */ customer_key?: string | undefined @@ -139123,7 +139492,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139136,7 +139505,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139155,7 +139524,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139175,7 +139544,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139195,7 +139564,7 @@ export type Routes = { | { /** ID of the event. */ event_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. */ + /** ID of the workspace associated with the event. */ workspace_id: string /** Date and time at which the event was created. */ created_at: string @@ -139218,13 +139587,13 @@ export type Routes = { | { /** ID of the Instant Key. */ instant_key_id: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key. */ + /** ID of the workspace that contains the Instant Key. */ workspace_id: string /** Date and time at which the Instant Key was created. */ created_at: string /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */ instant_key_url: string - /** ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */ + /** ID of the client session associated with the Instant Key. */ client_session_id: string /** ID of the user identity associated with the Instant Key. */ user_identity_id: string @@ -139255,6 +139624,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -139295,7 +139665,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -139405,6 +139775,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true }[] | undefined @@ -139418,6 +139789,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -139458,7 +139830,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -139599,26 +139971,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -139683,26 +140035,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -139726,36 +140058,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -139776,36 +140078,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -139824,17 +140096,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -139844,7 +140118,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -139856,7 +140130,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -139992,18 +140266,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -140015,14 +140277,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140031,14 +140285,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140092,14 +140338,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140116,14 +140354,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140132,14 +140362,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140226,26 +140448,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'provider_issue' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_access_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'smartthings_failed_to_set_after_multiple_retries' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140310,26 +140512,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'access_code_state_unconfirmed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'kwikset_unable_to_confirm_deletion' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140353,36 +140535,6 @@ export type Routes = { }[] | undefined } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_invalid_code_length' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_missing_keypad' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140403,36 +140555,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'salto_ks_user_not_subscribed' } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_duplicate_code_name' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'wyze_potential_duplicate_code' - } - | { - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true - /** Date and time at which Seam created the error. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_oracode_invalid_time_range' - } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140451,17 +140573,19 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at?: string | undefined /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'keynest_unsupported_third_party_locker' + error_code: 'replaced_by_newer_access_code' } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ message: string - /** Indicates that this is an access code error. */ - is_access_code_error: true + /** Indicates that the error is not a device error. */ + is_device_error: false /** Date and time at which Seam created the error. */ - created_at?: string | undefined + created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'replaced_by_newer_access_code' + error_code: 'account_disconnected' + /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ + is_connected_account_error: true } | { /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ @@ -140471,7 +140595,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'account_disconnected' + error_code: 'salto_ks_subscription_limit_exceeded' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -140483,7 +140607,7 @@ export type Routes = { /** Date and time at which Seam created the error. */ created_at: string /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'salto_ks_subscription_limit_exceeded' + error_code: 'dormakaba_sites_disconnected' /** Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. */ is_connected_account_error: true } @@ -140619,18 +140743,6 @@ export type Routes = { /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ error_code: 'bridge_disconnected' } - | { - /** Date and time at which Seam created the error. */ - created_at: string - /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Indicates whether the error is related specifically to the connected account. */ - is_connected_account_error?: boolean | undefined - /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). */ - is_bridge_error?: boolean | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'dormakaba_sites_disconnected' - } )[] /** Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). */ warnings: ( @@ -140642,14 +140754,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'provider_issue' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'smartthings_failed_to_set_access_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140658,14 +140762,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'schlage_detected_duplicate' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'schlage_creation_outage' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140719,14 +140815,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'third_party_integration_detected' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - warning_code: 'august_lock_temporarily_offline' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140743,14 +140831,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'management_transferred' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'kwikset_unable_to_confirm_code' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140759,14 +140839,6 @@ export type Routes = { /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ warning_code: 'access_code_inactive' } - | { - /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ - message: string - /** Date and time at which Seam created the warning. */ - created_at?: string | undefined - /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */ - warning_code: 'ultraloq_access_code_disabled' - } | { /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */ message: string @@ -140929,7 +141001,7 @@ export type Routes = { /** Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string }[] - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. */ + /** ID of the workspace that contains the thermostat daily program. */ workspace_id: string /** Date and time at which the thermostat daily program was created. */ created_at: string @@ -140953,7 +141025,7 @@ export type Routes = { is_override_allowed?: boolean | undefined /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. */ + /** ID of the workspace that contains the thermostat schedule. */ workspace_id: string /** Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string @@ -141003,6 +141075,13 @@ export type Routes = { mono_font_family?: string | undefined } | undefined + message_overrides?: + | { + [x: string]: { + [x: string]: string + } + } + | undefined }[] | undefined } @@ -141019,7 +141098,7 @@ export type Routes = { jsonResponse: { /** Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces). */ workspace: { - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ + /** ID of the workspace. */ workspace_id: string /** Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ name: string @@ -141048,6 +141127,8 @@ export type Routes = { publishable_key?: string | undefined /** Indicates whether publishable key authentication is enabled for this workspace. */ is_publishable_key_auth_enabled: boolean + /** ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization. */ + organization_id: string | null } } maxDuration: undefined @@ -141061,7 +141142,7 @@ export type Routes = { formData: {} jsonResponse: { workspaces: { - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ + /** ID of the workspace. */ workspace_id: string /** Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). */ name: string @@ -141090,6 +141171,8 @@ export type Routes = { publishable_key?: string | undefined /** Indicates whether publishable key authentication is enabled for this workspace. */ is_publishable_key_auth_enabled: boolean + /** ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization. */ + organization_id: string | null }[] } maxDuration: undefined @@ -141215,6 +141298,7 @@ export type Routes = { acs_credential_on_encoder: { /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null + /** Indicates whether the credential has been issued (encoded onto a card). */ is_issued: boolean | null /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null @@ -141264,6 +141348,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -141308,7 +141393,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -141420,6 +141505,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -141431,6 +141517,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -141475,7 +141562,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -141678,6 +141765,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -141718,7 +141806,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -141828,6 +141916,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } | { @@ -141839,6 +141928,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -141879,7 +141969,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -142091,6 +142181,7 @@ export type Routes = { user_identity_id?: string | undefined /** ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs. */ connected_account_id: string + /** ID of the credential pool to which the credential belongs. */ acs_credential_pool_id?: string | undefined /** ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ acs_system_id: string @@ -142131,7 +142222,7 @@ export type Routes = { external_type_display_name?: string | undefined /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string - /** ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ + /** ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */ workspace_id: string /** Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at?: string | undefined @@ -142241,6 +142332,7 @@ export type Routes = { endpoint_id?: string | undefined } | undefined + /** Indicates whether Seam manages the credential. */ is_managed: true } } @@ -143035,6 +143127,8 @@ export type Routes = { jsonBody: { /** Name of the workspace. */ name?: string | undefined + /** ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization. */ + organization_id?: string | undefined /** Connect partner name for the workspace. */ connect_partner_name?: string | undefined /** [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */