@seamapi/types 1.326.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 +820 -370
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +276 -16
- 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.d.ts +64 -0
- package/lib/seam/connect/models/events/acs/access_groups.js +15 -0
- package/lib/seam/connect/models/events/acs/access_groups.js.map +1 -0
- 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/index.d.ts +30 -0
- package/lib/seam/connect/models/events/acs/index.js +2 -0
- package/lib/seam/connect/models/events/acs/index.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.d.ts +30 -0
- 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 +165 -4
- package/lib/seam/connect/openapi.js +154 -6
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +81 -7
- 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 +22 -0
- 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/index.ts +2 -0
- 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 +157 -6
- package/src/lib/seam/connect/route-types.ts +83 -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,
|
|
@@ -2394,20 +2495,38 @@ var common_acs_event = common_event.extend({
|
|
|
2394
2495
|
)
|
|
2395
2496
|
});
|
|
2396
2497
|
|
|
2397
|
-
// src/lib/seam/connect/models/events/acs/
|
|
2498
|
+
// src/lib/seam/connect/models/events/acs/access_groups.ts
|
|
2499
|
+
var acs_access_group_event = common_acs_event.extend({
|
|
2500
|
+
acs_access_group_id: zod.z.string().uuid()
|
|
2501
|
+
});
|
|
2502
|
+
var acs_access_group_deleted_event = acs_access_group_event.extend({
|
|
2503
|
+
event_type: zod.z.literal("acs_access_group.deleted")
|
|
2504
|
+
}).describe(`
|
|
2505
|
+
---
|
|
2506
|
+
route_path: /acs/access_groups
|
|
2507
|
+
---
|
|
2508
|
+
An ACS access group was deleted.
|
|
2509
|
+
`);
|
|
2510
|
+
var acs_access_group_events = [acs_access_group_deleted_event];
|
|
2398
2511
|
var acs_credential_event = common_acs_event.extend({
|
|
2399
2512
|
acs_credential_id: zod.z.string().uuid()
|
|
2400
2513
|
});
|
|
2401
2514
|
var acs_credential_deleted_event = acs_credential_event.extend({
|
|
2402
2515
|
event_type: zod.z.literal("acs_credential.deleted")
|
|
2403
|
-
}).describe(
|
|
2404
|
-
|
|
2405
|
-
|
|
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
|
+
`);
|
|
2406
2522
|
var acs_credential_issued = acs_credential_event.extend({
|
|
2407
2523
|
event_type: zod.z.literal("acs_credential.issued")
|
|
2408
|
-
}).describe(
|
|
2409
|
-
|
|
2410
|
-
|
|
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
|
+
`);
|
|
2411
2530
|
var acs_credential_events = [
|
|
2412
2531
|
acs_credential_deleted_event,
|
|
2413
2532
|
acs_credential_issued
|
|
@@ -2419,14 +2538,20 @@ var acs_encoder_event = common_acs_event.extend({
|
|
|
2419
2538
|
});
|
|
2420
2539
|
var acs_encoder_added_event = acs_encoder_event.extend({
|
|
2421
2540
|
event_type: zod.z.literal("acs_encoder.added")
|
|
2422
|
-
}).describe(
|
|
2423
|
-
|
|
2424
|
-
|
|
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
|
+
`);
|
|
2425
2547
|
var acs_encoder_removed_event = acs_encoder_event.extend({
|
|
2426
2548
|
event_type: zod.z.literal("acs_encoder.removed")
|
|
2427
|
-
}).describe(
|
|
2428
|
-
|
|
2429
|
-
|
|
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
|
+
`);
|
|
2430
2555
|
var acs_encoder_events = [
|
|
2431
2556
|
acs_encoder_added_event,
|
|
2432
2557
|
acs_encoder_removed_event
|
|
@@ -2434,19 +2559,28 @@ var acs_encoder_events = [
|
|
|
2434
2559
|
var acs_system_event = common_acs_event.extend({});
|
|
2435
2560
|
var acs_system_connected_event = acs_system_event.extend({
|
|
2436
2561
|
event_type: zod.z.literal("acs_system.connected")
|
|
2437
|
-
}).describe(
|
|
2438
|
-
|
|
2439
|
-
|
|
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
|
+
`);
|
|
2440
2568
|
var acs_system_disconnected_event = acs_system_event.extend({
|
|
2441
2569
|
event_type: zod.z.literal("acs_system.disconnected")
|
|
2442
|
-
}).describe(
|
|
2443
|
-
|
|
2444
|
-
|
|
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
|
+
`);
|
|
2445
2576
|
var acs_system_added_event = acs_system_event.extend({
|
|
2446
2577
|
event_type: zod.z.literal("acs_system.added")
|
|
2447
|
-
}).describe(
|
|
2448
|
-
|
|
2449
|
-
|
|
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
|
+
`);
|
|
2450
2584
|
var acs_system_events = [
|
|
2451
2585
|
acs_system_connected_event,
|
|
2452
2586
|
acs_system_added_event,
|
|
@@ -2459,9 +2593,12 @@ var acs_user_event = common_acs_event.extend({
|
|
|
2459
2593
|
);
|
|
2460
2594
|
var acs_user_deleted_event = acs_user_event.extend({
|
|
2461
2595
|
event_type: zod.z.literal("acs_user.deleted")
|
|
2462
|
-
}).describe(
|
|
2463
|
-
|
|
2464
|
-
|
|
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
|
+
`);
|
|
2465
2602
|
var acs_user_events = [acs_user_deleted_event];
|
|
2466
2603
|
|
|
2467
2604
|
// src/lib/seam/connect/models/events/acs/index.ts
|
|
@@ -2469,7 +2606,8 @@ var acs_events = [
|
|
|
2469
2606
|
...acs_system_events,
|
|
2470
2607
|
...acs_credential_events,
|
|
2471
2608
|
...acs_user_events,
|
|
2472
|
-
...acs_encoder_events
|
|
2609
|
+
...acs_encoder_events,
|
|
2610
|
+
...acs_access_group_events
|
|
2473
2611
|
];
|
|
2474
2612
|
var action_attempt_event = common_event.extend({
|
|
2475
2613
|
action_attempt_id: zod.z.string().uuid().describe(
|
|
@@ -2480,24 +2618,36 @@ var action_attempt_event = common_event.extend({
|
|
|
2480
2618
|
});
|
|
2481
2619
|
var action_attempt_lock_door_succeeded_event = action_attempt_event.extend({
|
|
2482
2620
|
event_type: zod.z.literal("action_attempt.lock_door.succeeded")
|
|
2483
|
-
}).describe(
|
|
2484
|
-
|
|
2485
|
-
|
|
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
|
+
`);
|
|
2486
2627
|
var action_attempt_lock_door_failed_event = action_attempt_event.extend({
|
|
2487
2628
|
event_type: zod.z.literal("action_attempt.lock_door.failed")
|
|
2488
|
-
}).describe(
|
|
2489
|
-
|
|
2490
|
-
|
|
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
|
+
`);
|
|
2491
2635
|
var action_attempt_unlock_door_succeeded_event = action_attempt_event.extend({
|
|
2492
2636
|
event_type: zod.z.literal("action_attempt.unlock_door.succeeded")
|
|
2493
|
-
}).describe(
|
|
2494
|
-
|
|
2495
|
-
|
|
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
|
+
`);
|
|
2496
2643
|
var action_attempt_unlock_door_failed_event = action_attempt_event.extend({
|
|
2497
2644
|
event_type: zod.z.literal("action_attempt.unlock_door.failed")
|
|
2498
|
-
}).describe(
|
|
2499
|
-
|
|
2500
|
-
|
|
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
|
+
`);
|
|
2501
2651
|
var action_attempt_events = [
|
|
2502
2652
|
action_attempt_lock_door_succeeded_event,
|
|
2503
2653
|
action_attempt_lock_door_failed_event,
|
|
@@ -2511,9 +2661,12 @@ var client_session_event = common_event.extend({
|
|
|
2511
2661
|
});
|
|
2512
2662
|
var client_session_deleted_event = client_session_event.extend({
|
|
2513
2663
|
event_type: zod.z.literal("client_session.deleted")
|
|
2514
|
-
}).describe(
|
|
2515
|
-
|
|
2516
|
-
|
|
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
|
+
`);
|
|
2517
2670
|
var client_session_events = [client_session_deleted_event];
|
|
2518
2671
|
var connect_webview_event = common_event.extend({
|
|
2519
2672
|
connect_webview_id: zod.z.string().uuid().describe(
|
|
@@ -2526,14 +2679,20 @@ var connected_account_id = zod.z.string().uuid().describe(
|
|
|
2526
2679
|
var connect_webview_login_succeeded_event = connect_webview_event.extend({
|
|
2527
2680
|
event_type: zod.z.literal("connect_webview.login_succeeded"),
|
|
2528
2681
|
connected_account_id
|
|
2529
|
-
}).describe(
|
|
2530
|
-
|
|
2531
|
-
|
|
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
|
+
`);
|
|
2532
2688
|
var connect_webview_login_failed_event = connect_webview_event.extend({
|
|
2533
2689
|
event_type: zod.z.literal("connect_webview.login_failed")
|
|
2534
|
-
}).describe(
|
|
2535
|
-
|
|
2536
|
-
|
|
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
|
+
`);
|
|
2537
2696
|
var connect_webview_events = [
|
|
2538
2697
|
connect_webview_login_succeeded_event,
|
|
2539
2698
|
connect_webview_login_failed_event
|
|
@@ -2546,48 +2705,70 @@ var connected_account_event = common_event.extend({
|
|
|
2546
2705
|
var connect_webview_id = zod.z.string().uuid().describe(
|
|
2547
2706
|
"ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)."
|
|
2548
2707
|
);
|
|
2549
|
-
var connected_account_connected_event = connected_account_event.extend(
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
)
|
|
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
|
+
`);
|
|
2555
2719
|
var connected_account_created_event = connected_account_event.extend({
|
|
2556
2720
|
event_type: zod.z.literal("connected_account.created"),
|
|
2557
2721
|
connect_webview_id
|
|
2558
|
-
}).describe(
|
|
2559
|
-
|
|
2560
|
-
|
|
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
|
+
`);
|
|
2561
2728
|
var connected_account_successful_login_event = connected_account_event.extend({
|
|
2562
2729
|
event_type: zod.z.literal("connected_account.successful_login"),
|
|
2563
2730
|
connect_webview_id
|
|
2564
2731
|
}).describe(`
|
|
2565
2732
|
---
|
|
2566
2733
|
deprecated: Use \`connect_webview.login_succeeded\`.
|
|
2734
|
+
route_path: /connected_accounts
|
|
2567
2735
|
---
|
|
2568
|
-
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
|
+
`);
|
|
2569
2738
|
var connected_account_disconnected_event = connected_account_event.extend({
|
|
2570
2739
|
event_type: zod.z.literal("connected_account.disconnected")
|
|
2571
|
-
}).describe(
|
|
2572
|
-
|
|
2573
|
-
|
|
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
|
+
`);
|
|
2574
2746
|
var connected_account_completed_first_sync_event = connected_account_event.extend({
|
|
2575
2747
|
event_type: zod.z.literal("connected_account.completed_first_sync")
|
|
2576
|
-
}).describe(
|
|
2577
|
-
|
|
2578
|
-
|
|
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
|
+
`);
|
|
2579
2754
|
var connected_account_deleted_event = connected_account_event.extend({
|
|
2580
2755
|
event_type: zod.z.literal("connected_account.deleted")
|
|
2581
|
-
}).describe(
|
|
2582
|
-
|
|
2583
|
-
|
|
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
|
+
`);
|
|
2584
2762
|
var connected_account_completed_first_sync_after_reconnection_event = connected_account_event.extend({
|
|
2585
2763
|
event_type: zod.z.literal(
|
|
2586
2764
|
"connected_account.completed_first_sync_after_reconnection"
|
|
2587
2765
|
)
|
|
2588
|
-
}).describe(
|
|
2589
|
-
|
|
2590
|
-
|
|
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
|
+
`);
|
|
2591
2772
|
var connected_account_events = [
|
|
2592
2773
|
connected_account_connected_event,
|
|
2593
2774
|
connected_account_created_event,
|
|
@@ -2615,137 +2796,206 @@ var lock_method = zod.z.enum(["keycode", "manual", "automatic", "unknown", "seam
|
|
|
2615
2796
|
);
|
|
2616
2797
|
var device_connected_event = device_event.extend({
|
|
2617
2798
|
event_type: zod.z.literal("device.connected")
|
|
2618
|
-
}).describe(
|
|
2619
|
-
|
|
2620
|
-
|
|
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
|
+
`);
|
|
2621
2805
|
var device_added_event = device_event.extend({
|
|
2622
2806
|
event_type: zod.z.literal("device.added")
|
|
2623
|
-
}).describe(
|
|
2624
|
-
|
|
2625
|
-
|
|
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
|
+
`);
|
|
2626
2813
|
var device_converted_to_unmanaged_event = device_event.extend({
|
|
2627
2814
|
event_type: zod.z.literal("device.converted_to_unmanaged")
|
|
2628
|
-
}).describe(
|
|
2629
|
-
|
|
2630
|
-
|
|
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
|
+
`);
|
|
2631
2821
|
var unmanaged_device_converted_to_managed_event = device_event.extend({
|
|
2632
2822
|
event_type: zod.z.literal("device.unmanaged.converted_to_managed")
|
|
2633
|
-
}).describe(
|
|
2634
|
-
|
|
2635
|
-
|
|
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
|
+
`);
|
|
2636
2829
|
var unmanaged_device_connected_event = device_event.extend({
|
|
2637
2830
|
event_type: zod.z.literal("device.unmanaged.connected")
|
|
2638
|
-
}).describe(
|
|
2639
|
-
|
|
2640
|
-
|
|
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
|
+
`);
|
|
2641
2837
|
var device_disconnected_event = device_event.extend({
|
|
2642
2838
|
event_type: zod.z.literal("device.disconnected"),
|
|
2643
2839
|
error_code: disconnection_error_code
|
|
2644
|
-
}).describe(
|
|
2645
|
-
|
|
2646
|
-
|
|
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
|
+
`);
|
|
2647
2846
|
var unmanaged_device_disconnected_event = device_event.extend({
|
|
2648
2847
|
event_type: zod.z.literal("device.unmanaged.disconnected"),
|
|
2649
2848
|
error_code: disconnection_error_code
|
|
2650
|
-
}).describe(
|
|
2651
|
-
|
|
2652
|
-
|
|
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
|
+
`);
|
|
2653
2855
|
var device_tampered_event = device_event.extend({
|
|
2654
2856
|
event_type: zod.z.literal("device.tampered")
|
|
2655
|
-
}).describe(
|
|
2656
|
-
|
|
2657
|
-
|
|
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
|
+
`);
|
|
2658
2863
|
var device_low_battery_event = device_event.extend({
|
|
2659
2864
|
event_type: zod.z.literal("device.low_battery"),
|
|
2660
2865
|
battery_level
|
|
2661
|
-
}).describe(
|
|
2662
|
-
|
|
2663
|
-
|
|
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
|
+
`);
|
|
2664
2872
|
var device_battery_status_changed_event = device_event.extend({
|
|
2665
2873
|
event_type: zod.z.literal("device.battery_status_changed"),
|
|
2666
2874
|
battery_status: device_battery_status,
|
|
2667
2875
|
battery_level
|
|
2668
|
-
}).describe(
|
|
2669
|
-
|
|
2670
|
-
|
|
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
|
+
`);
|
|
2671
2882
|
var device_removed_event = device_event.extend({
|
|
2672
2883
|
event_type: zod.z.literal("device.removed")
|
|
2673
|
-
}).describe(
|
|
2674
|
-
|
|
2675
|
-
|
|
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
|
+
`);
|
|
2676
2890
|
var device_deleted_event = device_event.extend({
|
|
2677
2891
|
event_type: zod.z.literal("device.deleted")
|
|
2678
|
-
}).describe(
|
|
2679
|
-
|
|
2680
|
-
|
|
2892
|
+
}).describe(`
|
|
2893
|
+
---
|
|
2894
|
+
route_path: /devices
|
|
2895
|
+
---
|
|
2896
|
+
A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.
|
|
2897
|
+
`);
|
|
2681
2898
|
var device_third_party_integration_detected_event = device_event.extend({
|
|
2682
2899
|
event_type: zod.z.literal("device.third_party_integration_detected")
|
|
2683
|
-
}).describe(
|
|
2684
|
-
|
|
2685
|
-
|
|
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
|
+
`);
|
|
2686
2906
|
var device_third_party_integration_no_longer_detected_event = device_event.extend({
|
|
2687
|
-
event_type: zod.z.literal(
|
|
2688
|
-
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
|
|
2692
|
-
)
|
|
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
|
+
`);
|
|
2693
2914
|
var device_salto_privacy_mode_activated_event = device_event.extend({
|
|
2694
2915
|
event_type: zod.z.literal("device.salto.privacy_mode_activated")
|
|
2695
|
-
}).describe(
|
|
2696
|
-
|
|
2697
|
-
|
|
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
|
+
`);
|
|
2698
2922
|
var device_salto_privacy_mode_deactivated_event = device_event.extend({
|
|
2699
2923
|
event_type: zod.z.literal("device.salto.privacy_mode_deactivated")
|
|
2700
|
-
}).describe(
|
|
2701
|
-
|
|
2702
|
-
|
|
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
|
+
`);
|
|
2703
2930
|
var device_connection_became_flaky_event = device_event.extend({
|
|
2704
2931
|
event_type: zod.z.literal("device.connection_became_flaky")
|
|
2705
|
-
}).describe(
|
|
2706
|
-
|
|
2707
|
-
|
|
2932
|
+
}).describe(`
|
|
2933
|
+
---
|
|
2934
|
+
route_path: /devices
|
|
2935
|
+
---
|
|
2936
|
+
Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.
|
|
2937
|
+
`);
|
|
2708
2938
|
var device_connection_stabilized_event = device_event.extend({
|
|
2709
2939
|
event_type: zod.z.literal("device.connection_stabilized")
|
|
2710
|
-
}).describe(
|
|
2711
|
-
|
|
2712
|
-
|
|
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
|
+
`);
|
|
2713
2946
|
var device_error_subscription_required_event = device_event.extend({
|
|
2714
2947
|
event_type: zod.z.literal("device.error.subscription_required")
|
|
2715
|
-
}).describe(
|
|
2716
|
-
|
|
2717
|
-
|
|
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
|
+
`);
|
|
2718
2954
|
var device_error_subscription_required_resolved_event = device_event.extend({
|
|
2719
2955
|
event_type: zod.z.literal("device.error.subscription_required.resolved")
|
|
2720
|
-
}).describe(
|
|
2721
|
-
|
|
2722
|
-
|
|
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
|
+
`);
|
|
2723
2962
|
var device_accessory_keypad_connected_event = device_event.extend({
|
|
2724
2963
|
event_type: zod.z.literal("device.accessory_keypad_connected")
|
|
2725
|
-
}).describe(
|
|
2726
|
-
|
|
2727
|
-
|
|
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
|
+
`);
|
|
2728
2970
|
var device_accessory_keypad_disconnected_event = device_event.extend({
|
|
2729
2971
|
event_type: zod.z.literal("device.accessory_keypad_disconnected")
|
|
2730
|
-
}).describe(
|
|
2731
|
-
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2745
|
-
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
)
|
|
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
|
+
`);
|
|
2749
2999
|
var lock_locked_event = device_event.extend({
|
|
2750
3000
|
event_type: zod.z.literal("lock.locked"),
|
|
2751
3001
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
@@ -2757,9 +3007,12 @@ var lock_locked_event = device_event.extend({
|
|
|
2757
3007
|
method: lock_method.describe(
|
|
2758
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."
|
|
2759
3009
|
)
|
|
2760
|
-
}).describe(
|
|
2761
|
-
|
|
2762
|
-
|
|
3010
|
+
}).describe(`
|
|
3011
|
+
---
|
|
3012
|
+
route_path: /locks
|
|
3013
|
+
---
|
|
3014
|
+
A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.
|
|
3015
|
+
`);
|
|
2763
3016
|
var lock_unlocked_event = device_event.extend({
|
|
2764
3017
|
event_type: zod.z.literal("lock.unlocked"),
|
|
2765
3018
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
@@ -2771,17 +3024,23 @@ var lock_unlocked_event = device_event.extend({
|
|
|
2771
3024
|
method: lock_method.describe(
|
|
2772
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."
|
|
2773
3026
|
)
|
|
2774
|
-
}).describe(
|
|
2775
|
-
|
|
2776
|
-
|
|
3027
|
+
}).describe(`
|
|
3028
|
+
---
|
|
3029
|
+
route_path: /locks
|
|
3030
|
+
---
|
|
3031
|
+
A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.
|
|
3032
|
+
`);
|
|
2777
3033
|
var lock_access_denied_event = device_event.extend({
|
|
2778
3034
|
event_type: zod.z.literal("lock.access_denied"),
|
|
2779
3035
|
access_code_id: zod.z.string().uuid().optional().describe(
|
|
2780
3036
|
"ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts."
|
|
2781
3037
|
)
|
|
2782
|
-
}).describe(
|
|
2783
|
-
|
|
2784
|
-
|
|
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
|
+
`);
|
|
2785
3044
|
var thermostat_climate_preset_activated_event = device_event.extend({
|
|
2786
3045
|
event_type: zod.z.literal("thermostat.climate_preset_activated"),
|
|
2787
3046
|
thermostat_schedule_id: zod.z.string().uuid().nullable().describe(
|
|
@@ -2793,9 +3052,12 @@ var thermostat_climate_preset_activated_event = device_event.extend({
|
|
|
2793
3052
|
is_fallback_climate_preset: zod.z.boolean().describe(
|
|
2794
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)."
|
|
2795
3054
|
)
|
|
2796
|
-
}).describe(
|
|
2797
|
-
|
|
2798
|
-
|
|
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
|
+
`);
|
|
2799
3061
|
var thermostat_manually_adjusted_method = zod.z.enum(["seam", "external"]).describe(
|
|
2800
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)."
|
|
2801
3063
|
);
|
|
@@ -2811,9 +3073,12 @@ var thermostat_manually_adjusted_event = device_event.extend({
|
|
|
2811
3073
|
cooling_set_point_fahrenheit: true,
|
|
2812
3074
|
heating_set_point_fahrenheit: true
|
|
2813
3075
|
})
|
|
2814
|
-
).describe(
|
|
2815
|
-
|
|
2816
|
-
|
|
3076
|
+
).describe(`
|
|
3077
|
+
---
|
|
3078
|
+
route_path: /thermostats
|
|
3079
|
+
---
|
|
3080
|
+
A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.
|
|
3081
|
+
`);
|
|
2817
3082
|
var temperature_threshold_exceeded_event = device_event.extend({
|
|
2818
3083
|
event_type: zod.z.literal("thermostat.temperature_threshold_exceeded"),
|
|
2819
3084
|
temperature_celsius: zod.z.number().describe(
|
|
@@ -2834,9 +3099,12 @@ var temperature_threshold_exceeded_event = device_event.extend({
|
|
|
2834
3099
|
lower_limit_fahrenheit: zod.z.number().nullable().describe(
|
|
2835
3100
|
"Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
|
|
2836
3101
|
)
|
|
2837
|
-
}).describe(
|
|
2838
|
-
|
|
2839
|
-
|
|
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
|
+
`);
|
|
2840
3108
|
var temperature_threshold_no_longer_exceeded_event = device_event.extend({
|
|
2841
3109
|
event_type: zod.z.literal(
|
|
2842
3110
|
"thermostat.temperature_threshold_no_longer_exceeded"
|
|
@@ -2859,9 +3127,12 @@ var temperature_threshold_no_longer_exceeded_event = device_event.extend({
|
|
|
2859
3127
|
lower_limit_fahrenheit: zod.z.number().nullable().describe(
|
|
2860
3128
|
"Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
|
|
2861
3129
|
)
|
|
2862
|
-
}).describe(
|
|
2863
|
-
|
|
2864
|
-
|
|
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
|
+
`);
|
|
2865
3136
|
var temperature_reached_set_point_event = device_event.extend({
|
|
2866
3137
|
event_type: zod.z.literal("thermostat.temperature_reached_set_point"),
|
|
2867
3138
|
temperature_celsius: zod.z.number().describe("Temperature, in \xB0C, reported by the thermostat."),
|
|
@@ -2872,7 +3143,11 @@ var temperature_reached_set_point_event = device_event.extend({
|
|
|
2872
3143
|
desired_temperature_fahrenheit: zod.z.number().optional().describe(
|
|
2873
3144
|
"Desired temperature, in \xB0F, set by the thermostat's cooling or heating set point."
|
|
2874
3145
|
)
|
|
2875
|
-
})
|
|
3146
|
+
}).describe(`
|
|
3147
|
+
---
|
|
3148
|
+
route_path: /thermostats
|
|
3149
|
+
---
|
|
3150
|
+
`);
|
|
2876
3151
|
var device_events = [
|
|
2877
3152
|
device_connected_event,
|
|
2878
3153
|
device_added_event,
|
|
@@ -2913,9 +3188,12 @@ var enrollment_automation_event = common_event.extend({
|
|
|
2913
3188
|
});
|
|
2914
3189
|
var enrollment_automation_deleted_event = enrollment_automation_event.extend({
|
|
2915
3190
|
event_type: zod.z.literal("enrollment_automation.deleted")
|
|
2916
|
-
}).describe(
|
|
2917
|
-
|
|
2918
|
-
|
|
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
|
+
`);
|
|
2919
3197
|
var enrollment_automation_events = [
|
|
2920
3198
|
enrollment_automation_deleted_event
|
|
2921
3199
|
];
|
|
@@ -2926,7 +3204,12 @@ var phone_event = common_event.extend({
|
|
|
2926
3204
|
});
|
|
2927
3205
|
var phone_deactivated_event = phone_event.extend({
|
|
2928
3206
|
event_type: zod.z.literal("phone.deactivated")
|
|
2929
|
-
}).describe(
|
|
3207
|
+
}).describe(`
|
|
3208
|
+
---
|
|
3209
|
+
route_path: /phones
|
|
3210
|
+
---
|
|
3211
|
+
A phone device was deactivated.
|
|
3212
|
+
`);
|
|
2930
3213
|
var phone_events = [phone_deactivated_event];
|
|
2931
3214
|
|
|
2932
3215
|
// src/lib/seam/connect/models/events/seam-event.ts
|
|
@@ -2940,7 +3223,11 @@ var seam_event = zod.z.discriminatedUnion("event_type", [
|
|
|
2940
3223
|
...device_events,
|
|
2941
3224
|
...enrollment_automation_events,
|
|
2942
3225
|
...phone_events
|
|
2943
|
-
])
|
|
3226
|
+
]).describe(`
|
|
3227
|
+
---
|
|
3228
|
+
route_path: /events
|
|
3229
|
+
---
|
|
3230
|
+
`);
|
|
2944
3231
|
var noise_threshold = zod.z.object({
|
|
2945
3232
|
noise_threshold_id: zod.z.string().uuid(),
|
|
2946
3233
|
device_id: zod.z.string().uuid(),
|
|
@@ -2951,7 +3238,11 @@ var noise_threshold = zod.z.object({
|
|
|
2951
3238
|
ends_daily_at: zod.z.string(),
|
|
2952
3239
|
// TODO: zoned_time
|
|
2953
3240
|
noise_threshold_decibels: zod.z.number()
|
|
2954
|
-
})
|
|
3241
|
+
}).describe(`
|
|
3242
|
+
---
|
|
3243
|
+
route_path: /noise_sensors/noise_thresholds
|
|
3244
|
+
---
|
|
3245
|
+
`);
|
|
2955
3246
|
var user_identity = zod.z.object({
|
|
2956
3247
|
user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
|
|
2957
3248
|
user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
|
|
@@ -2965,15 +3256,22 @@ var user_identity = zod.z.object({
|
|
|
2965
3256
|
workspace_id: zod.z.string().uuid().describe(
|
|
2966
3257
|
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity."
|
|
2967
3258
|
)
|
|
2968
|
-
}).describe(
|
|
2969
|
-
|
|
2970
|
-
|
|
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
|
+
`);
|
|
2971
3265
|
var webhook = zod.z.object({
|
|
2972
3266
|
webhook_id: zod.z.string(),
|
|
2973
3267
|
url: zod.z.string(),
|
|
2974
3268
|
event_types: zod.z.array(zod.z.string()).optional(),
|
|
2975
3269
|
secret: zod.z.string().optional()
|
|
2976
|
-
})
|
|
3270
|
+
}).describe(`
|
|
3271
|
+
---
|
|
3272
|
+
route_path: /webhooks
|
|
3273
|
+
---
|
|
3274
|
+
`);
|
|
2977
3275
|
var workspace = zod.z.object({
|
|
2978
3276
|
workspace_id: zod.z.string().uuid(),
|
|
2979
3277
|
name: zod.z.string(),
|
|
@@ -2986,7 +3284,11 @@ var workspace = zod.z.object({
|
|
|
2986
3284
|
---
|
|
2987
3285
|
`
|
|
2988
3286
|
).nullable()
|
|
2989
|
-
})
|
|
3287
|
+
}).describe(`
|
|
3288
|
+
---
|
|
3289
|
+
route_path: /workspaces
|
|
3290
|
+
---
|
|
3291
|
+
`);
|
|
2990
3292
|
|
|
2991
3293
|
// src/lib/seam/connect/openapi.ts
|
|
2992
3294
|
var openapi_default = {
|
|
@@ -3335,7 +3637,8 @@ var openapi_default = {
|
|
|
3335
3637
|
"is_one_time_use",
|
|
3336
3638
|
"is_offline_access_code"
|
|
3337
3639
|
],
|
|
3338
|
-
type: "object"
|
|
3640
|
+
type: "object",
|
|
3641
|
+
"x-route-path": "/access_codes"
|
|
3339
3642
|
},
|
|
3340
3643
|
acs_access_group: {
|
|
3341
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).",
|
|
@@ -3437,7 +3740,8 @@ var openapi_default = {
|
|
|
3437
3740
|
"warnings",
|
|
3438
3741
|
"is_managed"
|
|
3439
3742
|
],
|
|
3440
|
-
type: "object"
|
|
3743
|
+
type: "object",
|
|
3744
|
+
"x-route-path": "/acs/access_groups"
|
|
3441
3745
|
},
|
|
3442
3746
|
acs_credential: {
|
|
3443
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.",
|
|
@@ -3717,7 +4021,8 @@ var openapi_default = {
|
|
|
3717
4021
|
"created_at",
|
|
3718
4022
|
"workspace_id"
|
|
3719
4023
|
],
|
|
3720
|
-
type: "object"
|
|
4024
|
+
type: "object",
|
|
4025
|
+
"x-route-path": "/acs/credential_pools"
|
|
3721
4026
|
},
|
|
3722
4027
|
acs_credential_provisioning_automation: {
|
|
3723
4028
|
properties: {
|
|
@@ -3737,7 +4042,8 @@ var openapi_default = {
|
|
|
3737
4042
|
"created_at",
|
|
3738
4043
|
"workspace_id"
|
|
3739
4044
|
],
|
|
3740
|
-
type: "object"
|
|
4045
|
+
type: "object",
|
|
4046
|
+
"x-route-path": "/acs/credential_provisioning_automations"
|
|
3741
4047
|
},
|
|
3742
4048
|
acs_entrance: {
|
|
3743
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).",
|
|
@@ -3776,10 +4082,7 @@ var openapi_default = {
|
|
|
3776
4082
|
type: "string"
|
|
3777
4083
|
},
|
|
3778
4084
|
dormakaba_community_metadata: {
|
|
3779
|
-
properties: {
|
|
3780
|
-
access_point_name: { type: "string" },
|
|
3781
|
-
common_area_number: { format: "float", type: "number" }
|
|
3782
|
-
},
|
|
4085
|
+
properties: { access_point_name: { type: "string" } },
|
|
3783
4086
|
required: ["access_point_name"],
|
|
3784
4087
|
type: "object"
|
|
3785
4088
|
},
|
|
@@ -3879,7 +4182,8 @@ var openapi_default = {
|
|
|
3879
4182
|
"display_name",
|
|
3880
4183
|
"errors"
|
|
3881
4184
|
],
|
|
3882
|
-
type: "object"
|
|
4185
|
+
type: "object",
|
|
4186
|
+
"x-route-path": "/acs/entrances"
|
|
3883
4187
|
},
|
|
3884
4188
|
acs_system: {
|
|
3885
4189
|
description: "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
@@ -4226,7 +4530,8 @@ var openapi_default = {
|
|
|
4226
4530
|
"errors",
|
|
4227
4531
|
"warnings"
|
|
4228
4532
|
],
|
|
4229
|
-
type: "object"
|
|
4533
|
+
type: "object",
|
|
4534
|
+
"x-route-path": "/acs/systems"
|
|
4230
4535
|
},
|
|
4231
4536
|
acs_user: {
|
|
4232
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).",
|
|
@@ -4496,7 +4801,8 @@ var openapi_default = {
|
|
|
4496
4801
|
"errors",
|
|
4497
4802
|
"is_managed"
|
|
4498
4803
|
],
|
|
4499
|
-
type: "object"
|
|
4804
|
+
type: "object",
|
|
4805
|
+
"x-route-path": "/acs/users"
|
|
4500
4806
|
},
|
|
4501
4807
|
action_attempt: {
|
|
4502
4808
|
oneOf: [
|
|
@@ -6974,7 +7280,8 @@ var openapi_default = {
|
|
|
6974
7280
|
],
|
|
6975
7281
|
type: "object"
|
|
6976
7282
|
}
|
|
6977
|
-
]
|
|
7283
|
+
],
|
|
7284
|
+
"x-route-path": "/action_attempts"
|
|
6978
7285
|
},
|
|
6979
7286
|
client_session: {
|
|
6980
7287
|
properties: {
|
|
@@ -7010,7 +7317,8 @@ var openapi_default = {
|
|
|
7010
7317
|
"connect_webview_ids",
|
|
7011
7318
|
"user_identity_ids"
|
|
7012
7319
|
],
|
|
7013
|
-
type: "object"
|
|
7320
|
+
type: "object",
|
|
7321
|
+
"x-route-path": "/client_sessions"
|
|
7014
7322
|
},
|
|
7015
7323
|
connect_webview: {
|
|
7016
7324
|
properties: {
|
|
@@ -7088,7 +7396,8 @@ var openapi_default = {
|
|
|
7088
7396
|
"authorized_at",
|
|
7089
7397
|
"selected_provider"
|
|
7090
7398
|
],
|
|
7091
|
-
type: "object"
|
|
7399
|
+
type: "object",
|
|
7400
|
+
"x-route-path": "/connect_webviews"
|
|
7092
7401
|
},
|
|
7093
7402
|
connected_account: {
|
|
7094
7403
|
properties: {
|
|
@@ -7162,7 +7471,8 @@ var openapi_default = {
|
|
|
7162
7471
|
"custom_metadata",
|
|
7163
7472
|
"automatically_manage_new_devices"
|
|
7164
7473
|
],
|
|
7165
|
-
type: "object"
|
|
7474
|
+
type: "object",
|
|
7475
|
+
"x-route-path": "/connected_accounts"
|
|
7166
7476
|
},
|
|
7167
7477
|
device: {
|
|
7168
7478
|
properties: {
|
|
@@ -8373,7 +8683,8 @@ var openapi_default = {
|
|
|
8373
8683
|
"created_at",
|
|
8374
8684
|
"errors"
|
|
8375
8685
|
],
|
|
8376
|
-
type: "object"
|
|
8686
|
+
type: "object",
|
|
8687
|
+
"x-route-path": "/thermostats/schedules"
|
|
8377
8688
|
},
|
|
8378
8689
|
available_climate_presets: {
|
|
8379
8690
|
items: {
|
|
@@ -8729,7 +9040,8 @@ var openapi_default = {
|
|
|
8729
9040
|
"is_managed",
|
|
8730
9041
|
"custom_metadata"
|
|
8731
9042
|
],
|
|
8732
|
-
type: "object"
|
|
9043
|
+
type: "object",
|
|
9044
|
+
"x-route-path": "/devices"
|
|
8733
9045
|
},
|
|
8734
9046
|
device_provider: {
|
|
8735
9047
|
properties: {
|
|
@@ -8816,7 +9128,8 @@ var openapi_default = {
|
|
|
8816
9128
|
"image_url",
|
|
8817
9129
|
"provider_categories"
|
|
8818
9130
|
],
|
|
8819
|
-
type: "object"
|
|
9131
|
+
type: "object",
|
|
9132
|
+
"x-route-path": "/devices"
|
|
8820
9133
|
},
|
|
8821
9134
|
enrollment_automation: {
|
|
8822
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).",
|
|
@@ -8854,7 +9167,8 @@ var openapi_default = {
|
|
|
8854
9167
|
"created_at",
|
|
8855
9168
|
"workspace_id"
|
|
8856
9169
|
],
|
|
8857
|
-
type: "object"
|
|
9170
|
+
type: "object",
|
|
9171
|
+
"x-route-path": "/user_identities/enrollment_automations"
|
|
8858
9172
|
},
|
|
8859
9173
|
event: {
|
|
8860
9174
|
discriminator: { propertyName: "event_type" },
|
|
@@ -8909,7 +9223,8 @@ var openapi_default = {
|
|
|
8909
9223
|
"connected_account_id",
|
|
8910
9224
|
"event_type"
|
|
8911
9225
|
],
|
|
8912
|
-
type: "object"
|
|
9226
|
+
type: "object",
|
|
9227
|
+
"x-route-path": "/access_codes"
|
|
8913
9228
|
},
|
|
8914
9229
|
{
|
|
8915
9230
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.",
|
|
@@ -8961,7 +9276,8 @@ var openapi_default = {
|
|
|
8961
9276
|
"connected_account_id",
|
|
8962
9277
|
"event_type"
|
|
8963
9278
|
],
|
|
8964
|
-
type: "object"
|
|
9279
|
+
type: "object",
|
|
9280
|
+
"x-route-path": "/access_codes"
|
|
8965
9281
|
},
|
|
8966
9282
|
{
|
|
8967
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.",
|
|
@@ -9021,7 +9337,8 @@ var openapi_default = {
|
|
|
9021
9337
|
"event_type",
|
|
9022
9338
|
"code"
|
|
9023
9339
|
],
|
|
9024
|
-
type: "object"
|
|
9340
|
+
type: "object",
|
|
9341
|
+
"x-route-path": "/access_codes"
|
|
9025
9342
|
},
|
|
9026
9343
|
{
|
|
9027
9344
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.",
|
|
@@ -9081,7 +9398,8 @@ var openapi_default = {
|
|
|
9081
9398
|
"event_type",
|
|
9082
9399
|
"code"
|
|
9083
9400
|
],
|
|
9084
|
-
type: "object"
|
|
9401
|
+
type: "object",
|
|
9402
|
+
"x-route-path": "/access_codes"
|
|
9085
9403
|
},
|
|
9086
9404
|
{
|
|
9087
9405
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.",
|
|
@@ -9136,7 +9454,8 @@ var openapi_default = {
|
|
|
9136
9454
|
"connected_account_id",
|
|
9137
9455
|
"event_type"
|
|
9138
9456
|
],
|
|
9139
|
-
type: "object"
|
|
9457
|
+
type: "object",
|
|
9458
|
+
"x-route-path": "/access_codes"
|
|
9140
9459
|
},
|
|
9141
9460
|
{
|
|
9142
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.",
|
|
@@ -9191,7 +9510,8 @@ var openapi_default = {
|
|
|
9191
9510
|
"connected_account_id",
|
|
9192
9511
|
"event_type"
|
|
9193
9512
|
],
|
|
9194
|
-
type: "object"
|
|
9513
|
+
type: "object",
|
|
9514
|
+
"x-route-path": "/access_codes"
|
|
9195
9515
|
},
|
|
9196
9516
|
{
|
|
9197
9517
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.",
|
|
@@ -9246,7 +9566,8 @@ var openapi_default = {
|
|
|
9246
9566
|
"connected_account_id",
|
|
9247
9567
|
"event_type"
|
|
9248
9568
|
],
|
|
9249
|
-
type: "object"
|
|
9569
|
+
type: "object",
|
|
9570
|
+
"x-route-path": "/access_codes"
|
|
9250
9571
|
},
|
|
9251
9572
|
{
|
|
9252
9573
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.",
|
|
@@ -9304,7 +9625,8 @@ var openapi_default = {
|
|
|
9304
9625
|
"event_type",
|
|
9305
9626
|
"code"
|
|
9306
9627
|
],
|
|
9307
|
-
type: "object"
|
|
9628
|
+
type: "object",
|
|
9629
|
+
"x-route-path": "/access_codes"
|
|
9308
9630
|
},
|
|
9309
9631
|
{
|
|
9310
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.",
|
|
@@ -9359,7 +9681,8 @@ var openapi_default = {
|
|
|
9359
9681
|
"connected_account_id",
|
|
9360
9682
|
"event_type"
|
|
9361
9683
|
],
|
|
9362
|
-
type: "object"
|
|
9684
|
+
type: "object",
|
|
9685
|
+
"x-route-path": "/access_codes"
|
|
9363
9686
|
},
|
|
9364
9687
|
{
|
|
9365
9688
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.",
|
|
@@ -9414,7 +9737,8 @@ var openapi_default = {
|
|
|
9414
9737
|
"connected_account_id",
|
|
9415
9738
|
"event_type"
|
|
9416
9739
|
],
|
|
9417
|
-
type: "object"
|
|
9740
|
+
type: "object",
|
|
9741
|
+
"x-route-path": "/access_codes"
|
|
9418
9742
|
},
|
|
9419
9743
|
{
|
|
9420
9744
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.",
|
|
@@ -9469,7 +9793,8 @@ var openapi_default = {
|
|
|
9469
9793
|
"connected_account_id",
|
|
9470
9794
|
"event_type"
|
|
9471
9795
|
],
|
|
9472
|
-
type: "object"
|
|
9796
|
+
type: "object",
|
|
9797
|
+
"x-route-path": "/access_codes"
|
|
9473
9798
|
},
|
|
9474
9799
|
{
|
|
9475
9800
|
description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.",
|
|
@@ -9524,7 +9849,8 @@ var openapi_default = {
|
|
|
9524
9849
|
"connected_account_id",
|
|
9525
9850
|
"event_type"
|
|
9526
9851
|
],
|
|
9527
|
-
type: "object"
|
|
9852
|
+
type: "object",
|
|
9853
|
+
"x-route-path": "/access_codes"
|
|
9528
9854
|
},
|
|
9529
9855
|
{
|
|
9530
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.",
|
|
@@ -9581,7 +9907,8 @@ var openapi_default = {
|
|
|
9581
9907
|
"event_type",
|
|
9582
9908
|
"backup_access_code_id"
|
|
9583
9909
|
],
|
|
9584
|
-
type: "object"
|
|
9910
|
+
type: "object",
|
|
9911
|
+
"x-route-path": "/access_codes"
|
|
9585
9912
|
},
|
|
9586
9913
|
{
|
|
9587
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.",
|
|
@@ -9636,7 +9963,8 @@ var openapi_default = {
|
|
|
9636
9963
|
"connected_account_id",
|
|
9637
9964
|
"event_type"
|
|
9638
9965
|
],
|
|
9639
|
-
type: "object"
|
|
9966
|
+
type: "object",
|
|
9967
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9640
9968
|
},
|
|
9641
9969
|
{
|
|
9642
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.",
|
|
@@ -9691,7 +10019,8 @@ var openapi_default = {
|
|
|
9691
10019
|
"connected_account_id",
|
|
9692
10020
|
"event_type"
|
|
9693
10021
|
],
|
|
9694
|
-
type: "object"
|
|
10022
|
+
type: "object",
|
|
10023
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9695
10024
|
},
|
|
9696
10025
|
{
|
|
9697
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.",
|
|
@@ -9746,7 +10075,8 @@ var openapi_default = {
|
|
|
9746
10075
|
"connected_account_id",
|
|
9747
10076
|
"event_type"
|
|
9748
10077
|
],
|
|
9749
|
-
type: "object"
|
|
10078
|
+
type: "object",
|
|
10079
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9750
10080
|
},
|
|
9751
10081
|
{
|
|
9752
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.",
|
|
@@ -9801,7 +10131,8 @@ var openapi_default = {
|
|
|
9801
10131
|
"connected_account_id",
|
|
9802
10132
|
"event_type"
|
|
9803
10133
|
],
|
|
9804
|
-
type: "object"
|
|
10134
|
+
type: "object",
|
|
10135
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
9805
10136
|
},
|
|
9806
10137
|
{
|
|
9807
10138
|
description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.",
|
|
@@ -9846,7 +10177,8 @@ var openapi_default = {
|
|
|
9846
10177
|
"acs_system_id",
|
|
9847
10178
|
"event_type"
|
|
9848
10179
|
],
|
|
9849
|
-
type: "object"
|
|
10180
|
+
type: "object",
|
|
10181
|
+
"x-route-path": "/acs/systems"
|
|
9850
10182
|
},
|
|
9851
10183
|
{
|
|
9852
10184
|
description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.",
|
|
@@ -9891,7 +10223,8 @@ var openapi_default = {
|
|
|
9891
10223
|
"acs_system_id",
|
|
9892
10224
|
"event_type"
|
|
9893
10225
|
],
|
|
9894
|
-
type: "object"
|
|
10226
|
+
type: "object",
|
|
10227
|
+
"x-route-path": "/acs/systems"
|
|
9895
10228
|
},
|
|
9896
10229
|
{
|
|
9897
10230
|
description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.",
|
|
@@ -9936,7 +10269,8 @@ var openapi_default = {
|
|
|
9936
10269
|
"acs_system_id",
|
|
9937
10270
|
"event_type"
|
|
9938
10271
|
],
|
|
9939
|
-
type: "object"
|
|
10272
|
+
type: "object",
|
|
10273
|
+
"x-route-path": "/acs/systems"
|
|
9940
10274
|
},
|
|
9941
10275
|
{
|
|
9942
10276
|
description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.",
|
|
@@ -9983,7 +10317,8 @@ var openapi_default = {
|
|
|
9983
10317
|
"acs_credential_id",
|
|
9984
10318
|
"event_type"
|
|
9985
10319
|
],
|
|
9986
|
-
type: "object"
|
|
10320
|
+
type: "object",
|
|
10321
|
+
"x-route-path": "/acs/credentials"
|
|
9987
10322
|
},
|
|
9988
10323
|
{
|
|
9989
10324
|
description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.",
|
|
@@ -10030,7 +10365,8 @@ var openapi_default = {
|
|
|
10030
10365
|
"acs_credential_id",
|
|
10031
10366
|
"event_type"
|
|
10032
10367
|
],
|
|
10033
|
-
type: "object"
|
|
10368
|
+
type: "object",
|
|
10369
|
+
"x-route-path": "/acs/credentials"
|
|
10034
10370
|
},
|
|
10035
10371
|
{
|
|
10036
10372
|
description: "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.",
|
|
@@ -10077,7 +10413,8 @@ var openapi_default = {
|
|
|
10077
10413
|
"acs_user_id",
|
|
10078
10414
|
"event_type"
|
|
10079
10415
|
],
|
|
10080
|
-
type: "object"
|
|
10416
|
+
type: "object",
|
|
10417
|
+
"x-route-path": "/acs/users"
|
|
10081
10418
|
},
|
|
10082
10419
|
{
|
|
10083
10420
|
description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.",
|
|
@@ -10128,7 +10465,8 @@ var openapi_default = {
|
|
|
10128
10465
|
"acs_encoder_id",
|
|
10129
10466
|
"event_type"
|
|
10130
10467
|
],
|
|
10131
|
-
type: "object"
|
|
10468
|
+
type: "object",
|
|
10469
|
+
"x-route-path": "/acs/encoders"
|
|
10132
10470
|
},
|
|
10133
10471
|
{
|
|
10134
10472
|
description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.",
|
|
@@ -10179,7 +10517,59 @@ var openapi_default = {
|
|
|
10179
10517
|
"acs_encoder_id",
|
|
10180
10518
|
"event_type"
|
|
10181
10519
|
],
|
|
10182
|
-
type: "object"
|
|
10520
|
+
type: "object",
|
|
10521
|
+
"x-route-path": "/acs/encoders"
|
|
10522
|
+
},
|
|
10523
|
+
{
|
|
10524
|
+
description: "An ACS access group was deleted.",
|
|
10525
|
+
properties: {
|
|
10526
|
+
acs_access_group_id: { format: "uuid", type: "string" },
|
|
10527
|
+
acs_system_id: {
|
|
10528
|
+
description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
10529
|
+
format: "uuid",
|
|
10530
|
+
type: "string"
|
|
10531
|
+
},
|
|
10532
|
+
connected_account_id: {
|
|
10533
|
+
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
10534
|
+
format: "uuid",
|
|
10535
|
+
type: "string"
|
|
10536
|
+
},
|
|
10537
|
+
created_at: {
|
|
10538
|
+
description: "Date and time at which the event was created.",
|
|
10539
|
+
format: "date-time",
|
|
10540
|
+
type: "string"
|
|
10541
|
+
},
|
|
10542
|
+
event_id: {
|
|
10543
|
+
description: "ID of the event.",
|
|
10544
|
+
format: "uuid",
|
|
10545
|
+
type: "string"
|
|
10546
|
+
},
|
|
10547
|
+
event_type: {
|
|
10548
|
+
enum: ["acs_access_group.deleted"],
|
|
10549
|
+
type: "string"
|
|
10550
|
+
},
|
|
10551
|
+
occurred_at: {
|
|
10552
|
+
description: "Date and time at which the event occurred.",
|
|
10553
|
+
format: "date-time",
|
|
10554
|
+
type: "string"
|
|
10555
|
+
},
|
|
10556
|
+
workspace_id: {
|
|
10557
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
|
|
10558
|
+
format: "uuid",
|
|
10559
|
+
type: "string"
|
|
10560
|
+
}
|
|
10561
|
+
},
|
|
10562
|
+
required: [
|
|
10563
|
+
"event_id",
|
|
10564
|
+
"workspace_id",
|
|
10565
|
+
"created_at",
|
|
10566
|
+
"occurred_at",
|
|
10567
|
+
"acs_system_id",
|
|
10568
|
+
"acs_access_group_id",
|
|
10569
|
+
"event_type"
|
|
10570
|
+
],
|
|
10571
|
+
type: "object",
|
|
10572
|
+
"x-route-path": "/acs/access_groups"
|
|
10183
10573
|
},
|
|
10184
10574
|
{
|
|
10185
10575
|
description: "A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.",
|
|
@@ -10219,7 +10609,8 @@ var openapi_default = {
|
|
|
10219
10609
|
"client_session_id",
|
|
10220
10610
|
"event_type"
|
|
10221
10611
|
],
|
|
10222
|
-
type: "object"
|
|
10612
|
+
type: "object",
|
|
10613
|
+
"x-route-path": "/client_sessions"
|
|
10223
10614
|
},
|
|
10224
10615
|
{
|
|
10225
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.",
|
|
@@ -10268,7 +10659,8 @@ var openapi_default = {
|
|
|
10268
10659
|
"event_type",
|
|
10269
10660
|
"connect_webview_id"
|
|
10270
10661
|
],
|
|
10271
|
-
type: "object"
|
|
10662
|
+
type: "object",
|
|
10663
|
+
"x-route-path": "/connected_accounts"
|
|
10272
10664
|
},
|
|
10273
10665
|
{
|
|
10274
10666
|
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.",
|
|
@@ -10317,7 +10709,8 @@ var openapi_default = {
|
|
|
10317
10709
|
"event_type",
|
|
10318
10710
|
"connect_webview_id"
|
|
10319
10711
|
],
|
|
10320
|
-
type: "object"
|
|
10712
|
+
type: "object",
|
|
10713
|
+
"x-route-path": "/connected_accounts"
|
|
10321
10714
|
},
|
|
10322
10715
|
{
|
|
10323
10716
|
deprecated: true,
|
|
@@ -10368,7 +10761,8 @@ var openapi_default = {
|
|
|
10368
10761
|
"connect_webview_id"
|
|
10369
10762
|
],
|
|
10370
10763
|
type: "object",
|
|
10371
|
-
"x-deprecated": "Use `connect_webview.login_succeeded`."
|
|
10764
|
+
"x-deprecated": "Use `connect_webview.login_succeeded`.",
|
|
10765
|
+
"x-route-path": "/connected_accounts"
|
|
10372
10766
|
},
|
|
10373
10767
|
{
|
|
10374
10768
|
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.",
|
|
@@ -10411,7 +10805,8 @@ var openapi_default = {
|
|
|
10411
10805
|
"connected_account_id",
|
|
10412
10806
|
"event_type"
|
|
10413
10807
|
],
|
|
10414
|
-
type: "object"
|
|
10808
|
+
type: "object",
|
|
10809
|
+
"x-route-path": "/connected_accounts"
|
|
10415
10810
|
},
|
|
10416
10811
|
{
|
|
10417
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.",
|
|
@@ -10454,7 +10849,8 @@ var openapi_default = {
|
|
|
10454
10849
|
"connected_account_id",
|
|
10455
10850
|
"event_type"
|
|
10456
10851
|
],
|
|
10457
|
-
type: "object"
|
|
10852
|
+
type: "object",
|
|
10853
|
+
"x-route-path": "/connected_accounts"
|
|
10458
10854
|
},
|
|
10459
10855
|
{
|
|
10460
10856
|
description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.",
|
|
@@ -10497,7 +10893,8 @@ var openapi_default = {
|
|
|
10497
10893
|
"connected_account_id",
|
|
10498
10894
|
"event_type"
|
|
10499
10895
|
],
|
|
10500
|
-
type: "object"
|
|
10896
|
+
type: "object",
|
|
10897
|
+
"x-route-path": "/connected_accounts"
|
|
10501
10898
|
},
|
|
10502
10899
|
{
|
|
10503
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.",
|
|
@@ -10542,7 +10939,8 @@ var openapi_default = {
|
|
|
10542
10939
|
"connected_account_id",
|
|
10543
10940
|
"event_type"
|
|
10544
10941
|
],
|
|
10545
|
-
type: "object"
|
|
10942
|
+
type: "object",
|
|
10943
|
+
"x-route-path": "/connected_accounts"
|
|
10546
10944
|
},
|
|
10547
10945
|
{
|
|
10548
10946
|
description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
|
|
@@ -10589,7 +10987,8 @@ var openapi_default = {
|
|
|
10589
10987
|
"status",
|
|
10590
10988
|
"event_type"
|
|
10591
10989
|
],
|
|
10592
|
-
type: "object"
|
|
10990
|
+
type: "object",
|
|
10991
|
+
"x-route-path": "/action_attempts"
|
|
10593
10992
|
},
|
|
10594
10993
|
{
|
|
10595
10994
|
description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
|
|
@@ -10636,7 +11035,8 @@ var openapi_default = {
|
|
|
10636
11035
|
"status",
|
|
10637
11036
|
"event_type"
|
|
10638
11037
|
],
|
|
10639
|
-
type: "object"
|
|
11038
|
+
type: "object",
|
|
11039
|
+
"x-route-path": "/action_attempts"
|
|
10640
11040
|
},
|
|
10641
11041
|
{
|
|
10642
11042
|
description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
|
|
@@ -10683,7 +11083,8 @@ var openapi_default = {
|
|
|
10683
11083
|
"status",
|
|
10684
11084
|
"event_type"
|
|
10685
11085
|
],
|
|
10686
|
-
type: "object"
|
|
11086
|
+
type: "object",
|
|
11087
|
+
"x-route-path": "/action_attempts"
|
|
10687
11088
|
},
|
|
10688
11089
|
{
|
|
10689
11090
|
description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
|
|
@@ -10730,7 +11131,8 @@ var openapi_default = {
|
|
|
10730
11131
|
"status",
|
|
10731
11132
|
"event_type"
|
|
10732
11133
|
],
|
|
10733
|
-
type: "object"
|
|
11134
|
+
type: "object",
|
|
11135
|
+
"x-route-path": "/action_attempts"
|
|
10734
11136
|
},
|
|
10735
11137
|
{
|
|
10736
11138
|
description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.",
|
|
@@ -10779,7 +11181,8 @@ var openapi_default = {
|
|
|
10779
11181
|
"event_type",
|
|
10780
11182
|
"connected_account_id"
|
|
10781
11183
|
],
|
|
10782
|
-
type: "object"
|
|
11184
|
+
type: "object",
|
|
11185
|
+
"x-route-path": "/connect_webviews"
|
|
10783
11186
|
},
|
|
10784
11187
|
{
|
|
10785
11188
|
description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.",
|
|
@@ -10822,7 +11225,8 @@ var openapi_default = {
|
|
|
10822
11225
|
"connect_webview_id",
|
|
10823
11226
|
"event_type"
|
|
10824
11227
|
],
|
|
10825
|
-
type: "object"
|
|
11228
|
+
type: "object",
|
|
11229
|
+
"x-route-path": "/connect_webviews"
|
|
10826
11230
|
},
|
|
10827
11231
|
{
|
|
10828
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.",
|
|
@@ -10868,7 +11272,8 @@ var openapi_default = {
|
|
|
10868
11272
|
"connected_account_id",
|
|
10869
11273
|
"event_type"
|
|
10870
11274
|
],
|
|
10871
|
-
type: "object"
|
|
11275
|
+
type: "object",
|
|
11276
|
+
"x-route-path": "/devices"
|
|
10872
11277
|
},
|
|
10873
11278
|
{
|
|
10874
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.",
|
|
@@ -10914,10 +11319,11 @@ var openapi_default = {
|
|
|
10914
11319
|
"connected_account_id",
|
|
10915
11320
|
"event_type"
|
|
10916
11321
|
],
|
|
10917
|
-
type: "object"
|
|
11322
|
+
type: "object",
|
|
11323
|
+
"x-route-path": "/devices"
|
|
10918
11324
|
},
|
|
10919
11325
|
{
|
|
10920
|
-
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).",
|
|
10921
11327
|
properties: {
|
|
10922
11328
|
connected_account_id: {
|
|
10923
11329
|
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
@@ -10963,10 +11369,11 @@ var openapi_default = {
|
|
|
10963
11369
|
"connected_account_id",
|
|
10964
11370
|
"event_type"
|
|
10965
11371
|
],
|
|
10966
|
-
type: "object"
|
|
11372
|
+
type: "object",
|
|
11373
|
+
"x-route-path": "/devices"
|
|
10967
11374
|
},
|
|
10968
11375
|
{
|
|
10969
|
-
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.",
|
|
10970
11377
|
properties: {
|
|
10971
11378
|
connected_account_id: {
|
|
10972
11379
|
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
@@ -11012,7 +11419,8 @@ var openapi_default = {
|
|
|
11012
11419
|
"connected_account_id",
|
|
11013
11420
|
"event_type"
|
|
11014
11421
|
],
|
|
11015
|
-
type: "object"
|
|
11422
|
+
type: "object",
|
|
11423
|
+
"x-route-path": "/devices/unmanaged"
|
|
11016
11424
|
},
|
|
11017
11425
|
{
|
|
11018
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`.",
|
|
@@ -11061,7 +11469,8 @@ var openapi_default = {
|
|
|
11061
11469
|
"connected_account_id",
|
|
11062
11470
|
"event_type"
|
|
11063
11471
|
],
|
|
11064
|
-
type: "object"
|
|
11472
|
+
type: "object",
|
|
11473
|
+
"x-route-path": "/devices/unmanaged"
|
|
11065
11474
|
},
|
|
11066
11475
|
{
|
|
11067
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`.",
|
|
@@ -11117,7 +11526,8 @@ var openapi_default = {
|
|
|
11117
11526
|
"event_type",
|
|
11118
11527
|
"error_code"
|
|
11119
11528
|
],
|
|
11120
|
-
type: "object"
|
|
11529
|
+
type: "object",
|
|
11530
|
+
"x-route-path": "/devices"
|
|
11121
11531
|
},
|
|
11122
11532
|
{
|
|
11123
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`.",
|
|
@@ -11176,7 +11586,8 @@ var openapi_default = {
|
|
|
11176
11586
|
"event_type",
|
|
11177
11587
|
"error_code"
|
|
11178
11588
|
],
|
|
11179
|
-
type: "object"
|
|
11589
|
+
type: "object",
|
|
11590
|
+
"x-route-path": "/devices/unmanaged"
|
|
11180
11591
|
},
|
|
11181
11592
|
{
|
|
11182
11593
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.",
|
|
@@ -11222,7 +11633,8 @@ var openapi_default = {
|
|
|
11222
11633
|
"connected_account_id",
|
|
11223
11634
|
"event_type"
|
|
11224
11635
|
],
|
|
11225
|
-
type: "object"
|
|
11636
|
+
type: "object",
|
|
11637
|
+
"x-route-path": "/devices"
|
|
11226
11638
|
},
|
|
11227
11639
|
{
|
|
11228
11640
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.",
|
|
@@ -11276,7 +11688,8 @@ var openapi_default = {
|
|
|
11276
11688
|
"event_type",
|
|
11277
11689
|
"battery_level"
|
|
11278
11690
|
],
|
|
11279
|
-
type: "object"
|
|
11691
|
+
type: "object",
|
|
11692
|
+
"x-route-path": "/devices"
|
|
11280
11693
|
},
|
|
11281
11694
|
{
|
|
11282
11695
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.",
|
|
@@ -11339,7 +11752,8 @@ var openapi_default = {
|
|
|
11339
11752
|
"battery_status",
|
|
11340
11753
|
"battery_level"
|
|
11341
11754
|
],
|
|
11342
|
-
type: "object"
|
|
11755
|
+
type: "object",
|
|
11756
|
+
"x-route-path": "/devices"
|
|
11343
11757
|
},
|
|
11344
11758
|
{
|
|
11345
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).",
|
|
@@ -11385,7 +11799,8 @@ var openapi_default = {
|
|
|
11385
11799
|
"connected_account_id",
|
|
11386
11800
|
"event_type"
|
|
11387
11801
|
],
|
|
11388
|
-
type: "object"
|
|
11802
|
+
type: "object",
|
|
11803
|
+
"x-route-path": "/devices"
|
|
11389
11804
|
},
|
|
11390
11805
|
{
|
|
11391
11806
|
description: "A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.",
|
|
@@ -11431,7 +11846,8 @@ var openapi_default = {
|
|
|
11431
11846
|
"connected_account_id",
|
|
11432
11847
|
"event_type"
|
|
11433
11848
|
],
|
|
11434
|
-
type: "object"
|
|
11849
|
+
type: "object",
|
|
11850
|
+
"x-route-path": "/devices"
|
|
11435
11851
|
},
|
|
11436
11852
|
{
|
|
11437
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.",
|
|
@@ -11480,7 +11896,8 @@ var openapi_default = {
|
|
|
11480
11896
|
"connected_account_id",
|
|
11481
11897
|
"event_type"
|
|
11482
11898
|
],
|
|
11483
|
-
type: "object"
|
|
11899
|
+
type: "object",
|
|
11900
|
+
"x-route-path": "/devices"
|
|
11484
11901
|
},
|
|
11485
11902
|
{
|
|
11486
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.",
|
|
@@ -11529,7 +11946,8 @@ var openapi_default = {
|
|
|
11529
11946
|
"connected_account_id",
|
|
11530
11947
|
"event_type"
|
|
11531
11948
|
],
|
|
11532
|
-
type: "object"
|
|
11949
|
+
type: "object",
|
|
11950
|
+
"x-route-path": "/devices"
|
|
11533
11951
|
},
|
|
11534
11952
|
{
|
|
11535
11953
|
description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.",
|
|
@@ -11578,7 +11996,8 @@ var openapi_default = {
|
|
|
11578
11996
|
"connected_account_id",
|
|
11579
11997
|
"event_type"
|
|
11580
11998
|
],
|
|
11581
|
-
type: "object"
|
|
11999
|
+
type: "object",
|
|
12000
|
+
"x-route-path": "/devices"
|
|
11582
12001
|
},
|
|
11583
12002
|
{
|
|
11584
12003
|
description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.",
|
|
@@ -11627,7 +12046,8 @@ var openapi_default = {
|
|
|
11627
12046
|
"connected_account_id",
|
|
11628
12047
|
"event_type"
|
|
11629
12048
|
],
|
|
11630
|
-
type: "object"
|
|
12049
|
+
type: "object",
|
|
12050
|
+
"x-route-path": "/devices"
|
|
11631
12051
|
},
|
|
11632
12052
|
{
|
|
11633
12053
|
description: "Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.",
|
|
@@ -11676,7 +12096,8 @@ var openapi_default = {
|
|
|
11676
12096
|
"connected_account_id",
|
|
11677
12097
|
"event_type"
|
|
11678
12098
|
],
|
|
11679
|
-
type: "object"
|
|
12099
|
+
type: "object",
|
|
12100
|
+
"x-route-path": "/devices"
|
|
11680
12101
|
},
|
|
11681
12102
|
{
|
|
11682
12103
|
description: "Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.",
|
|
@@ -11725,7 +12146,8 @@ var openapi_default = {
|
|
|
11725
12146
|
"connected_account_id",
|
|
11726
12147
|
"event_type"
|
|
11727
12148
|
],
|
|
11728
|
-
type: "object"
|
|
12149
|
+
type: "object",
|
|
12150
|
+
"x-route-path": "/devices"
|
|
11729
12151
|
},
|
|
11730
12152
|
{
|
|
11731
12153
|
description: "A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.",
|
|
@@ -11774,7 +12196,8 @@ var openapi_default = {
|
|
|
11774
12196
|
"connected_account_id",
|
|
11775
12197
|
"event_type"
|
|
11776
12198
|
],
|
|
11777
|
-
type: "object"
|
|
12199
|
+
type: "object",
|
|
12200
|
+
"x-route-path": "/devices"
|
|
11778
12201
|
},
|
|
11779
12202
|
{
|
|
11780
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.",
|
|
@@ -11823,7 +12246,8 @@ var openapi_default = {
|
|
|
11823
12246
|
"connected_account_id",
|
|
11824
12247
|
"event_type"
|
|
11825
12248
|
],
|
|
11826
|
-
type: "object"
|
|
12249
|
+
type: "object",
|
|
12250
|
+
"x-route-path": "/devices"
|
|
11827
12251
|
},
|
|
11828
12252
|
{
|
|
11829
12253
|
description: "An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
@@ -11872,7 +12296,8 @@ var openapi_default = {
|
|
|
11872
12296
|
"connected_account_id",
|
|
11873
12297
|
"event_type"
|
|
11874
12298
|
],
|
|
11875
|
-
type: "object"
|
|
12299
|
+
type: "object",
|
|
12300
|
+
"x-route-path": "/devices"
|
|
11876
12301
|
},
|
|
11877
12302
|
{
|
|
11878
12303
|
description: "An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
@@ -11921,7 +12346,8 @@ var openapi_default = {
|
|
|
11921
12346
|
"connected_account_id",
|
|
11922
12347
|
"event_type"
|
|
11923
12348
|
],
|
|
11924
|
-
type: "object"
|
|
12349
|
+
type: "object",
|
|
12350
|
+
"x-route-path": "/devices"
|
|
11925
12351
|
},
|
|
11926
12352
|
{
|
|
11927
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.",
|
|
@@ -11999,7 +12425,8 @@ var openapi_default = {
|
|
|
11999
12425
|
"connected_account_id",
|
|
12000
12426
|
"event_type"
|
|
12001
12427
|
],
|
|
12002
|
-
type: "object"
|
|
12428
|
+
type: "object",
|
|
12429
|
+
"x-route-path": "/noise_sensors/noise_thresholds"
|
|
12003
12430
|
},
|
|
12004
12431
|
{
|
|
12005
12432
|
description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.",
|
|
@@ -12061,7 +12488,8 @@ var openapi_default = {
|
|
|
12061
12488
|
"event_type",
|
|
12062
12489
|
"method"
|
|
12063
12490
|
],
|
|
12064
|
-
type: "object"
|
|
12491
|
+
type: "object",
|
|
12492
|
+
"x-route-path": "/locks"
|
|
12065
12493
|
},
|
|
12066
12494
|
{
|
|
12067
12495
|
description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.",
|
|
@@ -12123,7 +12551,8 @@ var openapi_default = {
|
|
|
12123
12551
|
"event_type",
|
|
12124
12552
|
"method"
|
|
12125
12553
|
],
|
|
12126
|
-
type: "object"
|
|
12554
|
+
type: "object",
|
|
12555
|
+
"x-route-path": "/locks"
|
|
12127
12556
|
},
|
|
12128
12557
|
{
|
|
12129
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.",
|
|
@@ -12174,7 +12603,8 @@ var openapi_default = {
|
|
|
12174
12603
|
"connected_account_id",
|
|
12175
12604
|
"event_type"
|
|
12176
12605
|
],
|
|
12177
|
-
type: "object"
|
|
12606
|
+
type: "object",
|
|
12607
|
+
"x-route-path": "/locks"
|
|
12178
12608
|
},
|
|
12179
12609
|
{
|
|
12180
12610
|
description: "A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.",
|
|
@@ -12240,7 +12670,8 @@ var openapi_default = {
|
|
|
12240
12670
|
"climate_preset_key",
|
|
12241
12671
|
"is_fallback_climate_preset"
|
|
12242
12672
|
],
|
|
12243
|
-
type: "object"
|
|
12673
|
+
type: "object",
|
|
12674
|
+
"x-route-path": "/thermostats"
|
|
12244
12675
|
},
|
|
12245
12676
|
{
|
|
12246
12677
|
description: "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.",
|
|
@@ -12325,7 +12756,8 @@ var openapi_default = {
|
|
|
12325
12756
|
"event_type",
|
|
12326
12757
|
"method"
|
|
12327
12758
|
],
|
|
12328
|
-
type: "object"
|
|
12759
|
+
type: "object",
|
|
12760
|
+
"x-route-path": "/thermostats"
|
|
12329
12761
|
},
|
|
12330
12762
|
{
|
|
12331
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).",
|
|
@@ -12414,7 +12846,8 @@ var openapi_default = {
|
|
|
12414
12846
|
"lower_limit_celsius",
|
|
12415
12847
|
"lower_limit_fahrenheit"
|
|
12416
12848
|
],
|
|
12417
|
-
type: "object"
|
|
12849
|
+
type: "object",
|
|
12850
|
+
"x-route-path": "/thermostats"
|
|
12418
12851
|
},
|
|
12419
12852
|
{
|
|
12420
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).",
|
|
@@ -12503,7 +12936,8 @@ var openapi_default = {
|
|
|
12503
12936
|
"lower_limit_celsius",
|
|
12504
12937
|
"lower_limit_fahrenheit"
|
|
12505
12938
|
],
|
|
12506
|
-
type: "object"
|
|
12939
|
+
type: "object",
|
|
12940
|
+
"x-route-path": "/thermostats"
|
|
12507
12941
|
},
|
|
12508
12942
|
{
|
|
12509
12943
|
properties: {
|
|
@@ -12573,7 +13007,8 @@ var openapi_default = {
|
|
|
12573
13007
|
"temperature_celsius",
|
|
12574
13008
|
"temperature_fahrenheit"
|
|
12575
13009
|
],
|
|
12576
|
-
type: "object"
|
|
13010
|
+
type: "object",
|
|
13011
|
+
"x-route-path": "/thermostats"
|
|
12577
13012
|
},
|
|
12578
13013
|
{
|
|
12579
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.",
|
|
@@ -12616,7 +13051,8 @@ var openapi_default = {
|
|
|
12616
13051
|
"enrollment_automation_id",
|
|
12617
13052
|
"event_type"
|
|
12618
13053
|
],
|
|
12619
|
-
type: "object"
|
|
13054
|
+
type: "object",
|
|
13055
|
+
"x-route-path": "/user_identities/enrollment_automations"
|
|
12620
13056
|
},
|
|
12621
13057
|
{
|
|
12622
13058
|
description: "A phone device was deactivated.",
|
|
@@ -12656,9 +13092,11 @@ var openapi_default = {
|
|
|
12656
13092
|
"device_id",
|
|
12657
13093
|
"event_type"
|
|
12658
13094
|
],
|
|
12659
|
-
type: "object"
|
|
13095
|
+
type: "object",
|
|
13096
|
+
"x-route-path": "/phones"
|
|
12660
13097
|
}
|
|
12661
|
-
]
|
|
13098
|
+
],
|
|
13099
|
+
"x-route-path": "/events"
|
|
12662
13100
|
},
|
|
12663
13101
|
network: {
|
|
12664
13102
|
properties: {
|
|
@@ -12668,7 +13106,8 @@ var openapi_default = {
|
|
|
12668
13106
|
workspace_id: { format: "uuid", type: "string" }
|
|
12669
13107
|
},
|
|
12670
13108
|
required: ["network_id", "workspace_id", "display_name", "created_at"],
|
|
12671
|
-
type: "object"
|
|
13109
|
+
type: "object",
|
|
13110
|
+
"x-route-path": "/networks"
|
|
12672
13111
|
},
|
|
12673
13112
|
noise_threshold: {
|
|
12674
13113
|
properties: {
|
|
@@ -12688,7 +13127,8 @@ var openapi_default = {
|
|
|
12688
13127
|
"ends_daily_at",
|
|
12689
13128
|
"noise_threshold_decibels"
|
|
12690
13129
|
],
|
|
12691
|
-
type: "object"
|
|
13130
|
+
type: "object",
|
|
13131
|
+
"x-route-path": "/noise_sensors/noise_thresholds"
|
|
12692
13132
|
},
|
|
12693
13133
|
phone: {
|
|
12694
13134
|
properties: {
|
|
@@ -13029,7 +13469,8 @@ var openapi_default = {
|
|
|
13029
13469
|
"is_managed",
|
|
13030
13470
|
"custom_metadata"
|
|
13031
13471
|
],
|
|
13032
|
-
type: "object"
|
|
13472
|
+
type: "object",
|
|
13473
|
+
"x-route-path": "/phones"
|
|
13033
13474
|
},
|
|
13034
13475
|
service_health: {
|
|
13035
13476
|
properties: {
|
|
@@ -13038,7 +13479,8 @@ var openapi_default = {
|
|
|
13038
13479
|
status: { enum: ["healthy", "degraded", "down"], type: "string" }
|
|
13039
13480
|
},
|
|
13040
13481
|
required: ["service", "status", "description"],
|
|
13041
|
-
type: "object"
|
|
13482
|
+
type: "object",
|
|
13483
|
+
"x-route-path": "/health"
|
|
13042
13484
|
},
|
|
13043
13485
|
thermostat_schedule: {
|
|
13044
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.",
|
|
@@ -13109,7 +13551,8 @@ var openapi_default = {
|
|
|
13109
13551
|
"created_at",
|
|
13110
13552
|
"errors"
|
|
13111
13553
|
],
|
|
13112
|
-
type: "object"
|
|
13554
|
+
type: "object",
|
|
13555
|
+
"x-route-path": "/thermostats/schedules"
|
|
13113
13556
|
},
|
|
13114
13557
|
unmanaged_access_code: {
|
|
13115
13558
|
properties: {
|
|
@@ -13402,7 +13845,8 @@ var openapi_default = {
|
|
|
13402
13845
|
"is_managed",
|
|
13403
13846
|
"status"
|
|
13404
13847
|
],
|
|
13405
|
-
type: "object"
|
|
13848
|
+
type: "object",
|
|
13849
|
+
"x-route-path": "/access_codes/unmanaged"
|
|
13406
13850
|
},
|
|
13407
13851
|
unmanaged_device: {
|
|
13408
13852
|
properties: {
|
|
@@ -13876,7 +14320,8 @@ var openapi_default = {
|
|
|
13876
14320
|
"is_managed",
|
|
13877
14321
|
"properties"
|
|
13878
14322
|
],
|
|
13879
|
-
type: "object"
|
|
14323
|
+
type: "object",
|
|
14324
|
+
"x-route-path": "/devices/unmanaged"
|
|
13880
14325
|
},
|
|
13881
14326
|
user_identity: {
|
|
13882
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.",
|
|
@@ -13926,7 +14371,8 @@ var openapi_default = {
|
|
|
13926
14371
|
"created_at",
|
|
13927
14372
|
"workspace_id"
|
|
13928
14373
|
],
|
|
13929
|
-
type: "object"
|
|
14374
|
+
type: "object",
|
|
14375
|
+
"x-route-path": "/user_identities"
|
|
13930
14376
|
},
|
|
13931
14377
|
webhook: {
|
|
13932
14378
|
properties: {
|
|
@@ -13936,7 +14382,8 @@ var openapi_default = {
|
|
|
13936
14382
|
webhook_id: { type: "string" }
|
|
13937
14383
|
},
|
|
13938
14384
|
required: ["webhook_id", "url"],
|
|
13939
|
-
type: "object"
|
|
14385
|
+
type: "object",
|
|
14386
|
+
"x-route-path": "/webhooks"
|
|
13940
14387
|
},
|
|
13941
14388
|
workspace: {
|
|
13942
14389
|
properties: {
|
|
@@ -13958,7 +14405,8 @@ var openapi_default = {
|
|
|
13958
14405
|
"is_sandbox",
|
|
13959
14406
|
"connect_partner_name"
|
|
13960
14407
|
],
|
|
13961
|
-
type: "object"
|
|
14408
|
+
type: "object",
|
|
14409
|
+
"x-route-path": "/workspaces"
|
|
13962
14410
|
}
|
|
13963
14411
|
},
|
|
13964
14412
|
securitySchemes: {
|
|
@@ -22557,6 +23005,7 @@ var openapi_default = {
|
|
|
22557
23005
|
"acs_system.added",
|
|
22558
23006
|
"acs_system.connected",
|
|
22559
23007
|
"acs_system.disconnected",
|
|
23008
|
+
"acs_access_group.deleted",
|
|
22560
23009
|
"acs_user.deleted",
|
|
22561
23010
|
"acs_credential.deleted",
|
|
22562
23011
|
"acs_credential.issued",
|
|
@@ -22635,6 +23084,7 @@ var openapi_default = {
|
|
|
22635
23084
|
"acs_system.added",
|
|
22636
23085
|
"acs_system.connected",
|
|
22637
23086
|
"acs_system.disconnected",
|
|
23087
|
+
"acs_access_group.deleted",
|
|
22638
23088
|
"acs_user.deleted",
|
|
22639
23089
|
"acs_credential.deleted",
|
|
22640
23090
|
"acs_credential.issued",
|