From 1f727198c5b0f077fa5c940fb41634b958c8ce4f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 8 Jan 2025 22:51:14 +0000 Subject: [PATCH] Update via seamapi/seam-connect@bda6aa9452bb4a65aec63822606b5257c13313c3 --- .../access-codes/managed-access-code.ts | 6 +- .../access-codes/unmanaged-access-code.ts | 6 +- .../connect/models/acs/acs-access-group.ts | 10 +- .../connect/models/acs/acs-credential-pool.ts | 6 +- .../acs-credential-provisioning-automation.ts | 73 +- .../seam/connect/models/acs/acs-entrance.ts | 61 +- src/lib/seam/connect/models/acs/acs-system.ts | 10 +- src/lib/seam/connect/models/acs/acs-user.ts | 19 +- .../acs/metadata/dormakaba-community.ts | 1 - .../models/action-attempts/action-attempt.ts | 6 +- .../models/client-sessions/client-session.ts | 6 +- .../connect-webviews/connect-webview.ts | 6 +- .../connected-accounts/connected-account.ts | 6 +- .../connect/models/devices/device-provider.ts | 6 +- src/lib/seam/connect/models/devices/device.ts | 6 +- src/lib/seam/connect/models/devices/phone.ts | 6 +- .../models/devices/unmanaged-device.ts | 6 +- .../connect/models/events/access-codes.ts | 256 +++---- .../models/events/acs/access_groups.ts | 13 +- .../connect/models/events/acs/credentials.ts | 30 +- .../connect/models/events/acs/encoders.ts | 30 +- .../seam/connect/models/events/acs/systems.ts | 45 +- .../seam/connect/models/events/acs/users.ts | 15 +- .../connect/models/events/action-attempts.ts | 56 +- .../connect/models/events/client-sessions.ts | 15 +- .../connect/models/events/connect-webviews.ts | 29 +- .../models/events/connected-accounts.ts | 99 +-- src/lib/seam/connect/models/events/devices.ts | 640 ++++++++++-------- .../models/events/enrollment-automations.ts | 14 +- src/lib/seam/connect/models/events/phones.ts | 13 +- .../seam/connect/models/events/seam-event.ts | 6 +- .../models/noise-sensors/noise-threshold.ts | 6 +- .../models/thermostats/thermostat-schedule.ts | 122 ++-- .../models/user-identities/user-identity.ts | 69 +- .../seam/connect/models/webhooks/webhook.ts | 6 +- .../connect/models/workspaces/workspace.ts | 6 +- src/lib/seam/connect/openapi.ts | 108 ++- src/lib/seam/connect/route-types.ts | 54 +- 38 files changed, 1090 insertions(+), 782 deletions(-) diff --git a/src/lib/seam/connect/models/access-codes/managed-access-code.ts b/src/lib/seam/connect/models/access-codes/managed-access-code.ts index 921c3cde..9665e30a 100644 --- a/src/lib/seam/connect/models/access-codes/managed-access-code.ts +++ b/src/lib/seam/connect/models/access-codes/managed-access-code.ts @@ -138,6 +138,10 @@ export const access_code = z.object({ .describe( '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.', ), -}) +}).describe(` + --- + route_path: /access_codes + --- +`) export type AccessCode = z.infer diff --git a/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts b/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts index 02b02648..cb0fb0b9 100644 --- a/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +++ b/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts @@ -19,6 +19,10 @@ export const unmanaged_access_code = access_code .extend({ is_managed: z.literal(false), status: z.enum(['set']), - }) + }).describe(` + --- + route_path: /access_codes/unmanaged + --- + `) export type UnmanagedAccessCode = z.infer diff --git a/src/lib/seam/connect/models/acs/acs-access-group.ts b/src/lib/seam/connect/models/acs/acs-access-group.ts index 674df72f..a077218e 100644 --- a/src/lib/seam/connect/models/acs/acs-access-group.ts +++ b/src/lib/seam/connect/models/acs/acs-access-group.ts @@ -100,9 +100,13 @@ const common_acs_access_group = z.object({ export const acs_access_group = common_acs_access_group.extend({ is_managed: z.literal(true), -}) - .describe(`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).`) +}).describe(` + --- + route_path: /acs/access_groups + --- + 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). + `) export const unmanaged_acs_access_group = common_acs_access_group.extend({ is_managed: z.literal(false), }) diff --git a/src/lib/seam/connect/models/acs/acs-credential-pool.ts b/src/lib/seam/connect/models/acs/acs-credential-pool.ts index bc1c096f..7b560a3d 100644 --- a/src/lib/seam/connect/models/acs/acs-credential-pool.ts +++ b/src/lib/seam/connect/models/acs/acs-credential-pool.ts @@ -14,6 +14,10 @@ export const acs_credential_pool = z.object({ external_type_display_name: z.string(), created_at: z.string().datetime(), workspace_id: z.string().uuid(), -}) +}).describe(` + --- + route_path: /acs/credential_pools + --- +`) export type AcsCredentialPool = z.output diff --git a/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts b/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts index 092d323d..c95e4796 100644 --- a/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +++ b/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts @@ -6,42 +6,45 @@ export const acs_credential_provisioning_automation = z.object({ user_identity_id: z.string().uuid(), created_at: z.string().datetime(), workspace_id: z.string().uuid(), -}) +}).describe(` + --- + route_path: /acs/credential_provisioning_automations + --- +`) -export const enrollment_automation = z - .object({ - enrollment_automation_id: z - .string() - .uuid() - .describe('ID of the enrollment automation.'), - credential_manager_acs_system_id: z - .string() - .uuid() - .describe( - 'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.', - ), - user_identity_id: z - .string() - .uuid() - .describe( - '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).', - ), - created_at: z - .string() - .datetime() - .describe( - 'Date and time at which the enrollment automation was created.', - ), - workspace_id: z - .string() - .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.', - ), - }) - .describe( - '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).', - ) +export const enrollment_automation = z.object({ + enrollment_automation_id: z + .string() + .uuid() + .describe('ID of the enrollment automation.'), + credential_manager_acs_system_id: z + .string() + .uuid() + .describe( + 'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.', + ), + user_identity_id: z + .string() + .uuid() + .describe( + '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).', + ), + created_at: z + .string() + .datetime() + .describe('Date and time at which the enrollment automation was created.'), + workspace_id: z + .string() + .uuid() + .describe( + 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.', + ), +}).describe(` + --- + route_path: /user_identities/enrollment_automations + --- + 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). +`) export type EnrollmentAutomation = z.output diff --git a/src/lib/seam/connect/models/acs/acs-entrance.ts b/src/lib/seam/connect/models/acs/acs-entrance.ts index 502a7c24..e8c3f5df 100644 --- a/src/lib/seam/connect/models/acs/acs-entrance.ts +++ b/src/lib/seam/connect/models/acs/acs-entrance.ts @@ -9,35 +9,36 @@ import { } from './metadata/index.js' import { acs_entrance_salto_space_metadata } from './metadata/salto-space.js' -export const acs_entrance = z - .object({ - acs_system_id: z - .string() - .uuid() - .describe('ID of the access control system that contains the entrance.'), - acs_entrance_id: z.string().uuid().describe('ID of the entrance.'), - created_at: z - .string() - .datetime() - .describe('Date and time at which the entrance was created.'), - display_name: z.string().describe('Display name for the entrance.'), - errors: z.array( - z.object({ - error_code: z.string(), - message: z.string(), - }), - ), - latch_metadata: acs_entrance_latch_metadata.optional(), - visionline_metadata: acs_entrance_visionline_metadata.optional(), - salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(), - dormakaba_community_metadata: - acs_entrance_dormakaba_community_metadata.optional(), - assa_abloy_vostio_metadata: - acs_entrance_assa_abloy_vostio_metadata.optional(), - salto_space_metadata: acs_entrance_salto_space_metadata.optional(), - }) - .describe( - '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).', - ) +export const acs_entrance = z.object({ + acs_system_id: z + .string() + .uuid() + .describe('ID of the access control system that contains the entrance.'), + acs_entrance_id: z.string().uuid().describe('ID of the entrance.'), + created_at: z + .string() + .datetime() + .describe('Date and time at which the entrance was created.'), + display_name: z.string().describe('Display name for the entrance.'), + errors: z.array( + z.object({ + error_code: z.string(), + message: z.string(), + }), + ), + latch_metadata: acs_entrance_latch_metadata.optional(), + visionline_metadata: acs_entrance_visionline_metadata.optional(), + salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(), + dormakaba_community_metadata: + acs_entrance_dormakaba_community_metadata.optional(), + assa_abloy_vostio_metadata: + acs_entrance_assa_abloy_vostio_metadata.optional(), + salto_space_metadata: acs_entrance_salto_space_metadata.optional(), +}).describe(` + --- + route_path: /acs/entrances + --- + 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). +`) export type AcsEntrance = z.infer diff --git a/src/lib/seam/connect/models/acs/acs-system.ts b/src/lib/seam/connect/models/acs/acs-system.ts index 0c5ce151..f04751cc 100644 --- a/src/lib/seam/connect/models/acs/acs-system.ts +++ b/src/lib/seam/connect/models/acs/acs-system.ts @@ -296,9 +296,11 @@ export const acs_system = z .array(acs_system_warning) .describe('Warnings associated with the `acs_system`.'), }) - .merge(acs_system_capability_flags) - .describe( - 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - ) + .merge(acs_system_capability_flags).describe(` + --- + route_path: /acs/systems + --- + Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `) export type AcsSystem = z.output diff --git a/src/lib/seam/connect/models/acs/acs-user.ts b/src/lib/seam/connect/models/acs/acs-user.ts index f8524799..ed19ca6e 100644 --- a/src/lib/seam/connect/models/acs/acs-user.ts +++ b/src/lib/seam/connect/models/acs/acs-user.ts @@ -273,15 +273,16 @@ const common_acs_user = z }) .merge(user_fields) -export const acs_user = common_acs_user - .merge( - z.object({ - is_managed: z.literal(true), - }), - ) - .describe( - '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).', - ) +export const acs_user = common_acs_user.merge( + z.object({ + is_managed: z.literal(true), + }), +).describe(` + --- + route_path: /acs/users + --- + 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). + `) export const unmanaged_acs_user = common_acs_user .merge( diff --git a/src/lib/seam/connect/models/acs/metadata/dormakaba-community.ts b/src/lib/seam/connect/models/acs/metadata/dormakaba-community.ts index c15692fe..75be922a 100644 --- a/src/lib/seam/connect/models/acs/metadata/dormakaba-community.ts +++ b/src/lib/seam/connect/models/acs/metadata/dormakaba-community.ts @@ -2,7 +2,6 @@ import { z } from 'zod' export const acs_entrance_dormakaba_community_metadata = z.object({ access_point_name: z.string(), - common_area_number: z.number().optional(), }) export type AcsEntranceDormakabaCommunityMetadata = z.infer< diff --git a/src/lib/seam/connect/models/action-attempts/action-attempt.ts b/src/lib/seam/connect/models/action-attempts/action-attempt.ts index 1b6d7192..85fdb07a 100644 --- a/src/lib/seam/connect/models/action-attempts/action-attempt.ts +++ b/src/lib/seam/connect/models/action-attempts/action-attempt.ts @@ -20,6 +20,10 @@ export const action_attempt = z.union([ ...set_hvac_mode_action_attempt.options, ...activate_climate_preset_action_attempt.options, ...deprecated_action_attempts, -]) +]).describe(` + --- + route_path: /action_attempts + --- +`) export type ActionAttempt = z.infer diff --git a/src/lib/seam/connect/models/client-sessions/client-session.ts b/src/lib/seam/connect/models/client-sessions/client-session.ts index 584eb539..99a21a2d 100644 --- a/src/lib/seam/connect/models/client-sessions/client-session.ts +++ b/src/lib/seam/connect/models/client-sessions/client-session.ts @@ -11,6 +11,10 @@ export const client_session = z.object({ connected_account_ids: z.array(z.string().uuid()), connect_webview_ids: z.array(z.string().uuid()), user_identity_ids: z.array(z.string().uuid()), -}) +}).describe(` + --- + route_path: /client_sessions + --- +`) export type ClientSession = z.infer diff --git a/src/lib/seam/connect/models/connect-webviews/connect-webview.ts b/src/lib/seam/connect/models/connect-webviews/connect-webview.ts index d076f201..d70671e4 100644 --- a/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +++ b/src/lib/seam/connect/models/connect-webviews/connect-webview.ts @@ -44,6 +44,10 @@ export const connect_webview = z.object({ wait_for_device_creation: z.boolean(), authorized_at: z.string().datetime().nullable(), selected_provider: z.string().nullable(), -}) +}).describe(` + --- + route_path: /connect_webviews + --- +`) export type ConnectWebview = z.infer diff --git a/src/lib/seam/connect/models/connected-accounts/connected-account.ts b/src/lib/seam/connect/models/connected-accounts/connected-account.ts index 518071e4..e582ba2c 100644 --- a/src/lib/seam/connect/models/connected-accounts/connected-account.ts +++ b/src/lib/seam/connect/models/connected-accounts/connected-account.ts @@ -61,6 +61,10 @@ export const connected_account = z.object({ warnings: z.array(connected_account_warning), custom_metadata, automatically_manage_new_devices: z.boolean(), -}) +}).describe(` + --- + route_path: /connected_accounts + --- +`) export type ConnectedAccount = z.infer diff --git a/src/lib/seam/connect/models/devices/device-provider.ts b/src/lib/seam/connect/models/devices/device-provider.ts index 4a17d63f..d99f235b 100644 --- a/src/lib/seam/connect/models/devices/device-provider.ts +++ b/src/lib/seam/connect/models/devices/device-provider.ts @@ -133,6 +133,10 @@ export const device_provider = z image_url: z.string(), provider_categories: z.array(z.enum(PUBLIC_PROVIDER_CATEGORIES)), }) - .extend(device_capability_flags.shape) + .extend(device_capability_flags.shape).describe(` + --- + route_path: /devices + --- + `) export type DeviceProvider = z.infer diff --git a/src/lib/seam/connect/models/devices/device.ts b/src/lib/seam/connect/models/devices/device.ts index c442dbcd..4b4cc992 100644 --- a/src/lib/seam/connect/models/devices/device.ts +++ b/src/lib/seam/connect/models/devices/device.ts @@ -370,6 +370,10 @@ export const device = z .describe('Indicates whether Seam manages the device.'), custom_metadata, }) - .merge(device_capability_flags) + .merge(device_capability_flags).describe(` + --- + route_path: /devices + --- + `) export type Device = z.infer diff --git a/src/lib/seam/connect/models/devices/phone.ts b/src/lib/seam/connect/models/devices/phone.ts index 30eff739..b1576668 100644 --- a/src/lib/seam/connect/models/devices/phone.ts +++ b/src/lib/seam/connect/models/devices/phone.ts @@ -12,4 +12,8 @@ export const phone = device .extend({ device_type: z.enum(['android_phone', 'ios_phone']), }) - .merge(z.object({ properties: phone_specific_properties })) + .merge(z.object({ properties: phone_specific_properties })).describe(` + --- + route_path: /phones + --- + `) diff --git a/src/lib/seam/connect/models/devices/unmanaged-device.ts b/src/lib/seam/connect/models/devices/unmanaged-device.ts index fa7bf982..d236ca72 100644 --- a/src/lib/seam/connect/models/devices/unmanaged-device.ts +++ b/src/lib/seam/connect/models/devices/unmanaged-device.ts @@ -34,6 +34,10 @@ export const unmanaged_device = device model: true, }), }) - .merge(device_capability_flags) + .merge(device_capability_flags).describe(` + --- + route_path: /devices/unmanaged + --- + `) export type UnmanagedDevice = z.infer diff --git a/src/lib/seam/connect/models/events/access-codes.ts b/src/lib/seam/connect/models/events/access-codes.ts index 5f812efd..6b67360c 100644 --- a/src/lib/seam/connect/models/events/access-codes.ts +++ b/src/lib/seam/connect/models/events/access-codes.ts @@ -29,207 +29,229 @@ const code = z 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).', ) -export const access_code_created_event = access_code_event - .extend({ - event_type: z.literal('access_code.created'), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.', - ) +export const access_code_created_event = access_code_event.extend({ + event_type: z.literal('access_code.created'), +}).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created. + `) export type AccessCodeCreatedEvent = z.infer -export const access_code_changed_event = access_code_event - .extend({ - event_type: z.literal('access_code.changed'), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.', - ) +export const access_code_changed_event = access_code_event.extend({ + event_type: z.literal('access_code.changed'), +}).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed. + `) export type AccessCodeChangedEvent = z.infer -export const access_code_scheduled_on_device_event = access_code_event - .extend({ - event_type: z.literal('access_code.scheduled_on_device'), - code, - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device.', - ) +export const access_code_scheduled_on_device_event = access_code_event.extend({ + event_type: z.literal('access_code.scheduled_on_device'), + code, +}).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device. + `) export type AccessCodeScheduledOnDeviceEvent = z.infer< typeof access_code_scheduled_on_device_event > -export const access_code_set_on_device_event = access_code_event - .extend({ - event_type: z.literal('access_code.set_on_device'), - code, - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.', - ) +export const access_code_set_on_device_event = access_code_event.extend({ + event_type: z.literal('access_code.set_on_device'), + code, +}).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device. + `) export type AccessCodeSetOnDeviceEvent = z.infer< typeof access_code_set_on_device_event > -export const access_code_removed_from_device_event = access_code_event - .extend({ - event_type: z.literal('access_code.removed_from_device'), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.', - ) +export const access_code_removed_from_device_event = access_code_event.extend({ + event_type: z.literal('access_code.removed_from_device'), +}).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device. + `) export type AccessCodeRemovedFromDeviceEvent = z.infer< typeof access_code_removed_from_device_event > -export const access_code_delay_in_setting_on_device_event = access_code_event - .extend({ +export const access_code_delay_in_setting_on_device_event = + access_code_event.extend({ event_type: z.literal('access_code.delay_in_setting_on_device'), - }) - .describe( - 'There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device.', - ) + }).describe(` + --- + route_path: /access_codes + --- + There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device. + `) export type AccessCodeDelayInSettingOnDeviceEvent = z.infer< typeof access_code_delay_in_setting_on_device_event > -export const access_code_failed_to_set_on_device_event = access_code_event - .extend({ +export const access_code_failed_to_set_on_device_event = + access_code_event.extend({ event_type: z.literal('access_code.failed_to_set_on_device'), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.', - ) + }).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device. + `) export type AccessCodeFailedToSetOnDeviceEvent = z.infer< typeof access_code_failed_to_set_on_device_event > -export const access_code_deleted_event = access_code_event - .extend({ - event_type: z.literal('access_code.deleted'), - code: code.nullable(), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.', - ) +export const access_code_deleted_event = access_code_event.extend({ + event_type: z.literal('access_code.deleted'), + code: code.nullable(), +}).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted. + `) export type AccessCodeDeletedEvent = z.infer -export const access_code_delay_in_removing_from_device_event = access_code_event - .extend({ +export const access_code_delay_in_removing_from_device_event = + access_code_event.extend({ event_type: z.literal('access_code.delay_in_removing_from_device'), - }) - .describe( - 'There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device.', - ) + }).describe(` + --- + route_path: /access_codes + --- + There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device. + `) export type AccessCodeDelayInRemovingFromDeviceEvent = z.infer< typeof access_code_delay_in_removing_from_device_event > -export const access_code_failed_to_remove_from_device_event = access_code_event - .extend({ +export const access_code_failed_to_remove_from_device_event = + access_code_event.extend({ event_type: z.literal('access_code.failed_to_remove_from_device'), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.', - ) + }).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device. + `) export type AccessCodeFailedToRemoveFromDeviceEvent = z.infer< typeof access_code_failed_to_remove_from_device_event > -export const access_code_modified_external_to_seam_event = access_code_event - .extend({ +export const access_code_modified_external_to_seam_event = + access_code_event.extend({ event_type: z.literal('access_code.modified_external_to_seam'), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.', - ) + }).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam. + `) export type AccessCodeModifiedExternalToSeamEvent = z.infer< typeof access_code_modified_external_to_seam_event > -export const access_code_deleted_external_to_seam_event = access_code_event - .extend({ +export const access_code_deleted_external_to_seam_event = + access_code_event.extend({ event_type: z.literal('access_code.deleted_external_to_seam'), - }) - .describe( - 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.', - ) + }).describe(` + --- + route_path: /access_codes + --- + An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam. + `) export type AccessCodeDeletedExternalToSeamEvent = z.infer< typeof access_code_deleted_external_to_seam_event > -export const access_code_backup_access_code_pulled_event = access_code_event - .extend({ +export const access_code_backup_access_code_pulled_event = + access_code_event.extend({ event_type: z.literal('access_code.backup_access_code_pulled'), backup_access_code_id: z.string(), - }) - .describe( - 'A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.', - ) + }).describe(` + --- + route_path: /access_codes + --- + A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. + `) export type AccessCodeBackupAccessCodePulledEvent = z.infer< typeof access_code_backup_access_code_pulled_event > export const unmanaged_access_code_converted_to_managed_event = - access_code_event - .extend({ - event_type: z.literal('access_code.unmanaged.converted_to_managed'), - }) - .describe( - 'An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.', - ) + access_code_event.extend({ + event_type: z.literal('access_code.unmanaged.converted_to_managed'), + }).describe(` + --- + route_path: /access_codes/unmanaged + --- + An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. + `) export type UnmanagedAccessCodeConvertedToManagedEvent = z.infer< typeof unmanaged_access_code_converted_to_managed_event > export const unmanaged_access_code_failed_to_convert_to_managed_event = - access_code_event - .extend({ - event_type: z.literal( - 'access_code.unmanaged.failed_to_convert_to_managed', - ), - }) - .describe( - 'An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.', - ) + access_code_event.extend({ + event_type: z.literal('access_code.unmanaged.failed_to_convert_to_managed'), + }).describe(` + --- + route_path: /access_codes/unmanaged + --- + An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. + `) export type UnmanagedAccessCodeFailedToConvertToManagedEvent = z.infer< typeof unmanaged_access_code_failed_to_convert_to_managed_event > -export const unmanaged_access_code_created_event = access_code_event - .extend({ - event_type: z.literal('access_code.unmanaged.created'), - }) - .describe( - 'An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.', - ) +export const unmanaged_access_code_created_event = access_code_event.extend({ + event_type: z.literal('access_code.unmanaged.created'), +}).describe(` + --- + route_path: /access_codes/unmanaged + --- + An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. + `) export type UnmanagedAccessCodeCreatedEvent = z.infer< typeof unmanaged_access_code_created_event > -export const unmanaged_access_code_removed_event = access_code_event - .extend({ - event_type: z.literal('access_code.unmanaged.removed'), - }) - .describe( - 'An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.', - ) +export const unmanaged_access_code_removed_event = access_code_event.extend({ + event_type: z.literal('access_code.unmanaged.removed'), +}).describe(` + --- + route_path: /access_codes/unmanaged + --- + An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. + `) export type UnmanagedAccessCodeRemovedEvent = z.infer< typeof unmanaged_access_code_removed_event diff --git a/src/lib/seam/connect/models/events/acs/access_groups.ts b/src/lib/seam/connect/models/events/acs/access_groups.ts index e41e3b68..6bad3ca1 100644 --- a/src/lib/seam/connect/models/events/acs/access_groups.ts +++ b/src/lib/seam/connect/models/events/acs/access_groups.ts @@ -6,11 +6,14 @@ const acs_access_group_event = common_acs_event.extend({ acs_access_group_id: z.string().uuid(), }) -export const acs_access_group_deleted_event = acs_access_group_event - .extend({ - event_type: z.literal('acs_access_group.deleted'), - }) - .describe('An ACS access group was deleted.') +export const acs_access_group_deleted_event = acs_access_group_event.extend({ + event_type: z.literal('acs_access_group.deleted'), +}).describe(` + --- + route_path: /acs/access_groups + --- + An ACS access group was deleted. +`) export type AcsAccessGroupDeletedEvent = z.infer< typeof acs_access_group_deleted_event diff --git a/src/lib/seam/connect/models/events/acs/credentials.ts b/src/lib/seam/connect/models/events/acs/credentials.ts index 31b1cf2e..72ce3d4b 100644 --- a/src/lib/seam/connect/models/events/acs/credentials.ts +++ b/src/lib/seam/connect/models/events/acs/credentials.ts @@ -6,25 +6,27 @@ const acs_credential_event = common_acs_event.extend({ acs_credential_id: z.string().uuid(), }) -export const acs_credential_deleted_event = acs_credential_event - .extend({ - event_type: z.literal('acs_credential.deleted'), - }) - .describe( - 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.', - ) +export const acs_credential_deleted_event = acs_credential_event.extend({ + event_type: z.literal('acs_credential.deleted'), +}).describe(` + --- + route_path: /acs/credentials + --- + An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted. + `) export type AcsCredentialDeletedEvent = z.infer< typeof acs_credential_deleted_event > -export const acs_credential_issued = acs_credential_event - .extend({ - event_type: z.literal('acs_credential.issued'), - }) - .describe( - 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.', - ) +export const acs_credential_issued = acs_credential_event.extend({ + event_type: z.literal('acs_credential.issued'), +}).describe(` + --- + route_path: /acs/credentials + --- + An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued. + `) export const acs_credential_events = [ acs_credential_deleted_event, diff --git a/src/lib/seam/connect/models/events/acs/encoders.ts b/src/lib/seam/connect/models/events/acs/encoders.ts index aa6f2c89..01b11104 100644 --- a/src/lib/seam/connect/models/events/acs/encoders.ts +++ b/src/lib/seam/connect/models/events/acs/encoders.ts @@ -11,23 +11,25 @@ const acs_encoder_event = common_acs_event.extend({ ), }) -export const acs_encoder_added_event = acs_encoder_event - .extend({ - event_type: z.literal('acs_encoder.added'), - }) - .describe( - 'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.', - ) +export const acs_encoder_added_event = acs_encoder_event.extend({ + event_type: z.literal('acs_encoder.added'), +}).describe(` + --- + route_path: /acs/encoders + --- + An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added. + `) export type AcsEncoderAddedEvent = z.infer -export const acs_encoder_removed_event = acs_encoder_event - .extend({ - event_type: z.literal('acs_encoder.removed'), - }) - .describe( - 'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.', - ) +export const acs_encoder_removed_event = acs_encoder_event.extend({ + event_type: z.literal('acs_encoder.removed'), +}).describe(` + --- + route_path: /acs/encoders + --- + An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed. + `) export type AcsEncoderRemovedEvent = z.infer diff --git a/src/lib/seam/connect/models/events/acs/systems.ts b/src/lib/seam/connect/models/events/acs/systems.ts index 3dc6af43..f8beced3 100644 --- a/src/lib/seam/connect/models/events/acs/systems.ts +++ b/src/lib/seam/connect/models/events/acs/systems.ts @@ -4,35 +4,38 @@ import { common_acs_event } from './common.js' const acs_system_event = common_acs_event.extend({}) -export const acs_system_connected_event = acs_system_event - .extend({ - event_type: z.literal('acs_system.connected'), - }) - .describe( - 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.', - ) +export const acs_system_connected_event = acs_system_event.extend({ + event_type: z.literal('acs_system.connected'), +}).describe(` + --- + route_path: /acs/systems + --- + An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected. + `) export type AcsSystemConnectedEvent = z.infer -export const acs_system_disconnected_event = acs_system_event - .extend({ - event_type: z.literal('acs_system.disconnected'), - }) - .describe( - 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.', - ) +export const acs_system_disconnected_event = acs_system_event.extend({ + event_type: z.literal('acs_system.disconnected'), +}).describe(` + --- + route_path: /acs/systems + --- + An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected. + `) export type AcsSystemDisconnectedEvent = z.infer< typeof acs_system_disconnected_event > -export const acs_system_added_event = acs_system_event - .extend({ - event_type: z.literal('acs_system.added'), - }) - .describe( - 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.', - ) +export const acs_system_added_event = acs_system_event.extend({ + event_type: z.literal('acs_system.added'), +}).describe(` + --- + route_path: /acs/systems + --- + An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added. + `) export type AcsSystemAddedEvent = z.infer diff --git a/src/lib/seam/connect/models/events/acs/users.ts b/src/lib/seam/connect/models/events/acs/users.ts index de9ccef6..c7d212f5 100644 --- a/src/lib/seam/connect/models/events/acs/users.ts +++ b/src/lib/seam/connect/models/events/acs/users.ts @@ -10,13 +10,14 @@ const acs_user_event = common_acs_event 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', ) -export const acs_user_deleted_event = acs_user_event - .extend({ - event_type: z.literal('acs_user.deleted'), - }) - .describe( - 'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.', - ) +export const acs_user_deleted_event = acs_user_event.extend({ + event_type: z.literal('acs_user.deleted'), +}).describe(` + --- + route_path: /acs/users + --- + An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted. + `) export type AcsUserDeletedEvent = z.infer diff --git a/src/lib/seam/connect/models/events/action-attempts.ts b/src/lib/seam/connect/models/events/action-attempts.ts index 03e77963..c3eeae99 100644 --- a/src/lib/seam/connect/models/events/action-attempts.ts +++ b/src/lib/seam/connect/models/events/action-attempts.ts @@ -13,37 +13,45 @@ const action_attempt_event = common_event.extend({ status: z.string().describe('Status of the action.'), }) -export const action_attempt_lock_door_succeeded_event = action_attempt_event - .extend({ +export const action_attempt_lock_door_succeeded_event = + action_attempt_event.extend({ event_type: z.literal('action_attempt.lock_door.succeeded'), - }) - .describe( - 'A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.', - ) + }).describe(` + --- + route_path: /action_attempts + --- + A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded. + `) -export const action_attempt_lock_door_failed_event = action_attempt_event - .extend({ +export const action_attempt_lock_door_failed_event = + action_attempt_event.extend({ event_type: z.literal('action_attempt.lock_door.failed'), - }) - .describe( - 'A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.', - ) + }).describe(` + --- + route_path: /action_attempts + --- + A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed. + `) -export const action_attempt_unlock_door_succeeded_event = action_attempt_event - .extend({ +export const action_attempt_unlock_door_succeeded_event = + action_attempt_event.extend({ event_type: z.literal('action_attempt.unlock_door.succeeded'), - }) - .describe( - 'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.', - ) + }).describe(` + --- + route_path: /action_attempts + --- + An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded. + `) -export const action_attempt_unlock_door_failed_event = action_attempt_event - .extend({ +export const action_attempt_unlock_door_failed_event = + action_attempt_event.extend({ event_type: z.literal('action_attempt.unlock_door.failed'), - }) - .describe( - 'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.', - ) + }).describe(` + --- + route_path: /action_attempts + --- + An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed. + `) export const action_attempt_events = [ action_attempt_lock_door_succeeded_event, diff --git a/src/lib/seam/connect/models/events/client-sessions.ts b/src/lib/seam/connect/models/events/client-sessions.ts index 44d3970c..398fe738 100644 --- a/src/lib/seam/connect/models/events/client-sessions.ts +++ b/src/lib/seam/connect/models/events/client-sessions.ts @@ -11,13 +11,14 @@ const client_session_event = common_event.extend({ ), }) -export const client_session_deleted_event = client_session_event - .extend({ - event_type: z.literal('client_session.deleted'), - }) - .describe( - 'A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.', - ) +export const client_session_deleted_event = client_session_event.extend({ + event_type: z.literal('client_session.deleted'), +}).describe(` + --- + route_path: /client_sessions + --- + A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted. + `) export type ClientSessionDeletedEvent = z.infer< typeof client_session_deleted_event diff --git a/src/lib/seam/connect/models/events/connect-webviews.ts b/src/lib/seam/connect/models/events/connect-webviews.ts index c29f3954..a16ace4a 100644 --- a/src/lib/seam/connect/models/events/connect-webviews.ts +++ b/src/lib/seam/connect/models/events/connect-webviews.ts @@ -18,26 +18,29 @@ const connected_account_id = z 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', ) -export const connect_webview_login_succeeded_event = connect_webview_event - .extend({ +export const connect_webview_login_succeeded_event = + connect_webview_event.extend({ event_type: z.literal('connect_webview.login_succeeded'), connected_account_id, - }) - .describe( - 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.', - ) + }).describe(` + --- + route_path: /connect_webviews + --- + A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded. + `) export type ConnectWebviewLoginSucceededEvent = z.infer< typeof connect_webview_login_succeeded_event > -export const connect_webview_login_failed_event = connect_webview_event - .extend({ - event_type: z.literal('connect_webview.login_failed'), - }) - .describe( - 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.', - ) +export const connect_webview_login_failed_event = connect_webview_event.extend({ + event_type: z.literal('connect_webview.login_failed'), +}).describe(` + --- + route_path: /connect_webviews + --- + A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed. + `) export type ConnectWebviewLoginFailedEvent = z.infer< typeof connect_webview_login_failed_event diff --git a/src/lib/seam/connect/models/events/connected-accounts.ts b/src/lib/seam/connect/models/events/connected-accounts.ts index 5b1f970b..f2ff5aeb 100644 --- a/src/lib/seam/connect/models/events/connected-accounts.ts +++ b/src/lib/seam/connect/models/events/connected-accounts.ts @@ -18,27 +18,31 @@ const connect_webview_id = z 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).', ) -export const connected_account_connected_event = connected_account_event - .extend({ +export const connected_account_connected_event = connected_account_event.extend( + { event_type: z.literal('connected_account.connected'), connect_webview_id, - }) - .describe( - 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.', - ) + }, +).describe(` + --- + route_path: /connected_accounts + --- + A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected. +`) export type ConnectedAccountConnectedEvent = z.infer< typeof connected_account_connected_event > -export const connected_account_created_event = connected_account_event - .extend({ - event_type: z.literal('connected_account.created'), - connect_webview_id, - }) - .describe( - 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.', - ) +export const connected_account_created_event = connected_account_event.extend({ + event_type: z.literal('connected_account.created'), + connect_webview_id, +}).describe(` + --- + route_path: /connected_accounts + --- + A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created. +`) export type ConnectedAccountCreatedEvent = z.infer< typeof connected_account_created_event @@ -51,61 +55,68 @@ export const connected_account_successful_login_event = }).describe(` --- deprecated: Use \`connect_webview.login_succeeded\`. + route_path: /connected_accounts --- - A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).`) + A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). + `) /** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */ export type ConnectedAccountSuccessfulLoginEvent = z.infer< typeof connected_account_successful_login_event > -export const connected_account_disconnected_event = connected_account_event - .extend({ +export const connected_account_disconnected_event = + connected_account_event.extend({ event_type: z.literal('connected_account.disconnected'), - }) - .describe( - 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.', - ) + }).describe(` + --- + route_path: /connected_accounts + --- + A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected. + `) export type ConnectedAccountDisconnectedEvent = z.infer< typeof connected_account_disconnected_event > export const connected_account_completed_first_sync_event = - connected_account_event - .extend({ - event_type: z.literal('connected_account.completed_first_sync'), - }) - .describe( - 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available.', - ) + connected_account_event.extend({ + event_type: z.literal('connected_account.completed_first_sync'), + }).describe(` + --- + route_path: /connected_accounts + --- + A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync with Seam, and the corresponding devices or systems are now available. + `) export type ConnectedAccountCompletedFirstSyncEvent = z.infer< typeof connected_account_completed_first_sync_event > -export const connected_account_deleted_event = connected_account_event - .extend({ - event_type: z.literal('connected_account.deleted'), - }) - .describe( - 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.', - ) +export const connected_account_deleted_event = connected_account_event.extend({ + event_type: z.literal('connected_account.deleted'), +}).describe(` + --- + route_path: /connected_accounts + --- + A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted. +`) export type ConnectedAccountDeletedEvent = z.infer< typeof connected_account_deleted_event > export const connected_account_completed_first_sync_after_reconnection_event = - connected_account_event - .extend({ - event_type: z.literal( - 'connected_account.completed_first_sync_after_reconnection', - ), - }) - .describe( - 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.', - ) + connected_account_event.extend({ + event_type: z.literal( + 'connected_account.completed_first_sync_after_reconnection', + ), + }).describe(` + --- + route_path: /connected_accounts + --- + A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available. + `) export type ConnectedAccountCompletedFirstSyncAfterReconnectionEvent = z.infer< typeof connected_account_completed_first_sync_after_reconnection_event diff --git a/src/lib/seam/connect/models/events/devices.ts b/src/lib/seam/connect/models/events/devices.ts index ceb50e1a..82b82c20 100644 --- a/src/lib/seam/connect/models/events/devices.ts +++ b/src/lib/seam/connect/models/events/devices.ts @@ -38,266 +38,288 @@ export const lock_method = z ) export type LockMethod = z.infer -export const device_connected_event = device_event - .extend({ - event_type: z.literal('device.connected'), - }) - .describe( - 'The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.', - ) +export const device_connected_event = device_event.extend({ + event_type: z.literal('device.connected'), +}).describe(` + --- + route_path: /devices + --- + The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices. +`) export type DeviceConnectedEvent = z.infer -export const device_added_event = device_event - .extend({ - event_type: z.literal('device.added'), - }) - .describe( - 'A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.', - ) +export const device_added_event = device_event.extend({ + event_type: z.literal('device.added'), +}).describe(` + --- + route_path: /devices + --- + A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed. +`) export type DeviceAddedEvent = z.infer -export const device_converted_to_unmanaged_event = device_event - .extend({ - event_type: z.literal('device.converted_to_unmanaged'), - }) - .describe( - 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.', - ) +export const device_converted_to_unmanaged_event = device_event.extend({ + event_type: z.literal('device.converted_to_unmanaged'), +}).describe(` + --- + route_path: /devices + --- + A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). +`) export type DeviceConvertedToUnmanagedEvent = z.infer< typeof device_converted_to_unmanaged_event > -export const unmanaged_device_converted_to_managed_event = device_event - .extend({ - event_type: z.literal('device.unmanaged.converted_to_managed'), - }) - .describe( - 'A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).', - ) +export const unmanaged_device_converted_to_managed_event = device_event.extend({ + event_type: z.literal('device.unmanaged.converted_to_managed'), +}).describe(` + --- + route_path: /devices/unmanaged + --- + An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device. +`) export type UnmanagedDeviceConvertedToManagedEvent = z.infer< typeof unmanaged_device_converted_to_managed_event > -export const unmanaged_device_connected_event = device_event - .extend({ - event_type: z.literal('device.unmanaged.connected'), - }) - .describe( - 'The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`.', - ) +export const unmanaged_device_connected_event = device_event.extend({ + event_type: z.literal('device.unmanaged.connected'), +}).describe(` + --- + route_path: /devices/unmanaged + --- + The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. +`) export type UnmanagedDeviceConnectedEvent = z.infer< typeof unmanaged_device_connected_event > -export const device_disconnected_event = device_event - .extend({ - event_type: z.literal('device.disconnected'), - error_code: disconnection_error_code, - }) - .describe( - 'The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.', - ) +export const device_disconnected_event = device_event.extend({ + event_type: z.literal('device.disconnected'), + error_code: disconnection_error_code, +}).describe(` + --- + route_path: /devices + --- + The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`. +`) export type DeviceDisconnectedEvent = z.infer -export const unmanaged_device_disconnected_event = device_event - .extend({ - event_type: z.literal('device.unmanaged.disconnected'), - error_code: disconnection_error_code, - }) - .describe( - 'The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.', - ) +export const unmanaged_device_disconnected_event = device_event.extend({ + event_type: z.literal('device.unmanaged.disconnected'), + error_code: disconnection_error_code, +}).describe(` + --- + route_path: /devices/unmanaged + --- + The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`. +`) export type UnmanagedDeviceDisconnectedEvent = z.infer< typeof unmanaged_device_disconnected_event > -export const device_tampered_event = device_event - .extend({ - event_type: z.literal('device.tampered'), - }) - .describe( - 'A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.', - ) +export const device_tampered_event = device_event.extend({ + event_type: z.literal('device.tampered'), +}).describe(` + --- + route_path: /devices + --- + A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved. +`) export type DeviceTamperedEvent = z.infer -export const device_low_battery_event = device_event - .extend({ - event_type: z.literal('device.low_battery'), - battery_level, - }) - .describe( - 'A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.', - ) +export const device_low_battery_event = device_event.extend({ + event_type: z.literal('device.low_battery'), + battery_level, +}).describe(` + --- + route_path: /devices + --- + A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold. +`) export type DeviceLowBatteryEvent = z.infer -export const device_battery_status_changed_event = device_event - .extend({ - event_type: z.literal('device.battery_status_changed'), - battery_status: device_battery_status, - battery_level, - }) - .describe( - 'A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.', - ) +export const device_battery_status_changed_event = device_event.extend({ + event_type: z.literal('device.battery_status_changed'), + battery_status: device_battery_status, + battery_level, +}).describe(` + --- + route_path: /devices + --- + A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last \`battery_status_changed\` event. +`) export type DeviceBatteryStatusChangedEvent = z.infer< typeof device_battery_status_changed_event > -export const device_removed_event = device_event - .extend({ - event_type: z.literal('device.removed'), - }) - .describe( - 'A [device](https://docs.seam.co/latest/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).', - ) +export const device_removed_event = device_event.extend({ + event_type: z.literal('device.removed'), +}).describe(` + --- + route_path: /devices + --- + A [device](https://docs.seam.co/latest/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). +`) export type DeviceRemovedEvent = z.infer -export const device_deleted_event = device_event - .extend({ - event_type: z.literal('device.deleted'), - }) - .describe( - 'A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.', - ) +export const device_deleted_event = device_event.extend({ + event_type: z.literal('device.deleted'), +}).describe(` + --- + route_path: /devices + --- + A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted. +`) export type DeviceDeletedEvent = z.infer -export const device_third_party_integration_detected_event = device_event - .extend({ +export const device_third_party_integration_detected_event = + device_event.extend({ event_type: z.literal('device.third_party_integration_detected'), - }) - .describe( - 'Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is using a third-party integration that will interfere with Seam device management.', - ) + }).describe(` + --- + route_path: /devices + --- + Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is using a third-party integration that will interfere with Seam device management. + `) export type DeviceThirdPartyIntegrationDetectedEvent = z.infer< typeof device_third_party_integration_detected_event > export const device_third_party_integration_no_longer_detected_event = - device_event - .extend({ - event_type: z.literal( - 'device.third_party_integration_no_longer_detected', - ), - }) - .describe( - 'Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management.', - ) + device_event.extend({ + event_type: z.literal('device.third_party_integration_no_longer_detected'), + }).describe(` + --- + route_path: /devices + --- + Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management. + `) export type DeviceThirdPartyIntegrationNoLongerDetectedEvent = z.infer< typeof device_third_party_integration_no_longer_detected_event > -export const device_salto_privacy_mode_activated_event = device_event - .extend({ - event_type: z.literal('device.salto.privacy_mode_activated'), - }) - .describe( - 'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.', - ) +export const device_salto_privacy_mode_activated_event = device_event.extend({ + event_type: z.literal('device.salto.privacy_mode_activated'), +}).describe(` + --- + route_path: /devices + --- + A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode. +`) export type DeviceSaltoPrivacyModeActivatedEvent = z.infer< typeof device_salto_privacy_mode_activated_event > -export const device_salto_privacy_mode_deactivated_event = device_event - .extend({ - event_type: z.literal('device.salto.privacy_mode_deactivated'), - }) - .describe( - 'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.', - ) +export const device_salto_privacy_mode_deactivated_event = device_event.extend({ + event_type: z.literal('device.salto.privacy_mode_deactivated'), +}).describe(` + --- + route_path: /devices + --- + A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode. +`) export type DeviceSaltoPrivacyModeDeactivatedEvent = z.infer< typeof device_salto_privacy_mode_deactivated_event > -export const device_connection_became_flaky_event = device_event - .extend({ - event_type: z.literal('device.connection_became_flaky'), - }) - .describe( - 'Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.', - ) +export const device_connection_became_flaky_event = device_event.extend({ + event_type: z.literal('device.connection_became_flaky'), +}).describe(` + --- + route_path: /devices + --- + Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection. +`) export type DeviceConnectionBecameFlakyEvent = z.infer< typeof device_connection_became_flaky_event > -export const device_connection_stabilized_event = device_event - .extend({ - event_type: z.literal('device.connection_stabilized'), - }) - .describe( - 'Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.', - ) +export const device_connection_stabilized_event = device_event.extend({ + event_type: z.literal('device.connection_stabilized'), +}).describe(` + --- + route_path: /devices + --- + Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized. +`) export type DeviceConnectionStabilizedEvent = z.infer< typeof device_connection_stabilized_event > -export const device_error_subscription_required_event = device_event - .extend({ - event_type: z.literal('device.error.subscription_required'), - }) - .describe( - 'A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.', - ) +export const device_error_subscription_required_event = device_event.extend({ + event_type: z.literal('device.error.subscription_required'), +}).describe(` + --- + route_path: /devices + --- + A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features. +`) export type DeviceErrorSubscriptionRequiredEvent = z.infer< typeof device_error_subscription_required_event > -export const device_error_subscription_required_resolved_event = device_event - .extend({ +export const device_error_subscription_required_resolved_event = + device_event.extend({ event_type: z.literal('device.error.subscription_required.resolved'), - }) - .describe( - 'A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.', - ) + }).describe(` + --- + route_path: /devices + --- + A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features. + `) export type DeviceErrorSubscriptionRequiredResolvedEvent = z.infer< typeof device_error_subscription_required_resolved_event > -export const device_accessory_keypad_connected_event = device_event - .extend({ - event_type: z.literal('device.accessory_keypad_connected'), - }) - .describe( - 'An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).', - ) +export const device_accessory_keypad_connected_event = device_event.extend({ + event_type: z.literal('device.accessory_keypad_connected'), +}).describe(` + --- + route_path: /devices + --- + An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices). +`) export type DeviceAccessoryKeypadConnectedEvent = z.infer< typeof device_accessory_keypad_connected_event > -export const device_accessory_keypad_disconnected_event = device_event - .extend({ - event_type: z.literal('device.accessory_keypad_disconnected'), - }) - .describe( - 'An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).', - ) +export const device_accessory_keypad_disconnected_event = device_event.extend({ + event_type: z.literal('device.accessory_keypad_disconnected'), +}).describe(` + --- + route_path: /devices + --- + An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices). +`) export type DeviceAccessoryKeypadDisconnectedEvent = z.infer< typeof device_accessory_keypad_disconnected_event > -export const noise_sensor_noise_threshold_triggered_event = device_event - .extend({ +export const noise_sensor_noise_threshold_triggered_event = device_event.extend( + { event_type: z.literal('noise_sensor.noise_threshold_triggered'), noise_level_decibels: z .number() @@ -329,110 +351,117 @@ export const noise_sensor_noise_threshold_triggered_event = device_event .record(z.unknown()) .optional() .describe('Metadata from Minut.'), - }) - .describe( - 'Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.', - ) + }, +).describe(` + --- + route_path: /noise_sensors/noise_thresholds + --- + Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected. + `) export type NoiseSensorNoiseThresholdTriggeredEvent = z.infer< typeof noise_sensor_noise_threshold_triggered_event > -export const lock_locked_event = device_event - .extend({ - event_type: z.literal('lock.locked'), - access_code_id: z - .string() - .uuid() - .optional() - .describe( - 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.', - ), - action_attempt_id: z - .string() - .uuid() - .optional() - .describe( - 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.', - ), - method: lock_method.describe( - 'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) 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.', +export const lock_locked_event = device_event.extend({ + event_type: z.literal('lock.locked'), + access_code_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.', ), - }) - .describe( - 'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.', - ) + action_attempt_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.', + ), + method: lock_method.describe( + 'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) 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.', + ), +}).describe(` + --- + route_path: /locks + --- + A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked. +`) export type LockLockedEvent = z.infer -export const lock_unlocked_event = device_event - .extend({ - event_type: z.literal('lock.unlocked'), - access_code_id: z - .string() - .uuid() - .optional() - .describe( - 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.', - ), - action_attempt_id: z - .string() - .uuid() - .optional() - .describe( - 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.', - ), - method: lock_method.describe( - 'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) 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.', +export const lock_unlocked_event = device_event.extend({ + event_type: z.literal('lock.unlocked'), + access_code_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.', ), - }) - .describe( - 'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.', - ) + action_attempt_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.', + ), + method: lock_method.describe( + 'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) 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.', + ), +}).describe(` + --- + route_path: /locks + --- + A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked. +`) export type LockUnlockedEvent = z.infer -export const lock_access_denied_event = device_event - .extend({ - event_type: z.literal('lock.access_denied'), - access_code_id: z - .string() - .uuid() - .optional() - .describe( - 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.', - ), - }) - .describe( - 'The [lock](https://docs.seam.co/latest/capability-guides/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device.', - ) +export const lock_access_denied_event = device_event.extend({ + event_type: z.literal('lock.access_denied'), + access_code_id: z + .string() + .uuid() + .optional() + .describe( + 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.', + ), +}).describe(` + --- + route_path: /locks + --- + The [lock](https://docs.seam.co/latest/capability-guides/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device. +`) export type LockAccessDeniedEvent = z.infer -export const thermostat_climate_preset_activated_event = device_event - .extend({ - event_type: z.literal('thermostat.climate_preset_activated'), - thermostat_schedule_id: z - .string() - .uuid() - .nullable() - .describe( - '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.', - ), - climate_preset_key: z - .string() - .describe( - 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.', - ), - is_fallback_climate_preset: z - .boolean() - .describe( - '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](https://docs.seam.co/latest/capability-guides/thermostats).', - ), - }) - .describe( - 'A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.', - ) +export const thermostat_climate_preset_activated_event = device_event.extend({ + event_type: z.literal('thermostat.climate_preset_activated'), + thermostat_schedule_id: z + .string() + .uuid() + .nullable() + .describe( + '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.', + ), + climate_preset_key: z + .string() + .describe( + 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.', + ), + is_fallback_climate_preset: z + .boolean() + .describe( + '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](https://docs.seam.co/latest/capability-guides/thermostats).', + ), +}).describe(` + --- + route_path: /thermostats + --- + A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated. +`) export type ThermostatClimatePresetActivatedEvent = z.infer< typeof thermostat_climate_preset_activated_event @@ -458,63 +487,66 @@ export const thermostat_manually_adjusted_event = device_event cooling_set_point_fahrenheit: true, heating_set_point_fahrenheit: true, }), - ) - .describe( - 'A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.', - ) + ).describe(` + --- + route_path: /thermostats + --- + A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually. + `) export type ThermostatManuallyAdjustedEvent = z.infer< typeof thermostat_manually_adjusted_event > -export const temperature_threshold_exceeded_event = device_event - .extend({ - event_type: z.literal('thermostat.temperature_threshold_exceeded'), - temperature_celsius: z - .number() - .describe( - 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).', - ), - temperature_fahrenheit: z - .number() - .describe( - 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).', - ), - upper_limit_celsius: z - .number() - .nullable() - .describe( - 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', - ), - upper_limit_fahrenheit: z - .number() - .nullable() - .describe( - 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', - ), - lower_limit_celsius: z - .number() - .nullable() - .describe( - 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', - ), - lower_limit_fahrenheit: z - .number() - .nullable() - .describe( - 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', - ), - }) - .describe( - "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", - ) +export const temperature_threshold_exceeded_event = device_event.extend({ + event_type: z.literal('thermostat.temperature_threshold_exceeded'), + temperature_celsius: z + .number() + .describe( + 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).', + ), + temperature_fahrenheit: z + .number() + .describe( + 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).', + ), + upper_limit_celsius: z + .number() + .nullable() + .describe( + 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + ), + upper_limit_fahrenheit: z + .number() + .nullable() + .describe( + 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + ), + lower_limit_celsius: z + .number() + .nullable() + .describe( + 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + ), + lower_limit_fahrenheit: z + .number() + .nullable() + .describe( + 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', + ), +}).describe(` + --- + route_path: /thermostats + --- + A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). +`) export type TemperatureThresholdExceededEvent = z.infer< typeof temperature_threshold_exceeded_event > -export const temperature_threshold_no_longer_exceeded_event = device_event - .extend({ +export const temperature_threshold_no_longer_exceeded_event = + device_event.extend({ event_type: z.literal( 'thermostat.temperature_threshold_no_longer_exceeded', ), @@ -552,10 +584,12 @@ export const temperature_threshold_no_longer_exceeded_event = device_event .describe( 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).', ), - }) - .describe( - "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).", - ) + }).describe(` + --- + route_path: /thermostats + --- + A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds). + `) export type TemperatureThresholdNoLongerExceededEvent = z.infer< typeof temperature_threshold_no_longer_exceeded_event @@ -581,7 +615,11 @@ export const temperature_reached_set_point_event = device_event.extend({ .describe( "Desired temperature, in °F, set by the thermostat's cooling or heating set point.", ), -}) +}).describe(` + --- + route_path: /thermostats + --- +`) export type TemperatureReachedSetPointEvent = z.infer< typeof temperature_reached_set_point_event diff --git a/src/lib/seam/connect/models/events/enrollment-automations.ts b/src/lib/seam/connect/models/events/enrollment-automations.ts index c85be3d8..c5315581 100644 --- a/src/lib/seam/connect/models/events/enrollment-automations.ts +++ b/src/lib/seam/connect/models/events/enrollment-automations.ts @@ -11,13 +11,15 @@ const enrollment_automation_event = common_event.extend({ ), }) -export const enrollment_automation_deleted_event = enrollment_automation_event - .extend({ +export const enrollment_automation_deleted_event = + enrollment_automation_event.extend({ event_type: z.literal('enrollment_automation.deleted'), - }) - .describe( - 'An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.', - ) + }).describe(` + --- + route_path: /user_identities/enrollment_automations + --- + An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted. + `) export type EnrollmentAutomationDeletedEvent = z.infer< typeof enrollment_automation_deleted_event diff --git a/src/lib/seam/connect/models/events/phones.ts b/src/lib/seam/connect/models/events/phones.ts index fbbce0bd..26ec449e 100644 --- a/src/lib/seam/connect/models/events/phones.ts +++ b/src/lib/seam/connect/models/events/phones.ts @@ -11,11 +11,14 @@ const phone_event = common_event.extend({ ), }) -export const phone_deactivated_event = phone_event - .extend({ - event_type: z.literal('phone.deactivated'), - }) - .describe('A phone device was deactivated.') +export const phone_deactivated_event = phone_event.extend({ + event_type: z.literal('phone.deactivated'), +}).describe(` + --- + route_path: /phones + --- + A phone device was deactivated. + `) export type PhoneDeactivatedEvent = z.infer diff --git a/src/lib/seam/connect/models/events/seam-event.ts b/src/lib/seam/connect/models/events/seam-event.ts index 573dfd36..032313dd 100644 --- a/src/lib/seam/connect/models/events/seam-event.ts +++ b/src/lib/seam/connect/models/events/seam-event.ts @@ -20,7 +20,11 @@ export const seam_event = z.discriminatedUnion('event_type', [ ...device_events, ...enrollment_automation_events, ...phone_events, -]) +]).describe(` + --- + route_path: /events + --- +`) export type SeamEvent = z.infer diff --git a/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts b/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts index e30081bc..d05ed18f 100644 --- a/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +++ b/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts @@ -8,6 +8,10 @@ export const noise_threshold = z.object({ starts_daily_at: z.string(), // TODO: zoned_time ends_daily_at: z.string(), // TODO: zoned_time noise_threshold_decibels: z.number(), -}) +}).describe(` + --- + route_path: /noise_sensors/noise_thresholds + --- +`) export type NoiseThreshold = z.infer diff --git a/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts b/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts index b5d67348..f86d6342 100644 --- a/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +++ b/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts @@ -1,70 +1,68 @@ import { z } from 'zod' -export const thermostat_schedule = z - .object({ - thermostat_schedule_id: z - .string() - .uuid() - .describe('ID of the thermostat schedule.'), - device_id: z - .string() - .uuid() - .describe('ID of the desired thermostat device.'), - name: z - .string() - .optional() - .describe('User-friendly name to identify the thermostat schedule.'), - climate_preset_key: z - .string() - .describe( - 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.', - ), - max_override_period_minutes: z - .number() - .int() - .nonnegative() - .describe( - "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).", - ), - starts_at: z - .string() - .datetime() - .describe( - 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', - ), - unstable_is_override_allowed: z - .boolean() - .optional() - .describe( - ` +export const thermostat_schedule = z.object({ + thermostat_schedule_id: z + .string() + .uuid() + .describe('ID of the thermostat schedule.'), + device_id: z.string().uuid().describe('ID of the desired thermostat device.'), + name: z + .string() + .optional() + .describe('User-friendly name to identify the thermostat schedule.'), + climate_preset_key: z + .string() + .describe( + 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.', + ), + max_override_period_minutes: z + .number() + .int() + .nonnegative() + .describe( + "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).", + ), + starts_at: z + .string() + .datetime() + .describe( + 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + ), + unstable_is_override_allowed: z + .boolean() + .optional() + .describe( + ` --- undocumented: Unstable --- Indicates whether a person at the thermostat can change the thermostat's settings.`, - ), - ends_at: z - .string() - .datetime() - .describe( - 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', - ), - created_at: z - .string() - .datetime() - .describe('Date and time at which the thermostat schedule was created.'), - errors: z - .array( - z.object({ - error_code: z.string(), - message: z.string(), - }), - ) - .describe( - 'Array of errors associated with the thermostat schedule. 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.', - ), - }) - .describe( - '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.', - ) + ), + ends_at: z + .string() + .datetime() + .describe( + 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + ), + created_at: z + .string() + .datetime() + .describe('Date and time at which the thermostat schedule was created.'), + errors: z + .array( + z.object({ + error_code: z.string(), + message: z.string(), + }), + ) + .describe( + 'Array of errors associated with the thermostat schedule. 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.', + ), +}).describe(` + --- + route_path: /thermostats/schedules + --- + 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. +`) export type ThermostatSchedule = z.infer diff --git a/src/lib/seam/connect/models/user-identities/user-identity.ts b/src/lib/seam/connect/models/user-identities/user-identity.ts index a9222f89..dc3641a3 100644 --- a/src/lib/seam/connect/models/user-identities/user-identity.ts +++ b/src/lib/seam/connect/models/user-identities/user-identity.ts @@ -2,39 +2,40 @@ import { z } from 'zod' import { phone_number } from '../phone-number.js' -export const user_identity = z - .object({ - user_identity_id: z.string().uuid().describe('ID of the user identity.'), - user_identity_key: z - .string() - .min(1) - .nullable() - .describe('Unique key for the user identity.'), - email_address: z - .string() - .email() - .nullable() - .describe('Unique email address for the user identity.'), - phone_number: phone_number - .nullable() - .describe( - 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).', - ), - display_name: z.string().min(1), - full_name: z.string().min(1).nullable(), - created_at: z - .string() - .datetime() - .describe('Date and time at which the user identity was created.'), - workspace_id: z - .string() - .uuid() - .describe( - 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.', - ), - }) - .describe( - 'Represents a [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) associated with an application user account.', - ) +export const user_identity = z.object({ + user_identity_id: z.string().uuid().describe('ID of the user identity.'), + user_identity_key: z + .string() + .min(1) + .nullable() + .describe('Unique key for the user identity.'), + email_address: z + .string() + .email() + .nullable() + .describe('Unique email address for the user identity.'), + phone_number: phone_number + .nullable() + .describe( + 'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).', + ), + display_name: z.string().min(1), + full_name: z.string().min(1).nullable(), + created_at: z + .string() + .datetime() + .describe('Date and time at which the user identity was created.'), + workspace_id: z + .string() + .uuid() + .describe( + 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.', + ), +}).describe(` + --- + route_path: /user_identities + --- + Represents a [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) associated with an application user account. +`) export type UserIdentity = z.output diff --git a/src/lib/seam/connect/models/webhooks/webhook.ts b/src/lib/seam/connect/models/webhooks/webhook.ts index b26ebb55..09f1db94 100644 --- a/src/lib/seam/connect/models/webhooks/webhook.ts +++ b/src/lib/seam/connect/models/webhooks/webhook.ts @@ -5,6 +5,10 @@ export const webhook = z.object({ url: z.string(), event_types: z.array(z.string()).optional(), secret: z.string().optional(), -}) +}).describe(` + --- + route_path: /webhooks + --- +`) export type Webhook = z.infer diff --git a/src/lib/seam/connect/models/workspaces/workspace.ts b/src/lib/seam/connect/models/workspaces/workspace.ts index 7f29c087..a592e67a 100644 --- a/src/lib/seam/connect/models/workspaces/workspace.ts +++ b/src/lib/seam/connect/models/workspaces/workspace.ts @@ -16,6 +16,10 @@ export const workspace = z.object({ `, ) .nullable(), -}) +}).describe(` + --- + route_path: /workspaces + --- +`) export type Workspace = z.infer diff --git a/src/lib/seam/connect/openapi.ts b/src/lib/seam/connect/openapi.ts index 10683ae8..e74bfa84 100644 --- a/src/lib/seam/connect/openapi.ts +++ b/src/lib/seam/connect/openapi.ts @@ -376,6 +376,7 @@ export default { 'is_offline_access_code', ], type: 'object', + 'x-route-path': '/access_codes', }, acs_access_group: { description: @@ -486,6 +487,7 @@ export default { 'is_managed', ], type: 'object', + 'x-route-path': '/acs/access_groups', }, acs_credential: { description: @@ -799,6 +801,7 @@ export default { 'workspace_id', ], type: 'object', + 'x-route-path': '/acs/credential_pools', }, acs_credential_provisioning_automation: { properties: { @@ -819,6 +822,7 @@ export default { 'workspace_id', ], type: 'object', + 'x-route-path': '/acs/credential_provisioning_automations', }, acs_entrance: { description: @@ -859,10 +863,7 @@ export default { type: 'string', }, dormakaba_community_metadata: { - properties: { - access_point_name: { type: 'string' }, - common_area_number: { format: 'float', type: 'number' }, - }, + properties: { access_point_name: { type: 'string' } }, required: ['access_point_name'], type: 'object', }, @@ -963,6 +964,7 @@ export default { 'errors', ], type: 'object', + 'x-route-path': '/acs/entrances', }, acs_system: { description: @@ -1354,6 +1356,7 @@ export default { 'warnings', ], type: 'object', + 'x-route-path': '/acs/systems', }, acs_user: { description: @@ -1654,6 +1657,7 @@ export default { 'is_managed', ], type: 'object', + 'x-route-path': '/acs/users', }, action_attempt: { oneOf: [ @@ -4302,6 +4306,7 @@ export default { type: 'object', }, ], + 'x-route-path': '/action_attempts', }, client_session: { properties: { @@ -4338,6 +4343,7 @@ export default { 'user_identity_ids', ], type: 'object', + 'x-route-path': '/client_sessions', }, connect_webview: { properties: { @@ -4416,6 +4422,7 @@ export default { 'selected_provider', ], type: 'object', + 'x-route-path': '/connect_webviews', }, connected_account: { properties: { @@ -4492,6 +4499,7 @@ export default { 'automatically_manage_new_devices', ], type: 'object', + 'x-route-path': '/connected_accounts', }, device: { properties: { @@ -5753,6 +5761,7 @@ export default { 'errors', ], type: 'object', + 'x-route-path': '/thermostats/schedules', }, available_climate_presets: { items: { @@ -6150,6 +6159,7 @@ export default { 'custom_metadata', ], type: 'object', + 'x-route-path': '/devices', }, device_provider: { properties: { @@ -6237,6 +6247,7 @@ export default { 'provider_categories', ], type: 'object', + 'x-route-path': '/devices', }, enrollment_automation: { description: @@ -6280,6 +6291,7 @@ export default { 'workspace_id', ], type: 'object', + 'x-route-path': '/user_identities/enrollment_automations', }, event: { discriminator: { propertyName: 'event_type' }, @@ -6340,6 +6352,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6397,6 +6410,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6463,6 +6477,7 @@ export default { 'code', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6529,6 +6544,7 @@ export default { 'code', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6589,6 +6605,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6649,6 +6666,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6709,6 +6727,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6773,6 +6792,7 @@ export default { 'code', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6833,6 +6853,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6893,6 +6914,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -6953,6 +6975,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -7013,6 +7036,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -7075,6 +7099,7 @@ export default { 'backup_access_code_id', ], type: 'object', + 'x-route-path': '/access_codes', }, { description: @@ -7135,6 +7160,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes/unmanaged', }, { description: @@ -7195,6 +7221,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes/unmanaged', }, { description: @@ -7255,6 +7282,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes/unmanaged', }, { description: @@ -7315,6 +7343,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/access_codes/unmanaged', }, { description: @@ -7364,6 +7393,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/systems', }, { description: @@ -7413,6 +7443,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/systems', }, { description: @@ -7462,6 +7493,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/systems', }, { description: @@ -7513,6 +7545,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/credentials', }, { description: @@ -7564,6 +7597,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/credentials', }, { description: @@ -7615,6 +7649,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/users', }, { description: @@ -7671,6 +7706,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/encoders', }, { description: @@ -7727,6 +7763,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/encoders', }, { description: 'An ACS access group was deleted.', @@ -7780,6 +7817,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/acs/access_groups', }, { description: @@ -7823,6 +7861,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/client_sessions', }, { description: @@ -7876,6 +7915,7 @@ export default { 'connect_webview_id', ], type: 'object', + 'x-route-path': '/connected_accounts', }, { description: @@ -7929,6 +7969,7 @@ export default { 'connect_webview_id', ], type: 'object', + 'x-route-path': '/connected_accounts', }, { deprecated: true, @@ -7984,6 +8025,7 @@ export default { ], type: 'object', 'x-deprecated': 'Use `connect_webview.login_succeeded`.', + 'x-route-path': '/connected_accounts', }, { description: @@ -8030,6 +8072,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/connected_accounts', }, { description: @@ -8076,6 +8119,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/connected_accounts', }, { description: @@ -8122,6 +8166,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/connected_accounts', }, { description: @@ -8170,6 +8215,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/connected_accounts', }, { description: @@ -8220,6 +8266,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/action_attempts', }, { description: @@ -8270,6 +8317,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/action_attempts', }, { description: @@ -8320,6 +8368,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/action_attempts', }, { description: @@ -8370,6 +8419,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/action_attempts', }, { description: @@ -8423,6 +8473,7 @@ export default { 'connected_account_id', ], type: 'object', + 'x-route-path': '/connect_webviews', }, { description: @@ -8469,6 +8520,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/connect_webviews', }, { description: @@ -8518,6 +8570,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -8567,10 +8620,11 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: - 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.', + 'A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).', properties: { connected_account_id: { description: @@ -8619,10 +8673,11 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: - 'A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).', + 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.', properties: { connected_account_id: { description: @@ -8671,6 +8726,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices/unmanaged', }, { description: @@ -8723,6 +8779,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices/unmanaged', }, { description: @@ -8783,6 +8840,7 @@ export default { 'error_code', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -8846,6 +8904,7 @@ export default { 'error_code', ], type: 'object', + 'x-route-path': '/devices/unmanaged', }, { description: @@ -8895,6 +8954,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -8953,6 +9013,7 @@ export default { 'battery_level', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9021,6 +9082,7 @@ export default { 'battery_level', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9070,6 +9132,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9119,6 +9182,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9171,6 +9235,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9223,6 +9288,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9275,6 +9341,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9327,6 +9394,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9379,6 +9447,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9431,6 +9500,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9483,6 +9553,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9535,6 +9606,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9587,6 +9659,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9639,6 +9712,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/devices', }, { description: @@ -9723,6 +9797,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/noise_sensors/noise_thresholds', }, { description: @@ -9791,6 +9866,7 @@ export default { 'method', ], type: 'object', + 'x-route-path': '/locks', }, { description: @@ -9859,6 +9935,7 @@ export default { 'method', ], type: 'object', + 'x-route-path': '/locks', }, { description: @@ -9914,6 +9991,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/locks', }, { description: @@ -9986,6 +10064,7 @@ export default { 'is_fallback_climate_preset', ], type: 'object', + 'x-route-path': '/thermostats', }, { description: @@ -10081,6 +10160,7 @@ export default { 'method', ], type: 'object', + 'x-route-path': '/thermostats', }, { description: @@ -10179,6 +10259,7 @@ export default { 'lower_limit_fahrenheit', ], type: 'object', + 'x-route-path': '/thermostats', }, { description: @@ -10277,6 +10358,7 @@ export default { 'lower_limit_fahrenheit', ], type: 'object', + 'x-route-path': '/thermostats', }, { properties: { @@ -10351,6 +10433,7 @@ export default { 'temperature_fahrenheit', ], type: 'object', + 'x-route-path': '/thermostats', }, { description: @@ -10397,6 +10480,7 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/user_identities/enrollment_automations', }, { description: 'A phone device was deactivated.', @@ -10439,8 +10523,10 @@ export default { 'event_type', ], type: 'object', + 'x-route-path': '/phones', }, ], + 'x-route-path': '/events', }, network: { properties: { @@ -10451,6 +10537,7 @@ export default { }, required: ['network_id', 'workspace_id', 'display_name', 'created_at'], type: 'object', + 'x-route-path': '/networks', }, noise_threshold: { properties: { @@ -10471,6 +10558,7 @@ export default { 'noise_threshold_decibels', ], type: 'object', + 'x-route-path': '/noise_sensors/noise_thresholds', }, phone: { properties: { @@ -10833,6 +10921,7 @@ export default { 'custom_metadata', ], type: 'object', + 'x-route-path': '/phones', }, service_health: { properties: { @@ -10842,6 +10931,7 @@ export default { }, required: ['service', 'status', 'description'], type: 'object', + 'x-route-path': '/health', }, thermostat_schedule: { description: @@ -10922,6 +11012,7 @@ export default { 'errors', ], type: 'object', + 'x-route-path': '/thermostats/schedules', }, unmanaged_access_code: { properties: { @@ -11237,6 +11328,7 @@ export default { 'status', ], type: 'object', + 'x-route-path': '/access_codes/unmanaged', }, unmanaged_device: { properties: { @@ -11742,6 +11834,7 @@ export default { 'properties', ], type: 'object', + 'x-route-path': '/devices/unmanaged', }, user_identity: { description: @@ -11796,6 +11889,7 @@ export default { 'workspace_id', ], type: 'object', + 'x-route-path': '/user_identities', }, webhook: { properties: { @@ -11806,6 +11900,7 @@ export default { }, required: ['webhook_id', 'url'], type: 'object', + 'x-route-path': '/webhooks', }, workspace: { properties: { @@ -11828,6 +11923,7 @@ export default { 'connect_partner_name', ], type: 'object', + 'x-route-path': '/workspaces', }, }, securitySchemes: { diff --git a/src/lib/seam/connect/route-types.ts b/src/lib/seam/connect/route-types.ts index 1239cd22..629b8e6b 100644 --- a/src/lib/seam/connect/route-types.ts +++ b/src/lib/seam/connect/route-types.ts @@ -25,6 +25,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -960,6 +961,7 @@ export interface Routes { message: string } } + /** */ access_code: { /** Unique identifier for a group of access codes that share the same code. */ common_code_key: string | null @@ -1281,6 +1283,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -2246,6 +2249,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ access_code: { /** Unique identifier for a group of access codes that share the same code. */ common_code_key: string | null @@ -2552,6 +2556,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ backup_access_code: { /** Unique identifier for a group of access codes that share the same code. */ common_code_key: string | null @@ -2692,6 +2697,7 @@ export interface Routes { /** 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. */ is_offline_access_code: boolean } + /** */ access_code: { /** Unique identifier for a group of access codes that share the same code. */ common_code_key: string | null @@ -2846,6 +2852,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ access_code: { /** 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. */ type: 'time_bound' | 'ongoing' @@ -2992,6 +2999,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -3941,6 +3949,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ access_code: { /** 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. */ type: 'time_bound' | 'ongoing' @@ -4235,6 +4244,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -5384,7 +5394,6 @@ export interface Routes { dormakaba_community_metadata?: | { access_point_name: string - common_area_number?: number | undefined } | undefined assa_abloy_vostio_metadata?: @@ -5704,6 +5713,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ acs_credential_provisioning_automation: { acs_credential_provisioning_automation_id: string credential_manager_acs_system_id: string @@ -6512,7 +6522,6 @@ export interface Routes { dormakaba_community_metadata?: | { access_point_name: string - common_area_number?: number | undefined } | undefined assa_abloy_vostio_metadata?: @@ -7086,6 +7095,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -8083,6 +8093,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -9172,7 +9183,6 @@ export interface Routes { dormakaba_community_metadata?: | { access_point_name: string - common_area_number?: number | undefined } | undefined assa_abloy_vostio_metadata?: @@ -9274,7 +9284,6 @@ export interface Routes { dormakaba_community_metadata?: | { access_point_name: string - common_area_number?: number | undefined } | undefined assa_abloy_vostio_metadata?: @@ -10442,7 +10451,6 @@ export interface Routes { dormakaba_community_metadata?: | { access_point_name: string - common_area_number?: number | undefined } | undefined assa_abloy_vostio_metadata?: @@ -10814,6 +10822,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -12713,6 +12722,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ client_session: { client_session_id: string workspace_id: string @@ -12749,6 +12759,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ client_session: { client_session_id: string workspace_id: string @@ -12777,6 +12788,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ client_session: { client_session_id: string workspace_id: string @@ -12805,6 +12817,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ client_session: { client_session_id: string workspace_id: string @@ -12935,6 +12948,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ connect_webview: { connect_webview_id: string workspace_id: string @@ -12983,6 +12997,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ connect_webview: { connect_webview_id: string workspace_id: string @@ -13077,6 +13092,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ connected_account: { connected_account_id?: string | undefined created_at?: string | undefined @@ -13172,6 +13188,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ connected_account: { connected_account_id?: string | undefined created_at?: string | undefined @@ -13229,6 +13246,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ device: { /** Unique identifier for the device. */ device_id: string @@ -15107,6 +15125,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ device: { /** Unique identifier for the device. */ device_id: string @@ -15788,6 +15807,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ event?: | ( | { @@ -18463,6 +18483,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ lock: { /** Unique identifier for the device. */ device_id: string @@ -19243,6 +19264,7 @@ export interface Routes { can_simulate_connection?: boolean | undefined can_simulate_disconnection?: boolean | undefined } + /** */ device: { /** Unique identifier for the device. */ device_id: string @@ -21780,6 +21802,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -22728,6 +22751,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -23675,6 +23699,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ network: { network_id: string workspace_id: string @@ -25459,6 +25484,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -26394,6 +26420,7 @@ export interface Routes { message: string } } + /** */ noise_threshold: { noise_threshold_id: string device_id: string @@ -26417,6 +26444,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -27364,6 +27392,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ noise_threshold: { noise_threshold_id: string device_id: string @@ -27414,6 +27443,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -28558,6 +28588,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ phone: { /** Unique identifier for the device. */ device_id: string @@ -28720,6 +28751,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -29674,6 +29706,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -30669,6 +30702,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ thermostat: { /** Unique identifier for the device. */ device_id: string @@ -31468,6 +31502,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -32426,6 +32461,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -35120,6 +35156,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -36254,6 +36291,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -37235,6 +37273,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */ @@ -40384,6 +40423,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ webhook: { webhook_id: string url: string @@ -40413,6 +40453,7 @@ export interface Routes { } formData: {} jsonResponse: { + /** */ webhook: { webhook_id: string url: string @@ -40467,6 +40508,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ workspace: { workspace_id: string name: string @@ -40486,6 +40528,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ workspace: { workspace_id: string name: string @@ -40524,6 +40567,7 @@ export interface Routes { commonParams: {} formData: {} jsonResponse: { + /** */ action_attempt: | { /** The ID of the action attempt. */