diff --git a/src/lib/seam/connect/models/devices/device.ts b/src/lib/seam/connect/models/devices/device.ts index 6efbb763..c442dbcd 100644 --- a/src/lib/seam/connect/models/devices/device.ts +++ b/src/lib/seam/connect/models/devices/device.ts @@ -26,13 +26,128 @@ const common_device_error = z.object({ is_device_error: z.literal(true), }) +const error_code_description = + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.' + const common_device_warning = z.object({ message: z.string(), }) -export const device_error = common_device_error.extend({ - error_code: z.string(), -}) +const device_offline = common_device_error + .extend({ + error_code: z.literal('device_offline').describe(error_code_description), + }) + .describe('Device is offline') + +const device_removed = common_device_error + .extend({ + error_code: z.literal('device_removed').describe(error_code_description), + }) + .describe('Device has been removed') + +const account_disconnected = common_device_error + .extend({ + error_code: z + .literal('account_disconnected') + .describe(error_code_description), + }) + .describe('Account is disconnected') + +const hub_disconnected = common_device_error + .extend({ + error_code: z.literal('hub_disconnected').describe(error_code_description), + }) + .describe('Hub is disconnected') + +const device_disconnected = common_device_error + .extend({ + error_code: z + .literal('device_disconnected') + .describe(error_code_description), + }) + .describe('Device is disconnected') + +const empty_backup_access_code_pool = common_device_error + .extend({ + error_code: z + .literal('empty_backup_access_code_pool') + .describe(error_code_description), + }) + .describe('The backup access code pool is empty.') + +const august_lock_not_authorized = common_device_error + .extend({ + error_code: z + .literal('august_lock_not_authorized') + .describe(error_code_description), + }) + .describe('User is not authorized to use the August Lock.') + +const august_lock_missing_bridge = common_device_error + .extend({ + error_code: z + .literal('august_lock_missing_bridge') + .describe(error_code_description), + }) + .describe('Lock is not connected to the Seam Bridge.') + +const salto_site_user_limit_reached = common_device_error + .extend({ + error_code: z + .literal('salto_site_user_limit_reached') + .describe(error_code_description), + }) + .describe('Salto site user limit reached.') + +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('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('Missing device credentials.') + +const auxiliary_heat_running = common_device_error + .extend({ + error_code: z + .literal('auxiliary_heat_running') + .describe(error_code_description), + }) + .describe('The auxiliary heat is running.') + +const subscription_required = common_device_error + .extend({ + error_code: z + .literal('subscription_required') + .describe(error_code_description), + }) + .describe('Subscription required to connect.') + +export const device_error = z + .union([ + device_offline, + device_removed, + account_disconnected, + hub_disconnected, + device_disconnected, + empty_backup_access_code_pool, + august_lock_not_authorized, + august_lock_missing_bridge, + salto_site_user_limit_reached, + ttlock_lock_not_paired_to_gateway, + missing_device_credentials, + auxiliary_heat_running, + subscription_required, + ]) + .describe('Error associated with the `device`.') export type DeviceError = z.infer diff --git a/src/lib/seam/connect/openapi.ts b/src/lib/seam/connect/openapi.ts index 84c7ae2a..4f43d8d3 100644 --- a/src/lib/seam/connect/openapi.ts +++ b/src/lib/seam/connect/openapi.ts @@ -53,13 +53,205 @@ export default { type: 'object', }, { - properties: { - error_code: { type: 'string' }, - is_device_error: { enum: [true], type: 'boolean' }, - message: { type: 'string' }, - }, - required: ['message', 'is_device_error', 'error_code'], - type: 'object', + description: 'Error associated with the `device`.', + oneOf: [ + { + description: 'Device is offline', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device has been removed', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Account is disconnected', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['account_disconnected'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Hub is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The backup access code pool is empty.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: + 'User is not authorized to use the August Lock.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not connected to the Seam Bridge.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['august_lock_missing_bridge'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Salto site user limit reached.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['salto_site_user_limit_reached'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not paired with a Gateway.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Missing device credentials.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The auxiliary heat is running.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Subscription required to connect.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['subscription_required'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + ], }, { properties: { @@ -4415,13 +4607,205 @@ export default { items: { oneOf: [ { - properties: { - error_code: { type: 'string' }, - is_device_error: { enum: [true], type: 'boolean' }, - message: { type: 'string' }, - }, - required: ['message', 'is_device_error', 'error_code'], - type: 'object', + description: 'Error associated with the `device`.', + oneOf: [ + { + description: 'Device is offline', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device has been removed', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Account is disconnected', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['account_disconnected'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Hub is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The backup access code pool is empty.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: + 'User is not authorized to use the August Lock.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not connected to the Seam Bridge.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['august_lock_missing_bridge'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Salto site user limit reached.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['salto_site_user_limit_reached'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not paired with a Gateway.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Missing device credentials.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The auxiliary heat is running.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Subscription required to connect.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['subscription_required'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + ], }, { properties: { @@ -10019,13 +10403,205 @@ export default { items: { oneOf: [ { - properties: { - error_code: { type: 'string' }, - is_device_error: { enum: [true], type: 'boolean' }, - message: { type: 'string' }, - }, - required: ['message', 'is_device_error', 'error_code'], - type: 'object', + description: 'Error associated with the `device`.', + oneOf: [ + { + description: 'Device is offline', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device has been removed', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Account is disconnected', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['account_disconnected'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Hub is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The backup access code pool is empty.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: + 'User is not authorized to use the August Lock.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not connected to the Seam Bridge.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['august_lock_missing_bridge'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Salto site user limit reached.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['salto_site_user_limit_reached'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not paired with a Gateway.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Missing device credentials.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The auxiliary heat is running.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Subscription required to connect.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['subscription_required'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + ], }, { properties: { @@ -10266,13 +10842,205 @@ export default { type: 'object', }, { - properties: { - error_code: { type: 'string' }, - is_device_error: { enum: [true], type: 'boolean' }, - message: { type: 'string' }, - }, - required: ['message', 'is_device_error', 'error_code'], - type: 'object', + description: 'Error associated with the `device`.', + oneOf: [ + { + description: 'Device is offline', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device has been removed', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Account is disconnected', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['account_disconnected'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Hub is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The backup access code pool is empty.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: + 'User is not authorized to use the August Lock.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not connected to the Seam Bridge.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['august_lock_missing_bridge'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Salto site user limit reached.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['salto_site_user_limit_reached'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not paired with a Gateway.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Missing device credentials.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The auxiliary heat is running.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Subscription required to connect.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['subscription_required'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + ], }, { properties: { @@ -10446,13 +11214,205 @@ export default { items: { oneOf: [ { - properties: { - error_code: { type: 'string' }, - is_device_error: { enum: [true], type: 'boolean' }, - message: { type: 'string' }, - }, - required: ['message', 'is_device_error', 'error_code'], - type: 'object', + description: 'Error associated with the `device`.', + oneOf: [ + { + description: 'Device is offline', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device has been removed', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Account is disconnected', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['account_disconnected'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Hub is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Device is disconnected', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The backup access code pool is empty.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: + 'User is not authorized to use the August Lock.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not connected to the Seam Bridge.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['august_lock_missing_bridge'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Salto site user limit reached.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['salto_site_user_limit_reached'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Lock is not paired with a Gateway.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Missing device credentials.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'The auxiliary heat is running.', + properties: { + 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: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + { + description: 'Subscription required to connect.', + properties: { + error_code: { + description: + 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + enum: ['subscription_required'], + type: 'string', + }, + is_device_error: { enum: [true], type: 'boolean' }, + message: { type: 'string' }, + }, + required: ['message', 'is_device_error', 'error_code'], + type: 'object', + }, + ], }, { properties: { diff --git a/src/lib/seam/connect/route-types.ts b/src/lib/seam/connect/route-types.ts index 12c876f8..ebcd03dc 100644 --- a/src/lib/seam/connect/route-types.ts +++ b/src/lib/seam/connect/route-types.ts @@ -986,11 +986,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -1078,11 +1153,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -2122,11 +2272,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -2201,11 +2426,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -2278,11 +2578,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -2343,11 +2718,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -2416,11 +2866,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -3436,11 +3961,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -3492,11 +4092,86 @@ export interface Routes { is_access_code_error: true error_code: string } - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -13226,11 +13901,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -14115,11 +14865,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -14346,11 +15171,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -14681,11 +15581,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -18078,11 +19053,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -18783,11 +19833,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -19672,11 +20797,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -20377,11 +21577,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -23196,11 +24471,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -23901,11 +25251,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -26916,11 +28341,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -27015,11 +28515,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -29684,11 +31259,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -32485,11 +34135,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -33190,11 +34915,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -37254,11 +39054,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true @@ -37961,11 +39836,86 @@ export interface Routes { workspace_id: string /** Array of errors associated with the device. Each error object within the array contains two fields: "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: Array< - | { - message: string - is_device_error: true - error_code: string - } + | ( + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_offline' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_removed' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'account_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'hub_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'device_disconnected' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'empty_backup_access_code_pool' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_not_authorized' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'august_lock_missing_bridge' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'salto_site_user_limit_reached' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'ttlock_lock_not_paired_to_gateway' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'missing_device_credentials' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'auxiliary_heat_running' + } + | { + message: string + is_device_error: true + /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ + error_code: 'subscription_required' + } + ) | { message: string is_connected_account_error: true