diff --git a/src/lib/blueprint.test.ts b/src/lib/blueprint.test.ts index a602dd06..2ab64520 100644 --- a/src/lib/blueprint.test.ts +++ b/src/lib/blueprint.test.ts @@ -8,7 +8,7 @@ import { type Method, type OpenapiAuthMethod, } from 'lib/blueprint.js' -import type { OpenapiOperation, OpenapiSchema } from 'lib/openapi.js' +import type { OpenapiOperation, OpenapiSchema } from 'lib/openapi/types.js' test('createProperties: assigns appropriate default values', (t) => { const minimalProperties = { diff --git a/src/lib/blueprint.ts b/src/lib/blueprint.ts index fb694905..a9f1736e 100644 --- a/src/lib/blueprint.ts +++ b/src/lib/blueprint.ts @@ -9,23 +9,27 @@ import type { CodeSampleDefinition, CodeSampleSyntax, } from './code-sample/schema.js' +import { findCommonOpenapiSchemaProperties } from './openapi/find-common-openapi-schema-properties.js' +import { + type AuthMethodSchema, + EventResourceSchema, + OpenapiOperationSchema, + PropertySchema, + ResourceSchema, +} from './openapi/schemas.js' import type { Openapi, OpenapiOperation, OpenapiPathItem, OpenapiPaths, OpenapiSchema, -} from './openapi.js' -import { - type AuthMethodSchema, - OpenapiOperationSchema, - PropertySchema, -} from './openapi-schema.js' +} from './openapi/types.js' export interface Blueprint { title: string routes: Route[] resources: Record + events: EventResource[] } export interface Route { @@ -43,6 +47,7 @@ export interface Resource { resourceType: string properties: Property[] description: string + routePath: string isDeprecated: boolean deprecationMessage: string isUndocumented: boolean @@ -51,6 +56,12 @@ export interface Resource { draftMessage: string } +interface EventResource extends Resource { + resourceType: 'event' + eventType: string + targetResourceType: string | null +} + export interface Namespace { path: string isDeprecated: boolean @@ -277,6 +288,43 @@ export interface BlueprintOptions { formatCode?: (content: string, syntax: CodeSampleSyntax) => Promise } +const createEvents = ( + schemas: Openapi['components']['schemas'], + resources: Record, +): EventResource[] => { + const eventSchema = schemas['event'] + if ( + eventSchema == null || + typeof eventSchema !== 'object' || + !('oneOf' in eventSchema) || + !Array.isArray(eventSchema.oneOf) + ) { + return [] + } + + return eventSchema.oneOf + .map((schema) => { + if ( + typeof schema !== 'object' || + schema.properties?.event_type?.enum?.[0] == null + ) { + return null + } + + const eventType = schema.properties.event_type.enum[0] + const targetResourceType = Object.keys(resources).find((resourceName) => + eventType.split('.').includes(resourceName), + ) + + return { + ...createResource('event', schema as OpenapiSchema), + eventType, + targetResourceType: targetResourceType ?? null, + } + }) + .filter((event): event is EventResource => event !== null) +} + export const createBlueprint = async ( typesModule: TypesModuleInput, { formatCode = async (content) => content }: BlueprintOptions = {}, @@ -291,10 +339,13 @@ export const createBlueprint = async ( formatCode, } + const resources = createResources(openapi.components.schemas) + return { title: openapi.info.title, routes: await createRoutes(openapi.paths, context), - resources: createResources(openapi.components.schemas), + resources, + events: createEvents(openapi.components.schemas, resources), } } @@ -752,39 +803,60 @@ const createParameter = ( } } -const createResources = ( +export const createResources = ( schemas: Openapi['components']['schemas'], ): Record => { return Object.entries(schemas).reduce>( - (acc, [schemaName, schema]) => { - if ( - typeof schema === 'object' && - schema !== null && - 'properties' in schema && - typeof schema.properties === 'object' && - schema.properties !== null - ) { + (resources, [schemaName, schema]) => { + const { success: isValidEventSchema, data: parsedEvent } = + EventResourceSchema.safeParse(schema) + if (isValidEventSchema) { + const commonProperties = findCommonOpenapiSchemaProperties( + parsedEvent.oneOf, + ) + const eventSchema: OpenapiSchema = { + properties: commonProperties, + type: 'object', + } + return { + ...resources, + [schemaName]: createResource(schemaName, eventSchema), + } + } + + const { success: isValidResourceSchema } = + ResourceSchema.safeParse(schema) + if (isValidResourceSchema) { return { - ...acc, - [schemaName]: { - resourceType: schemaName, - properties: createProperties(schema.properties, [schemaName]), - description: schema.description ?? '', - isDeprecated: schema.deprecated ?? false, - deprecationMessage: schema['x-deprecated'] ?? '', - isUndocumented: (schema['x-undocumented'] ?? '').length > 0, - undocumentedMessage: schema['x-undocumented'] ?? '', - isDraft: (schema['x-draft'] ?? '').length > 0, - draftMessage: schema['x-draft'] ?? '', - }, + ...resources, + [schemaName]: createResource(schemaName, schema), } } - return acc + + return resources }, {}, ) } +const createResource = ( + schemaName: string, + schema: OpenapiSchema, +): Resource => { + return { + resourceType: schemaName, + properties: createProperties(schema.properties ?? {}, [schemaName]), + description: schema.description ?? '', + isDeprecated: schema.deprecated ?? false, + routePath: schema['x-route-path'] ?? '', + deprecationMessage: schema['x-deprecated'] ?? '', + isUndocumented: (schema['x-undocumented'] ?? '').length > 0, + undocumentedMessage: schema['x-undocumented'] ?? '', + isDraft: (schema['x-draft'] ?? '').length > 0, + draftMessage: schema['x-draft'] ?? '', + } +} + const createResponse = ( operation: OpenapiOperation, path: string, diff --git a/src/lib/openapi/find-common-openapi-schema-properties.test.ts b/src/lib/openapi/find-common-openapi-schema-properties.test.ts new file mode 100644 index 00000000..9ce4bbcd --- /dev/null +++ b/src/lib/openapi/find-common-openapi-schema-properties.test.ts @@ -0,0 +1,38 @@ +import test from 'ava' + +import type { OpenapiSchema } from 'lib/openapi/types.js' + +import { findCommonOpenapiSchemaProperties } from './find-common-openapi-schema-properties.js' + +test('findCommonOpenapiSchemaProperties: extracts common properties from openapi schemas', (t) => { + const schemas: OpenapiSchema[] = [ + { + type: 'object', + properties: { + event_id: { type: 'string', format: 'uuid' }, + event_type: { type: 'string' }, + created_at: { type: 'string', format: 'date-time' }, + foo_id: { type: 'string' }, + }, + }, + { + type: 'object', + properties: { + event_id: { type: 'string', format: 'uuid' }, + event_type: { type: 'string' }, + created_at: { type: 'string', format: 'date-time' }, + bar_id: { type: 'string' }, + }, + }, + ] + + const commonProps = findCommonOpenapiSchemaProperties(schemas) + const commonKeys = Object.keys(commonProps) + + t.is(commonKeys.length, 3) + t.true( + ['event_id', 'event_type', 'created_at'].every((key) => + commonKeys.includes(key), + ), + ) +}) diff --git a/src/lib/openapi/find-common-openapi-schema-properties.ts b/src/lib/openapi/find-common-openapi-schema-properties.ts new file mode 100644 index 00000000..10b18c13 --- /dev/null +++ b/src/lib/openapi/find-common-openapi-schema-properties.ts @@ -0,0 +1,36 @@ +import type { OpenapiSchema } from 'lib/openapi/types.js' + +export function findCommonOpenapiSchemaProperties( + schemas: OpenapiSchema[], +): Record { + const firstSchema = schemas[0] + if (schemas.length === 0 || firstSchema?.properties == null) { + return {} + } + + return Object.entries(firstSchema.properties).reduce< + Record + >((commonProps, [propKey, propValue]) => { + const isPropInAllSchemas = schemas.every((schema) => + Object.keys(schema.properties ?? {}).includes(propKey), + ) + + if (!isPropInAllSchemas) { + return commonProps + } + + if ('enum' in propValue) { + const mergedEnumValues = schemas.reduce((allEnums, schema) => { + const enumValues = schema.properties?.[propKey]?.enum ?? [] + return [...new Set([...allEnums, ...enumValues])] + }, []) + + return { + ...commonProps, + [propKey]: { ...propValue, enum: mergedEnumValues }, + } + } + + return { ...commonProps, [propKey]: propValue } + }, {}) +} diff --git a/src/lib/openapi/index.ts b/src/lib/openapi/index.ts new file mode 100644 index 00000000..104c92f3 --- /dev/null +++ b/src/lib/openapi/index.ts @@ -0,0 +1,3 @@ +export * from './find-common-openapi-schema-properties.js' +export * from './schemas.js' +export * from './types.js' diff --git a/src/lib/openapi-schema.ts b/src/lib/openapi/schemas.ts similarity index 83% rename from src/lib/openapi-schema.ts rename to src/lib/openapi/schemas.ts index fb84a20b..0ec83345 100644 --- a/src/lib/openapi-schema.ts +++ b/src/lib/openapi/schemas.ts @@ -94,3 +94,19 @@ export const PropertySchema: z.ZodSchema = z.object({ $ref: z.string().optional(), format: z.string().optional(), }) + +export const ResourceSchema = z.object({ + type: z.literal('object'), + properties: z.record(z.string(), PropertySchema), + required: z.array(z.string()).default([]), + description: z.string().default(''), + 'x-route-path': z.string().default(''), + 'x-undocumented': z.string().default(''), + 'x-deprecated': z.string().default(''), + 'x-draft': z.string().default(''), +}) + +export const EventResourceSchema = z.object({ + discriminator: z.object({ propertyName: z.string() }), + oneOf: z.array(ResourceSchema), +}) diff --git a/src/lib/openapi.ts b/src/lib/openapi/types.ts similarity index 97% rename from src/lib/openapi.ts rename to src/lib/openapi/types.ts index 6df44b12..7c6e7a3d 100644 --- a/src/lib/openapi.ts +++ b/src/lib/openapi/types.ts @@ -71,12 +71,14 @@ export interface OpenapiSchema { items?: OpenapiSchema $ref?: string required?: string[] + enum?: string[] format?: string description?: string deprecated?: boolean 'x-deprecated'?: string 'x-draft'?: string 'x-undocumented'?: string + 'x-route-path'?: string } export interface OpenapiComponents { diff --git a/test/fixtures/types/openapi.ts b/test/fixtures/types/openapi.ts index d64b13fb..f88051b9 100644 --- a/test/fixtures/types/openapi.ts +++ b/test/fixtures/types/openapi.ts @@ -53,6 +53,7 @@ export default { }, }, required: ['foo_id', 'name'], + 'x-route-path': '/foos', }, plane: { type: 'object', @@ -69,6 +70,7 @@ export default { }, }, required: ['plane_id', 'name'], + 'x-route-path': '/planes', }, deprecated_resource: { type: 'object', @@ -83,6 +85,7 @@ export default { required: ['deprecated_resource_id'], deprecated: true, 'x-deprecated': 'This resource is deprecated', + 'x-route-path': '/deprecated/resources', }, draft_resource: { type: 'object', @@ -96,6 +99,7 @@ export default { }, required: ['draft_resource_id'], 'x-draft': 'This resource is draft', + 'x-route-path': '/draft/resources', }, undocumented_resource: { type: 'object', @@ -109,6 +113,39 @@ export default { }, required: ['undocumented_resource_id'], 'x-undocumented': 'This resource is undocumented', + 'x-route-path': '/undocumented/resources', + }, + event: { + oneOf: [ + { + type: 'object', + description: 'A foo.created event', + properties: { + event_id: { + description: 'Event ID', + format: 'uuid', + type: 'string', + }, + event_type: { + description: 'Type of event', + type: 'string', + enum: ['foo.created'], + }, + foo_id: { + description: 'ID of the foo that was created', + format: 'uuid', + type: 'string', + }, + created_at: { + description: 'When the event occurred', + type: 'string', + format: 'date-time', + }, + }, + required: ['event_id', 'event_type', 'foo_id', 'created_at'], + 'x-route-path': '/foos', + }, + ], }, }, }, diff --git a/test/snapshots/blueprint.test.ts.md b/test/snapshots/blueprint.test.ts.md index ed7e97a1..74ad027e 100644 --- a/test/snapshots/blueprint.test.ts.md +++ b/test/snapshots/blueprint.test.ts.md @@ -9,6 +9,76 @@ Generated by [AVA](https://avajs.dev). > blueprint { + events: [ + { + deprecationMessage: '', + description: 'A foo.created event', + draftMessage: '', + eventType: 'foo.created', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Event ID', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Type of event', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'foo.created', + }, + ], + }, + { + deprecationMessage: '', + description: 'ID of the foo that was created', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'foo_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'When the event occurred', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '/foos', + targetResourceType: 'foo', + undocumentedMessage: '', + }, + ], resources: { deprecated_resource: { deprecationMessage: 'This resource is deprecated', @@ -32,6 +102,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'deprecated_resource', + routePath: '/deprecated/resources', undocumentedMessage: '', }, draft_resource: { @@ -56,6 +127,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'draft_resource', + routePath: '/draft/resources', undocumentedMessage: '', }, foo: { @@ -190,6 +262,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'foo', + routePath: '/foos', undocumentedMessage: '', }, plane: { @@ -226,6 +299,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'plane', + routePath: '/planes', undocumentedMessage: '', }, undocumented_resource: { @@ -250,6 +324,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'undocumented_resource', + routePath: '/undocumented/resources', undocumentedMessage: 'This resource is undocumented', }, }, @@ -907,6 +982,76 @@ Generated by [AVA](https://avajs.dev). > blueprint { + events: [ + { + deprecationMessage: '', + description: 'A foo.created event', + draftMessage: '', + eventType: 'foo.created', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Event ID', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Type of event', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'foo.created', + }, + ], + }, + { + deprecationMessage: '', + description: 'ID of the foo that was created', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'foo_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'When the event occurred', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '/foos', + targetResourceType: 'foo', + undocumentedMessage: '', + }, + ], resources: { deprecated_resource: { deprecationMessage: 'This resource is deprecated', @@ -930,6 +1075,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'deprecated_resource', + routePath: '/deprecated/resources', undocumentedMessage: '', }, draft_resource: { @@ -954,6 +1100,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'draft_resource', + routePath: '/draft/resources', undocumentedMessage: '', }, foo: { @@ -1088,6 +1235,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'foo', + routePath: '/foos', undocumentedMessage: '', }, plane: { @@ -1124,6 +1272,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'plane', + routePath: '/planes', undocumentedMessage: '', }, undocumented_resource: { @@ -1148,6 +1297,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'undocumented_resource', + routePath: '/undocumented/resources', undocumentedMessage: 'This resource is undocumented', }, }, diff --git a/test/snapshots/blueprint.test.ts.snap b/test/snapshots/blueprint.test.ts.snap index 0d558af8..bb582328 100644 Binary files a/test/snapshots/blueprint.test.ts.snap and b/test/snapshots/blueprint.test.ts.snap differ diff --git a/test/snapshots/seam-blueprint.test.ts.md b/test/snapshots/seam-blueprint.test.ts.md index c3203117..31c816c5 100644 --- a/test/snapshots/seam-blueprint.test.ts.md +++ b/test/snapshots/seam-blueprint.test.ts.md @@ -9,18 +9,19 @@ Generated by [AVA](https://avajs.dev). > blueprint { - resources: { - access_code: { + events: [ + { deprecationMessage: '', - description: '', + description: 'An access code was created.', draftMessage: '', + eventType: 'access_code.created', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: 'Unique identifier for the access code.', + description: 'The ID of the access code.', draftMessage: '', format: 'id', isDeprecated: false, @@ -32,882 +33,932 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Code used for access. Typically, a numeric or alphanumeric string.', + description: 'The ID of the connected account.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'code', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for a group of access codes that share the same code.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'common_code_key', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the access code was created.', + description: 'The ID of the device.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the device associated with the access code.', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time after which the time-bound access code becomes inactive.', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'access_code.created', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'ends_at', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An access code was changed.', + draftMessage: '', + eventType: 'access_code.changed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Indicates whether the access code is a backup code.', + description: 'The ID of the access code.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_backup', + jsonType: 'string', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a backup access code is available for use if the primary access code is lost or compromised.', + description: 'The ID of the connected account.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_backup_access_code_available', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether changes to the access code from external sources are permitted.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_external_modification_allowed', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether Seam manages the access code.', + description: 'The ID of the device.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_offline_access_code', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.', + description: '', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_one_time_use', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'access_code.changed', + }, + ], }, { deprecationMessage: '', - description: 'Indicates whether the code is set on the device according to a preconfigured schedule.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_scheduled_on_device', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the access code is waiting for a code assignment.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_waiting_for_code_assignment', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An access code was natively scheduled on a device.', + draftMessage: '', + eventType: 'access_code.scheduled_on_device', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.', + description: 'The ID of the access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The code of the access code.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'code', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.', + description: 'The ID of the connected account.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'pulled_backup_access_code_id', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the time-bound access code becomes active.', + description: 'Time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_at', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: `␊ - Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.␊ - `, + description: 'The ID of the device.', draftMessage: '', - format: 'enum', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'status', + name: 'device_id', undocumentedMessage: '', - values: [ - { - name: 'setting', - }, - { - name: 'set', - }, - { - name: 'unset', - }, - { - name: 'removing', - }, - { - name: 'unknown', - }, - ], }, { deprecationMessage: '', - description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'type', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'time_bound', - }, - { - name: 'ongoing', + name: 'access_code.scheduled_on_device', }, ], }, { deprecationMessage: '', - description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, ], - resourceType: 'access_code', + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', undocumentedMessage: '', }, - acs_access_group: { + { deprecationMessage: '', - description: `Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.␊ - The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).`, + description: 'An access code was set on a device.', draftMessage: '', + eventType: 'access_code.set_on_device', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { - deprecationMessage: 'Use `external_type`.', - description: '', + deprecationMessage: '', + description: 'The ID of the access code.', draftMessage: '', - format: 'enum', - isDeprecated: true, + format: 'id', + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'access_group_type', + name: 'access_code_id', undocumentedMessage: '', - values: [ - { - name: 'pti_unit', - }, - { - name: 'pti_access_level', - }, - { - name: 'salto_ks_access_group', - }, - { - name: 'brivo_group', - }, - ], }, { - deprecationMessage: 'Use `external_type_display_name`.', - description: '', + deprecationMessage: '', + description: 'The code of the access code.', draftMessage: '', format: 'string', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'access_group_type_display_name', + name: 'code', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the access group.', + description: 'The ID of the connected account.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_access_group_id', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the access control system that contains the access group.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the access group was created.', + description: 'The ID of the device.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Brand-specific terminology for the access group type.', + description: '', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'pti_unit', - }, - { - name: 'pti_access_level', - }, - { - name: 'salto_ks_access_group', - }, - { - name: 'brivo_group', + name: 'access_code.set_on_device', }, ], }, { deprecationMessage: '', - description: 'Display name that corresponds to the brand-specific terminology for the access group type.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type_display_name', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An access code was removed from a device.', + draftMessage: '', + eventType: 'access_code.removed_from_device', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Name of the access group.', + description: 'The ID of the access code.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.', + description: 'The ID of the connected account.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'connected_account_id', undocumentedMessage: '', }, - ], - resourceType: 'acs_access_group', - undocumentedMessage: '', - }, - acs_credential: { - deprecationMessage: '', - description: `Means by which a user gains access at an entrance.␊ - The \`acs_credential\` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'enum', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'access_method', + name: 'created_at', undocumentedMessage: '', - values: [ - { - name: 'code', - }, - { - name: 'card', - }, - { - name: 'mobile_key', - }, - ], }, { deprecationMessage: '', - description: 'ID of the credential.', + description: 'The ID of the device.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_credential_id', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_credential_pool_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the access control system that contains the credential.', + description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'access_code.removed_from_device', + }, + ], }, { deprecationMessage: '', - description: 'ID of the ACS user to whom the credential belongs.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_user_id', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'card_number', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'There was an unusually long delay in setting an access code on a device.', + draftMessage: '', + eventType: 'access_code.delay_in_setting_on_device', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Access (PIN) code for the credential.', + description: 'The ID of the access code.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'code', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the credential was created.', + description: 'The ID of the connected account.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name that corresponds to the credential type.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.', + description: 'The ID of the device.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'ends_at', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the `acs_credential`.', + description: 'ID of the event.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.', + description: '', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'pti_card', - }, - { - name: 'brivo_credential', - }, - { - name: 'hid_credential', - }, - { - name: 'visionline_card', - }, - { - name: 'salto_ks_credential', + name: 'access_code.delay_in_setting_on_device', }, ], }, { deprecationMessage: '', - description: 'Display name that corresponds to the brand-specific terminology for the credential type.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type_display_name', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_issued', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An access code failed to be set on a device.', + draftMessage: '', + eventType: 'access_code.failed_to_set_on_device', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.', + description: 'The ID of the access code.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_latest_desired_state_synced_with_provider', + jsonType: 'string', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'The ID of the connected account.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_multi_phone_sync_credential', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.', + description: 'The ID of the device.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_one_time_use', + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'datetime', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'issued_at', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'access_code.failed_to_set_on_device', + }, + ], }, { deprecationMessage: '', - description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.', + description: 'Time when the event occurred.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'latest_desired_state_synced_with_provider_at', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the parent credential.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'parent_acs_credential_id', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An access code was deleted.', + draftMessage: '', + eventType: 'access_code.deleted', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'The ID of the access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + description: 'The code of the access code.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_at', + name: 'code', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Visionline-specific metadata for the credential.', + description: 'The ID of the connected account.', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'visionline_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'auto_join', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'card_function_type', - undocumentedMessage: '', - values: [ - { - name: 'guest', - }, - { - name: 'staff', - }, - ], - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'card_id', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'common_acs_entrance_ids', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'credential_id', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'guest_acs_entrance_ids', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_valid', - undocumentedMessage: '', - }, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'joiner_acs_credential_ids', - undocumentedMessage: '', + name: 'access_code.deleted', }, ], - undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Warnings associated with the `acs_credential`.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, @@ -918,44 +969,47 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'acs_credential', + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', undocumentedMessage: '', }, - acs_credential_pool: { + { deprecationMessage: '', - description: '', + description: 'There was an unusually long delay in removing an access code from a device.', draftMessage: '', + eventType: 'access_code.delay_in_removing_from_device', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'The ID of the access code.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_credential_pool_id', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'The ID of the connected account.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -967,14 +1021,26 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'The ID of the device.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { @@ -986,29 +1052,29 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'hid_part_number', + name: 'access_code.delay_in_removing_from_device', }, ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type_display_name', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, @@ -1019,32 +1085,47 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'acs_credential_pool', + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', undocumentedMessage: '', }, - acs_credential_provisioning_automation: { + { deprecationMessage: '', - description: '', + description: 'An access code failed to be removed from a device.', draftMessage: '', + eventType: 'access_code.failed_to_remove_from_device', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'The ID of the access code.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_credential_provisioning_automation_id', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'The ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -1056,32 +1137,61 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'The ID of the device.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'credential_manager_acs_system_id', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'access_code.failed_to_remove_from_device', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, @@ -1091,1227 +1201,820 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'acs_credential_provisioning_automation', + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', undocumentedMessage: '', }, - acs_entrance: { + { deprecationMessage: '', - description: 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + description: 'An access code was modified external to Seam.', draftMessage: '', + eventType: 'access_code.modified_external_to_seam', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: 'ID of the entrance.', + description: 'The ID of the access code.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_entrance_id', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the access control system that contains the entrance.', + description: 'The ID of the connected account.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'object', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'assa_abloy_vostio_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'door_number', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_type', - undocumentedMessage: '', - values: [ - { - name: 'CommonDoor', - }, - { - name: 'EntranceDoor', - }, - { - name: 'GuestDoor', - }, - { - name: 'Elevator', - }, - ], - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'pms_id', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'stand_open', - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the entrance was created.', + description: 'The ID of the device.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the entrance.', + description: 'ID of the event.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'dormakaba_community_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_point_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'common_area_number', - undocumentedMessage: '', - }, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'inner_access_points_names', - undocumentedMessage: '', + name: 'access_code.modified_external_to_seam', }, ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An access code was deleted external to Seam.', + draftMessage: '', + eventType: 'access_code.deleted_external_to_seam', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'The ID of the access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'latch_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'accessibility_type', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_type', - undocumentedMessage: '', - }, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_connected', - undocumentedMessage: '', + name: 'access_code.deleted_external_to_seam', }, ], - undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'object', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'salto_ks_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'battery_level', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'intrusion_alarm', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'left_open_alarm', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'lock_type', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'locked_state', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'online', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'privacy_mode', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'salto_space_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_description', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ext_door_id', - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'visionline_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_category', - undocumentedMessage: '', - values: [ - { - name: 'entrance', - }, - { - name: 'guest', - }, - { - name: 'elevator reader', - }, - { - name: 'common', - }, - { - name: 'common (PMS)', - }, - ], - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'profiles', - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, ], - resourceType: 'acs_entrance', + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', undocumentedMessage: '', }, - acs_system: { + { deprecationMessage: '', - description: 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + description: 'A backup access code was pulled from the backup access code pool and set on a device.', draftMessage: '', + eventType: 'access_code.backup_access_code_pulled', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: 'ID of the `acs_system`.', + description: 'The ID of the access code.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + description: '', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_add_acs_users_to_acs_access_groups', + jsonType: 'string', + name: 'backup_access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.', + description: 'The ID of the connected account.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_automate_enrollment', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_create_acs_access_groups', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + description: 'The ID of the device.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remove_acs_users_from_acs_access_groups', + jsonType: 'string', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.', + description: 'ID of the event.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'connected_account_ids', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the `acs_system` was created.', + description: '', draftMessage: '', - format: 'datetime', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'access_code.backup_access_code_pulled', + }, + ], }, { deprecationMessage: '', - description: 'ID of the default credential manager acs_system for this access control system.', - draftMessage: 'Needs review', - format: 'id', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', isDeprecated: false, - isDraft: true, + isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'default_credential_manager_acs_system_id', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the `acs_system`.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An unmanaged access code was successfully converted to a managed access code.', + draftMessage: '', + eventType: 'access_code.unmanaged.converted_to_managed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Brand-specific terminology for the `acs_system` type.', + description: 'The ID of the access code.', draftMessage: '', - format: 'enum', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type', + name: 'access_code_id', undocumentedMessage: '', - values: [ - { - name: 'pti_site', - }, - { - name: 'alta_org', - }, - { - name: 'salto_ks_site', - }, - { - name: 'salto_space_system', - }, - { - name: 'brivo_account', - }, - { - name: 'hid_credential_manager_organization', - }, - { - name: 'visionline_system', - }, - { - name: 'assa_abloy_credential_service', - }, - { - name: 'latch_building', - }, - { - name: 'dormakaba_community', - }, - { - name: 'legic_connect', - }, - { - name: 'assa_abloy_vostio', - }, - { - name: 'assa_abloy_vostio_credential_service', - }, - ], }, { deprecationMessage: '', - description: 'Display name that corresponds to the brand-specific terminology for the `acs_system` type.', + description: 'The ID of the connected account.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type_display_name', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Alternative text for the `acs_system` image.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'image_alt_text', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'URL for the image that represents the `acs_system`.', + description: 'The ID of the device.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'image_url', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates if the `acs_system` is a credential manager.', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_credential_manager', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'location', - properties: [ + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: 'Time zone in which the `acs_system` is located.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'time_zone', - undocumentedMessage: '', + name: 'access_code.unmanaged.converted_to_managed', }, ], - undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Name of the `acs_system`.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'occurred_at', undocumentedMessage: '', }, { - deprecationMessage: 'Use `external_type`.', - description: '', + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'enum', - isDeprecated: true, + format: 'id', + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'system_type', + name: 'workspace_id', undocumentedMessage: '', - values: [ - { - name: 'pti_site', - }, - { - name: 'alta_org', - }, - { - name: 'salto_ks_site', - }, - { - name: 'salto_space_system', - }, - { - name: 'brivo_account', - }, - { - name: 'hid_credential_manager_organization', - }, - { - name: 'visionline_system', - }, - { - name: 'assa_abloy_credential_service', - }, - { - name: 'latch_building', - }, - { - name: 'dormakaba_community', - }, - { - name: 'legic_connect', - }, - { - name: 'assa_abloy_vostio', - }, - { - name: 'assa_abloy_vostio_credential_service', - }, - ], }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An unmanaged access code failed to be converted to a managed access code.', + draftMessage: '', + eventType: 'access_code.unmanaged.failed_to_convert_to_managed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { - deprecationMessage: 'Use `external_type_display_name`.', - description: '', + deprecationMessage: '', + description: 'The ID of the access code.', draftMessage: '', - format: 'string', - isDeprecated: true, + format: 'id', + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'system_type_display_name', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'The ID of the connected account.', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'visionline_metadata', - properties: [ - { - deprecationMessage: '', - description: 'IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'lan_address', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mobile_access_uuid', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'system_id', - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Warnings associated with the `acs_system`.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.', + description: 'The ID of the device.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'device_id', undocumentedMessage: '', }, - ], - resourceType: 'acs_system', - undocumentedMessage: '', - }, - acs_user: { - deprecationMessage: '', - description: 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: '`starts_at` and `ends_at` timestamps for the `acs_user`\'s access.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'access_schedule', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the user\'s access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the user\'s access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the access control system that contains the `acs_user`.', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the `acs_user`.', + description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_user_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'access_code.unmanaged.failed_to_convert_to_managed', + }, + ], }, { deprecationMessage: '', - description: 'Date and time at which the `acs_user` was created.', + description: 'Time when the event occurred.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the `acs_user`.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', - undocumentedMessage: '', - }, - { - deprecationMessage: 'use email_address.', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'email', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An unmanaged access code was created on a device.', + draftMessage: '', + eventType: 'access_code.unmanaged.created', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Email address of the `acs_user`.', + description: 'The ID of the access code.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'email_address', + name: 'access_code_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the `acs_user`.', + description: 'The ID of the connected account.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Brand-specific terminology for the `acs_user` type.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'enum', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type', + name: 'created_at', undocumentedMessage: '', - values: [ - { - name: 'pti_user', - }, - { - name: 'brivo_user', - }, - { - name: 'hid_credential_manager_user', - }, - { - name: 'salto_site_user', - }, - { - name: 'latch_user', - }, - { - name: 'dormakaba_community_user', - }, - ], }, { deprecationMessage: '', - description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.', + description: 'The ID of the device.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type_display_name', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Full name of the `acs_user`.', + description: 'ID of the event.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'full_name', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'hid_acs_system_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'access_code.unmanaged.created', + }, + ], }, { deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - jsonType: 'boolean', - name: 'is_latest_desired_state_synced_with_provider', - undocumentedMessage: 'Only used internally.', - }, - { - deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_suspended', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An unmanaged access code was removed from a device.', + draftMessage: '', + eventType: 'access_code.unmanaged.removed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'The ID of the access code.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, - isUndocumented: true, + isUndocumented: false, jsonType: 'string', - name: 'latest_desired_state_synced_with_provider_at', - undocumentedMessage: 'Only used internally.', + name: 'access_code_id', + undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).', + description: 'The ID of the connected account.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'phone_number', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Email address of the user identity associated with the `acs_user`.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_email_address', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Full name of the user identity associated with the `acs_user`.', + description: 'The ID of the device.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_full_name', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the user identity associated with the `acs_user`.', + description: 'ID of the event.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).', + description: '', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_phone_number', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'access_code.unmanaged.removed', + }, + ], }, { deprecationMessage: '', - description: 'Warnings associated with the `acs_user`.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, @@ -2322,338 +2025,390 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'acs_user', + resourceType: 'event', + routePath: '', + targetResourceType: 'access_code', undocumentedMessage: '', }, - client_session: { + { deprecationMessage: '', - description: '', + description: 'An ACS system was connected.', draftMessage: '', + eventType: 'acs_system.connected', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the ACS system.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'client_session_id', + name: 'acs_system_id', undocumentedMessage: '', }, { - deprecationMessage: '', - description: '', + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', draftMessage: '', - format: 'list', - isDeprecated: false, + format: 'id', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'connect_webview_ids', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'connected_account_ids', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'number', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'device_count', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'acs_system.connected', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'expires_at', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'token', + name: 'workspace_id', undocumentedMessage: '', }, - { - deprecationMessage: '', - description: '', + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'acs_system', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An ACS system was added.', + draftMessage: '', + eventType: 'acs_system.added', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the ACS system.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identifier_key', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'user_identity_ids', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'event_id', undocumentedMessage: '', }, - ], - resourceType: 'client_session', - undocumentedMessage: '', - }, - connect_webview: { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { - deprecationMessage: 'Unused. Will be removed.', + deprecationMessage: '', description: '', draftMessage: '', - format: 'list', - isDeprecated: true, + format: 'enum', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'accepted_devices', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'acs_system.added', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'accepted_providers', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { - deprecationMessage: 'Unused. Will be removed.', - description: '', + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', - isDeprecated: true, + format: 'id', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'any_device_allowed', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'acs_system', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An ACS system was disconnected.', + draftMessage: '', + eventType: 'acs_system.disconnected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the ACS system.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'any_provider_allowed', + jsonType: 'string', + name: 'acs_system_id', undocumentedMessage: '', }, { - deprecationMessage: '', - description: '', + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', draftMessage: '', - format: 'datetime', - isDeprecated: false, + format: 'id', + isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'authorized_at', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'automatically_manage_new_devices', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'connect_webview_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'connected_account_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'acs_system.disconnected', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'record', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'custom_metadata', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'acs_system', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An ACS credential was deleted.', + draftMessage: '', + eventType: 'acs_credential.deleted', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', description: '', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'custom_redirect_failure_url', + name: 'acs_credential_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the ACS system.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'custom_redirect_url', + name: 'acs_system_id', undocumentedMessage: '', }, { - deprecationMessage: '', - description: '', + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', draftMessage: '', - format: 'enum', - isDeprecated: false, + format: 'id', + isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_selection_mode', + name: 'connected_account_id', undocumentedMessage: '', - values: [ - { - name: 'none', - }, - { - name: 'single', - }, - { - name: 'multiple', - }, - ], }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'login_successful', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'selected_provider', + name: 'event_id', undocumentedMessage: '', }, { @@ -2665,47 +2420,29 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'status', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'pending', - }, - { - name: 'failed', - }, - { - name: 'authorized', + name: 'acs_credential.deleted', }, ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'url', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'wait_for_device_creation', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, @@ -2716,13 +2453,16 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'connect_webview', + resourceType: 'event', + routePath: '', + targetResourceType: 'acs_credential', undocumentedMessage: '', }, - connected_account: { + { deprecationMessage: '', - description: '', + description: 'An ACS credential was issued.', draftMessage: '', + eventType: 'acs_credential.issued', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -2731,477 +2471,534 @@ Generated by [AVA](https://avajs.dev). deprecationMessage: '', description: '', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'account_type', + name: 'acs_credential_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the ACS system.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'account_type_display_name', + name: 'acs_system_id', undocumentedMessage: '', }, { - deprecationMessage: '', - description: '', + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', draftMessage: '', - format: 'boolean', - isDeprecated: false, + format: 'id', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'automatically_manage_new_devices', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'connected_account_id', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'record', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'custom_metadata', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'acs_credential.issued', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'user_identifier', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'api_url', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'email', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'exclusive', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'phone', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'username', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, ], - resourceType: 'connected_account', + resourceType: 'event', + routePath: '', + targetResourceType: 'acs_credential', undocumentedMessage: '', }, - device: { + { deprecationMessage: '', - description: '', + description: 'An ACS user was deleted.', draftMessage: '', + eventType: 'acs_user.deleted', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the ACS system.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_cool', + jsonType: 'string', + name: 'acs_system_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat', + jsonType: 'string', + name: 'acs_user_id', undocumentedMessage: '', }, { - deprecationMessage: '', - description: '', + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', draftMessage: '', - format: 'boolean', - isDeprecated: false, + format: 'id', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat_cool', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_offline_access_codes', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_online_access_codes', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_lock', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'acs_user.deleted', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_unlock', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_connection', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'acs_user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An ACS encoder was added.', + draftMessage: '', + eventType: 'acs_encoder.added', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the ACS encoder.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_disconnection', + jsonType: 'string', + name: 'acs_encoder_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the ACS system.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_removal', + jsonType: 'string', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_turn_off_hvac', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.', + description: 'ID of the event.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'capabilities_supported', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the account associated with the device.', + description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'connected_account_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'acs_encoder.added', + }, + ], }, { deprecationMessage: '', - description: 'Date and time at which the device object was created.', + description: 'Time when the event occurred.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'record', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'custom_metadata', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An ACS encoder was removed.', + draftMessage: '', + eventType: 'acs_encoder.removed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Unique identifier for the device.', + description: 'ID of the ACS encoder.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'acs_encoder_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.', + description: 'ID of the ACS system.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Will be removed.', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '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.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether Seam manages the device.', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Location information for the device.', + description: '', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'location', - properties: [ + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: 'Name of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'location_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Time zone of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'timezone', - undocumentedMessage: '', + name: 'acs_encoder.removed', }, ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Optional nickname to describe the device, settable through Seam', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'nickname', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A client session was deleted.', + draftMessage: '', + eventType: 'client_session.deleted', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the client session.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'client_session_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the Seam workspace associated with the device.', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'client_session.deleted', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, @@ -3212,147 +3009,170 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'device', + resourceType: 'event', + routePath: '', + targetResourceType: 'client_session', undocumentedMessage: '', }, - device_provider: { + { deprecationMessage: '', - description: '', + description: 'A connected account was connected for the first time, was reconnected after being disconnected.', draftMessage: '', + eventType: 'connected_account.connected', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the connect webview.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_cool', + jsonType: 'string', + name: 'connect_webview_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the connected account.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat_cool', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_offline_access_codes', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_online_access_codes', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'connected_account.connected', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_lock', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_unlock', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'connected_account', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A connected account was created.', + draftMessage: '', + eventType: 'connected_account.created', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the connect webview.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_connection', + jsonType: 'string', + name: 'connect_webview_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the connected account.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_disconnection', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_removal', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_turn_off_hvac', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { @@ -3364,197 +3184,80 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_provider_name', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'dormakaba_community', - }, - { - name: 'legic_connect', - }, - { - name: 'akuvox', - }, - { - name: 'august', - }, - { - name: 'avigilon_alta', - }, - { - name: 'brivo', - }, - { - name: 'butterflymx', - }, - { - name: 'schlage', - }, - { - name: 'smartthings', - }, - { - name: 'yale', - }, - { - name: 'genie', - }, - { - name: 'doorking', - }, - { - name: 'salto', - }, - { - name: 'salto_ks', - }, - { - name: 'lockly', - }, - { - name: 'ttlock', - }, - { - name: 'linear', - }, - { - name: 'noiseaware', - }, - { - name: 'nuki', - }, - { - name: 'seam_relay_admin', - }, - { - name: 'igloo', - }, - { - name: 'kwikset', - }, - { - name: 'minut', - }, - { - name: 'my_2n', - }, - { - name: 'controlbyweb', - }, - { - name: 'nest', - }, - { - name: 'igloohome', - }, - { - name: 'ecobee', - }, - { - name: 'hubitat', - }, - { - name: 'four_suites', - }, - { - name: 'dormakaba_oracode', - }, - { - name: 'pti', - }, - { - name: 'wyze', - }, - { - name: 'seam_passport', - }, - { - name: 'visionline', - }, - { - name: 'assa_abloy_credential_service', - }, - { - name: 'seam_bridge', - }, - { - name: 'tedee', - }, - { - name: 'honeywell_resideo', - }, - { - name: 'latch', - }, - { - name: 'akiles', - }, - { - name: 'assa_abloy_vostio', - }, - { - name: 'assa_abloy_vostio_credential_service', - }, - { - name: 'tado', - }, - { - name: 'salto_space', + name: 'connected_account.created', }, ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'image_url', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'connected_account', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Use `connect_webview.login_succeeded`.', + description: 'A connected account had a successful connect webview login.', + draftMessage: '', + eventType: 'connected_account.successful_login', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the connect webview.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'provider_categories', + jsonType: 'string', + name: 'connect_webview_id', undocumentedMessage: '', }, - ], - resourceType: 'device_provider', - undocumentedMessage: '', - }, - enrollment_automation: { - deprecationMessage: '', - description: 'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: 'Date and time at which the enrollment automation was created.', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -3566,43 +3269,48 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'credential_manager_acs_system_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the enrollment automation.', + description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'enrollment_automation_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'connected_account.successful_login', + }, + ], }, { deprecationMessage: '', - description: 'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).', + description: 'Time when the event occurred.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_id', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, @@ -3613,20 +3321,35 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'enrollment_automation', + resourceType: 'event', + routePath: '', + targetResourceType: 'connected_account', undocumentedMessage: '', }, - network: { + { deprecationMessage: '', - description: '', + description: 'A connected account was disconnected.', draftMessage: '', + eventType: 'connected_account.disconnected', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -3638,31 +3361,48 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'network_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'connected_account.disconnected', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, @@ -3673,291 +3413,342 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'network', + resourceType: 'event', + routePath: '', + targetResourceType: 'connected_account', undocumentedMessage: '', }, - noise_threshold: { + { deprecationMessage: '', - description: '', + description: 'A connected account completed the first sync with Seam and devices are now available.', draftMessage: '', + eventType: 'connected_account.completed_first_sync', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the connected account.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'ends_daily_at', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'noise_threshold_decibels', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'noise_threshold_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'connected_account.completed_first_sync', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'number', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'noise_threshold_nrs', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_daily_at', + name: 'workspace_id', undocumentedMessage: '', }, ], - resourceType: 'noise_threshold', + resourceType: 'event', + routePath: '', + targetResourceType: 'connected_account', undocumentedMessage: '', }, - phone: { + { deprecationMessage: '', - description: '', + description: 'A connected account was deleted.', draftMessage: '', + eventType: 'connected_account.deleted', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the connected account.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_cool', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat_cool', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_offline_access_codes', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'connected_account.deleted', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_online_access_codes', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_lock', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'connected_account', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A connected account completed the first sync after reconnection with Seam and devices are now available.', + draftMessage: '', + eventType: 'connected_account.completed_first_sync_after_reconnection', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_unlock', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_connection', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_disconnection', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_removal', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'connected_account.completed_first_sync_after_reconnection', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_turn_off_hvac', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'capabilities_supported', + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'connected_account', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A lock door action attempt succeeded.', + draftMessage: '', + eventType: 'action_attempt.lock_door.succeeded', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'The ID of the action attempt.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'action_attempt_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the device object was created.', + description: 'The type of action.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'action_type', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'record', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'custom_metadata', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the device.', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'event_id', undocumentedMessage: '', }, { @@ -3969,397 +3760,324 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_type', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'android_phone', - }, - { - name: 'ios_phone', + name: 'action_attempt.lock_door.succeeded', }, ], }, { deprecationMessage: '', - description: 'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '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.', + description: 'The status of the action.', draftMessage: '', - format: 'list', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'status', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether Seam manages the device.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A lock door action attempt failed.', + draftMessage: '', + eventType: 'action_attempt.lock_door.failed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Location information for the device.', + description: 'The ID of the action attempt.', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'location', - properties: [ - { - deprecationMessage: '', - description: 'Name of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'location_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Time zone of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'timezone', - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'action_attempt_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Optional nickname to describe the device, settable through Seam', + description: 'The type of action.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'nickname', + name: 'action_type', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'object', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'properties', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'assa_abloy_credential_service_metadata', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'array', - name: 'endpoints', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_active_endpoint', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.', + description: 'ID of the event.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the Seam workspace associated with the device.', + description: '', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'action_attempt.lock_door.failed', + }, + ], }, - ], - resourceType: 'phone', - undocumentedMessage: '', - }, - service_health: { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'description', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'The status of the action.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'service', + name: 'status', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'enum', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'status', + name: 'workspace_id', undocumentedMessage: '', - values: [ - { - name: 'healthy', - }, - { - name: 'degraded', - }, - { - name: 'down', - }, - ], }, ], - resourceType: 'service_health', + resourceType: 'event', + routePath: '', + targetResourceType: null, undocumentedMessage: '', }, - thermostat_schedule: { + { deprecationMessage: '', - description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.', + description: 'An unlock door action attempt succeeded.', draftMessage: '', + eventType: 'action_attempt.unlock_door.succeeded', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.', + description: 'The ID of the action attempt.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'climate_preset_key', + name: 'action_attempt_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the thermostat schedule was created.', + description: 'The type of action.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'action_type', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the desired thermostat device.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + description: 'ID of the event.', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'ends_at', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Number of minutes for which a person at the thermostat can change the thermostat\'s settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', + description: '', draftMessage: '', - format: 'number', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'max_override_period_minutes', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'action_attempt.unlock_door.succeeded', + }, + ], }, { deprecationMessage: '', - description: 'User-friendly name to identify the thermostat schedule.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + description: 'The status of the action.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_at', + name: 'status', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the thermostat schedule.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'thermostat_schedule_id', + name: 'workspace_id', undocumentedMessage: '', }, - { - deprecationMessage: '', - description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - jsonType: 'boolean', - name: 'unstable_is_override_allowed', - undocumentedMessage: 'Unstable', - }, ], - resourceType: 'thermostat_schedule', + resourceType: 'event', + routePath: '', + targetResourceType: null, undocumentedMessage: '', }, - unmanaged_access_code: { + { deprecationMessage: '', - description: '', + description: 'An unlock door action attempt failed.', draftMessage: '', + eventType: 'action_attempt.unlock_door.failed', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: 'Unique identifier for the access code.', + description: 'The ID of the action attempt.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'access_code_id', + name: 'action_attempt_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Code used for access. Typically, a numeric or alphanumeric string.', + description: 'The type of action.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'code', + name: 'action_type', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the access code was created.', + description: 'Time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -4371,74 +4089,130 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier for the device associated with the access code.', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time after which the time-bound access code becomes inactive.', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'action_attempt.unlock_door.failed', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'ends_at', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.', + description: 'The status of the action.', draftMessage: '', - format: 'list', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'status', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A connect webview had a successful login.', + draftMessage: '', + eventType: 'connect_webview.login_succeeded', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.', + description: 'ID of the connect webview.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'connect_webview_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the time-bound access code becomes active.', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_at', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { @@ -4450,463 +4224,8081 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'status', + name: 'event_type', undocumentedMessage: '', values: [ { - name: 'set', + name: 'connect_webview.login_succeeded', }, ], }, { deprecationMessage: '', - description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'enum', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'type', + name: 'occurred_at', undocumentedMessage: '', - values: [ - { - name: 'time_bound', - }, - { - name: 'ongoing', - }, - ], }, { deprecationMessage: '', - description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, ], - resourceType: 'unmanaged_access_code', + resourceType: 'event', + routePath: '', + targetResourceType: 'connect_webview', undocumentedMessage: '', }, - unmanaged_device: { + { deprecationMessage: '', - description: '', + description: 'A connect webview had a failed login.', draftMessage: '', + eventType: 'connect_webview.login_failed', isDeprecated: false, isDraft: false, isUndocumented: false, properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the connect webview.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_cool', + jsonType: 'string', + name: 'connect_webview_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat_cool', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_offline_access_codes', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'connect_webview.login_failed', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Time when the event occurred.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_online_access_codes', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_lock', + jsonType: 'string', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'connect_webview', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A new device was connected to Seam.', + draftMessage: '', + eventType: 'device.connected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_unlock', + jsonType: 'string', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Time at which the event was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_connection', + jsonType: 'string', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the device.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_disconnection', + jsonType: 'string', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_removal', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_turn_off_hvac', + jsonType: 'string', + name: 'event_type', undocumentedMessage: '', + values: [ + { + name: 'device.connected', + }, + ], }, { deprecationMessage: '', - description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.', + description: 'Time when the event occurred.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'capabilities_supported', + jsonType: 'string', + name: 'occurred_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the account associated with the device.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'connected_account_id', + name: 'workspace_id', undocumentedMessage: '', }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A device was added or reconnected to Seam.', + draftMessage: '', + eventType: 'device.added', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Date and time at which the device object was created.', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'connected_account_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the device.', + description: 'Time at which the event was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'created_at', undocumentedMessage: '', }, { deprecationMessage: '', - description: '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.', + description: 'ID of the device.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'device_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the event.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Location information for the device.', + description: '', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'location', - properties: [ + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: 'Name of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'location_name', - undocumentedMessage: '', + name: 'device.added', }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.', + draftMessage: '', + eventType: 'device.converted_to_unmanaged', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: 'Time zone of the device location.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'timezone', - undocumentedMessage: '', + name: 'device.converted_to_unmanaged', }, ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).', + draftMessage: '', + eventType: 'device.unmanaged.converted_to_managed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'properties', - properties: [ + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: 'Represents the accessory keypad state.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'accessory_keypad', - properties: [ - { - deprecationMessage: '', - description: 'Indicates if the keypad battery properties.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'battery', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'level', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates if the accessory_keypad is connected to the device.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_connected', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', + name: 'device.unmanaged.converted_to_managed', }, - { - deprecationMessage: '', - description: 'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'battery', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'level', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'status', - undocumentedMessage: '', - values: [ - { - name: 'critical', - }, - { - name: 'low', - }, - { - name: 'good', - }, - { - name: 'full', - }, - ], - }, - ], - undocumentedMessage: '', + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.', + draftMessage: '', + eventType: 'device.unmanaged.connected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.unmanaged.connected', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A device was disconnected from Seam.', + draftMessage: '', + eventType: 'device.disconnected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Error code associated with the disconnection event, if any.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'error_code', + undocumentedMessage: '', + values: [ + { + name: 'account_disconnected', + }, + { + name: 'hub_disconnected', + }, + { + name: 'device_disconnected', + }, + ], + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.disconnected', }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.', + draftMessage: '', + eventType: 'device.unmanaged.disconnected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Error code associated with the disconnection event, if any.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'error_code', + undocumentedMessage: '', + values: [ + { + name: 'account_disconnected', + }, + { + name: 'hub_disconnected', + }, + { + name: 'device_disconnected', + }, + ], + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.unmanaged.disconnected', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A device detected that it was tampered with, for example, opened or moved.', + draftMessage: '', + eventType: 'device.tampered', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.tampered', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A device battery level dropped below the low threshold.', + draftMessage: '', + eventType: 'device.low_battery', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'battery_level', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.low_battery', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A device battery status changed since the last `battery_status_changed` event.', + draftMessage: '', + eventType: 'device.battery_status_changed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'battery_level', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Battery status of the device, calculated from the numeric `battery_level` value.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'battery_status', + undocumentedMessage: '', + values: [ + { + name: 'critical', + }, + { + name: 'low', + }, + { + name: 'good', + }, + { + name: 'full', + }, + ], + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.battery_status_changed', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + eventType: 'device.removed', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.removed', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A device was [deleted](https://docs.seam.co/latest/api/devices/delete).', + draftMessage: '', + eventType: 'device.deleted', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.deleted', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Seam detected that a device is using a third-party integration that will interfere with Seam device management.', + draftMessage: '', + eventType: 'device.third_party_integration_detected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.third_party_integration_detected', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.', + draftMessage: '', + eventType: 'device.third_party_integration_no_longer_detected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.third_party_integration_no_longer_detected', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A Salto device activated privacy mode.', + draftMessage: '', + eventType: 'device.salto.privacy_mode_activated', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.salto.privacy_mode_activated', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A Salto device deactivated privacy mode.', + draftMessage: '', + eventType: 'device.salto.privacy_mode_deactivated', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.salto.privacy_mode_deactivated', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Seam detected a flaky device connection.', + draftMessage: '', + eventType: 'device.connection_became_flaky', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.connection_became_flaky', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Seam detected that a previously-flaky device connection stabilized.', + draftMessage: '', + eventType: 'device.connection_stabilized', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.connection_stabilized', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A third-party subscription is required to use all device features.', + draftMessage: '', + eventType: 'device.error.subscription_required', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.error.subscription_required', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A third-party subscription is active or no longer required to use all device features.', + draftMessage: '', + eventType: 'device.error.subscription_required.resolved', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.error.subscription_required.resolved', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An accessory keypad was connected to a device.', + draftMessage: '', + eventType: 'device.accessory_keypad_connected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.accessory_keypad_connected', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An accessory keypad was disconnected from a device.', + draftMessage: '', + eventType: 'device.accessory_keypad_disconnected', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'device.accessory_keypad_disconnected', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.', + draftMessage: '', + eventType: 'noise_sensor.noise_threshold_triggered', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'noise_sensor.noise_threshold_triggered', + }, + ], + }, + { + deprecationMessage: '', + description: 'Metadata from Minut.', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'minut_metadata', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detected noise level in decibels.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_level_decibels', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detected noise level in Noiseaware Noise Risk Score (NRS).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_level_nrs', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'noise_threshold_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'noise_threshold_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata from Noiseaware.', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'noiseaware_metadata', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A lock was locked.', + draftMessage: '', + eventType: 'lock.locked', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'action_attempt_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'lock.locked', + }, + ], + }, + { + deprecationMessage: '', + description: 'Method by which a lock device was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'method', + undocumentedMessage: '', + values: [ + { + name: 'keycode', + }, + { + name: 'manual', + }, + { + name: 'automatic', + }, + { + name: 'unknown', + }, + { + name: 'seamapi', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A lock was unlocked.', + draftMessage: '', + eventType: 'lock.unlocked', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'action_attempt_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'lock.unlocked', + }, + ], + }, + { + deprecationMessage: '', + description: 'Method by which a lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'method', + undocumentedMessage: '', + values: [ + { + name: 'keycode', + }, + { + name: 'manual', + }, + { + name: 'automatic', + }, + { + name: 'unknown', + }, + { + name: 'seamapi', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.', + draftMessage: '', + eventType: 'lock.access_denied', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'lock.access_denied', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.', + draftMessage: '', + eventType: 'thermostat.climate_preset_activated', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_preset_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'thermostat.climate_preset_activated', + }, + ], + }, + { + deprecationMessage: '', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_fallback_climate_preset', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'thermostat_schedule_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A thermostat was adjusted manually.', + draftMessage: '', + eventType: 'thermostat.manually_adjusted', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'cooling_set_point_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should cool (in °F).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'cooling_set_point_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'thermostat.manually_adjusted', + }, + ], + }, + { + deprecationMessage: '', + description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'fan_mode_setting', + undocumentedMessage: '', + values: [ + { + name: 'auto', + }, + { + name: 'on', + }, + { + name: 'circulate', + }, + ], + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should heat (in °C).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'heating_set_point_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should heat (in °F).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'heating_set_point_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'hvac_mode_setting', + undocumentedMessage: '', + values: [ + { + name: 'off', + }, + { + name: 'heat', + }, + { + name: 'cool', + }, + { + name: 'heat_cool', + }, + ], + }, + { + deprecationMessage: '', + description: 'Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'method', + undocumentedMessage: '', + values: [ + { + name: 'seam', + }, + { + name: 'external', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A thermostat\'s temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + eventType: 'thermostat.temperature_threshold_exceeded', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'thermostat.temperature_threshold_exceeded', + }, + ], + }, + { + deprecationMessage: '', + description: 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'lower_limit_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'lower_limit_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature, in °C, reported by the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'temperature_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature, in °F, reported by the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'temperature_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'upper_limit_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'upper_limit_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A thermostat\'s temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + eventType: 'thermostat.temperature_threshold_no_longer_exceeded', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'thermostat.temperature_threshold_no_longer_exceeded', + }, + ], + }, + { + deprecationMessage: '', + description: 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'lower_limit_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'lower_limit_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature, in °C, reported by the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'temperature_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature, in °F, reported by the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'temperature_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'upper_limit_celsius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'upper_limit_fahrenheit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'An enrollment automation was deleted.', + draftMessage: '', + eventType: 'enrollment_automation.deleted', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the enrollment automation.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'enrollment_automation_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'enrollment_automation.deleted', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'enrollment_automation', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A phone device was deactivated.', + draftMessage: '', + eventType: 'phone.deactivated', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'phone.deactivated', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + targetResourceType: 'phone', + undocumentedMessage: '', + }, + ], + resources: { + access_code: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Unique identifier for the access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Code used for access. Typically, a numeric or alphanumeric string.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier for a group of access codes that share the same code.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'common_code_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the access code was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier for the device associated with the access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time after which the time-bound access code becomes inactive.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the access code is a backup code.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_backup', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a backup access code is available for use if the primary access code is lost or compromised.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_backup_access_code_available', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether changes to the access code from external sources are permitted.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_external_modification_allowed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether Seam manages the access code.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_offline_access_code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_one_time_use', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the code is set on the device according to a preconfigured schedule.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_scheduled_on_device', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the access code is waiting for a code assignment.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_waiting_for_code_assignment', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'pulled_backup_access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the time-bound access code becomes active.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: `␊ + Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.␊ + `, + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'status', + undocumentedMessage: '', + values: [ + { + name: 'setting', + }, + { + name: 'set', + }, + { + name: 'unset', + }, + { + name: 'removing', + }, + { + name: 'unknown', + }, + ], + }, + { + deprecationMessage: '', + description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'type', + undocumentedMessage: '', + values: [ + { + name: 'time_bound', + }, + { + name: 'ongoing', + }, + ], + }, + { + deprecationMessage: '', + description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'warnings', + undocumentedMessage: '', + }, + ], + resourceType: 'access_code', + routePath: '', + undocumentedMessage: '', + }, + acs_access_group: { + deprecationMessage: '', + description: `Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.␊ + The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: 'Use `external_type`.', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_group_type', + undocumentedMessage: '', + values: [ + { + name: 'pti_unit', + }, + { + name: 'pti_access_level', + }, + { + name: 'salto_ks_access_group', + }, + { + name: 'brivo_group', + }, + ], + }, + { + deprecationMessage: 'Use `external_type_display_name`.', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_group_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the access group.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_access_group_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the access control system that contains the access group.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the access group was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Brand-specific terminology for the access group type.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type', + undocumentedMessage: '', + values: [ + { + name: 'pti_unit', + }, + { + name: 'pti_access_level', + }, + { + name: 'salto_ks_access_group', + }, + { + name: 'brivo_group', + }, + ], + }, + { + deprecationMessage: '', + description: 'Display name that corresponds to the brand-specific terminology for the access group type.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the access group.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'acs_access_group', + routePath: '', + undocumentedMessage: '', + }, + acs_credential: { + deprecationMessage: '', + description: `Means by which a user gains access at an entrance.␊ + The \`acs_credential\` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_method', + undocumentedMessage: '', + values: [ + { + name: 'code', + }, + { + name: 'card', + }, + { + name: 'mobile_key', + }, + ], + }, + { + deprecationMessage: '', + description: 'ID of the credential.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_credential_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_credential_pool_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the access control system that contains the credential.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the ACS user to whom the credential belongs.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_user_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'card_number', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Access (PIN) code for the credential.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the credential was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name that corresponds to the credential type.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Errors associated with the `acs_credential`.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type', + undocumentedMessage: '', + values: [ + { + name: 'pti_card', + }, + { + name: 'brivo_credential', + }, + { + name: 'hid_credential', + }, + { + name: 'visionline_card', + }, + { + name: 'salto_ks_credential', + }, + ], + }, + { + deprecationMessage: '', + description: 'Display name that corresponds to the brand-specific terminology for the credential type.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_issued', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_latest_desired_state_synced_with_provider', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_multi_phone_sync_credential', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_one_time_use', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'issued_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'latest_desired_state_synced_with_provider_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the parent credential.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'parent_acs_credential_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Visionline-specific metadata for the credential.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'visionline_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'auto_join', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'card_function_type', + undocumentedMessage: '', + values: [ + { + name: 'guest', + }, + { + name: 'staff', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'card_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'common_acs_entrance_ids', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'credential_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'guest_acs_entrance_ids', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_valid', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'joiner_acs_credential_ids', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Warnings associated with the `acs_credential`.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'warnings', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'acs_credential', + routePath: '', + undocumentedMessage: '', + }, + acs_credential_pool: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_credential_pool_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type', + undocumentedMessage: '', + values: [ + { + name: 'hid_part_number', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'acs_credential_pool', + routePath: '', + undocumentedMessage: '', + }, + acs_credential_provisioning_automation: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_credential_provisioning_automation_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'credential_manager_acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'acs_credential_provisioning_automation', + routePath: '', + undocumentedMessage: '', + }, + acs_entrance: { + deprecationMessage: '', + description: 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the entrance.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_entrance_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the access control system that contains the entrance.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'assa_abloy_vostio_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'door_number', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_type', + undocumentedMessage: '', + values: [ + { + name: 'CommonDoor', + }, + { + name: 'EntranceDoor', + }, + { + name: 'GuestDoor', + }, + { + name: 'Elevator', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'pms_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'stand_open', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the entrance was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the entrance.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'dormakaba_community_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_point_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'common_area_number', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'inner_access_points_names', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'latch_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'accessibility_type', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_type', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_connected', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_ks_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'battery_level', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'intrusion_alarm', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'left_open_alarm', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'lock_type', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'locked_state', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'online', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'privacy_mode', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_space_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_description', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ext_door_id', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'visionline_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_category', + undocumentedMessage: '', + values: [ + { + name: 'entrance', + }, + { + name: 'guest', + }, + { + name: 'elevator reader', + }, + { + name: 'common', + }, + { + name: 'common (PMS)', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'profiles', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + ], + resourceType: 'acs_entrance', + routePath: '', + undocumentedMessage: '', + }, + acs_system: { + deprecationMessage: '', + description: 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the `acs_system`.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_add_acs_users_to_acs_access_groups', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_automate_enrollment', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_create_acs_access_groups', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remove_acs_users_from_acs_access_groups', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'connected_account_ids', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the `acs_system` was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the default credential manager acs_system for this access control system.', + draftMessage: 'Needs review', + format: 'id', + isDeprecated: false, + isDraft: true, + isUndocumented: false, + jsonType: 'string', + name: 'default_credential_manager_acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Errors associated with the `acs_system`.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Brand-specific terminology for the `acs_system` type.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type', + undocumentedMessage: '', + values: [ + { + name: 'pti_site', + }, + { + name: 'alta_org', + }, + { + name: 'salto_ks_site', + }, + { + name: 'salto_space_system', + }, + { + name: 'brivo_account', + }, + { + name: 'hid_credential_manager_organization', + }, + { + name: 'visionline_system', + }, + { + name: 'assa_abloy_credential_service', + }, + { + name: 'latch_building', + }, + { + name: 'dormakaba_community', + }, + { + name: 'legic_connect', + }, + { + name: 'assa_abloy_vostio', + }, + { + name: 'assa_abloy_vostio_credential_service', + }, + ], + }, + { + deprecationMessage: '', + description: 'Display name that corresponds to the brand-specific terminology for the `acs_system` type.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Alternative text for the `acs_system` image.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'image_alt_text', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'URL for the image that represents the `acs_system`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'image_url', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates if the `acs_system` is a credential manager.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_credential_manager', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'location', + properties: [ + { + deprecationMessage: '', + description: 'Time zone in which the `acs_system` is located.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'time_zone', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the `acs_system`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Use `external_type`.', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'system_type', + undocumentedMessage: '', + values: [ + { + name: 'pti_site', + }, + { + name: 'alta_org', + }, + { + name: 'salto_ks_site', + }, + { + name: 'salto_space_system', + }, + { + name: 'brivo_account', + }, + { + name: 'hid_credential_manager_organization', + }, + { + name: 'visionline_system', + }, + { + name: 'assa_abloy_credential_service', + }, + { + name: 'latch_building', + }, + { + name: 'dormakaba_community', + }, + { + name: 'legic_connect', + }, + { + name: 'assa_abloy_vostio', + }, + { + name: 'assa_abloy_vostio_credential_service', + }, + ], + }, + { + deprecationMessage: 'Use `external_type_display_name`.', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'system_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'visionline_metadata', + properties: [ + { + deprecationMessage: '', + description: 'IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'lan_address', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mobile_access_uuid', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'system_id', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Warnings associated with the `acs_system`.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'warnings', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'acs_system', + routePath: '', + undocumentedMessage: '', + }, + acs_user: { + deprecationMessage: '', + description: 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '`starts_at` and `ends_at` timestamps for the `acs_user`\'s access.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'access_schedule', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the user\'s access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the user\'s access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the access control system that contains the `acs_user`.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the `acs_user`.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_user_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the `acs_user` was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the `acs_user`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: 'use email_address.', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'email', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Email address of the `acs_user`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'email_address', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Errors associated with the `acs_user`.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Brand-specific terminology for the `acs_user` type.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type', + undocumentedMessage: '', + values: [ + { + name: 'pti_user', + }, + { + name: 'brivo_user', + }, + { + name: 'hid_credential_manager_user', + }, + { + name: 'salto_site_user', + }, + { + name: 'latch_user', + }, + { + name: 'dormakaba_community_user', + }, + ], + }, + { + deprecationMessage: '', + description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'external_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Full name of the `acs_user`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'full_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'hid_acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + jsonType: 'boolean', + name: 'is_latest_desired_state_synced_with_provider', + undocumentedMessage: 'Only used internally.', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_suspended', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + jsonType: 'string', + name: 'latest_desired_state_synced_with_provider_at', + undocumentedMessage: 'Only used internally.', + }, + { + deprecationMessage: '', + description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'phone_number', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Email address of the user identity associated with the `acs_user`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_email_address', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Full name of the user identity associated with the `acs_user`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_full_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the user identity associated with the `acs_user`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_phone_number', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Warnings associated with the `acs_user`.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'warnings', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'acs_user', + routePath: '', + undocumentedMessage: '', + }, + client_session: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'client_session_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'connect_webview_ids', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'connected_account_ids', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'device_count', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'expires_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'token', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identifier_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'user_identity_ids', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'client_session', + routePath: '', + undocumentedMessage: '', + }, + connect_webview: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: 'Unused. Will be removed.', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'accepted_devices', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'accepted_providers', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Unused. Will be removed.', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'any_device_allowed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'any_provider_allowed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'authorized_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'automatically_manage_new_devices', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connect_webview_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'custom_metadata', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'custom_redirect_failure_url', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'custom_redirect_url', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_selection_mode', + undocumentedMessage: '', + values: [ + { + name: 'none', + }, + { + name: 'single', + }, + { + name: 'multiple', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'login_successful', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'selected_provider', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'status', + undocumentedMessage: '', + values: [ + { + name: 'pending', + }, + { + name: 'failed', + }, + { + name: 'authorized', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'url', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'wait_for_device_creation', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'connect_webview', + routePath: '', + undocumentedMessage: '', + }, + connected_account: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'account_type', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'account_type_display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'automatically_manage_new_devices', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'custom_metadata', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'user_identifier', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'api_url', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'email', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'exclusive', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'phone', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'username', + undocumentedMessage: '', + }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'warnings', + undocumentedMessage: '', + }, + ], + resourceType: 'connected_account', + routePath: '', + undocumentedMessage: '', + }, + device_provider: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_offline_access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_online_access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_unlock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_connection', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_disconnection', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_removal', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_turn_off_hvac', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_provider_name', + undocumentedMessage: '', + values: [ + { + name: 'dormakaba_community', + }, + { + name: 'legic_connect', + }, + { + name: 'akuvox', + }, + { + name: 'august', + }, + { + name: 'avigilon_alta', + }, + { + name: 'brivo', + }, + { + name: 'butterflymx', + }, + { + name: 'schlage', + }, + { + name: 'smartthings', + }, + { + name: 'yale', + }, + { + name: 'genie', + }, + { + name: 'doorking', + }, + { + name: 'salto', + }, + { + name: 'salto_ks', + }, + { + name: 'lockly', + }, + { + name: 'ttlock', + }, + { + name: 'linear', + }, + { + name: 'noiseaware', + }, + { + name: 'nuki', + }, + { + name: 'seam_relay_admin', + }, + { + name: 'igloo', + }, + { + name: 'kwikset', + }, + { + name: 'minut', + }, + { + name: 'my_2n', + }, + { + name: 'controlbyweb', + }, + { + name: 'nest', + }, + { + name: 'igloohome', + }, + { + name: 'ecobee', + }, + { + name: 'hubitat', + }, + { + name: 'four_suites', + }, + { + name: 'dormakaba_oracode', + }, + { + name: 'pti', + }, + { + name: 'wyze', + }, + { + name: 'seam_passport', + }, + { + name: 'visionline', + }, + { + name: 'assa_abloy_credential_service', + }, + { + name: 'seam_bridge', + }, + { + name: 'tedee', + }, + { + name: 'honeywell_resideo', + }, + { + name: 'latch', + }, + { + name: 'akiles', + }, + { + name: 'assa_abloy_vostio', + }, + { + name: 'assa_abloy_vostio_credential_service', + }, + { + name: 'tado', + }, + { + name: 'salto_space', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'image_url', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'provider_categories', + undocumentedMessage: '', + }, + ], + resourceType: 'device_provider', + routePath: '', + undocumentedMessage: '', + }, + enrollment_automation: { + deprecationMessage: '', + description: 'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the enrollment automation was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'credential_manager_acs_system_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the enrollment automation.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'enrollment_automation_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'enrollment_automation', + routePath: '', + undocumentedMessage: '', + }, + event: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Time at which the event was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'event_type', + undocumentedMessage: '', + values: [ + { + name: 'access_code.created', + }, + { + name: 'access_code.changed', + }, + { + name: 'access_code.scheduled_on_device', + }, + { + name: 'access_code.set_on_device', + }, + { + name: 'access_code.removed_from_device', + }, + { + name: 'access_code.delay_in_setting_on_device', + }, + { + name: 'access_code.failed_to_set_on_device', + }, + { + name: 'access_code.deleted', + }, + { + name: 'access_code.delay_in_removing_from_device', + }, + { + name: 'access_code.failed_to_remove_from_device', + }, + { + name: 'access_code.modified_external_to_seam', + }, + { + name: 'access_code.deleted_external_to_seam', + }, + { + name: 'access_code.backup_access_code_pulled', + }, + { + name: 'access_code.unmanaged.converted_to_managed', + }, + { + name: 'access_code.unmanaged.failed_to_convert_to_managed', + }, + { + name: 'access_code.unmanaged.created', + }, + { + name: 'access_code.unmanaged.removed', + }, + { + name: 'acs_system.connected', + }, + { + name: 'acs_system.added', + }, + { + name: 'acs_system.disconnected', + }, + { + name: 'acs_credential.deleted', + }, + { + name: 'acs_credential.issued', + }, + { + name: 'acs_user.deleted', + }, + { + name: 'acs_encoder.added', + }, + { + name: 'acs_encoder.removed', + }, + { + name: 'client_session.deleted', + }, + { + name: 'connected_account.connected', + }, + { + name: 'connected_account.created', + }, + { + name: 'connected_account.successful_login', + }, + { + name: 'connected_account.disconnected', + }, + { + name: 'connected_account.completed_first_sync', + }, + { + name: 'connected_account.deleted', + }, + { + name: 'connected_account.completed_first_sync_after_reconnection', + }, + { + name: 'action_attempt.lock_door.succeeded', + }, + { + name: 'action_attempt.lock_door.failed', + }, + { + name: 'action_attempt.unlock_door.succeeded', + }, + { + name: 'action_attempt.unlock_door.failed', + }, + { + name: 'connect_webview.login_succeeded', + }, + { + name: 'connect_webview.login_failed', + }, + { + name: 'device.connected', + }, + { + name: 'device.added', + }, + { + name: 'device.converted_to_unmanaged', + }, + { + name: 'device.unmanaged.converted_to_managed', + }, + { + name: 'device.unmanaged.connected', + }, + { + name: 'device.disconnected', + }, + { + name: 'device.unmanaged.disconnected', + }, + { + name: 'device.tampered', + }, + { + name: 'device.low_battery', + }, + { + name: 'device.battery_status_changed', + }, + { + name: 'device.removed', + }, + { + name: 'device.deleted', + }, + { + name: 'device.third_party_integration_detected', + }, + { + name: 'device.third_party_integration_no_longer_detected', + }, + { + name: 'device.salto.privacy_mode_activated', + }, + { + name: 'device.salto.privacy_mode_deactivated', + }, + { + name: 'device.connection_became_flaky', + }, + { + name: 'device.connection_stabilized', + }, + { + name: 'device.error.subscription_required', + }, + { + name: 'device.error.subscription_required.resolved', + }, + { + name: 'device.accessory_keypad_connected', + }, + { + name: 'device.accessory_keypad_disconnected', + }, + { + name: 'noise_sensor.noise_threshold_triggered', + }, + { + name: 'lock.locked', + }, + { + name: 'lock.unlocked', + }, + { + name: 'lock.access_denied', + }, + { + name: 'thermostat.climate_preset_activated', + }, + { + name: 'thermostat.manually_adjusted', + }, + { + name: 'thermostat.temperature_threshold_exceeded', + }, + { + name: 'thermostat.temperature_threshold_no_longer_exceeded', + }, + { + name: 'enrollment_automation.deleted', + }, + { + name: 'phone.deactivated', + }, + ], + }, + { + deprecationMessage: '', + description: 'Time when the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'event', + routePath: '', + undocumentedMessage: '', + }, + network: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'network_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + undocumentedMessage: '', + }, + ], + resourceType: 'network', + routePath: '', + undocumentedMessage: '', + }, + noise_threshold: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_daily_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_threshold_decibels', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'noise_threshold_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_threshold_nrs', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_daily_at', + undocumentedMessage: '', + }, + ], + resourceType: 'noise_threshold', + routePath: '', + undocumentedMessage: '', + }, + phone: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_offline_access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_online_access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_unlock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_connection', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_disconnection', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_removal', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_turn_off_hvac', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'capabilities_supported', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the device object was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'custom_metadata', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier for the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_type', + undocumentedMessage: '', + values: [ { - deprecationMessage: '', - description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'battery_level', - undocumentedMessage: '', + name: 'android_phone', }, { - deprecationMessage: '', - description: 'Alt text for the device image.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'image_alt_text', - undocumentedMessage: '', + name: 'ios_phone', }, + ], + }, + { + deprecationMessage: '', + description: 'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '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.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether Seam manages the device.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Location information for the device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'location', + properties: [ { deprecationMessage: '', - description: 'Image URL for the device.', + description: 'Name of the device location.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'image_url', + name: 'location_name', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Manufacturer of the device.', + description: 'Time zone of the device location.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'manufacturer', + name: 'timezone', undocumentedMessage: '', }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Optional nickname to describe the device, settable through Seam', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'nickname', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'properties', + properties: [ { deprecationMessage: '', description: '', @@ -4916,141 +12308,33 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'model', - properties: [ - { - deprecationMessage: 'use device.properties.model.can_connect_accessory_keypad', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'accessory_keypad_supported', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device can connect a accessory keypad.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_connect_accessory_keypad', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name of the device model.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device has a built in accessory keypad.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_built_in_keypad', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name that corresponds to the manufacturer-specific terminology for the device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'manufacturer_display_name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device supports offline access codes.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'offline_access_codes_supported', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device supports online access codes.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'online_access_codes_supported', - undocumentedMessage: '', - }, - ], - undocumentedMessage: '', - }, - { - deprecationMessage: 'use device.display_name instead', - description: 'Name of the device.', - draftMessage: '', - format: 'string', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'name', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether it is currently possible to use offline access codes for the device.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'offline_access_codes_enabled', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device is online.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'online', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether it is currently possible to use online access codes for the device.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'online_access_codes_enabled', + name: 'assa_abloy_credential_service_metadata', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'endpoints', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'has_active_endpoint', + undocumentedMessage: '', + }, + ], undocumentedMessage: '', }, ], @@ -5081,7 +12365,238 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - resourceType: 'unmanaged_device', + resourceType: 'phone', + routePath: '', + undocumentedMessage: '', + }, + service_health: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'description', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'status', + undocumentedMessage: '', + values: [ + { + name: 'healthy', + }, + { + name: 'degraded', + }, + { + name: 'down', + }, + ], + }, + ], + resourceType: 'service_health', + routePath: '', + undocumentedMessage: '', + }, + unmanaged_access_code: { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Unique identifier for the access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_code_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Code used for access. Typically, a numeric or alphanumeric string.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the access code was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier for the device associated with the access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time after which the time-bound access code becomes inactive.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'errors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the time-bound access code becomes active.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'status', + undocumentedMessage: '', + values: [ + { + name: 'set', + }, + ], + }, + { + deprecationMessage: '', + description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'type', + undocumentedMessage: '', + values: [ + { + name: 'time_bound', + }, + { + name: 'ongoing', + }, + ], + }, + { + deprecationMessage: '', + description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'array', + name: 'warnings', + undocumentedMessage: '', + }, + ], + resourceType: 'unmanaged_access_code', + routePath: '', undocumentedMessage: '', }, user_identity: { @@ -5190,6 +12705,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'user_identity', + routePath: '', undocumentedMessage: '', }, webhook: { @@ -5250,6 +12766,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'webhook', + routePath: '', undocumentedMessage: '', }, workspace: { @@ -5322,6 +12839,7 @@ Generated by [AVA](https://avajs.dev). }, ], resourceType: 'workspace', + routePath: '', undocumentedMessage: '', }, }, diff --git a/test/snapshots/seam-blueprint.test.ts.snap b/test/snapshots/seam-blueprint.test.ts.snap index 13071913..e7f4c91b 100644 Binary files a/test/snapshots/seam-blueprint.test.ts.snap and b/test/snapshots/seam-blueprint.test.ts.snap differ