@seamapi/types 1.327.0 → 1.328.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +761 -371
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +102 -14
- package/lib/seam/connect/models/access-codes/managed-access-code.js +5 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +5 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +7 -3
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential-pool.js +5 -1
- package/lib/seam/connect/models/acs/acs-credential-pool.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +12 -5
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +0 -5
- package/lib/seam/connect/models/acs/acs-entrance.js +7 -4
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +6 -2
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-user.js +7 -4
- package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
- package/lib/seam/connect/models/acs/metadata/dormakaba-community.d.ts +0 -3
- package/lib/seam/connect/models/acs/metadata/dormakaba-community.js +0 -1
- package/lib/seam/connect/models/acs/metadata/dormakaba-community.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.js +5 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/client-sessions/client-session.js +5 -1
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +5 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +5 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +5 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device.js +5 -1
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +5 -1
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +5 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/models/events/access-codes.js +119 -68
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/acs/access_groups.js +7 -4
- package/lib/seam/connect/models/events/acs/access_groups.js.map +1 -1
- package/lib/seam/connect/models/events/acs/credentials.js +14 -8
- package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
- package/lib/seam/connect/models/events/acs/encoders.js +14 -8
- package/lib/seam/connect/models/events/acs/encoders.js.map +1 -1
- package/lib/seam/connect/models/events/acs/systems.js +21 -12
- package/lib/seam/connect/models/events/acs/systems.js.map +1 -1
- package/lib/seam/connect/models/events/acs/users.js +7 -4
- package/lib/seam/connect/models/events/acs/users.js.map +1 -1
- package/lib/seam/connect/models/events/action-attempts.js +28 -16
- package/lib/seam/connect/models/events/action-attempts.js.map +1 -1
- package/lib/seam/connect/models/events/client-sessions.js +7 -4
- package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
- package/lib/seam/connect/models/events/connect-webviews.js +14 -8
- package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
- package/lib/seam/connect/models/events/connected-accounts.js +45 -25
- package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
- package/lib/seam/connect/models/events/devices.js +214 -119
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/enrollment-automations.js +7 -4
- package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
- package/lib/seam/connect/models/events/phones.js +7 -4
- package/lib/seam/connect/models/events/phones.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.js +5 -1
- package/lib/seam/connect/models/events/seam-event.js.map +1 -1
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js +5 -1
- package/lib/seam/connect/models/noise-sensors/noise-threshold.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +8 -8
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +7 -4
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/models/webhooks/webhook.js +5 -1
- package/lib/seam/connect/models/webhooks/webhook.js.map +1 -1
- package/lib/seam/connect/models/workspaces/workspace.js +5 -1
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +53 -4
- package/lib/seam/connect/openapi.js +102 -6
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +49 -5
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +5 -1
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +5 -1
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +7 -3
- package/src/lib/seam/connect/models/acs/acs-credential-pool.ts +5 -1
- package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +38 -35
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +31 -30
- package/src/lib/seam/connect/models/acs/acs-system.ts +6 -4
- package/src/lib/seam/connect/models/acs/acs-user.ts +10 -9
- package/src/lib/seam/connect/models/acs/metadata/dormakaba-community.ts +0 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +5 -1
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +5 -1
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +5 -1
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +5 -1
- package/src/lib/seam/connect/models/devices/device-provider.ts +5 -1
- package/src/lib/seam/connect/models/devices/device.ts +5 -1
- package/src/lib/seam/connect/models/devices/phone.ts +5 -1
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +5 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +139 -117
- package/src/lib/seam/connect/models/events/acs/access_groups.ts +8 -5
- package/src/lib/seam/connect/models/events/acs/credentials.ts +16 -14
- package/src/lib/seam/connect/models/events/acs/encoders.ts +16 -14
- package/src/lib/seam/connect/models/events/acs/systems.ts +24 -21
- package/src/lib/seam/connect/models/events/acs/users.ts +8 -7
- package/src/lib/seam/connect/models/events/action-attempts.ts +32 -24
- package/src/lib/seam/connect/models/events/client-sessions.ts +8 -7
- package/src/lib/seam/connect/models/events/connect-webviews.ts +16 -13
- package/src/lib/seam/connect/models/events/connected-accounts.ts +55 -44
- package/src/lib/seam/connect/models/events/devices.ts +339 -301
- package/src/lib/seam/connect/models/events/enrollment-automations.ts +8 -6
- package/src/lib/seam/connect/models/events/phones.ts +8 -5
- package/src/lib/seam/connect/models/events/seam-event.ts +5 -1
- package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts +5 -1
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +60 -62
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +35 -34
- package/src/lib/seam/connect/models/webhooks/webhook.ts +5 -1
- package/src/lib/seam/connect/models/workspaces/workspace.ts +5 -1
- package/src/lib/seam/connect/openapi.ts +102 -6
- package/src/lib/seam/connect/route-types.ts +49 -5
package/dist/connect.cjs
CHANGED
|
@@ -90,7 +90,11 @@ var connected_account = zod.z.object({
|
|
|
90
90
|
warnings: zod.z.array(connected_account_warning),
|
|
91
91
|
custom_metadata,
|
|
92
92
|
automatically_manage_new_devices: zod.z.boolean()
|
|
93
|
-
})
|
|
93
|
+
}).describe(`
|
|
94
|
+
---
|
|
95
|
+
route_path: /connected_accounts
|
|
96
|
+
---
|
|
97
|
+
`);
|
|
94
98
|
var capabilities = zod.z.enum([
|
|
95
99
|
"access_code",
|
|
96
100
|
"lock",
|
|
@@ -212,9 +216,12 @@ var thermostat_schedule = zod.z.object({
|
|
|
212
216
|
).describe(
|
|
213
217
|
"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."
|
|
214
218
|
)
|
|
215
|
-
}).describe(
|
|
216
|
-
|
|
217
|
-
|
|
219
|
+
}).describe(`
|
|
220
|
+
---
|
|
221
|
+
route_path: /thermostats/schedules
|
|
222
|
+
---
|
|
223
|
+
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.
|
|
224
|
+
`);
|
|
218
225
|
|
|
219
226
|
// src/lib/seam/connect/models/devices/capability-properties/thermostat.ts
|
|
220
227
|
var thermostat_capability_properties = zod.z.object({
|
|
@@ -986,7 +993,11 @@ var device = zod.z.object({
|
|
|
986
993
|
created_at: zod.z.string().datetime().describe("Date and time at which the device object was created."),
|
|
987
994
|
is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the device."),
|
|
988
995
|
custom_metadata
|
|
989
|
-
}).merge(device_capability_flags2)
|
|
996
|
+
}).merge(device_capability_flags2).describe(`
|
|
997
|
+
---
|
|
998
|
+
route_path: /devices
|
|
999
|
+
---
|
|
1000
|
+
`);
|
|
990
1001
|
var DEVICE_PROVIDERS = {
|
|
991
1002
|
DORMAKABA_COMMUNITY: "dormakaba_community",
|
|
992
1003
|
LEGIC_CONNECT: "legic_connect",
|
|
@@ -1098,7 +1109,11 @@ var device_provider = zod.z.object({
|
|
|
1098
1109
|
display_name: zod.z.string(),
|
|
1099
1110
|
image_url: zod.z.string(),
|
|
1100
1111
|
provider_categories: zod.z.array(zod.z.enum(PUBLIC_PROVIDER_CATEGORIES))
|
|
1101
|
-
}).extend(device_capability_flags2.shape)
|
|
1112
|
+
}).extend(device_capability_flags2.shape).describe(`
|
|
1113
|
+
---
|
|
1114
|
+
route_path: /devices
|
|
1115
|
+
---
|
|
1116
|
+
`);
|
|
1102
1117
|
var unmanaged_device = device.pick({
|
|
1103
1118
|
device_id: true,
|
|
1104
1119
|
device_type: true,
|
|
@@ -1124,7 +1139,11 @@ var unmanaged_device = device.pick({
|
|
|
1124
1139
|
offline_access_codes_enabled: true,
|
|
1125
1140
|
model: true
|
|
1126
1141
|
})
|
|
1127
|
-
}).merge(device_capability_flags2)
|
|
1142
|
+
}).merge(device_capability_flags2).describe(`
|
|
1143
|
+
---
|
|
1144
|
+
route_path: /devices/unmanaged
|
|
1145
|
+
---
|
|
1146
|
+
`);
|
|
1128
1147
|
|
|
1129
1148
|
// src/lib/seam/connect/models/access-codes/managed-access-code.ts
|
|
1130
1149
|
var common_access_code_error = zod.z.object({
|
|
@@ -1196,7 +1215,11 @@ var access_code = zod.z.object({
|
|
|
1196
1215
|
is_offline_access_code: zod.z.boolean().describe(
|
|
1197
1216
|
'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.'
|
|
1198
1217
|
)
|
|
1199
|
-
})
|
|
1218
|
+
}).describe(`
|
|
1219
|
+
---
|
|
1220
|
+
route_path: /access_codes
|
|
1221
|
+
---
|
|
1222
|
+
`);
|
|
1200
1223
|
var unmanaged_access_code = access_code.pick({
|
|
1201
1224
|
type: true,
|
|
1202
1225
|
access_code_id: true,
|
|
@@ -1212,7 +1235,11 @@ var unmanaged_access_code = access_code.pick({
|
|
|
1212
1235
|
}).extend({
|
|
1213
1236
|
is_managed: zod.z.literal(false),
|
|
1214
1237
|
status: zod.z.enum(["set"])
|
|
1215
|
-
})
|
|
1238
|
+
}).describe(`
|
|
1239
|
+
---
|
|
1240
|
+
route_path: /access_codes/unmanaged
|
|
1241
|
+
---
|
|
1242
|
+
`);
|
|
1216
1243
|
var acs_access_group_external_type = zod.z.enum([
|
|
1217
1244
|
"pti_unit",
|
|
1218
1245
|
"pti_access_level",
|
|
@@ -1270,8 +1297,13 @@ var common_acs_access_group = zod.z.object({
|
|
|
1270
1297
|
});
|
|
1271
1298
|
var acs_access_group = common_acs_access_group.extend({
|
|
1272
1299
|
is_managed: zod.z.literal(true)
|
|
1273
|
-
}).describe(`
|
|
1274
|
-
|
|
1300
|
+
}).describe(`
|
|
1301
|
+
---
|
|
1302
|
+
route_path: /acs/access_groups
|
|
1303
|
+
---
|
|
1304
|
+
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.
|
|
1305
|
+
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).
|
|
1306
|
+
`);
|
|
1275
1307
|
var unmanaged_acs_access_group = common_acs_access_group.extend({
|
|
1276
1308
|
is_managed: zod.z.literal(false)
|
|
1277
1309
|
});
|
|
@@ -1283,8 +1315,7 @@ var acs_entrance_assa_abloy_vostio_metadata = zod.z.object({
|
|
|
1283
1315
|
pms_id: zod.z.string().optional()
|
|
1284
1316
|
});
|
|
1285
1317
|
var acs_entrance_dormakaba_community_metadata = zod.z.object({
|
|
1286
|
-
access_point_name: zod.z.string()
|
|
1287
|
-
common_area_number: zod.z.number().optional()
|
|
1318
|
+
access_point_name: zod.z.string()
|
|
1288
1319
|
});
|
|
1289
1320
|
var acs_entrance_latch_metadata = zod.z.object({
|
|
1290
1321
|
accessibility_type: zod.z.string(),
|
|
@@ -1526,9 +1557,12 @@ var acs_entrance = zod.z.object({
|
|
|
1526
1557
|
dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata.optional(),
|
|
1527
1558
|
assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata.optional(),
|
|
1528
1559
|
salto_space_metadata: acs_entrance_salto_space_metadata.optional()
|
|
1529
|
-
}).describe(
|
|
1530
|
-
|
|
1531
|
-
|
|
1560
|
+
}).describe(`
|
|
1561
|
+
---
|
|
1562
|
+
route_path: /acs/entrances
|
|
1563
|
+
---
|
|
1564
|
+
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).
|
|
1565
|
+
`);
|
|
1532
1566
|
var acs_system_capability_flags = zod.z.object({
|
|
1533
1567
|
can_automate_enrollment: zod.z.boolean().optional().describe(
|
|
1534
1568
|
"Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`."
|
|
@@ -1696,9 +1730,12 @@ var acs_system = zod.z.object({
|
|
|
1696
1730
|
image_alt_text: zod.z.string().describe("Alternative text for the `acs_system` image."),
|
|
1697
1731
|
errors: zod.z.array(acs_system_error).describe("Errors associated with the `acs_system`."),
|
|
1698
1732
|
warnings: zod.z.array(acs_system_warning).describe("Warnings associated with the `acs_system`.")
|
|
1699
|
-
}).merge(acs_system_capability_flags).describe(
|
|
1700
|
-
|
|
1701
|
-
|
|
1733
|
+
}).merge(acs_system_capability_flags).describe(`
|
|
1734
|
+
---
|
|
1735
|
+
route_path: /acs/systems
|
|
1736
|
+
---
|
|
1737
|
+
Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
1738
|
+
`);
|
|
1702
1739
|
var phone_number = zod.z.coerce.string().trim().refine(
|
|
1703
1740
|
(val) => {
|
|
1704
1741
|
return /^\+[1-9]\d{1,14}$/.test(val);
|
|
@@ -1868,9 +1905,12 @@ var acs_user = common_acs_user.merge(
|
|
|
1868
1905
|
zod.z.object({
|
|
1869
1906
|
is_managed: zod.z.literal(true)
|
|
1870
1907
|
})
|
|
1871
|
-
).describe(
|
|
1872
|
-
|
|
1873
|
-
|
|
1908
|
+
).describe(`
|
|
1909
|
+
---
|
|
1910
|
+
route_path: /acs/users
|
|
1911
|
+
---
|
|
1912
|
+
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).
|
|
1913
|
+
`);
|
|
1874
1914
|
var unmanaged_acs_user = common_acs_user.merge(
|
|
1875
1915
|
zod.z.object({
|
|
1876
1916
|
is_managed: zod.z.literal(false)
|
|
@@ -2199,7 +2239,11 @@ var action_attempt = zod.z.union([
|
|
|
2199
2239
|
...set_hvac_mode_action_attempt.options,
|
|
2200
2240
|
...activate_climate_preset_action_attempt.options,
|
|
2201
2241
|
...deprecated_action_attempts
|
|
2202
|
-
])
|
|
2242
|
+
]).describe(`
|
|
2243
|
+
---
|
|
2244
|
+
route_path: /action_attempts
|
|
2245
|
+
---
|
|
2246
|
+
`);
|
|
2203
2247
|
var client_session = zod.z.object({
|
|
2204
2248
|
client_session_id: zod.z.string().uuid(),
|
|
2205
2249
|
workspace_id: zod.z.string().uuid(),
|
|
@@ -2211,7 +2255,11 @@ var client_session = zod.z.object({
|
|
|
2211
2255
|
connected_account_ids: zod.z.array(zod.z.string().uuid()),
|
|
2212
2256
|
connect_webview_ids: zod.z.array(zod.z.string().uuid()),
|
|
2213
2257
|
user_identity_ids: zod.z.array(zod.z.string().uuid())
|
|
2214
|
-
})
|
|
2258
|
+
}).describe(`
|
|
2259
|
+
---
|
|
2260
|
+
route_path: /client_sessions
|
|
2261
|
+
---
|
|
2262
|
+
`);
|
|
2215
2263
|
var connect_webview_device_selection_mode = zod.z.enum([
|
|
2216
2264
|
"none",
|
|
2217
2265
|
"single",
|
|
@@ -2250,7 +2298,11 @@ var connect_webview = zod.z.object({
|
|
|
2250
2298
|
wait_for_device_creation: zod.z.boolean(),
|
|
2251
2299
|
authorized_at: zod.z.string().datetime().nullable(),
|
|
2252
2300
|
selected_provider: zod.z.string().nullable()
|
|
2253
|
-
})
|
|
2301
|
+
}).describe(`
|
|
2302
|
+
---
|
|
2303
|
+
route_path: /connect_webviews
|
|
2304
|
+
---
|
|
2305
|
+
`);
|
|
2254
2306
|
var common_event = zod.z.object({
|
|
2255
2307
|
event_id: zod.z.string().uuid().describe("ID of the event."),
|
|
2256
2308
|
workspace_id: zod.z.string().uuid().describe(
|
|
@@ -2277,95 +2329,144 @@ var code = zod.z.string().describe(
|
|
|
2277
2329
|
);
|
|
2278
2330
|
var access_code_created_event = access_code_event.extend({
|
|
2279
2331
|
event_type: zod.z.literal("access_code.created")
|
|
2280
|
-
}).describe(
|
|
2281
|
-
|
|
2282
|
-
|
|
2332
|
+
}).describe(`
|
|
2333
|
+
---
|
|
2334
|
+
route_path: /access_codes
|
|
2335
|
+
---
|
|
2336
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.
|
|
2337
|
+
`);
|
|
2283
2338
|
var access_code_changed_event = access_code_event.extend({
|
|
2284
2339
|
event_type: zod.z.literal("access_code.changed")
|
|
2285
|
-
}).describe(
|
|
2286
|
-
|
|
2287
|
-
|
|
2340
|
+
}).describe(`
|
|
2341
|
+
---
|
|
2342
|
+
route_path: /access_codes
|
|
2343
|
+
---
|
|
2344
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.
|
|
2345
|
+
`);
|
|
2288
2346
|
var access_code_scheduled_on_device_event = access_code_event.extend({
|
|
2289
2347
|
event_type: zod.z.literal("access_code.scheduled_on_device"),
|
|
2290
2348
|
code
|
|
2291
|
-
}).describe(
|
|
2292
|
-
|
|
2293
|
-
|
|
2349
|
+
}).describe(`
|
|
2350
|
+
---
|
|
2351
|
+
route_path: /access_codes
|
|
2352
|
+
---
|
|
2353
|
+
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.
|
|
2354
|
+
`);
|
|
2294
2355
|
var access_code_set_on_device_event = access_code_event.extend({
|
|
2295
2356
|
event_type: zod.z.literal("access_code.set_on_device"),
|
|
2296
2357
|
code
|
|
2297
|
-
}).describe(
|
|
2298
|
-
|
|
2299
|
-
|
|
2358
|
+
}).describe(`
|
|
2359
|
+
---
|
|
2360
|
+
route_path: /access_codes
|
|
2361
|
+
---
|
|
2362
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.
|
|
2363
|
+
`);
|
|
2300
2364
|
var access_code_removed_from_device_event = access_code_event.extend({
|
|
2301
2365
|
event_type: zod.z.literal("access_code.removed_from_device")
|
|
2302
|
-
}).describe(
|
|
2303
|
-
|
|
2304
|
-
|
|
2366
|
+
}).describe(`
|
|
2367
|
+
---
|
|
2368
|
+
route_path: /access_codes
|
|
2369
|
+
---
|
|
2370
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.
|
|
2371
|
+
`);
|
|
2305
2372
|
var access_code_delay_in_setting_on_device_event = access_code_event.extend({
|
|
2306
2373
|
event_type: zod.z.literal("access_code.delay_in_setting_on_device")
|
|
2307
|
-
}).describe(
|
|
2308
|
-
|
|
2309
|
-
|
|
2374
|
+
}).describe(`
|
|
2375
|
+
---
|
|
2376
|
+
route_path: /access_codes
|
|
2377
|
+
---
|
|
2378
|
+
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.
|
|
2379
|
+
`);
|
|
2310
2380
|
var access_code_failed_to_set_on_device_event = access_code_event.extend({
|
|
2311
2381
|
event_type: zod.z.literal("access_code.failed_to_set_on_device")
|
|
2312
|
-
}).describe(
|
|
2313
|
-
|
|
2314
|
-
|
|
2382
|
+
}).describe(`
|
|
2383
|
+
---
|
|
2384
|
+
route_path: /access_codes
|
|
2385
|
+
---
|
|
2386
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.
|
|
2387
|
+
`);
|
|
2315
2388
|
var access_code_deleted_event = access_code_event.extend({
|
|
2316
2389
|
event_type: zod.z.literal("access_code.deleted"),
|
|
2317
2390
|
code: code.nullable()
|
|
2318
|
-
}).describe(
|
|
2319
|
-
|
|
2320
|
-
|
|
2391
|
+
}).describe(`
|
|
2392
|
+
---
|
|
2393
|
+
route_path: /access_codes
|
|
2394
|
+
---
|
|
2395
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.
|
|
2396
|
+
`);
|
|
2321
2397
|
var access_code_delay_in_removing_from_device_event = access_code_event.extend({
|
|
2322
2398
|
event_type: zod.z.literal("access_code.delay_in_removing_from_device")
|
|
2323
|
-
}).describe(
|
|
2324
|
-
|
|
2325
|
-
|
|
2399
|
+
}).describe(`
|
|
2400
|
+
---
|
|
2401
|
+
route_path: /access_codes
|
|
2402
|
+
---
|
|
2403
|
+
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.
|
|
2404
|
+
`);
|
|
2326
2405
|
var access_code_failed_to_remove_from_device_event = access_code_event.extend({
|
|
2327
2406
|
event_type: zod.z.literal("access_code.failed_to_remove_from_device")
|
|
2328
|
-
}).describe(
|
|
2329
|
-
|
|
2330
|
-
|
|
2407
|
+
}).describe(`
|
|
2408
|
+
---
|
|
2409
|
+
route_path: /access_codes
|
|
2410
|
+
---
|
|
2411
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.
|
|
2412
|
+
`);
|
|
2331
2413
|
var access_code_modified_external_to_seam_event = access_code_event.extend({
|
|
2332
2414
|
event_type: zod.z.literal("access_code.modified_external_to_seam")
|
|
2333
|
-
}).describe(
|
|
2334
|
-
|
|
2335
|
-
|
|
2415
|
+
}).describe(`
|
|
2416
|
+
---
|
|
2417
|
+
route_path: /access_codes
|
|
2418
|
+
---
|
|
2419
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.
|
|
2420
|
+
`);
|
|
2336
2421
|
var access_code_deleted_external_to_seam_event = access_code_event.extend({
|
|
2337
2422
|
event_type: zod.z.literal("access_code.deleted_external_to_seam")
|
|
2338
|
-
}).describe(
|
|
2339
|
-
|
|
2340
|
-
|
|
2423
|
+
}).describe(`
|
|
2424
|
+
---
|
|
2425
|
+
route_path: /access_codes
|
|
2426
|
+
---
|
|
2427
|
+
An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.
|
|
2428
|
+
`);
|
|
2341
2429
|
var access_code_backup_access_code_pulled_event = access_code_event.extend({
|
|
2342
2430
|
event_type: zod.z.literal("access_code.backup_access_code_pulled"),
|
|
2343
2431
|
backup_access_code_id: zod.z.string()
|
|
2344
|
-
}).describe(
|
|
2345
|
-
|
|
2346
|
-
|
|
2432
|
+
}).describe(`
|
|
2433
|
+
---
|
|
2434
|
+
route_path: /access_codes
|
|
2435
|
+
---
|
|
2436
|
+
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.
|
|
2437
|
+
`);
|
|
2347
2438
|
var unmanaged_access_code_converted_to_managed_event = access_code_event.extend({
|
|
2348
2439
|
event_type: zod.z.literal("access_code.unmanaged.converted_to_managed")
|
|
2349
|
-
}).describe(
|
|
2350
|
-
|
|
2351
|
-
|
|
2440
|
+
}).describe(`
|
|
2441
|
+
---
|
|
2442
|
+
route_path: /access_codes/unmanaged
|
|
2443
|
+
---
|
|
2444
|
+
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.
|
|
2445
|
+
`);
|
|
2352
2446
|
var unmanaged_access_code_failed_to_convert_to_managed_event = access_code_event.extend({
|
|
2353
|
-
event_type: zod.z.literal(
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
)
|
|
2447
|
+
event_type: zod.z.literal("access_code.unmanaged.failed_to_convert_to_managed")
|
|
2448
|
+
}).describe(`
|
|
2449
|
+
---
|
|
2450
|
+
route_path: /access_codes/unmanaged
|
|
2451
|
+
---
|
|
2452
|
+
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.
|
|
2453
|
+
`);
|
|
2359
2454
|
var unmanaged_access_code_created_event = access_code_event.extend({
|
|
2360
2455
|
event_type: zod.z.literal("access_code.unmanaged.created")
|
|
2361
|
-
}).describe(
|
|
2362
|
-
|
|
2363
|
-
|
|
2456
|
+
}).describe(`
|
|
2457
|
+
---
|
|
2458
|
+
route_path: /access_codes/unmanaged
|
|
2459
|
+
---
|
|
2460
|
+
An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.
|
|
2461
|
+
`);
|
|
2364
2462
|
var unmanaged_access_code_removed_event = access_code_event.extend({
|
|
2365
2463
|
event_type: zod.z.literal("access_code.unmanaged.removed")
|
|
2366
|
-
}).describe(
|
|
2367
|
-
|
|
2368
|
-
|
|
2464
|
+
}).describe(`
|
|
2465
|
+
---
|
|
2466
|
+
route_path: /access_codes/unmanaged
|
|
2467
|
+
---
|
|
2468
|
+
An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.
|
|
2469
|
+
`);
|
|
2369
2470
|
var access_code_events = [
|
|
2370
2471
|
access_code_created_event,
|
|
2371
2472
|
access_code_changed_event,
|
|
@@ -2400,21 +2501,32 @@ var acs_access_group_event = common_acs_event.extend({
|
|
|
2400
2501
|
});
|
|
2401
2502
|
var acs_access_group_deleted_event = acs_access_group_event.extend({
|
|
2402
2503
|
event_type: zod.z.literal("acs_access_group.deleted")
|
|
2403
|
-
}).describe(
|
|
2504
|
+
}).describe(`
|
|
2505
|
+
---
|
|
2506
|
+
route_path: /acs/access_groups
|
|
2507
|
+
---
|
|
2508
|
+
An ACS access group was deleted.
|
|
2509
|
+
`);
|
|
2404
2510
|
var acs_access_group_events = [acs_access_group_deleted_event];
|
|
2405
2511
|
var acs_credential_event = common_acs_event.extend({
|
|
2406
2512
|
acs_credential_id: zod.z.string().uuid()
|
|
2407
2513
|
});
|
|
2408
2514
|
var acs_credential_deleted_event = acs_credential_event.extend({
|
|
2409
2515
|
event_type: zod.z.literal("acs_credential.deleted")
|
|
2410
|
-
}).describe(
|
|
2411
|
-
|
|
2412
|
-
|
|
2516
|
+
}).describe(`
|
|
2517
|
+
---
|
|
2518
|
+
route_path: /acs/credentials
|
|
2519
|
+
---
|
|
2520
|
+
An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.
|
|
2521
|
+
`);
|
|
2413
2522
|
var acs_credential_issued = acs_credential_event.extend({
|
|
2414
2523
|
event_type: zod.z.literal("acs_credential.issued")
|
|
2415
|
-
}).describe(
|
|
2416
|
-
|
|
2417
|
-
|
|
2524
|
+
}).describe(`
|
|
2525
|
+
---
|
|
2526
|
+
route_path: /acs/credentials
|
|
2527
|
+
---
|
|
2528
|
+
An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.
|
|
2529
|
+
`);
|
|
2418
2530
|
var acs_credential_events = [
|
|
2419
2531
|
acs_credential_deleted_event,
|
|
2420
2532
|
acs_credential_issued
|
|
@@ -2426,14 +2538,20 @@ var acs_encoder_event = common_acs_event.extend({
|
|
|
2426
2538
|
});
|
|
2427
2539
|
var acs_encoder_added_event = acs_encoder_event.extend({
|
|
2428
2540
|
event_type: zod.z.literal("acs_encoder.added")
|
|
2429
|
-
}).describe(
|
|
2430
|
-
|
|
2431
|
-
|
|
2541
|
+
}).describe(`
|
|
2542
|
+
---
|
|
2543
|
+
route_path: /acs/encoders
|
|
2544
|
+
---
|
|
2545
|
+
An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.
|
|
2546
|
+
`);
|
|
2432
2547
|
var acs_encoder_removed_event = acs_encoder_event.extend({
|
|
2433
2548
|
event_type: zod.z.literal("acs_encoder.removed")
|
|
2434
|
-
}).describe(
|
|
2435
|
-
|
|
2436
|
-
|
|
2549
|
+
}).describe(`
|
|
2550
|
+
---
|
|
2551
|
+
route_path: /acs/encoders
|
|
2552
|
+
---
|
|
2553
|
+
An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.
|
|
2554
|
+
`);
|
|
2437
2555
|
var acs_encoder_events = [
|
|
2438
2556
|
acs_encoder_added_event,
|
|
2439
2557
|
acs_encoder_removed_event
|
|
@@ -2441,19 +2559,28 @@ var acs_encoder_events = [
|
|
|
2441
2559
|
var acs_system_event = common_acs_event.extend({});
|
|
2442
2560
|
var acs_system_connected_event = acs_system_event.extend({
|
|
2443
2561
|
event_type: zod.z.literal("acs_system.connected")
|
|
2444
|
-
}).describe(
|
|
2445
|
-
|
|
2446
|
-
|
|
2562
|
+
}).describe(`
|
|
2563
|
+
---
|
|
2564
|
+
route_path: /acs/systems
|
|
2565
|
+
---
|
|
2566
|
+
An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
|
|
2567
|
+
`);
|
|
2447
2568
|
var acs_system_disconnected_event = acs_system_event.extend({
|
|
2448
2569
|
event_type: zod.z.literal("acs_system.disconnected")
|
|
2449
|
-
}).describe(
|
|
2450
|
-
|
|
2451
|
-
|
|
2570
|
+
}).describe(`
|
|
2571
|
+
---
|
|
2572
|
+
route_path: /acs/systems
|
|
2573
|
+
---
|
|
2574
|
+
An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
|
|
2575
|
+
`);
|
|
2452
2576
|
var acs_system_added_event = acs_system_event.extend({
|
|
2453
2577
|
event_type: zod.z.literal("acs_system.added")
|
|
2454
|
-
}).describe(
|
|
2455
|
-
|
|
2456
|
-
|
|
2578
|
+
}).describe(`
|
|
2579
|
+
---
|
|
2580
|
+
route_path: /acs/systems
|
|
2581
|
+
---
|
|
2582
|
+
An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
|
|
2583
|
+
`);
|
|
2457
2584
|
var acs_system_events = [
|
|
2458
2585
|
acs_system_connected_event,
|
|
2459
2586
|
acs_system_added_event,
|
|
@@ -2466,9 +2593,12 @@ var acs_user_event = common_acs_event.extend({
|
|
|
2466
2593
|
);
|
|
2467
2594
|
var acs_user_deleted_event = acs_user_event.extend({
|
|
2468
2595
|
event_type: zod.z.literal("acs_user.deleted")
|
|
2469
|
-
}).describe(
|
|
2470
|
-
|
|
2471
|
-
|
|
2596
|
+
}).describe(`
|
|
2597
|
+
---
|
|
2598
|
+
route_path: /acs/users
|
|
2599
|
+
---
|
|
2600
|
+
An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
|
|
2601
|
+
`);
|
|
2472
2602
|
var acs_user_events = [acs_user_deleted_event];
|
|
2473
2603
|
|
|
2474
2604
|
// src/lib/seam/connect/models/events/acs/index.ts
|
|
@@ -2488,24 +2618,36 @@ var action_attempt_event = common_event.extend({
|
|
|
2488
2618
|
});
|
|
2489
2619
|
var action_attempt_lock_door_succeeded_event = action_attempt_event.extend({
|
|
2490
2620
|
event_type: zod.z.literal("action_attempt.lock_door.succeeded")
|
|
2491
|
-
}).describe(
|
|
2492
|
-
|
|
2493
|
-
|
|
2621
|
+
}).describe(`
|
|
2622
|
+
---
|
|
2623
|
+
route_path: /action_attempts
|
|
2624
|
+
---
|
|
2625
|
+
A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.
|
|
2626
|
+
`);
|
|
2494
2627
|
var action_attempt_lock_door_failed_event = action_attempt_event.extend({
|
|
2495
2628
|
event_type: zod.z.literal("action_attempt.lock_door.failed")
|
|
2496
|
-
}).describe(
|
|
2497
|
-
|
|
2498
|
-
|
|
2629
|
+
}).describe(`
|
|
2630
|
+
---
|
|
2631
|
+
route_path: /action_attempts
|
|
2632
|
+
---
|
|
2633
|
+
A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.
|
|
2634
|
+
`);
|
|
2499
2635
|
var action_attempt_unlock_door_succeeded_event = action_attempt_event.extend({
|
|
2500
2636
|
event_type: zod.z.literal("action_attempt.unlock_door.succeeded")
|
|
2501
|
-
}).describe(
|
|
2502
|
-
|
|
2503
|
-
|
|
2637
|
+
}).describe(`
|
|
2638
|
+
---
|
|
2639
|
+
route_path: /action_attempts
|
|
2640
|
+
---
|
|
2641
|
+
An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.
|
|
2642
|
+
`);
|
|
2504
2643
|
var action_attempt_unlock_door_failed_event = action_attempt_event.extend({
|
|
2505
2644
|
event_type: zod.z.literal("action_attempt.unlock_door.failed")
|
|
2506
|
-
}).describe(
|
|
2507
|
-
|
|
2508
|
-
|
|
2645
|
+
}).describe(`
|
|
2646
|
+
---
|
|
2647
|
+
route_path: /action_attempts
|
|
2648
|
+
---
|
|
2649
|
+
An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.
|
|
2650
|
+
`);
|
|
2509
2651
|
var action_attempt_events = [
|
|
2510
2652
|
action_attempt_lock_door_succeeded_event,
|
|
2511
2653
|
action_attempt_lock_door_failed_event,
|
|
@@ -2519,9 +2661,12 @@ var client_session_event = common_event.extend({
|
|
|
2519
2661
|
});
|
|
2520
2662
|
var client_session_deleted_event = client_session_event.extend({
|
|
2521
2663
|
event_type: zod.z.literal("client_session.deleted")
|
|
2522
|
-
}).describe(
|
|
2523
|
-
|
|
2524
|
-
|
|
2664
|
+
}).describe(`
|
|
2665
|
+
---
|
|
2666
|
+
route_path: /client_sessions
|
|
2667
|
+
---
|
|
2668
|
+
A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.
|
|
2669
|
+
`);
|
|
2525
2670
|
var client_session_events = [client_session_deleted_event];
|
|
2526
2671
|
var connect_webview_event = common_event.extend({
|
|
2527
2672
|
connect_webview_id: zod.z.string().uuid().describe(
|
|
@@ -2534,14 +2679,20 @@ var connected_account_id = zod.z.string().uuid().describe(
|
|
|
2534
2679
|
var connect_webview_login_succeeded_event = connect_webview_event.extend({
|
|
2535
2680
|
event_type: zod.z.literal("connect_webview.login_succeeded"),
|
|
2536
2681
|
connected_account_id
|
|
2537
|
-
}).describe(
|
|
2538
|
-
|
|
2539
|
-
|
|
2682
|
+
}).describe(`
|
|
2683
|
+
---
|
|
2684
|
+
route_path: /connect_webviews
|
|
2685
|
+
---
|
|
2686
|
+
A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.
|
|
2687
|
+
`);
|
|
2540
2688
|
var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
2541
2689
|
event_type: zod.z.literal("connect_webview.login_failed")
|
|
2542
|
-
}).describe(
|
|
2543
|
-
|
|
2544
|
-
|
|
2690
|
+
}).describe(`
|
|
2691
|
+
---
|
|
2692
|
+
route_path: /connect_webviews
|
|
2693
|
+
---
|
|
2694
|
+
A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.
|
|
2695
|
+
`);
|
|
2545
2696
|
var connect_webview_events = [
|
|
2546
2697
|
connect_webview_login_succeeded_event,
|
|
2547
2698
|
connect_webview_login_failed_event
|
|
@@ -2554,48 +2705,70 @@ var connected_account_event = common_event.extend({
|
|
|
2554
2705
|
var connect_webview_id = zod.z.string().uuid().describe(
|
|
2555
2706
|
"ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)."
|
|
2556
2707
|
);
|
|
2557
|
-
var connected_account_connected_event = connected_account_event.extend(
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
)
|
|
2708
|
+
var connected_account_connected_event = connected_account_event.extend(
|
|
2709
|
+
{
|
|
2710
|
+
event_type: zod.z.literal("connected_account.connected"),
|
|
2711
|
+
connect_webview_id
|
|
2712
|
+
}
|
|
2713
|
+
).describe(`
|
|
2714
|
+
---
|
|
2715
|
+
route_path: /connected_accounts
|
|
2716
|
+
---
|
|
2717
|
+
A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.
|
|
2718
|
+
`);
|
|
2563
2719
|
var connected_account_created_event = connected_account_event.extend({
|
|
2564
2720
|
event_type: zod.z.literal("connected_account.created"),
|
|
2565
2721
|
connect_webview_id
|
|
2566
|
-
}).describe(
|
|
2567
|
-
|
|
2568
|
-
|
|
2722
|
+
}).describe(`
|
|
2723
|
+
---
|
|
2724
|
+
route_path: /connected_accounts
|
|
2725
|
+
---
|
|
2726
|
+
A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.
|
|
2727
|
+
`);
|
|
2569
2728
|
var connected_account_successful_login_event = connected_account_event.extend({
|
|
2570
2729
|
event_type: zod.z.literal("connected_account.successful_login"),
|
|
2571
2730
|
connect_webview_id
|
|
2572
2731
|
}).describe(`
|
|
2573
2732
|
---
|
|
2574
2733
|
deprecated: Use \`connect_webview.login_succeeded\`.
|
|
2734
|
+
route_path: /connected_accounts
|
|
2575
2735
|
---
|
|
2576
|
-
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)
|
|
2736
|
+
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).
|
|
2737
|
+
`);
|
|
2577
2738
|
var connected_account_disconnected_event = connected_account_event.extend({
|
|
2578
2739
|
event_type: zod.z.literal("connected_account.disconnected")
|
|
2579
|
-
}).describe(
|
|
2580
|
-
|
|
2581
|
-
|
|
2740
|
+
}).describe(`
|
|
2741
|
+
---
|
|
2742
|
+
route_path: /connected_accounts
|
|
2743
|
+
---
|
|
2744
|
+
A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.
|
|
2745
|
+
`);
|
|
2582
2746
|
var connected_account_completed_first_sync_event = connected_account_event.extend({
|
|
2583
2747
|
event_type: zod.z.literal("connected_account.completed_first_sync")
|
|
2584
|
-
}).describe(
|
|
2585
|
-
|
|
2586
|
-
|
|
2748
|
+
}).describe(`
|
|
2749
|
+
---
|
|
2750
|
+
route_path: /connected_accounts
|
|
2751
|
+
---
|
|
2752
|
+
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.
|
|
2753
|
+
`);
|
|
2587
2754
|
var connected_account_deleted_event = connected_account_event.extend({
|
|
2588
2755
|
event_type: zod.z.literal("connected_account.deleted")
|
|
2589
|
-
}).describe(
|
|
2590
|
-
|
|
2591
|
-
|
|
2756
|
+
}).describe(`
|
|
2757
|
+
---
|
|
2758
|
+
route_path: /connected_accounts
|
|
2759
|
+
---
|
|
2760
|
+
A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.
|
|
2761
|
+
`);
|
|
2592
2762
|
var connected_account_completed_first_sync_after_reconnection_event = connected_account_event.extend({
|
|
2593
2763
|
event_type: zod.z.literal(
|
|
2594
2764
|
"connected_account.completed_first_sync_after_reconnection"
|
|
2595
2765
|
)
|
|
2596
|
-
}).describe(
|
|
2597
|
-
|
|
2598
|
-
|
|
2766
|
+
}).describe(`
|
|
2767
|
+
---
|
|
2768
|
+
route_path: /connected_accounts
|
|
2769
|
+
---
|
|
2770
|
+
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.
|
|
2771
|
+
`);
|
|
2599
2772
|
var connected_account_events = [
|
|
2600
2773
|
connected_account_connected_event,
|
|
2601
2774
|
connected_account_created_event,
|
|
@@ -2623,137 +2796,206 @@ var lock_method = zod.z.enum(["keycode", "manual", "automatic", "unknown", "seam
|
|
|
2623
2796
|
);
|
|
2624
2797
|
var device_connected_event = device_event.extend({
|
|
2625
2798
|
event_type: zod.z.literal("device.connected")
|
|
2626
|
-
}).describe(
|
|
2627
|
-
|
|
2628
|
-
|
|
2799
|
+
}).describe(`
|
|
2800
|
+
---
|
|
2801
|
+
route_path: /devices
|
|
2802
|
+
---
|
|
2803
|
+
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.
|
|
2804
|
+
`);
|
|
2629
2805
|
var device_added_event = device_event.extend({
|
|
2630
2806
|
event_type: zod.z.literal("device.added")
|
|
2631
|
-
}).describe(
|
|
2632
|
-
|
|
2633
|
-
|
|
2807
|
+
}).describe(`
|
|
2808
|
+
---
|
|
2809
|
+
route_path: /devices
|
|
2810
|
+
---
|
|
2811
|
+
A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.
|
|
2812
|
+
`);
|
|
2634
2813
|
var device_converted_to_unmanaged_event = device_event.extend({
|
|
2635
2814
|
event_type: zod.z.literal("device.converted_to_unmanaged")
|
|
2636
|
-
}).describe(
|
|
2637
|
-
|
|
2638
|
-
|
|
2815
|
+
}).describe(`
|
|
2816
|
+
---
|
|
2817
|
+
route_path: /devices
|
|
2818
|
+
---
|
|
2819
|
+
A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).
|
|
2820
|
+
`);
|
|
2639
2821
|
var unmanaged_device_converted_to_managed_event = device_event.extend({
|
|
2640
2822
|
event_type: zod.z.literal("device.unmanaged.converted_to_managed")
|
|
2641
|
-
}).describe(
|
|
2642
|
-
|
|
2643
|
-
|
|
2823
|
+
}).describe(`
|
|
2824
|
+
---
|
|
2825
|
+
route_path: /devices/unmanaged
|
|
2826
|
+
---
|
|
2827
|
+
An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.
|
|
2828
|
+
`);
|
|
2644
2829
|
var unmanaged_device_connected_event = device_event.extend({
|
|
2645
2830
|
event_type: zod.z.literal("device.unmanaged.connected")
|
|
2646
|
-
}).describe(
|
|
2647
|
-
|
|
2648
|
-
|
|
2831
|
+
}).describe(`
|
|
2832
|
+
---
|
|
2833
|
+
route_path: /devices/unmanaged
|
|
2834
|
+
---
|
|
2835
|
+
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\`.
|
|
2836
|
+
`);
|
|
2649
2837
|
var device_disconnected_event = device_event.extend({
|
|
2650
2838
|
event_type: zod.z.literal("device.disconnected"),
|
|
2651
2839
|
error_code: disconnection_error_code
|
|
2652
|
-
}).describe(
|
|
2653
|
-
|
|
2654
|
-
|
|
2840
|
+
}).describe(`
|
|
2841
|
+
---
|
|
2842
|
+
route_path: /devices
|
|
2843
|
+
---
|
|
2844
|
+
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\`.
|
|
2845
|
+
`);
|
|
2655
2846
|
var unmanaged_device_disconnected_event = device_event.extend({
|
|
2656
2847
|
event_type: zod.z.literal("device.unmanaged.disconnected"),
|
|
2657
2848
|
error_code: disconnection_error_code
|
|
2658
|
-
}).describe(
|
|
2659
|
-
|
|
2660
|
-
|
|
2849
|
+
}).describe(`
|
|
2850
|
+
---
|
|
2851
|
+
route_path: /devices/unmanaged
|
|
2852
|
+
---
|
|
2853
|
+
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\`.
|
|
2854
|
+
`);
|
|
2661
2855
|
var device_tampered_event = device_event.extend({
|
|
2662
2856
|
event_type: zod.z.literal("device.tampered")
|
|
2663
|
-
}).describe(
|
|
2664
|
-
|
|
2665
|
-
|
|
2857
|
+
}).describe(`
|
|
2858
|
+
---
|
|
2859
|
+
route_path: /devices
|
|
2860
|
+
---
|
|
2861
|
+
A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.
|
|
2862
|
+
`);
|
|
2666
2863
|
var device_low_battery_event = device_event.extend({
|
|
2667
2864
|
event_type: zod.z.literal("device.low_battery"),
|
|
2668
2865
|
battery_level
|
|
2669
|
-
}).describe(
|
|
2670
|
-
|
|
2671
|
-
|
|
2866
|
+
}).describe(`
|
|
2867
|
+
---
|
|
2868
|
+
route_path: /devices
|
|
2869
|
+
---
|
|
2870
|
+
A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.
|
|
2871
|
+
`);
|
|
2672
2872
|
var device_battery_status_changed_event = device_event.extend({
|
|
2673
2873
|
event_type: zod.z.literal("device.battery_status_changed"),
|
|
2674
2874
|
battery_status: device_battery_status,
|
|
2675
2875
|
battery_level
|
|
2676
|
-
}).describe(
|
|
2677
|
-
|
|
2678
|
-
|
|
2876
|
+
}).describe(`
|
|
2877
|
+
---
|
|
2878
|
+
route_path: /devices
|
|
2879
|
+
---
|
|
2880
|
+
A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last \`battery_status_changed\` event.
|
|
2881
|
+
`);
|
|
2679
2882
|
var device_removed_event = device_event.extend({
|
|
2680
2883
|
event_type: zod.z.literal("device.removed")
|
|
2681
|
-
}).describe(
|
|
2682
|
-
|
|
2683
|
-
|
|
2884
|
+
}).describe(`
|
|
2885
|
+
---
|
|
2886
|
+
route_path: /devices
|
|
2887
|
+
---
|
|
2888
|
+
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).
|
|
2889
|
+
`);
|
|
2684
2890
|
var device_deleted_event = device_event.extend({
|
|
2685
2891
|
event_type: zod.z.literal("device.deleted")
|
|
2686
|
-
}).describe(
|
|
2687
|
-
|
|
2688
|
-
|
|
2892
|
+
}).describe(`
|
|
2893
|
+
---
|
|
2894
|
+
route_path: /devices
|
|
2895
|
+
---
|
|
2896
|
+
A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.
|
|
2897
|
+
`);
|
|
2689
2898
|
var device_third_party_integration_detected_event = device_event.extend({
|
|
2690
2899
|
event_type: zod.z.literal("device.third_party_integration_detected")
|
|
2691
|
-
}).describe(
|
|
2692
|
-
|
|
2693
|
-
|
|
2900
|
+
}).describe(`
|
|
2901
|
+
---
|
|
2902
|
+
route_path: /devices
|
|
2903
|
+
---
|
|
2904
|
+
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.
|
|
2905
|
+
`);
|
|
2694
2906
|
var device_third_party_integration_no_longer_detected_event = device_event.extend({
|
|
2695
|
-
event_type: zod.z.literal(
|
|
2696
|
-
|
|
2697
|
-
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
)
|
|
2907
|
+
event_type: zod.z.literal("device.third_party_integration_no_longer_detected")
|
|
2908
|
+
}).describe(`
|
|
2909
|
+
---
|
|
2910
|
+
route_path: /devices
|
|
2911
|
+
---
|
|
2912
|
+
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.
|
|
2913
|
+
`);
|
|
2701
2914
|
var device_salto_privacy_mode_activated_event = device_event.extend({
|
|
2702
|
-
event_type: zod.z.literal("device.salto.privacy_mode_activated")
|
|
2703
|
-
}).describe(
|
|
2704
|
-
|
|
2705
|
-
|
|
2915
|
+
event_type: zod.z.literal("device.salto.privacy_mode_activated")
|
|
2916
|
+
}).describe(`
|
|
2917
|
+
---
|
|
2918
|
+
route_path: /devices
|
|
2919
|
+
---
|
|
2920
|
+
A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.
|
|
2921
|
+
`);
|
|
2706
2922
|
var device_salto_privacy_mode_deactivated_event = device_event.extend({
|
|
2707
2923
|
event_type: zod.z.literal("device.salto.privacy_mode_deactivated")
|
|
2708
|
-
}).describe(
|
|
2709
|
-
|
|
2710
|
-
|
|
2924
|
+
}).describe(`
|
|
2925
|
+
---
|
|
2926
|
+
route_path: /devices
|
|
2927
|
+
---
|
|
2928
|
+
A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.
|
|
2929
|
+
`);
|
|
2711
2930
|
var device_connection_became_flaky_event = device_event.extend({
|
|
2712
2931
|
event_type: zod.z.literal("device.connection_became_flaky")
|
|
2713
|
-
}).describe(
|
|
2714
|
-
|
|
2715
|
-
|
|
2932
|
+
}).describe(`
|
|
2933
|
+
---
|
|
2934
|
+
route_path: /devices
|
|
2935
|
+
---
|
|
2936
|
+
Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.
|
|
2937
|
+
`);
|
|
2716
2938
|
var device_connection_stabilized_event = device_event.extend({
|
|
2717
2939
|
event_type: zod.z.literal("device.connection_stabilized")
|
|
2718
|
-
}).describe(
|
|
2719
|
-
|
|
2720
|
-
|
|
2940
|
+
}).describe(`
|
|
2941
|
+
---
|
|
2942
|
+
route_path: /devices
|
|
2943
|
+
---
|
|
2944
|
+
Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.
|
|
2945
|
+
`);
|
|
2721
2946
|
var device_error_subscription_required_event = device_event.extend({
|
|
2722
2947
|
event_type: zod.z.literal("device.error.subscription_required")
|
|
2723
|
-
}).describe(
|
|
2724
|
-
|
|
2725
|
-
|
|
2948
|
+
}).describe(`
|
|
2949
|
+
---
|
|
2950
|
+
route_path: /devices
|
|
2951
|
+
---
|
|
2952
|
+
A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.
|
|
2953
|
+
`);
|
|
2726
2954
|
var device_error_subscription_required_resolved_event = device_event.extend({
|
|
2727
2955
|
event_type: zod.z.literal("device.error.subscription_required.resolved")
|
|
2728
|
-
}).describe(
|
|
2729
|
-
|
|
2730
|
-
|
|
2956
|
+
}).describe(`
|
|
2957
|
+
---
|
|
2958
|
+
route_path: /devices
|
|
2959
|
+
---
|
|
2960
|
+
A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.
|
|
2961
|
+
`);
|
|
2731
2962
|
var device_accessory_keypad_connected_event = device_event.extend({
|
|
2732
2963
|
event_type: zod.z.literal("device.accessory_keypad_connected")
|
|
2733
|
-
}).describe(
|
|
2734
|
-
|
|
2735
|
-
|
|
2964
|
+
}).describe(`
|
|
2965
|
+
---
|
|
2966
|
+
route_path: /devices
|
|
2967
|
+
---
|
|
2968
|
+
An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).
|
|
2969
|
+
`);
|
|
2736
2970
|
var device_accessory_keypad_disconnected_event = device_event.extend({
|
|
2737
2971
|
event_type: zod.z.literal("device.accessory_keypad_disconnected")
|
|
2738
|
-
}).describe(
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2745
|
-
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
|
|
2753
|
-
|
|
2754
|
-
|
|
2755
|
-
|
|
2756
|
-
)
|
|
2972
|
+
}).describe(`
|
|
2973
|
+
---
|
|
2974
|
+
route_path: /devices
|
|
2975
|
+
---
|
|
2976
|
+
An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).
|
|
2977
|
+
`);
|
|
2978
|
+
var noise_sensor_noise_threshold_triggered_event = device_event.extend(
|
|
2979
|
+
{
|
|
2980
|
+
event_type: zod.z.literal("noise_sensor.noise_threshold_triggered"),
|
|
2981
|
+
noise_level_decibels: zod.z.number().optional().describe("Detected noise level in decibels."),
|
|
2982
|
+
noise_level_nrs: zod.z.number().optional().describe("Detected noise level in Noiseaware Noise Risk Score (NRS)."),
|
|
2983
|
+
noise_threshold_id: zod.z.string().uuid().optional().describe(
|
|
2984
|
+
"ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered."
|
|
2985
|
+
),
|
|
2986
|
+
noise_threshold_name: zod.z.string().optional().describe(
|
|
2987
|
+
"Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered."
|
|
2988
|
+
),
|
|
2989
|
+
// TODO: remove metadata from this event
|
|
2990
|
+
noiseaware_metadata: zod.z.record(zod.z.unknown()).optional().describe("Metadata from Noiseaware."),
|
|
2991
|
+
minut_metadata: zod.z.record(zod.z.unknown()).optional().describe("Metadata from Minut.")
|
|
2992
|
+
}
|
|
2993
|
+
).describe(`
|
|
2994
|
+
---
|
|
2995
|
+
route_path: /noise_sensors/noise_thresholds
|
|
2996
|
+
---
|
|
2997
|
+
Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.
|
|
2998
|
+
`);
|
|
2757
2999
|
var lock_locked_event = device_event.extend({
|
|
2758
3000
|
event_type: zod.z.literal("lock.locked"),
|
|
2759
3001
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
@@ -2765,9 +3007,12 @@ var lock_locked_event = device_event.extend({
|
|
|
2765
3007
|
method: lock_method.describe(
|
|
2766
3008
|
"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."
|
|
2767
3009
|
)
|
|
2768
|
-
}).describe(
|
|
2769
|
-
|
|
2770
|
-
|
|
3010
|
+
}).describe(`
|
|
3011
|
+
---
|
|
3012
|
+
route_path: /locks
|
|
3013
|
+
---
|
|
3014
|
+
A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.
|
|
3015
|
+
`);
|
|
2771
3016
|
var lock_unlocked_event = device_event.extend({
|
|
2772
3017
|
event_type: zod.z.literal("lock.unlocked"),
|
|
2773
3018
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
@@ -2779,17 +3024,23 @@ var lock_unlocked_event = device_event.extend({
|
|
|
2779
3024
|
method: lock_method.describe(
|
|
2780
3025
|
"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."
|
|
2781
3026
|
)
|
|
2782
|
-
}).describe(
|
|
2783
|
-
|
|
2784
|
-
|
|
3027
|
+
}).describe(`
|
|
3028
|
+
---
|
|
3029
|
+
route_path: /locks
|
|
3030
|
+
---
|
|
3031
|
+
A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.
|
|
3032
|
+
`);
|
|
2785
3033
|
var lock_access_denied_event = device_event.extend({
|
|
2786
3034
|
event_type: zod.z.literal("lock.access_denied"),
|
|
2787
3035
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
2788
3036
|
"ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts."
|
|
2789
3037
|
)
|
|
2790
|
-
}).describe(
|
|
2791
|
-
|
|
2792
|
-
|
|
3038
|
+
}).describe(`
|
|
3039
|
+
---
|
|
3040
|
+
route_path: /locks
|
|
3041
|
+
---
|
|
3042
|
+
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.
|
|
3043
|
+
`);
|
|
2793
3044
|
var thermostat_climate_preset_activated_event = device_event.extend({
|
|
2794
3045
|
event_type: zod.z.literal("thermostat.climate_preset_activated"),
|
|
2795
3046
|
thermostat_schedule_id: zod.z.string().uuid().nullable().describe(
|
|
@@ -2801,9 +3052,12 @@ var thermostat_climate_preset_activated_event = device_event.extend({
|
|
|
2801
3052
|
is_fallback_climate_preset: zod.z.boolean().describe(
|
|
2802
3053
|
"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)."
|
|
2803
3054
|
)
|
|
2804
|
-
}).describe(
|
|
2805
|
-
|
|
2806
|
-
|
|
3055
|
+
}).describe(`
|
|
3056
|
+
---
|
|
3057
|
+
route_path: /thermostats
|
|
3058
|
+
---
|
|
3059
|
+
A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.
|
|
3060
|
+
`);
|
|
2807
3061
|
var thermostat_manually_adjusted_method = zod.z.enum(["seam", "external"]).describe(
|
|
2808
3062
|
"Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
|
|
2809
3063
|
);
|
|
@@ -2819,9 +3073,12 @@ var thermostat_manually_adjusted_event = device_event.extend({
|
|
|
2819
3073
|
cooling_set_point_fahrenheit: true,
|
|
2820
3074
|
heating_set_point_fahrenheit: true
|
|
2821
3075
|
})
|
|
2822
|
-
).describe(
|
|
2823
|
-
|
|
2824
|
-
|
|
3076
|
+
).describe(`
|
|
3077
|
+
---
|
|
3078
|
+
route_path: /thermostats
|
|
3079
|
+
---
|
|
3080
|
+
A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.
|
|
3081
|
+
`);
|
|
2825
3082
|
var temperature_threshold_exceeded_event = device_event.extend({
|
|
2826
3083
|
event_type: zod.z.literal("thermostat.temperature_threshold_exceeded"),
|
|
2827
3084
|
temperature_celsius: zod.z.number().describe(
|
|
@@ -2842,9 +3099,12 @@ var temperature_threshold_exceeded_event = device_event.extend({
|
|
|
2842
3099
|
lower_limit_fahrenheit: zod.z.number().nullable().describe(
|
|
2843
3100
|
"Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
|
|
2844
3101
|
)
|
|
2845
|
-
}).describe(
|
|
2846
|
-
|
|
2847
|
-
|
|
3102
|
+
}).describe(`
|
|
3103
|
+
---
|
|
3104
|
+
route_path: /thermostats
|
|
3105
|
+
---
|
|
3106
|
+
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).
|
|
3107
|
+
`);
|
|
2848
3108
|
var temperature_threshold_no_longer_exceeded_event = device_event.extend({
|
|
2849
3109
|
event_type: zod.z.literal(
|
|
2850
3110
|
"thermostat.temperature_threshold_no_longer_exceeded"
|
|
@@ -2867,9 +3127,12 @@ var temperature_threshold_no_longer_exceeded_event = device_event.extend({
|
|
|
2867
3127
|
lower_limit_fahrenheit: zod.z.number().nullable().describe(
|
|
2868
3128
|
"Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
|
|
2869
3129
|
)
|
|
2870
|
-
}).describe(
|
|
2871
|
-
|
|
2872
|
-
|
|
3130
|
+
}).describe(`
|
|
3131
|
+
---
|
|
3132
|
+
route_path: /thermostats
|
|
3133
|
+
---
|
|
3134
|
+
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).
|
|
3135
|
+
`);
|
|
2873
3136
|
var temperature_reached_set_point_event = device_event.extend({
|
|
2874
3137
|
event_type: zod.z.literal("thermostat.temperature_reached_set_point"),
|
|
2875
3138
|
temperature_celsius: zod.z.number().describe("Temperature, in \xB0C, reported by the thermostat."),
|
|
@@ -2880,7 +3143,11 @@ var temperature_reached_set_point_event = device_event.extend({
|
|
|
2880
3143
|
desired_temperature_fahrenheit: zod.z.number().optional().describe(
|
|
2881
3144
|
"Desired temperature, in \xB0F, set by the thermostat's cooling or heating set point."
|
|
2882
3145
|
)
|
|
2883
|
-
})
|
|
3146
|
+
}).describe(`
|
|
3147
|
+
---
|
|
3148
|
+
route_path: /thermostats
|
|
3149
|
+
---
|
|
3150
|
+
`);
|
|
2884
3151
|
var device_events = [
|
|
2885
3152
|
device_connected_event,
|
|
2886
3153
|
device_added_event,
|
|
@@ -2921,9 +3188,12 @@ var enrollment_automation_event = common_event.extend({
|
|
|
2921
3188
|
});
|
|
2922
3189
|
var enrollment_automation_deleted_event = enrollment_automation_event.extend({
|
|
2923
3190
|
event_type: zod.z.literal("enrollment_automation.deleted")
|
|
2924
|
-
}).describe(
|
|
2925
|
-
|
|
2926
|
-
|
|
3191
|
+
}).describe(`
|
|
3192
|
+
---
|
|
3193
|
+
route_path: /user_identities/enrollment_automations
|
|
3194
|
+
---
|
|
3195
|
+
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.
|
|
3196
|
+
`);
|
|
2927
3197
|
var enrollment_automation_events = [
|
|
2928
3198
|
enrollment_automation_deleted_event
|
|
2929
3199
|
];
|
|
@@ -2934,7 +3204,12 @@ var phone_event = common_event.extend({
|
|
|
2934
3204
|
});
|
|
2935
3205
|
var phone_deactivated_event = phone_event.extend({
|
|
2936
3206
|
event_type: zod.z.literal("phone.deactivated")
|
|
2937
|
-
}).describe(
|
|
3207
|
+
}).describe(`
|
|
3208
|
+
---
|
|
3209
|
+
route_path: /phones
|
|
3210
|
+
---
|
|
3211
|
+
A phone device was deactivated.
|
|
3212
|
+
`);
|
|
2938
3213
|
var phone_events = [phone_deactivated_event];
|
|
2939
3214
|
|
|
2940
3215
|
// src/lib/seam/connect/models/events/seam-event.ts
|
|
@@ -2948,7 +3223,11 @@ var seam_event = zod.z.discriminatedUnion("event_type", [
|
|
|
2948
3223
|
...device_events,
|
|
2949
3224
|
...enrollment_automation_events,
|
|
2950
3225
|
...phone_events
|
|
2951
|
-
])
|
|
3226
|
+
]).describe(`
|
|
3227
|
+
---
|
|
3228
|
+
route_path: /events
|
|
3229
|
+
---
|
|
3230
|
+
`);
|
|
2952
3231
|
var noise_threshold = zod.z.object({
|
|
2953
3232
|
noise_threshold_id: zod.z.string().uuid(),
|
|
2954
3233
|
device_id: zod.z.string().uuid(),
|
|
@@ -2959,7 +3238,11 @@ var noise_threshold = zod.z.object({
|
|
|
2959
3238
|
ends_daily_at: zod.z.string(),
|
|
2960
3239
|
// TODO: zoned_time
|
|
2961
3240
|
noise_threshold_decibels: zod.z.number()
|
|
2962
|
-
})
|
|
3241
|
+
}).describe(`
|
|
3242
|
+
---
|
|
3243
|
+
route_path: /noise_sensors/noise_thresholds
|
|
3244
|
+
---
|
|
3245
|
+
`);
|
|
2963
3246
|
var user_identity = zod.z.object({
|
|
2964
3247
|
user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
|
|
2965
3248
|
user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
|
|
@@ -2973,15 +3256,22 @@ var user_identity = zod.z.object({
|
|
|
2973
3256
|
workspace_id: zod.z.string().uuid().describe(
|
|
2974
3257
|
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity."
|
|
2975
3258
|
)
|
|
2976
|
-
}).describe(
|
|
2977
|
-
|
|
2978
|
-
|
|
3259
|
+
}).describe(`
|
|
3260
|
+
---
|
|
3261
|
+
route_path: /user_identities
|
|
3262
|
+
---
|
|
3263
|
+
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.
|
|
3264
|
+
`);
|
|
2979
3265
|
var webhook = zod.z.object({
|
|
2980
3266
|
webhook_id: zod.z.string(),
|
|
2981
3267
|
url: zod.z.string(),
|
|
2982
3268
|
event_types: zod.z.array(zod.z.string()).optional(),
|
|
2983
3269
|
secret: zod.z.string().optional()
|
|
2984
|
-
})
|
|
3270
|
+
}).describe(`
|
|
3271
|
+
---
|
|
3272
|
+
route_path: /webhooks
|
|
3273
|
+
---
|
|
3274
|
+
`);
|
|
2985
3275
|
var workspace = zod.z.object({
|
|
2986
3276
|
workspace_id: zod.z.string().uuid(),
|
|
2987
3277
|
name: zod.z.string(),
|
|
@@ -2994,7 +3284,11 @@ var workspace = zod.z.object({
|
|
|
2994
3284
|
---
|
|
2995
3285
|
`
|
|
2996
3286
|
).nullable()
|
|
2997
|
-
})
|
|
3287
|
+
}).describe(`
|
|
3288
|
+
---
|
|
3289
|
+
route_path: /workspaces
|
|
3290
|
+
---
|
|
3291
|
+
`);
|
|
2998
3292
|
|
|
2999
3293
|
// src/lib/seam/connect/openapi.ts
|
|
3000
3294
|
var openapi_default = {
|
|
@@ -3343,7 +3637,8 @@ var openapi_default = {
|
|
|
3343
3637
|
"is_one_time_use",
|
|
3344
3638
|
"is_offline_access_code"
|
|
3345
3639
|
],
|
|
3346
|
-
type: "object"
|
|
3640
|
+
type: "object",
|
|
3641
|
+
"x-route-path": "/access_codes"
|
|
3347
3642
|
},
|
|
3348
3643
|
acs_access_group: {
|
|
3349
3644
|
description: "Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.\nThe `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).",
|
|
@@ -3445,7 +3740,8 @@ var openapi_default = {
|
|
|
3445
3740
|
"warnings",
|
|
3446
3741
|
"is_managed"
|
|
3447
3742
|
],
|
|
3448
|
-
type: "object"
|
|
3743
|
+
type: "object",
|
|
3744
|
+
"x-route-path": "/acs/access_groups"
|
|
3449
3745
|
},
|
|
3450
3746
|
acs_credential: {
|
|
3451
3747
|
description: "Means by which a user gains access at an entrance.\nThe `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
@@ -3725,7 +4021,8 @@ var openapi_default = {
|
|
|
3725
4021
|
"created_at",
|
|
3726
4022
|
"workspace_id"
|
|
3727
4023
|
],
|
|
3728
|
-
type: "object"
|
|
4024
|
+
type: "object",
|
|
4025
|
+
"x-route-path": "/acs/credential_pools"
|
|
3729
4026
|
},
|
|
3730
4027
|
acs_credential_provisioning_automation: {
|
|
3731
4028
|
properties: {
|
|
@@ -3745,7 +4042,8 @@ var openapi_default = {
|
|
|
3745
4042
|
"created_at",
|
|
3746
4043
|
"workspace_id"
|
|
3747
4044
|
],
|
|
3748
|
-
type: "object"
|
|
4045
|
+
type: "object",
|
|
4046
|
+
"x-route-path": "/acs/credential_provisioning_automations"
|
|
3749
4047
|
},
|
|
3750
4048
|
acs_entrance: {
|
|
3751
4049
|
description: "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
@@ -3784,10 +4082,7 @@ var openapi_default = {
|
|
|
3784
4082
|
type: "string"
|
|
3785
4083
|
},
|
|
3786
4084
|
dormakaba_community_metadata: {
|
|
3787
|
-
properties: {
|
|
3788
|
-
access_point_name: { type: "string" },
|
|
3789
|
-
common_area_number: { format: "float", type: "number" }
|
|
3790
|
-
},
|
|
4085
|
+
properties: { access_point_name: { type: "string" } },
|
|
3791
4086
|
required: ["access_point_name"],
|
|
3792
4087
|
type: "object"
|
|
3793
4088
|
},
|
|
@@ -3887,7 +4182,8 @@ var openapi_default = {
|
|
|
3887
4182
|
"display_name",
|
|
3888
4183
|
"errors"
|
|
3889
4184
|
],
|
|
3890
|
-
type: "object"
|
|
4185
|
+
type: "object",
|
|
4186
|
+
"x-route-path": "/acs/entrances"
|
|
3891
4187
|
},
|
|
3892
4188
|
acs_system: {
|
|
3893
4189
|
description: "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
@@ -4234,7 +4530,8 @@ var openapi_default = {
|
|
|
4234
4530
|
"errors",
|
|
4235
4531
|
"warnings"
|
|
4236
4532
|
],
|
|
4237
|
-
type: "object"
|
|
4533
|
+
type: "object",
|
|
4534
|
+
"x-route-path": "/acs/systems"
|
|
4238
4535
|
},
|
|
4239
4536
|
acs_user: {
|
|
4240
4537
|
description: "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
@@ -4504,7 +4801,8 @@ var openapi_default = {
|
|
|
4504
4801
|
"errors",
|
|
4505
4802
|
"is_managed"
|
|
4506
4803
|
],
|
|
4507
|
-
type: "object"
|
|
4804
|
+
type: "object",
|
|
4805
|
+
"x-route-path": "/acs/users"
|
|
4508
4806
|
},
|
|
4509
4807
|
action_attempt: {
|
|
4510
4808
|
oneOf: [
|
|
@@ -6982,7 +7280,8 @@ var openapi_default = {
|
|
|
6982
7280
|
],
|
|
6983
7281
|
type: "object"
|
|
6984
7282
|
}
|
|
6985
|
-
]
|
|
7283
|
+
],
|
|
7284
|
+
"x-route-path": "/action_attempts"
|
|
6986
7285
|
},
|
|
6987
7286
|
client_session: {
|
|
6988
7287
|
properties: {
|
|
@@ -7018,7 +7317,8 @@ var openapi_default = {
|
|
|
7018
7317
|
"connect_webview_ids",
|
|
7019
7318
|
"user_identity_ids"
|
|
7020
7319
|
],
|
|
7021
|
-
type: "object"
|
|
7320
|
+
type: "object",
|
|
7321
|
+
"x-route-path": "/client_sessions"
|
|
7022
7322
|
},
|
|
7023
7323
|
connect_webview: {
|
|
7024
7324
|
properties: {
|
|
@@ -7096,7 +7396,8 @@ var openapi_default = {
|
|
|
7096
7396
|
"authorized_at",
|
|
7097
7397
|
"selected_provider"
|
|
7098
7398
|
],
|
|
7099
|
-
type: "object"
|
|
7399
|
+
type: "object",
|
|
7400
|
+
"x-route-path": "/connect_webviews"
|
|
7100
7401
|
},
|
|
7101
7402
|
connected_account: {
|
|
7102
7403
|
properties: {
|
|
@@ -7170,7 +7471,8 @@ var openapi_default = {
|
|
|
7170
7471
|
"custom_metadata",
|
|
7171
7472
|
"automatically_manage_new_devices"
|
|
7172
7473
|
],
|
|
7173
|
-
type: "object"
|
|
7474
|
+
type: "object",
|
|
7475
|
+
"x-route-path": "/connected_accounts"
|
|
7174
7476
|
},
|
|
7175
7477
|
device: {
|
|
7176
7478
|
properties: {
|
|
@@ -8381,7 +8683,8 @@ var openapi_default = {
|
|
|
8381
8683
|
"created_at",
|
|
8382
8684
|
"errors"
|
|
8383
8685
|
],
|
|
8384
|
-
type: "object"
|
|
8686
|
+
type: "object",
|
|
8687
|
+
"x-route-path": "/thermostats/schedules"
|
|
8385
8688
|
},
|
|
8386
8689
|
available_climate_presets: {
|
|
8387
8690
|
items: {
|
|
@@ -8737,7 +9040,8 @@ var openapi_default = {
|
|
|
8737
9040
|
"is_managed",
|
|
8738
9041
|
"custom_metadata"
|
|
8739
9042
|
],
|
|
8740
|
-
type: "object"
|
|
9043
|
+
type: "object",
|
|
9044
|
+
"x-route-path": "/devices"
|
|
8741
9045
|
},
|
|
8742
9046
|
device_provider: {
|
|
8743
9047
|
properties: {
|
|
@@ -8824,7 +9128,8 @@ var openapi_default = {
|
|
|
8824
9128
|
"image_url",
|
|
8825
9129
|
"provider_categories"
|
|
8826
9130
|
],
|
|
8827
|
-
type: "object"
|
|
9131
|
+
type: "object",
|
|
9132
|
+
"x-route-path": "/devices"
|
|
8828
9133
|
},
|
|
8829
9134
|
enrollment_automation: {
|
|
8830
9135
|
description: "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).",
|
|
@@ -8862,7 +9167,8 @@ var openapi_default = {
|
|
|
8862
9167
|
"created_at",
|
|
8863
9168
|
"workspace_id"
|
|
8864
9169
|
],
|
|
8865
|
-
type: "object"
|
|
9170
|
+
type: "object",
|
|
9171
|
+
"x-route-path": "/user_identities/enrollment_automations"
|
|
8866
9172
|
},
|
|
8867
9173
|
event: {
|
|
8868
9174
|
discriminator: { propertyName: "event_type" },
|
|
@@ -8917,7 +9223,8 @@ var openapi_default = {
|
|
|
8917
9223
|
"connected_account_id",
|
|
8918
9224
|
"event_type"
|
|
8919
9225
|
],
|
|
8920
|
-
type: "object"
|
|
9226
|
+
type: "object",
|
|
9227
|
+
"x-route-path": "/access_codes"
|
|
8921
9228
|
},
|
|
8922
9229
|
{
|
|
8923
9230
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.",
|
|
@@ -8969,7 +9276,8 @@ var openapi_default = {
|
|
|
8969
9276
|
"connected_account_id",
|
|
8970
9277
|
"event_type"
|
|
8971
9278
|
],
|
|
8972
|
-
type: "object"
|
|
9279
|
+
type: "object",
|
|
9280
|
+
"x-route-path": "/access_codes"
|
|
8973
9281
|
},
|
|
8974
9282
|
{
|
|
8975
9283
|
description: "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.",
|
|
@@ -9029,7 +9337,8 @@ var openapi_default = {
|
|
|
9029
9337
|
"event_type",
|
|
9030
9338
|
"code"
|
|
9031
9339
|
],
|
|
9032
|
-
type: "object"
|
|
9340
|
+
type: "object",
|
|
9341
|
+
"x-route-path": "/access_codes"
|
|
9033
9342
|
},
|
|
9034
9343
|
{
|
|
9035
9344
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.",
|
|
@@ -9089,7 +9398,8 @@ var openapi_default = {
|
|
|
9089
9398
|
"event_type",
|
|
9090
9399
|
"code"
|
|
9091
9400
|
],
|
|
9092
|
-
type: "object"
|
|
9401
|
+
type: "object",
|
|
9402
|
+
"x-route-path": "/access_codes"
|
|
9093
9403
|
},
|
|
9094
9404
|
{
|
|
9095
9405
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.",
|
|
@@ -9144,7 +9454,8 @@ var openapi_default = {
|
|
|
9144
9454
|
"connected_account_id",
|
|
9145
9455
|
"event_type"
|
|
9146
9456
|
],
|
|
9147
|
-
type: "object"
|
|
9457
|
+
type: "object",
|
|
9458
|
+
"x-route-path": "/access_codes"
|
|
9148
9459
|
},
|
|
9149
9460
|
{
|
|
9150
9461
|
description: "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.",
|
|
@@ -9199,7 +9510,8 @@ var openapi_default = {
|
|
|
9199
9510
|
"connected_account_id",
|
|
9200
9511
|
"event_type"
|
|
9201
9512
|
],
|
|
9202
|
-
type: "object"
|
|
9513
|
+
type: "object",
|
|
9514
|
+
"x-route-path": "/access_codes"
|
|
9203
9515
|
},
|
|
9204
9516
|
{
|
|
9205
9517
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.",
|
|
@@ -9254,7 +9566,8 @@ var openapi_default = {
|
|
|
9254
9566
|
"connected_account_id",
|
|
9255
9567
|
"event_type"
|
|
9256
9568
|
],
|
|
9257
|
-
type: "object"
|
|
9569
|
+
type: "object",
|
|
9570
|
+
"x-route-path": "/access_codes"
|
|
9258
9571
|
},
|
|
9259
9572
|
{
|
|
9260
9573
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.",
|
|
@@ -9312,7 +9625,8 @@ var openapi_default = {
|
|
|
9312
9625
|
"event_type",
|
|
9313
9626
|
"code"
|
|
9314
9627
|
],
|
|
9315
|
-
type: "object"
|
|
9628
|
+
type: "object",
|
|
9629
|
+
"x-route-path": "/access_codes"
|
|
9316
9630
|
},
|
|
9317
9631
|
{
|
|
9318
9632
|
description: "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.",
|
|
@@ -9367,7 +9681,8 @@ var openapi_default = {
|
|
|
9367
9681
|
"connected_account_id",
|
|
9368
9682
|
"event_type"
|
|
9369
9683
|
],
|
|
9370
|
-
type: "object"
|
|
9684
|
+
type: "object",
|
|
9685
|
+
"x-route-path": "/access_codes"
|
|
9371
9686
|
},
|
|
9372
9687
|
{
|
|
9373
9688
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.",
|
|
@@ -9422,7 +9737,8 @@ var openapi_default = {
|
|
|
9422
9737
|
"connected_account_id",
|
|
9423
9738
|
"event_type"
|
|
9424
9739
|
],
|
|
9425
|
-
type: "object"
|
|
9740
|
+
type: "object",
|
|
9741
|
+
"x-route-path": "/access_codes"
|
|
9426
9742
|
},
|
|
9427
9743
|
{
|
|
9428
9744
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.",
|
|
@@ -9477,7 +9793,8 @@ var openapi_default = {
|
|
|
9477
9793
|
"connected_account_id",
|
|
9478
9794
|
"event_type"
|
|
9479
9795
|
],
|
|
9480
|
-
type: "object"
|
|
9796
|
+
type: "object",
|
|
9797
|
+
"x-route-path": "/access_codes"
|
|
9481
9798
|
},
|
|
9482
9799
|
{
|
|
9483
9800
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.",
|
|
@@ -9532,7 +9849,8 @@ var openapi_default = {
|
|
|
9532
9849
|
"connected_account_id",
|
|
9533
9850
|
"event_type"
|
|
9534
9851
|
],
|
|
9535
|
-
type: "object"
|
|
9852
|
+
type: "object",
|
|
9853
|
+
"x-route-path": "/access_codes"
|
|
9536
9854
|
},
|
|
9537
9855
|
{
|
|
9538
9856
|
description: "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.",
|
|
@@ -9589,7 +9907,8 @@ var openapi_default = {
|
|
|
9589
9907
|
"event_type",
|
|
9590
9908
|
"backup_access_code_id"
|
|
9591
9909
|
],
|
|
9592
|
-
type: "object"
|
|
9910
|
+
type: "object",
|
|
9911
|
+
"x-route-path": "/access_codes"
|
|
9593
9912
|
},
|
|
9594
9913
|
{
|
|
9595
9914
|
description: "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.",
|
|
@@ -9644,7 +9963,8 @@ var openapi_default = {
|
|
|
9644
9963
|
"connected_account_id",
|
|
9645
9964
|
"event_type"
|
|
9646
9965
|
],
|
|
9647
|
-
type: "object"
|
|
9966
|
+
type: "object",
|
|
9967
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9648
9968
|
},
|
|
9649
9969
|
{
|
|
9650
9970
|
description: "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.",
|
|
@@ -9699,7 +10019,8 @@ var openapi_default = {
|
|
|
9699
10019
|
"connected_account_id",
|
|
9700
10020
|
"event_type"
|
|
9701
10021
|
],
|
|
9702
|
-
type: "object"
|
|
10022
|
+
type: "object",
|
|
10023
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9703
10024
|
},
|
|
9704
10025
|
{
|
|
9705
10026
|
description: "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.",
|
|
@@ -9754,7 +10075,8 @@ var openapi_default = {
|
|
|
9754
10075
|
"connected_account_id",
|
|
9755
10076
|
"event_type"
|
|
9756
10077
|
],
|
|
9757
|
-
type: "object"
|
|
10078
|
+
type: "object",
|
|
10079
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9758
10080
|
},
|
|
9759
10081
|
{
|
|
9760
10082
|
description: "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.",
|
|
@@ -9809,7 +10131,8 @@ var openapi_default = {
|
|
|
9809
10131
|
"connected_account_id",
|
|
9810
10132
|
"event_type"
|
|
9811
10133
|
],
|
|
9812
|
-
type: "object"
|
|
10134
|
+
type: "object",
|
|
10135
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9813
10136
|
},
|
|
9814
10137
|
{
|
|
9815
10138
|
description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.",
|
|
@@ -9854,7 +10177,8 @@ var openapi_default = {
|
|
|
9854
10177
|
"acs_system_id",
|
|
9855
10178
|
"event_type"
|
|
9856
10179
|
],
|
|
9857
|
-
type: "object"
|
|
10180
|
+
type: "object",
|
|
10181
|
+
"x-route-path": "/acs/systems"
|
|
9858
10182
|
},
|
|
9859
10183
|
{
|
|
9860
10184
|
description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.",
|
|
@@ -9899,7 +10223,8 @@ var openapi_default = {
|
|
|
9899
10223
|
"acs_system_id",
|
|
9900
10224
|
"event_type"
|
|
9901
10225
|
],
|
|
9902
|
-
type: "object"
|
|
10226
|
+
type: "object",
|
|
10227
|
+
"x-route-path": "/acs/systems"
|
|
9903
10228
|
},
|
|
9904
10229
|
{
|
|
9905
10230
|
description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.",
|
|
@@ -9944,7 +10269,8 @@ var openapi_default = {
|
|
|
9944
10269
|
"acs_system_id",
|
|
9945
10270
|
"event_type"
|
|
9946
10271
|
],
|
|
9947
|
-
type: "object"
|
|
10272
|
+
type: "object",
|
|
10273
|
+
"x-route-path": "/acs/systems"
|
|
9948
10274
|
},
|
|
9949
10275
|
{
|
|
9950
10276
|
description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.",
|
|
@@ -9991,7 +10317,8 @@ var openapi_default = {
|
|
|
9991
10317
|
"acs_credential_id",
|
|
9992
10318
|
"event_type"
|
|
9993
10319
|
],
|
|
9994
|
-
type: "object"
|
|
10320
|
+
type: "object",
|
|
10321
|
+
"x-route-path": "/acs/credentials"
|
|
9995
10322
|
},
|
|
9996
10323
|
{
|
|
9997
10324
|
description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.",
|
|
@@ -10038,7 +10365,8 @@ var openapi_default = {
|
|
|
10038
10365
|
"acs_credential_id",
|
|
10039
10366
|
"event_type"
|
|
10040
10367
|
],
|
|
10041
|
-
type: "object"
|
|
10368
|
+
type: "object",
|
|
10369
|
+
"x-route-path": "/acs/credentials"
|
|
10042
10370
|
},
|
|
10043
10371
|
{
|
|
10044
10372
|
description: "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.",
|
|
@@ -10085,7 +10413,8 @@ var openapi_default = {
|
|
|
10085
10413
|
"acs_user_id",
|
|
10086
10414
|
"event_type"
|
|
10087
10415
|
],
|
|
10088
|
-
type: "object"
|
|
10416
|
+
type: "object",
|
|
10417
|
+
"x-route-path": "/acs/users"
|
|
10089
10418
|
},
|
|
10090
10419
|
{
|
|
10091
10420
|
description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.",
|
|
@@ -10136,7 +10465,8 @@ var openapi_default = {
|
|
|
10136
10465
|
"acs_encoder_id",
|
|
10137
10466
|
"event_type"
|
|
10138
10467
|
],
|
|
10139
|
-
type: "object"
|
|
10468
|
+
type: "object",
|
|
10469
|
+
"x-route-path": "/acs/encoders"
|
|
10140
10470
|
},
|
|
10141
10471
|
{
|
|
10142
10472
|
description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.",
|
|
@@ -10187,7 +10517,8 @@ var openapi_default = {
|
|
|
10187
10517
|
"acs_encoder_id",
|
|
10188
10518
|
"event_type"
|
|
10189
10519
|
],
|
|
10190
|
-
type: "object"
|
|
10520
|
+
type: "object",
|
|
10521
|
+
"x-route-path": "/acs/encoders"
|
|
10191
10522
|
},
|
|
10192
10523
|
{
|
|
10193
10524
|
description: "An ACS access group was deleted.",
|
|
@@ -10237,7 +10568,8 @@ var openapi_default = {
|
|
|
10237
10568
|
"acs_access_group_id",
|
|
10238
10569
|
"event_type"
|
|
10239
10570
|
],
|
|
10240
|
-
type: "object"
|
|
10571
|
+
type: "object",
|
|
10572
|
+
"x-route-path": "/acs/access_groups"
|
|
10241
10573
|
},
|
|
10242
10574
|
{
|
|
10243
10575
|
description: "A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.",
|
|
@@ -10277,7 +10609,8 @@ var openapi_default = {
|
|
|
10277
10609
|
"client_session_id",
|
|
10278
10610
|
"event_type"
|
|
10279
10611
|
],
|
|
10280
|
-
type: "object"
|
|
10612
|
+
type: "object",
|
|
10613
|
+
"x-route-path": "/client_sessions"
|
|
10281
10614
|
},
|
|
10282
10615
|
{
|
|
10283
10616
|
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.",
|
|
@@ -10326,7 +10659,8 @@ var openapi_default = {
|
|
|
10326
10659
|
"event_type",
|
|
10327
10660
|
"connect_webview_id"
|
|
10328
10661
|
],
|
|
10329
|
-
type: "object"
|
|
10662
|
+
type: "object",
|
|
10663
|
+
"x-route-path": "/connected_accounts"
|
|
10330
10664
|
},
|
|
10331
10665
|
{
|
|
10332
10666
|
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.",
|
|
@@ -10375,7 +10709,8 @@ var openapi_default = {
|
|
|
10375
10709
|
"event_type",
|
|
10376
10710
|
"connect_webview_id"
|
|
10377
10711
|
],
|
|
10378
|
-
type: "object"
|
|
10712
|
+
type: "object",
|
|
10713
|
+
"x-route-path": "/connected_accounts"
|
|
10379
10714
|
},
|
|
10380
10715
|
{
|
|
10381
10716
|
deprecated: true,
|
|
@@ -10426,7 +10761,8 @@ var openapi_default = {
|
|
|
10426
10761
|
"connect_webview_id"
|
|
10427
10762
|
],
|
|
10428
10763
|
type: "object",
|
|
10429
|
-
"x-deprecated": "Use `connect_webview.login_succeeded`."
|
|
10764
|
+
"x-deprecated": "Use `connect_webview.login_succeeded`.",
|
|
10765
|
+
"x-route-path": "/connected_accounts"
|
|
10430
10766
|
},
|
|
10431
10767
|
{
|
|
10432
10768
|
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.",
|
|
@@ -10469,7 +10805,8 @@ var openapi_default = {
|
|
|
10469
10805
|
"connected_account_id",
|
|
10470
10806
|
"event_type"
|
|
10471
10807
|
],
|
|
10472
|
-
type: "object"
|
|
10808
|
+
type: "object",
|
|
10809
|
+
"x-route-path": "/connected_accounts"
|
|
10473
10810
|
},
|
|
10474
10811
|
{
|
|
10475
10812
|
description: "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.",
|
|
@@ -10512,7 +10849,8 @@ var openapi_default = {
|
|
|
10512
10849
|
"connected_account_id",
|
|
10513
10850
|
"event_type"
|
|
10514
10851
|
],
|
|
10515
|
-
type: "object"
|
|
10852
|
+
type: "object",
|
|
10853
|
+
"x-route-path": "/connected_accounts"
|
|
10516
10854
|
},
|
|
10517
10855
|
{
|
|
10518
10856
|
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.",
|
|
@@ -10555,7 +10893,8 @@ var openapi_default = {
|
|
|
10555
10893
|
"connected_account_id",
|
|
10556
10894
|
"event_type"
|
|
10557
10895
|
],
|
|
10558
|
-
type: "object"
|
|
10896
|
+
type: "object",
|
|
10897
|
+
"x-route-path": "/connected_accounts"
|
|
10559
10898
|
},
|
|
10560
10899
|
{
|
|
10561
10900
|
description: "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.",
|
|
@@ -10600,7 +10939,8 @@ var openapi_default = {
|
|
|
10600
10939
|
"connected_account_id",
|
|
10601
10940
|
"event_type"
|
|
10602
10941
|
],
|
|
10603
|
-
type: "object"
|
|
10942
|
+
type: "object",
|
|
10943
|
+
"x-route-path": "/connected_accounts"
|
|
10604
10944
|
},
|
|
10605
10945
|
{
|
|
10606
10946
|
description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
|
|
@@ -10647,7 +10987,8 @@ var openapi_default = {
|
|
|
10647
10987
|
"status",
|
|
10648
10988
|
"event_type"
|
|
10649
10989
|
],
|
|
10650
|
-
type: "object"
|
|
10990
|
+
type: "object",
|
|
10991
|
+
"x-route-path": "/action_attempts"
|
|
10651
10992
|
},
|
|
10652
10993
|
{
|
|
10653
10994
|
description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
|
|
@@ -10694,7 +11035,8 @@ var openapi_default = {
|
|
|
10694
11035
|
"status",
|
|
10695
11036
|
"event_type"
|
|
10696
11037
|
],
|
|
10697
|
-
type: "object"
|
|
11038
|
+
type: "object",
|
|
11039
|
+
"x-route-path": "/action_attempts"
|
|
10698
11040
|
},
|
|
10699
11041
|
{
|
|
10700
11042
|
description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
|
|
@@ -10741,7 +11083,8 @@ var openapi_default = {
|
|
|
10741
11083
|
"status",
|
|
10742
11084
|
"event_type"
|
|
10743
11085
|
],
|
|
10744
|
-
type: "object"
|
|
11086
|
+
type: "object",
|
|
11087
|
+
"x-route-path": "/action_attempts"
|
|
10745
11088
|
},
|
|
10746
11089
|
{
|
|
10747
11090
|
description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
|
|
@@ -10788,7 +11131,8 @@ var openapi_default = {
|
|
|
10788
11131
|
"status",
|
|
10789
11132
|
"event_type"
|
|
10790
11133
|
],
|
|
10791
|
-
type: "object"
|
|
11134
|
+
type: "object",
|
|
11135
|
+
"x-route-path": "/action_attempts"
|
|
10792
11136
|
},
|
|
10793
11137
|
{
|
|
10794
11138
|
description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.",
|
|
@@ -10837,7 +11181,8 @@ var openapi_default = {
|
|
|
10837
11181
|
"event_type",
|
|
10838
11182
|
"connected_account_id"
|
|
10839
11183
|
],
|
|
10840
|
-
type: "object"
|
|
11184
|
+
type: "object",
|
|
11185
|
+
"x-route-path": "/connect_webviews"
|
|
10841
11186
|
},
|
|
10842
11187
|
{
|
|
10843
11188
|
description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.",
|
|
@@ -10880,7 +11225,8 @@ var openapi_default = {
|
|
|
10880
11225
|
"connect_webview_id",
|
|
10881
11226
|
"event_type"
|
|
10882
11227
|
],
|
|
10883
|
-
type: "object"
|
|
11228
|
+
type: "object",
|
|
11229
|
+
"x-route-path": "/connect_webviews"
|
|
10884
11230
|
},
|
|
10885
11231
|
{
|
|
10886
11232
|
description: "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.",
|
|
@@ -10926,7 +11272,8 @@ var openapi_default = {
|
|
|
10926
11272
|
"connected_account_id",
|
|
10927
11273
|
"event_type"
|
|
10928
11274
|
],
|
|
10929
|
-
type: "object"
|
|
11275
|
+
type: "object",
|
|
11276
|
+
"x-route-path": "/devices"
|
|
10930
11277
|
},
|
|
10931
11278
|
{
|
|
10932
11279
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.",
|
|
@@ -10972,10 +11319,11 @@ var openapi_default = {
|
|
|
10972
11319
|
"connected_account_id",
|
|
10973
11320
|
"event_type"
|
|
10974
11321
|
],
|
|
10975
|
-
type: "object"
|
|
11322
|
+
type: "object",
|
|
11323
|
+
"x-route-path": "/devices"
|
|
10976
11324
|
},
|
|
10977
11325
|
{
|
|
10978
|
-
description: "
|
|
11326
|
+
description: "A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
|
|
10979
11327
|
properties: {
|
|
10980
11328
|
connected_account_id: {
|
|
10981
11329
|
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
@@ -11021,10 +11369,11 @@ var openapi_default = {
|
|
|
11021
11369
|
"connected_account_id",
|
|
11022
11370
|
"event_type"
|
|
11023
11371
|
],
|
|
11024
|
-
type: "object"
|
|
11372
|
+
type: "object",
|
|
11373
|
+
"x-route-path": "/devices"
|
|
11025
11374
|
},
|
|
11026
11375
|
{
|
|
11027
|
-
description: "
|
|
11376
|
+
description: "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.",
|
|
11028
11377
|
properties: {
|
|
11029
11378
|
connected_account_id: {
|
|
11030
11379
|
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
@@ -11070,7 +11419,8 @@ var openapi_default = {
|
|
|
11070
11419
|
"connected_account_id",
|
|
11071
11420
|
"event_type"
|
|
11072
11421
|
],
|
|
11073
|
-
type: "object"
|
|
11422
|
+
type: "object",
|
|
11423
|
+
"x-route-path": "/devices/unmanaged"
|
|
11074
11424
|
},
|
|
11075
11425
|
{
|
|
11076
11426
|
description: "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`.",
|
|
@@ -11119,7 +11469,8 @@ var openapi_default = {
|
|
|
11119
11469
|
"connected_account_id",
|
|
11120
11470
|
"event_type"
|
|
11121
11471
|
],
|
|
11122
|
-
type: "object"
|
|
11472
|
+
type: "object",
|
|
11473
|
+
"x-route-path": "/devices/unmanaged"
|
|
11123
11474
|
},
|
|
11124
11475
|
{
|
|
11125
11476
|
description: "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`.",
|
|
@@ -11175,7 +11526,8 @@ var openapi_default = {
|
|
|
11175
11526
|
"event_type",
|
|
11176
11527
|
"error_code"
|
|
11177
11528
|
],
|
|
11178
|
-
type: "object"
|
|
11529
|
+
type: "object",
|
|
11530
|
+
"x-route-path": "/devices"
|
|
11179
11531
|
},
|
|
11180
11532
|
{
|
|
11181
11533
|
description: "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`.",
|
|
@@ -11234,7 +11586,8 @@ var openapi_default = {
|
|
|
11234
11586
|
"event_type",
|
|
11235
11587
|
"error_code"
|
|
11236
11588
|
],
|
|
11237
|
-
type: "object"
|
|
11589
|
+
type: "object",
|
|
11590
|
+
"x-route-path": "/devices/unmanaged"
|
|
11238
11591
|
},
|
|
11239
11592
|
{
|
|
11240
11593
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.",
|
|
@@ -11280,7 +11633,8 @@ var openapi_default = {
|
|
|
11280
11633
|
"connected_account_id",
|
|
11281
11634
|
"event_type"
|
|
11282
11635
|
],
|
|
11283
|
-
type: "object"
|
|
11636
|
+
type: "object",
|
|
11637
|
+
"x-route-path": "/devices"
|
|
11284
11638
|
},
|
|
11285
11639
|
{
|
|
11286
11640
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.",
|
|
@@ -11334,7 +11688,8 @@ var openapi_default = {
|
|
|
11334
11688
|
"event_type",
|
|
11335
11689
|
"battery_level"
|
|
11336
11690
|
],
|
|
11337
|
-
type: "object"
|
|
11691
|
+
type: "object",
|
|
11692
|
+
"x-route-path": "/devices"
|
|
11338
11693
|
},
|
|
11339
11694
|
{
|
|
11340
11695
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.",
|
|
@@ -11397,7 +11752,8 @@ var openapi_default = {
|
|
|
11397
11752
|
"battery_status",
|
|
11398
11753
|
"battery_level"
|
|
11399
11754
|
],
|
|
11400
|
-
type: "object"
|
|
11755
|
+
type: "object",
|
|
11756
|
+
"x-route-path": "/devices"
|
|
11401
11757
|
},
|
|
11402
11758
|
{
|
|
11403
11759
|
description: "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).",
|
|
@@ -11443,7 +11799,8 @@ var openapi_default = {
|
|
|
11443
11799
|
"connected_account_id",
|
|
11444
11800
|
"event_type"
|
|
11445
11801
|
],
|
|
11446
|
-
type: "object"
|
|
11802
|
+
type: "object",
|
|
11803
|
+
"x-route-path": "/devices"
|
|
11447
11804
|
},
|
|
11448
11805
|
{
|
|
11449
11806
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.",
|
|
@@ -11489,7 +11846,8 @@ var openapi_default = {
|
|
|
11489
11846
|
"connected_account_id",
|
|
11490
11847
|
"event_type"
|
|
11491
11848
|
],
|
|
11492
|
-
type: "object"
|
|
11849
|
+
type: "object",
|
|
11850
|
+
"x-route-path": "/devices"
|
|
11493
11851
|
},
|
|
11494
11852
|
{
|
|
11495
11853
|
description: "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.",
|
|
@@ -11538,7 +11896,8 @@ var openapi_default = {
|
|
|
11538
11896
|
"connected_account_id",
|
|
11539
11897
|
"event_type"
|
|
11540
11898
|
],
|
|
11541
|
-
type: "object"
|
|
11899
|
+
type: "object",
|
|
11900
|
+
"x-route-path": "/devices"
|
|
11542
11901
|
},
|
|
11543
11902
|
{
|
|
11544
11903
|
description: "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.",
|
|
@@ -11587,7 +11946,8 @@ var openapi_default = {
|
|
|
11587
11946
|
"connected_account_id",
|
|
11588
11947
|
"event_type"
|
|
11589
11948
|
],
|
|
11590
|
-
type: "object"
|
|
11949
|
+
type: "object",
|
|
11950
|
+
"x-route-path": "/devices"
|
|
11591
11951
|
},
|
|
11592
11952
|
{
|
|
11593
11953
|
description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.",
|
|
@@ -11636,7 +11996,8 @@ var openapi_default = {
|
|
|
11636
11996
|
"connected_account_id",
|
|
11637
11997
|
"event_type"
|
|
11638
11998
|
],
|
|
11639
|
-
type: "object"
|
|
11999
|
+
type: "object",
|
|
12000
|
+
"x-route-path": "/devices"
|
|
11640
12001
|
},
|
|
11641
12002
|
{
|
|
11642
12003
|
description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.",
|
|
@@ -11685,7 +12046,8 @@ var openapi_default = {
|
|
|
11685
12046
|
"connected_account_id",
|
|
11686
12047
|
"event_type"
|
|
11687
12048
|
],
|
|
11688
|
-
type: "object"
|
|
12049
|
+
type: "object",
|
|
12050
|
+
"x-route-path": "/devices"
|
|
11689
12051
|
},
|
|
11690
12052
|
{
|
|
11691
12053
|
description: "Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.",
|
|
@@ -11734,7 +12096,8 @@ var openapi_default = {
|
|
|
11734
12096
|
"connected_account_id",
|
|
11735
12097
|
"event_type"
|
|
11736
12098
|
],
|
|
11737
|
-
type: "object"
|
|
12099
|
+
type: "object",
|
|
12100
|
+
"x-route-path": "/devices"
|
|
11738
12101
|
},
|
|
11739
12102
|
{
|
|
11740
12103
|
description: "Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.",
|
|
@@ -11783,7 +12146,8 @@ var openapi_default = {
|
|
|
11783
12146
|
"connected_account_id",
|
|
11784
12147
|
"event_type"
|
|
11785
12148
|
],
|
|
11786
|
-
type: "object"
|
|
12149
|
+
type: "object",
|
|
12150
|
+
"x-route-path": "/devices"
|
|
11787
12151
|
},
|
|
11788
12152
|
{
|
|
11789
12153
|
description: "A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.",
|
|
@@ -11832,7 +12196,8 @@ var openapi_default = {
|
|
|
11832
12196
|
"connected_account_id",
|
|
11833
12197
|
"event_type"
|
|
11834
12198
|
],
|
|
11835
|
-
type: "object"
|
|
12199
|
+
type: "object",
|
|
12200
|
+
"x-route-path": "/devices"
|
|
11836
12201
|
},
|
|
11837
12202
|
{
|
|
11838
12203
|
description: "A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.",
|
|
@@ -11881,7 +12246,8 @@ var openapi_default = {
|
|
|
11881
12246
|
"connected_account_id",
|
|
11882
12247
|
"event_type"
|
|
11883
12248
|
],
|
|
11884
|
-
type: "object"
|
|
12249
|
+
type: "object",
|
|
12250
|
+
"x-route-path": "/devices"
|
|
11885
12251
|
},
|
|
11886
12252
|
{
|
|
11887
12253
|
description: "An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
@@ -11930,7 +12296,8 @@ var openapi_default = {
|
|
|
11930
12296
|
"connected_account_id",
|
|
11931
12297
|
"event_type"
|
|
11932
12298
|
],
|
|
11933
|
-
type: "object"
|
|
12299
|
+
type: "object",
|
|
12300
|
+
"x-route-path": "/devices"
|
|
11934
12301
|
},
|
|
11935
12302
|
{
|
|
11936
12303
|
description: "An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
@@ -11979,7 +12346,8 @@ var openapi_default = {
|
|
|
11979
12346
|
"connected_account_id",
|
|
11980
12347
|
"event_type"
|
|
11981
12348
|
],
|
|
11982
|
-
type: "object"
|
|
12349
|
+
type: "object",
|
|
12350
|
+
"x-route-path": "/devices"
|
|
11983
12351
|
},
|
|
11984
12352
|
{
|
|
11985
12353
|
description: "Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.",
|
|
@@ -12057,7 +12425,8 @@ var openapi_default = {
|
|
|
12057
12425
|
"connected_account_id",
|
|
12058
12426
|
"event_type"
|
|
12059
12427
|
],
|
|
12060
|
-
type: "object"
|
|
12428
|
+
type: "object",
|
|
12429
|
+
"x-route-path": "/noise_sensors/noise_thresholds"
|
|
12061
12430
|
},
|
|
12062
12431
|
{
|
|
12063
12432
|
description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.",
|
|
@@ -12119,7 +12488,8 @@ var openapi_default = {
|
|
|
12119
12488
|
"event_type",
|
|
12120
12489
|
"method"
|
|
12121
12490
|
],
|
|
12122
|
-
type: "object"
|
|
12491
|
+
type: "object",
|
|
12492
|
+
"x-route-path": "/locks"
|
|
12123
12493
|
},
|
|
12124
12494
|
{
|
|
12125
12495
|
description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.",
|
|
@@ -12181,7 +12551,8 @@ var openapi_default = {
|
|
|
12181
12551
|
"event_type",
|
|
12182
12552
|
"method"
|
|
12183
12553
|
],
|
|
12184
|
-
type: "object"
|
|
12554
|
+
type: "object",
|
|
12555
|
+
"x-route-path": "/locks"
|
|
12185
12556
|
},
|
|
12186
12557
|
{
|
|
12187
12558
|
description: "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.",
|
|
@@ -12232,7 +12603,8 @@ var openapi_default = {
|
|
|
12232
12603
|
"connected_account_id",
|
|
12233
12604
|
"event_type"
|
|
12234
12605
|
],
|
|
12235
|
-
type: "object"
|
|
12606
|
+
type: "object",
|
|
12607
|
+
"x-route-path": "/locks"
|
|
12236
12608
|
},
|
|
12237
12609
|
{
|
|
12238
12610
|
description: "A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.",
|
|
@@ -12298,7 +12670,8 @@ var openapi_default = {
|
|
|
12298
12670
|
"climate_preset_key",
|
|
12299
12671
|
"is_fallback_climate_preset"
|
|
12300
12672
|
],
|
|
12301
|
-
type: "object"
|
|
12673
|
+
type: "object",
|
|
12674
|
+
"x-route-path": "/thermostats"
|
|
12302
12675
|
},
|
|
12303
12676
|
{
|
|
12304
12677
|
description: "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.",
|
|
@@ -12383,7 +12756,8 @@ var openapi_default = {
|
|
|
12383
12756
|
"event_type",
|
|
12384
12757
|
"method"
|
|
12385
12758
|
],
|
|
12386
|
-
type: "object"
|
|
12759
|
+
type: "object",
|
|
12760
|
+
"x-route-path": "/thermostats"
|
|
12387
12761
|
},
|
|
12388
12762
|
{
|
|
12389
12763
|
description: "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).",
|
|
@@ -12472,7 +12846,8 @@ var openapi_default = {
|
|
|
12472
12846
|
"lower_limit_celsius",
|
|
12473
12847
|
"lower_limit_fahrenheit"
|
|
12474
12848
|
],
|
|
12475
|
-
type: "object"
|
|
12849
|
+
type: "object",
|
|
12850
|
+
"x-route-path": "/thermostats"
|
|
12476
12851
|
},
|
|
12477
12852
|
{
|
|
12478
12853
|
description: "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).",
|
|
@@ -12561,7 +12936,8 @@ var openapi_default = {
|
|
|
12561
12936
|
"lower_limit_celsius",
|
|
12562
12937
|
"lower_limit_fahrenheit"
|
|
12563
12938
|
],
|
|
12564
|
-
type: "object"
|
|
12939
|
+
type: "object",
|
|
12940
|
+
"x-route-path": "/thermostats"
|
|
12565
12941
|
},
|
|
12566
12942
|
{
|
|
12567
12943
|
properties: {
|
|
@@ -12631,7 +13007,8 @@ var openapi_default = {
|
|
|
12631
13007
|
"temperature_celsius",
|
|
12632
13008
|
"temperature_fahrenheit"
|
|
12633
13009
|
],
|
|
12634
|
-
type: "object"
|
|
13010
|
+
type: "object",
|
|
13011
|
+
"x-route-path": "/thermostats"
|
|
12635
13012
|
},
|
|
12636
13013
|
{
|
|
12637
13014
|
description: "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.",
|
|
@@ -12674,7 +13051,8 @@ var openapi_default = {
|
|
|
12674
13051
|
"enrollment_automation_id",
|
|
12675
13052
|
"event_type"
|
|
12676
13053
|
],
|
|
12677
|
-
type: "object"
|
|
13054
|
+
type: "object",
|
|
13055
|
+
"x-route-path": "/user_identities/enrollment_automations"
|
|
12678
13056
|
},
|
|
12679
13057
|
{
|
|
12680
13058
|
description: "A phone device was deactivated.",
|
|
@@ -12714,9 +13092,11 @@ var openapi_default = {
|
|
|
12714
13092
|
"device_id",
|
|
12715
13093
|
"event_type"
|
|
12716
13094
|
],
|
|
12717
|
-
type: "object"
|
|
13095
|
+
type: "object",
|
|
13096
|
+
"x-route-path": "/phones"
|
|
12718
13097
|
}
|
|
12719
|
-
]
|
|
13098
|
+
],
|
|
13099
|
+
"x-route-path": "/events"
|
|
12720
13100
|
},
|
|
12721
13101
|
network: {
|
|
12722
13102
|
properties: {
|
|
@@ -12726,7 +13106,8 @@ var openapi_default = {
|
|
|
12726
13106
|
workspace_id: { format: "uuid", type: "string" }
|
|
12727
13107
|
},
|
|
12728
13108
|
required: ["network_id", "workspace_id", "display_name", "created_at"],
|
|
12729
|
-
type: "object"
|
|
13109
|
+
type: "object",
|
|
13110
|
+
"x-route-path": "/networks"
|
|
12730
13111
|
},
|
|
12731
13112
|
noise_threshold: {
|
|
12732
13113
|
properties: {
|
|
@@ -12746,7 +13127,8 @@ var openapi_default = {
|
|
|
12746
13127
|
"ends_daily_at",
|
|
12747
13128
|
"noise_threshold_decibels"
|
|
12748
13129
|
],
|
|
12749
|
-
type: "object"
|
|
13130
|
+
type: "object",
|
|
13131
|
+
"x-route-path": "/noise_sensors/noise_thresholds"
|
|
12750
13132
|
},
|
|
12751
13133
|
phone: {
|
|
12752
13134
|
properties: {
|
|
@@ -13087,7 +13469,8 @@ var openapi_default = {
|
|
|
13087
13469
|
"is_managed",
|
|
13088
13470
|
"custom_metadata"
|
|
13089
13471
|
],
|
|
13090
|
-
type: "object"
|
|
13472
|
+
type: "object",
|
|
13473
|
+
"x-route-path": "/phones"
|
|
13091
13474
|
},
|
|
13092
13475
|
service_health: {
|
|
13093
13476
|
properties: {
|
|
@@ -13096,7 +13479,8 @@ var openapi_default = {
|
|
|
13096
13479
|
status: { enum: ["healthy", "degraded", "down"], type: "string" }
|
|
13097
13480
|
},
|
|
13098
13481
|
required: ["service", "status", "description"],
|
|
13099
|
-
type: "object"
|
|
13482
|
+
type: "object",
|
|
13483
|
+
"x-route-path": "/health"
|
|
13100
13484
|
},
|
|
13101
13485
|
thermostat_schedule: {
|
|
13102
13486
|
description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
|
|
@@ -13167,7 +13551,8 @@ var openapi_default = {
|
|
|
13167
13551
|
"created_at",
|
|
13168
13552
|
"errors"
|
|
13169
13553
|
],
|
|
13170
|
-
type: "object"
|
|
13554
|
+
type: "object",
|
|
13555
|
+
"x-route-path": "/thermostats/schedules"
|
|
13171
13556
|
},
|
|
13172
13557
|
unmanaged_access_code: {
|
|
13173
13558
|
properties: {
|
|
@@ -13460,7 +13845,8 @@ var openapi_default = {
|
|
|
13460
13845
|
"is_managed",
|
|
13461
13846
|
"status"
|
|
13462
13847
|
],
|
|
13463
|
-
type: "object"
|
|
13848
|
+
type: "object",
|
|
13849
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
13464
13850
|
},
|
|
13465
13851
|
unmanaged_device: {
|
|
13466
13852
|
properties: {
|
|
@@ -13934,7 +14320,8 @@ var openapi_default = {
|
|
|
13934
14320
|
"is_managed",
|
|
13935
14321
|
"properties"
|
|
13936
14322
|
],
|
|
13937
|
-
type: "object"
|
|
14323
|
+
type: "object",
|
|
14324
|
+
"x-route-path": "/devices/unmanaged"
|
|
13938
14325
|
},
|
|
13939
14326
|
user_identity: {
|
|
13940
14327
|
description: "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.",
|
|
@@ -13984,7 +14371,8 @@ var openapi_default = {
|
|
|
13984
14371
|
"created_at",
|
|
13985
14372
|
"workspace_id"
|
|
13986
14373
|
],
|
|
13987
|
-
type: "object"
|
|
14374
|
+
type: "object",
|
|
14375
|
+
"x-route-path": "/user_identities"
|
|
13988
14376
|
},
|
|
13989
14377
|
webhook: {
|
|
13990
14378
|
properties: {
|
|
@@ -13994,7 +14382,8 @@ var openapi_default = {
|
|
|
13994
14382
|
webhook_id: { type: "string" }
|
|
13995
14383
|
},
|
|
13996
14384
|
required: ["webhook_id", "url"],
|
|
13997
|
-
type: "object"
|
|
14385
|
+
type: "object",
|
|
14386
|
+
"x-route-path": "/webhooks"
|
|
13998
14387
|
},
|
|
13999
14388
|
workspace: {
|
|
14000
14389
|
properties: {
|
|
@@ -14016,7 +14405,8 @@ var openapi_default = {
|
|
|
14016
14405
|
"is_sandbox",
|
|
14017
14406
|
"connect_partner_name"
|
|
14018
14407
|
],
|
|
14019
|
-
type: "object"
|
|
14408
|
+
type: "object",
|
|
14409
|
+
"x-route-path": "/workspaces"
|
|
14020
14410
|
}
|
|
14021
14411
|
},
|
|
14022
14412
|
securitySchemes: {
|