@seamapi/types 1.323.0 → 1.325.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.
Files changed (61) hide show
  1. package/dist/connect.cjs +1627 -773
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3829 -1177
  4. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +257 -5
  5. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +257 -5
  6. package/lib/seam/connect/models/acs/acs-system.d.ts +10 -10
  7. package/lib/seam/connect/models/devices/device.d.ts +419 -11
  8. package/lib/seam/connect/models/devices/device.js +103 -3
  9. package/lib/seam/connect/models/devices/device.js.map +1 -1
  10. package/lib/seam/connect/models/devices/phone.d.ts +258 -6
  11. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +258 -6
  12. package/lib/seam/connect/models/events/access-codes.js +32 -41
  13. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  14. package/lib/seam/connect/models/events/acs/common.js +9 -12
  15. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  16. package/lib/seam/connect/models/events/acs/credentials.js +2 -2
  17. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  18. package/lib/seam/connect/models/events/acs/encoders.js +6 -3
  19. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -1
  20. package/lib/seam/connect/models/events/acs/systems.js +3 -3
  21. package/lib/seam/connect/models/events/acs/systems.js.map +1 -1
  22. package/lib/seam/connect/models/events/acs/users.js +5 -3
  23. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  24. package/lib/seam/connect/models/events/action-attempts.js +10 -22
  25. package/lib/seam/connect/models/events/action-attempts.js.map +1 -1
  26. package/lib/seam/connect/models/events/client-sessions.js +5 -7
  27. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  28. package/lib/seam/connect/models/events/common.js +5 -2
  29. package/lib/seam/connect/models/events/common.js.map +1 -1
  30. package/lib/seam/connect/models/events/connect-webviews.js +10 -14
  31. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  32. package/lib/seam/connect/models/events/connected-accounts.js +15 -19
  33. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  34. package/lib/seam/connect/models/events/devices.js +43 -47
  35. package/lib/seam/connect/models/events/devices.js.map +1 -1
  36. package/lib/seam/connect/models/events/enrollment-automations.js +5 -7
  37. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  38. package/lib/seam/connect/models/events/phones.js +4 -6
  39. package/lib/seam/connect/models/events/phones.js.map +1 -1
  40. package/lib/seam/connect/openapi.d.ts +124 -222
  41. package/lib/seam/connect/openapi.js +1241 -475
  42. package/lib/seam/connect/openapi.js.map +1 -1
  43. package/lib/seam/connect/route-types.d.ts +2131 -545
  44. package/package.json +1 -1
  45. package/src/lib/seam/connect/models/devices/device.ts +118 -3
  46. package/src/lib/seam/connect/models/events/access-codes.ts +64 -41
  47. package/src/lib/seam/connect/models/events/acs/common.ts +13 -12
  48. package/src/lib/seam/connect/models/events/acs/credentials.ts +6 -2
  49. package/src/lib/seam/connect/models/events/acs/encoders.ts +12 -3
  50. package/src/lib/seam/connect/models/events/acs/systems.ts +9 -3
  51. package/src/lib/seam/connect/models/events/acs/users.ts +10 -4
  52. package/src/lib/seam/connect/models/events/action-attempts.ts +20 -22
  53. package/src/lib/seam/connect/models/events/client-sessions.ts +9 -7
  54. package/src/lib/seam/connect/models/events/common.ts +5 -2
  55. package/src/lib/seam/connect/models/events/connect-webviews.ts +18 -14
  56. package/src/lib/seam/connect/models/events/connected-accounts.ts +25 -19
  57. package/src/lib/seam/connect/models/events/devices.ts +75 -47
  58. package/src/lib/seam/connect/models/events/enrollment-automations.ts +9 -7
  59. package/src/lib/seam/connect/models/events/phones.ts +6 -6
  60. package/src/lib/seam/connect/openapi.ts +1449 -475
  61. package/src/lib/seam/connect/route-types.ts +2580 -630
package/dist/connect.cjs CHANGED
@@ -812,12 +812,64 @@ var common_device_error = zod.z.object({
812
812
  message: zod.z.string(),
813
813
  is_device_error: zod.z.literal(true)
814
814
  });
815
+ var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
815
816
  var common_device_warning = zod.z.object({
816
817
  message: zod.z.string()
817
818
  });
818
- var device_error = common_device_error.extend({
819
- error_code: zod.z.string()
820
- });
819
+ var device_offline = common_device_error.extend({
820
+ error_code: zod.z.literal("device_offline").describe(error_code_description)
821
+ }).describe("Device is offline");
822
+ var device_removed = common_device_error.extend({
823
+ error_code: zod.z.literal("device_removed").describe(error_code_description)
824
+ }).describe("Device has been removed");
825
+ var account_disconnected = common_device_error.extend({
826
+ error_code: zod.z.literal("account_disconnected").describe(error_code_description)
827
+ }).describe("Account is disconnected");
828
+ var hub_disconnected = common_device_error.extend({
829
+ error_code: zod.z.literal("hub_disconnected").describe(error_code_description)
830
+ }).describe("Hub is disconnected");
831
+ var device_disconnected = common_device_error.extend({
832
+ error_code: zod.z.literal("device_disconnected").describe(error_code_description)
833
+ }).describe("Device is disconnected");
834
+ var empty_backup_access_code_pool = common_device_error.extend({
835
+ error_code: zod.z.literal("empty_backup_access_code_pool").describe(error_code_description)
836
+ }).describe("The backup access code pool is empty.");
837
+ var august_lock_not_authorized = common_device_error.extend({
838
+ error_code: zod.z.literal("august_lock_not_authorized").describe(error_code_description)
839
+ }).describe("User is not authorized to use the August Lock.");
840
+ var august_lock_missing_bridge = common_device_error.extend({
841
+ error_code: zod.z.literal("august_lock_missing_bridge").describe(error_code_description)
842
+ }).describe("Lock is not connected to the Seam Bridge.");
843
+ var salto_site_user_limit_reached = common_device_error.extend({
844
+ error_code: zod.z.literal("salto_site_user_limit_reached").describe(error_code_description)
845
+ }).describe("Salto site user limit reached.");
846
+ var ttlock_lock_not_paired_to_gateway = common_device_error.extend({
847
+ error_code: zod.z.literal("ttlock_lock_not_paired_to_gateway").describe(error_code_description)
848
+ }).describe("Lock is not paired with a Gateway.");
849
+ var missing_device_credentials = common_device_error.extend({
850
+ error_code: zod.z.literal("missing_device_credentials").describe(error_code_description)
851
+ }).describe("Missing device credentials.");
852
+ var auxiliary_heat_running = common_device_error.extend({
853
+ error_code: zod.z.literal("auxiliary_heat_running").describe(error_code_description)
854
+ }).describe("The auxiliary heat is running.");
855
+ var subscription_required = common_device_error.extend({
856
+ error_code: zod.z.literal("subscription_required").describe(error_code_description)
857
+ }).describe("Subscription required to connect.");
858
+ var device_error = zod.z.union([
859
+ device_offline,
860
+ device_removed,
861
+ account_disconnected,
862
+ hub_disconnected,
863
+ device_disconnected,
864
+ empty_backup_access_code_pool,
865
+ august_lock_not_authorized,
866
+ august_lock_missing_bridge,
867
+ salto_site_user_limit_reached,
868
+ ttlock_lock_not_paired_to_gateway,
869
+ missing_device_credentials,
870
+ auxiliary_heat_running,
871
+ subscription_required
872
+ ]).describe("Error associated with the `device`.");
821
873
  var device_warning = common_device_warning.extend({
822
874
  warning_code: zod.z.string()
823
875
  });
@@ -1427,9 +1479,9 @@ var common_acs_encoder_error = zod.z.object({
1427
1479
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
1428
1480
  )
1429
1481
  });
1430
- var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
1482
+ var error_code_description2 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
1431
1483
  var acs_encoder_removed = common_acs_encoder_error.extend({
1432
- error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description)
1484
+ error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description2)
1433
1485
  });
1434
1486
  var acs_encoder_error = (
1435
1487
  // z.union([
@@ -1515,29 +1567,29 @@ var common_acs_system_error = zod.z.object({
1515
1567
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
1516
1568
  )
1517
1569
  });
1518
- var error_code_description2 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
1570
+ var error_code_description3 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
1519
1571
  var seam_bridge_disconnected = common_acs_system_error.extend({
1520
- error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description2)
1572
+ error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description3)
1521
1573
  }).describe(`Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
1522
1574
  This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
1523
1575
  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
1524
1576
  var visionline_instance_unreachable = common_acs_system_error.extend({
1525
- error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description2)
1577
+ error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description3)
1526
1578
  }).describe(`Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
1527
1579
  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
1528
1580
  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`);
1529
1581
  var salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
1530
- error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description2)
1582
+ error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description3)
1531
1583
  }).describe(
1532
1584
  "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
1533
1585
  );
1534
1586
  var acs_system_disconnected = common_acs_system_error.extend({
1535
- error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description2)
1587
+ error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description3)
1536
1588
  }).describe(
1537
1589
  "Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue."
1538
1590
  );
1539
- var account_disconnected = common_acs_system_error.extend({
1540
- error_code: zod.z.literal("account_disconnected").describe(error_code_description2)
1591
+ var account_disconnected2 = common_acs_system_error.extend({
1592
+ error_code: zod.z.literal("account_disconnected").describe(error_code_description3)
1541
1593
  }).describe(
1542
1594
  "Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access."
1543
1595
  );
@@ -1551,7 +1603,7 @@ var acs_system_error = zod.z.union([
1551
1603
  visionline_instance_unreachable,
1552
1604
  salto_ks_subscription_limit_exceeded,
1553
1605
  acs_system_disconnected,
1554
- account_disconnected,
1606
+ account_disconnected2,
1555
1607
  salto_ks_certification_expired
1556
1608
  ]).describe("Error associated with the `acs_system`.");
1557
1609
  zod.z.object({
@@ -1559,7 +1611,7 @@ zod.z.object({
1559
1611
  visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
1560
1612
  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded.optional().nullable(),
1561
1613
  acs_system_disconnected: acs_system_disconnected.optional().nullable(),
1562
- account_disconnected: account_disconnected.optional().nullable(),
1614
+ account_disconnected: account_disconnected2.optional().nullable(),
1563
1615
  salto_ks_certification_expired: salto_ks_certification_expired.optional().nullable()
1564
1616
  });
1565
1617
  var common_acs_system_warning = zod.z.object({
@@ -2204,104 +2256,116 @@ var common_event = zod.z.object({
2204
2256
  workspace_id: zod.z.string().uuid().describe(
2205
2257
  "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces)."
2206
2258
  ),
2207
- created_at: zod.z.string().datetime().describe("Time at which the event was created."),
2208
- occurred_at: zod.z.string().datetime().describe("Time when the event occurred.")
2259
+ created_at: zod.z.string().datetime().describe("Date and time at which the event was created."),
2260
+ occurred_at: zod.z.string().datetime().describe("Date and time at which the event occurred.")
2209
2261
  });
2210
2262
 
2211
2263
  // src/lib/seam/connect/models/events/access-codes.ts
2212
2264
  var access_code_event = common_event.extend({
2213
- access_code_id: zod.z.string().uuid().describe(`
2214
- ---
2215
- title: Access Code ID
2216
- ---
2217
- The ID of the access code.
2218
- `),
2219
- device_id: zod.z.string().uuid().describe(`
2220
- ---
2221
- title: Device ID
2222
- ---
2223
- The ID of the device.
2224
- `),
2225
- connected_account_id: zod.z.string().uuid().describe(`
2226
- ---
2227
- title: Connected Account ID
2228
- ---
2229
- The ID of the connected account.
2230
- `)
2265
+ access_code_id: zod.z.string().uuid().describe(
2266
+ "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
2267
+ ),
2268
+ device_id: zod.z.string().uuid().describe(
2269
+ "ID of the [device](https://docs.seam.co/latest/core-concepts/devices)."
2270
+ ),
2271
+ connected_account_id: zod.z.string().uuid().describe(
2272
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2273
+ )
2231
2274
  });
2232
- var code = zod.z.string().describe(`
2233
- ---
2234
- title: Access Code
2235
- ---
2236
- The code of the access code.
2237
- `);
2275
+ var code = zod.z.string().describe(
2276
+ "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
2277
+ );
2238
2278
  var access_code_created_event = access_code_event.extend({
2239
2279
  event_type: zod.z.literal("access_code.created")
2240
- }).describe("An access code was created.");
2280
+ }).describe(
2281
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created."
2282
+ );
2241
2283
  var access_code_changed_event = access_code_event.extend({
2242
2284
  event_type: zod.z.literal("access_code.changed")
2243
- }).describe("An access code was changed.");
2285
+ }).describe(
2286
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed."
2287
+ );
2244
2288
  var access_code_scheduled_on_device_event = access_code_event.extend({
2245
2289
  event_type: zod.z.literal("access_code.scheduled_on_device"),
2246
2290
  code
2247
- }).describe("An access code was natively scheduled on a device.");
2291
+ }).describe(
2292
+ "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."
2293
+ );
2248
2294
  var access_code_set_on_device_event = access_code_event.extend({
2249
2295
  event_type: zod.z.literal("access_code.set_on_device"),
2250
2296
  code
2251
- }).describe("An access code was set on a device.");
2297
+ }).describe(
2298
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device."
2299
+ );
2252
2300
  var access_code_removed_from_device_event = access_code_event.extend({
2253
2301
  event_type: zod.z.literal("access_code.removed_from_device")
2254
- }).describe("An access code was removed from a device.");
2302
+ }).describe(
2303
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device."
2304
+ );
2255
2305
  var access_code_delay_in_setting_on_device_event = access_code_event.extend({
2256
2306
  event_type: zod.z.literal("access_code.delay_in_setting_on_device")
2257
2307
  }).describe(
2258
- "There was an unusually long delay in setting an access code on a device."
2308
+ "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."
2259
2309
  );
2260
2310
  var access_code_failed_to_set_on_device_event = access_code_event.extend({
2261
2311
  event_type: zod.z.literal("access_code.failed_to_set_on_device")
2262
- }).describe("An access code failed to be set on a device.");
2312
+ }).describe(
2313
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device."
2314
+ );
2263
2315
  var access_code_deleted_event = access_code_event.extend({
2264
2316
  event_type: zod.z.literal("access_code.deleted"),
2265
2317
  code: code.nullable()
2266
- }).describe("An access code was deleted.");
2318
+ }).describe(
2319
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted."
2320
+ );
2267
2321
  var access_code_delay_in_removing_from_device_event = access_code_event.extend({
2268
2322
  event_type: zod.z.literal("access_code.delay_in_removing_from_device")
2269
2323
  }).describe(
2270
- "There was an unusually long delay in removing an access code from a device."
2324
+ "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."
2271
2325
  );
2272
2326
  var access_code_failed_to_remove_from_device_event = access_code_event.extend({
2273
2327
  event_type: zod.z.literal("access_code.failed_to_remove_from_device")
2274
- }).describe("An access code failed to be removed from a device.");
2328
+ }).describe(
2329
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device."
2330
+ );
2275
2331
  var access_code_modified_external_to_seam_event = access_code_event.extend({
2276
2332
  event_type: zod.z.literal("access_code.modified_external_to_seam")
2277
- }).describe("An access code was modified external to Seam.");
2333
+ }).describe(
2334
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam."
2335
+ );
2278
2336
  var access_code_deleted_external_to_seam_event = access_code_event.extend({
2279
2337
  event_type: zod.z.literal("access_code.deleted_external_to_seam")
2280
- }).describe("An access code was deleted external to Seam.");
2338
+ }).describe(
2339
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam."
2340
+ );
2281
2341
  var access_code_backup_access_code_pulled_event = access_code_event.extend({
2282
2342
  event_type: zod.z.literal("access_code.backup_access_code_pulled"),
2283
2343
  backup_access_code_id: zod.z.string()
2284
2344
  }).describe(
2285
- "A backup access code was pulled from the backup access code pool and set on a device."
2345
+ "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."
2286
2346
  );
2287
2347
  var unmanaged_access_code_converted_to_managed_event = access_code_event.extend({
2288
2348
  event_type: zod.z.literal("access_code.unmanaged.converted_to_managed")
2289
2349
  }).describe(
2290
- "An unmanaged access code was successfully converted to a managed access code."
2350
+ "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."
2291
2351
  );
2292
2352
  var unmanaged_access_code_failed_to_convert_to_managed_event = access_code_event.extend({
2293
2353
  event_type: zod.z.literal(
2294
2354
  "access_code.unmanaged.failed_to_convert_to_managed"
2295
2355
  )
2296
2356
  }).describe(
2297
- "An unmanaged access code failed to be converted to a managed access code."
2357
+ "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."
2298
2358
  );
2299
2359
  var unmanaged_access_code_created_event = access_code_event.extend({
2300
2360
  event_type: zod.z.literal("access_code.unmanaged.created")
2301
- }).describe("An unmanaged access code was created on a device.");
2361
+ }).describe(
2362
+ "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device."
2363
+ );
2302
2364
  var unmanaged_access_code_removed_event = access_code_event.extend({
2303
2365
  event_type: zod.z.literal("access_code.unmanaged.removed")
2304
- }).describe("An unmanaged access code was removed from a device.");
2366
+ }).describe(
2367
+ "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device."
2368
+ );
2305
2369
  var access_code_events = [
2306
2370
  access_code_created_event,
2307
2371
  access_code_changed_event,
@@ -2322,18 +2386,12 @@ var access_code_events = [
2322
2386
  unmanaged_access_code_removed_event
2323
2387
  ];
2324
2388
  var common_acs_event = common_event.extend({
2325
- connected_account_id: zod.z.string().uuid().optional().describe(`
2326
- ---
2327
- title: Connected Account ID
2328
- ---
2329
- ID of the connected account.
2330
- `),
2331
- acs_system_id: zod.z.string().uuid().describe(`
2332
- ---
2333
- title: ACS System ID
2334
- ---
2335
- ID of the ACS system.
2336
- `)
2389
+ connected_account_id: zod.z.string().uuid().optional().describe(
2390
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2391
+ ),
2392
+ acs_system_id: zod.z.string().uuid().describe(
2393
+ "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems)."
2394
+ )
2337
2395
  });
2338
2396
 
2339
2397
  // src/lib/seam/connect/models/events/acs/credentials.ts
@@ -2342,23 +2400,33 @@ var acs_credential_event = common_acs_event.extend({
2342
2400
  });
2343
2401
  var acs_credential_deleted_event = acs_credential_event.extend({
2344
2402
  event_type: zod.z.literal("acs_credential.deleted")
2345
- }).describe("An ACS credential was deleted.");
2403
+ }).describe(
2404
+ "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted."
2405
+ );
2346
2406
  var acs_credential_issued = acs_credential_event.extend({
2347
2407
  event_type: zod.z.literal("acs_credential.issued")
2348
- }).describe("An ACS credential was issued.");
2408
+ }).describe(
2409
+ "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued."
2410
+ );
2349
2411
  var acs_credential_events = [
2350
2412
  acs_credential_deleted_event,
2351
2413
  acs_credential_issued
2352
2414
  ];
2353
2415
  var acs_encoder_event = common_acs_event.extend({
2354
- acs_encoder_id: zod.z.string().uuid().describe("ID of the ACS encoder.")
2416
+ acs_encoder_id: zod.z.string().uuid().describe(
2417
+ "ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
2418
+ )
2355
2419
  });
2356
2420
  var acs_encoder_added_event = acs_encoder_event.extend({
2357
2421
  event_type: zod.z.literal("acs_encoder.added")
2358
- }).describe("An ACS encoder was added.");
2422
+ }).describe(
2423
+ "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added."
2424
+ );
2359
2425
  var acs_encoder_removed_event = acs_encoder_event.extend({
2360
2426
  event_type: zod.z.literal("acs_encoder.removed")
2361
- }).describe("An ACS encoder was removed.");
2427
+ }).describe(
2428
+ "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed."
2429
+ );
2362
2430
  var acs_encoder_events = [
2363
2431
  acs_encoder_added_event,
2364
2432
  acs_encoder_removed_event
@@ -2366,13 +2434,19 @@ var acs_encoder_events = [
2366
2434
  var acs_system_event = common_acs_event.extend({});
2367
2435
  var acs_system_connected_event = acs_system_event.extend({
2368
2436
  event_type: zod.z.literal("acs_system.connected")
2369
- }).describe("An ACS system was connected.");
2437
+ }).describe(
2438
+ "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected."
2439
+ );
2370
2440
  var acs_system_disconnected_event = acs_system_event.extend({
2371
2441
  event_type: zod.z.literal("acs_system.disconnected")
2372
- }).describe("An ACS system was disconnected.");
2442
+ }).describe(
2443
+ "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected."
2444
+ );
2373
2445
  var acs_system_added_event = acs_system_event.extend({
2374
2446
  event_type: zod.z.literal("acs_system.added")
2375
- }).describe("An ACS system was added.");
2447
+ }).describe(
2448
+ "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added."
2449
+ );
2376
2450
  var acs_system_events = [
2377
2451
  acs_system_connected_event,
2378
2452
  acs_system_added_event,
@@ -2380,10 +2454,14 @@ var acs_system_events = [
2380
2454
  ];
2381
2455
  var acs_user_event = common_acs_event.extend({
2382
2456
  acs_user_id: zod.z.string().uuid()
2383
- });
2457
+ }).describe(
2458
+ "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2459
+ );
2384
2460
  var acs_user_deleted_event = acs_user_event.extend({
2385
2461
  event_type: zod.z.literal("acs_user.deleted")
2386
- }).describe("An ACS user was deleted.");
2462
+ }).describe(
2463
+ "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted."
2464
+ );
2387
2465
  var acs_user_events = [acs_user_deleted_event];
2388
2466
 
2389
2467
  // src/lib/seam/connect/models/events/acs/index.ts
@@ -2394,37 +2472,32 @@ var acs_events = [
2394
2472
  ...acs_encoder_events
2395
2473
  ];
2396
2474
  var action_attempt_event = common_event.extend({
2397
- action_attempt_id: zod.z.string().uuid().describe(`
2398
- ---
2399
- title: Action Attempt ID
2400
- ---
2401
- The ID of the action attempt.
2402
- `),
2403
- action_type: zod.z.string().describe(`
2404
- ---
2405
- title: Action Type
2406
- ---
2407
- The type of action.
2408
- `),
2409
- status: zod.z.string().describe(`
2410
- ---
2411
- title: Status
2412
- ---
2413
- The status of the action.
2414
- `)
2475
+ action_attempt_id: zod.z.string().uuid().describe(
2476
+ "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts)."
2477
+ ),
2478
+ action_type: zod.z.string().describe("Type of action."),
2479
+ status: zod.z.string().describe("Status of the action.")
2415
2480
  });
2416
2481
  var action_attempt_lock_door_succeeded_event = action_attempt_event.extend({
2417
2482
  event_type: zod.z.literal("action_attempt.lock_door.succeeded")
2418
- }).describe("A lock door action attempt succeeded.");
2483
+ }).describe(
2484
+ "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded."
2485
+ );
2419
2486
  var action_attempt_lock_door_failed_event = action_attempt_event.extend({
2420
2487
  event_type: zod.z.literal("action_attempt.lock_door.failed")
2421
- }).describe("A lock door action attempt failed.");
2488
+ }).describe(
2489
+ "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed."
2490
+ );
2422
2491
  var action_attempt_unlock_door_succeeded_event = action_attempt_event.extend({
2423
2492
  event_type: zod.z.literal("action_attempt.unlock_door.succeeded")
2424
- }).describe("An unlock door action attempt succeeded.");
2493
+ }).describe(
2494
+ "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded."
2495
+ );
2425
2496
  var action_attempt_unlock_door_failed_event = action_attempt_event.extend({
2426
2497
  event_type: zod.z.literal("action_attempt.unlock_door.failed")
2427
- }).describe("An unlock door action attempt failed.");
2498
+ }).describe(
2499
+ "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed."
2500
+ );
2428
2501
  var action_attempt_events = [
2429
2502
  action_attempt_lock_door_succeeded_event,
2430
2503
  action_attempt_lock_door_failed_event,
@@ -2432,66 +2505,59 @@ var action_attempt_events = [
2432
2505
  action_attempt_unlock_door_failed_event
2433
2506
  ];
2434
2507
  var client_session_event = common_event.extend({
2435
- client_session_id: zod.z.string().uuid().describe(`
2436
- ---
2437
- title: Client Session ID
2438
- ---
2439
- ID of the client session.
2440
- `)
2508
+ client_session_id: zod.z.string().uuid().describe(
2509
+ "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
2510
+ )
2441
2511
  });
2442
2512
  var client_session_deleted_event = client_session_event.extend({
2443
2513
  event_type: zod.z.literal("client_session.deleted")
2444
- }).describe("A client session was deleted.");
2514
+ }).describe(
2515
+ "A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted."
2516
+ );
2445
2517
  var client_session_events = [client_session_deleted_event];
2446
2518
  var connect_webview_event = common_event.extend({
2447
- connect_webview_id: zod.z.string().uuid().describe(`
2448
- ---
2449
- title: Connect Webview ID
2450
- ---
2451
- ID of the connect webview.
2452
- `)
2519
+ connect_webview_id: zod.z.string().uuid().describe(
2520
+ "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)."
2521
+ )
2453
2522
  });
2454
- var connected_account_id = zod.z.string().uuid().describe(`
2455
- ---
2456
- title: Connected Account ID
2457
- ---
2458
- ID of the connected account.
2459
- `);
2523
+ var connected_account_id = zod.z.string().uuid().describe(
2524
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2525
+ );
2460
2526
  var connect_webview_login_succeeded_event = connect_webview_event.extend({
2461
2527
  event_type: zod.z.literal("connect_webview.login_succeeded"),
2462
2528
  connected_account_id
2463
- }).describe("A connect webview had a successful login.");
2529
+ }).describe(
2530
+ "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded."
2531
+ );
2464
2532
  var connect_webview_login_failed_event = connect_webview_event.extend({
2465
2533
  event_type: zod.z.literal("connect_webview.login_failed")
2466
- }).describe("A connect webview had a failed login.");
2534
+ }).describe(
2535
+ "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed."
2536
+ );
2467
2537
  var connect_webview_events = [
2468
2538
  connect_webview_login_succeeded_event,
2469
2539
  connect_webview_login_failed_event
2470
2540
  ];
2471
2541
  var connected_account_event = common_event.extend({
2472
- connected_account_id: zod.z.string().uuid().describe(`
2473
- ---
2474
- title: Connected Account ID
2475
- ---
2476
- ID of the connected account.
2477
- `)
2542
+ connected_account_id: zod.z.string().uuid().describe(
2543
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2544
+ )
2478
2545
  });
2479
- var connect_webview_id = zod.z.string().uuid().describe(`
2480
- ---
2481
- title: Connect Webview ID
2482
- ---
2483
- ID of the connect webview.
2484
- `);
2546
+ var connect_webview_id = zod.z.string().uuid().describe(
2547
+ "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)."
2548
+ );
2485
2549
  var connected_account_connected_event = connected_account_event.extend({
2486
2550
  event_type: zod.z.literal("connected_account.connected"),
2487
2551
  connect_webview_id
2488
2552
  }).describe(
2489
- "A connected account was connected for the first time, was reconnected after being disconnected."
2553
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected."
2490
2554
  );
2491
2555
  var connected_account_created_event = connected_account_event.extend({
2492
2556
  event_type: zod.z.literal("connected_account.created"),
2493
2557
  connect_webview_id
2494
- }).describe("A connected account was created.");
2558
+ }).describe(
2559
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created."
2560
+ );
2495
2561
  var connected_account_successful_login_event = connected_account_event.extend({
2496
2562
  event_type: zod.z.literal("connected_account.successful_login"),
2497
2563
  connect_webview_id
@@ -2499,24 +2565,28 @@ var connected_account_successful_login_event = connected_account_event.extend({
2499
2565
  ---
2500
2566
  deprecated: Use \`connect_webview.login_succeeded\`.
2501
2567
  ---
2502
- A connected account had a successful connect webview login.`);
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).`);
2503
2569
  var connected_account_disconnected_event = connected_account_event.extend({
2504
2570
  event_type: zod.z.literal("connected_account.disconnected")
2505
- }).describe("A connected account was disconnected.");
2571
+ }).describe(
2572
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected."
2573
+ );
2506
2574
  var connected_account_completed_first_sync_event = connected_account_event.extend({
2507
2575
  event_type: zod.z.literal("connected_account.completed_first_sync")
2508
2576
  }).describe(
2509
- "A connected account completed the first sync with Seam and devices are now available."
2577
+ "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."
2510
2578
  );
2511
2579
  var connected_account_deleted_event = connected_account_event.extend({
2512
2580
  event_type: zod.z.literal("connected_account.deleted")
2513
- }).describe("A connected account was deleted.");
2581
+ }).describe(
2582
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted."
2583
+ );
2514
2584
  var connected_account_completed_first_sync_after_reconnection_event = connected_account_event.extend({
2515
2585
  event_type: zod.z.literal(
2516
2586
  "connected_account.completed_first_sync_after_reconnection"
2517
2587
  )
2518
2588
  }).describe(
2519
- "A connected account completed the first sync after reconnection with Seam and devices are now available."
2589
+ "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."
2520
2590
  );
2521
2591
  var connected_account_events = [
2522
2592
  connected_account_connected_event,
@@ -2541,14 +2611,18 @@ var device_battery_status = zod.z.enum(["critical", "low", "good", "full"]).desc
2541
2611
  );
2542
2612
  var disconnection_error_code = zod.z.enum(["account_disconnected", "hub_disconnected", "device_disconnected"]).describe("Error code associated with the disconnection event, if any.");
2543
2613
  var lock_method = zod.z.enum(["keycode", "manual", "automatic", "unknown", "seamapi"]).describe(
2544
- "Method by which a lock device was locked or 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."
2614
+ "Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was locked or 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."
2545
2615
  );
2546
2616
  var device_connected_event = device_event.extend({
2547
2617
  event_type: zod.z.literal("device.connected")
2548
- }).describe("A new device was connected to Seam.");
2618
+ }).describe(
2619
+ "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."
2620
+ );
2549
2621
  var device_added_event = device_event.extend({
2550
2622
  event_type: zod.z.literal("device.added")
2551
- }).describe("A device was added or reconnected to Seam.");
2623
+ }).describe(
2624
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed."
2625
+ );
2552
2626
  var device_converted_to_unmanaged_event = device_event.extend({
2553
2627
  event_type: zod.z.literal("device.converted_to_unmanaged")
2554
2628
  }).describe(
@@ -2562,86 +2636,100 @@ var unmanaged_device_converted_to_managed_event = device_event.extend({
2562
2636
  var unmanaged_device_connected_event = device_event.extend({
2563
2637
  event_type: zod.z.literal("device.unmanaged.connected")
2564
2638
  }).describe(
2565
- "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam."
2639
+ "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`."
2566
2640
  );
2567
2641
  var device_disconnected_event = device_event.extend({
2568
2642
  event_type: zod.z.literal("device.disconnected"),
2569
2643
  error_code: disconnection_error_code
2570
- }).describe("A device was disconnected from Seam.");
2644
+ }).describe(
2645
+ "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`."
2646
+ );
2571
2647
  var unmanaged_device_disconnected_event = device_event.extend({
2572
2648
  event_type: zod.z.literal("device.unmanaged.disconnected"),
2573
2649
  error_code: disconnection_error_code
2574
2650
  }).describe(
2575
- "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam."
2651
+ "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`."
2576
2652
  );
2577
2653
  var device_tampered_event = device_event.extend({
2578
2654
  event_type: zod.z.literal("device.tampered")
2579
2655
  }).describe(
2580
- "A device detected that it was tampered with, for example, opened or moved."
2656
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved."
2581
2657
  );
2582
2658
  var device_low_battery_event = device_event.extend({
2583
2659
  event_type: zod.z.literal("device.low_battery"),
2584
2660
  battery_level
2585
- }).describe("A device battery level dropped below the low threshold.");
2661
+ }).describe(
2662
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold."
2663
+ );
2586
2664
  var device_battery_status_changed_event = device_event.extend({
2587
2665
  event_type: zod.z.literal("device.battery_status_changed"),
2588
2666
  battery_status: device_battery_status,
2589
2667
  battery_level
2590
2668
  }).describe(
2591
- "A device battery status changed since the last `battery_status_changed` event."
2669
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event."
2592
2670
  );
2593
2671
  var device_removed_event = device_event.extend({
2594
2672
  event_type: zod.z.literal("device.removed")
2595
2673
  }).describe(
2596
- "A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2674
+ "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)."
2597
2675
  );
2598
2676
  var device_deleted_event = device_event.extend({
2599
2677
  event_type: zod.z.literal("device.deleted")
2600
2678
  }).describe(
2601
- "A device was [deleted](https://docs.seam.co/latest/api/devices/delete)."
2679
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted."
2602
2680
  );
2603
2681
  var device_third_party_integration_detected_event = device_event.extend({
2604
2682
  event_type: zod.z.literal("device.third_party_integration_detected")
2605
2683
  }).describe(
2606
- "Seam detected that a device is using a third-party integration that will interfere with Seam device management."
2684
+ "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."
2607
2685
  );
2608
2686
  var device_third_party_integration_no_longer_detected_event = device_event.extend({
2609
2687
  event_type: zod.z.literal(
2610
2688
  "device.third_party_integration_no_longer_detected"
2611
2689
  )
2612
2690
  }).describe(
2613
- "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management."
2691
+ "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."
2614
2692
  );
2615
2693
  var device_salto_privacy_mode_activated_event = device_event.extend({
2616
2694
  event_type: zod.z.literal("device.salto.privacy_mode_activated")
2617
- }).describe("A Salto device activated privacy mode.");
2695
+ }).describe(
2696
+ "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode."
2697
+ );
2618
2698
  var device_salto_privacy_mode_deactivated_event = device_event.extend({
2619
2699
  event_type: zod.z.literal("device.salto.privacy_mode_deactivated")
2620
- }).describe("A Salto device deactivated privacy mode.");
2700
+ }).describe(
2701
+ "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode."
2702
+ );
2621
2703
  var device_connection_became_flaky_event = device_event.extend({
2622
2704
  event_type: zod.z.literal("device.connection_became_flaky")
2623
- }).describe("Seam detected a flaky device connection.");
2705
+ }).describe(
2706
+ "Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection."
2707
+ );
2624
2708
  var device_connection_stabilized_event = device_event.extend({
2625
2709
  event_type: zod.z.literal("device.connection_stabilized")
2626
2710
  }).describe(
2627
- "Seam detected that a previously-flaky device connection stabilized."
2711
+ "Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized."
2628
2712
  );
2629
2713
  var device_error_subscription_required_event = device_event.extend({
2630
2714
  event_type: zod.z.literal("device.error.subscription_required")
2631
2715
  }).describe(
2632
- "A third-party subscription is required to use all device features."
2716
+ "A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features."
2633
2717
  );
2634
2718
  var device_error_subscription_required_resolved_event = device_event.extend({
2635
2719
  event_type: zod.z.literal("device.error.subscription_required.resolved")
2636
2720
  }).describe(
2637
- "A third-party subscription is active or no longer required to use all device features."
2721
+ "A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features."
2638
2722
  );
2639
2723
  var device_accessory_keypad_connected_event = device_event.extend({
2640
2724
  event_type: zod.z.literal("device.accessory_keypad_connected")
2641
- }).describe("An accessory keypad was connected to a device.");
2725
+ }).describe(
2726
+ "An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices)."
2727
+ );
2642
2728
  var device_accessory_keypad_disconnected_event = device_event.extend({
2643
2729
  event_type: zod.z.literal("device.accessory_keypad_disconnected")
2644
- }).describe("An accessory keypad was disconnected from a device.");
2730
+ }).describe(
2731
+ "An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices)."
2732
+ );
2645
2733
  var noise_sensor_noise_threshold_triggered_event = device_event.extend({
2646
2734
  event_type: zod.z.literal("noise_sensor.noise_threshold_triggered"),
2647
2735
  noise_level_decibels: zod.z.number().optional().describe("Detected noise level in decibels."),
@@ -2653,18 +2741,8 @@ var noise_sensor_noise_threshold_triggered_event = device_event.extend({
2653
2741
  "Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered."
2654
2742
  ),
2655
2743
  // TODO: remove metadata from this event
2656
- noiseaware_metadata: zod.z.record(zod.z.unknown()).optional().describe(`
2657
- ---
2658
- title: Noiseaware Metadata
2659
- ---
2660
- Metadata from Noiseaware.
2661
- `),
2662
- minut_metadata: zod.z.record(zod.z.unknown()).optional().describe(`
2663
- ---
2664
- title: Minut Metadata
2665
- ---
2666
- Metadata from Minut.
2667
- `)
2744
+ noiseaware_metadata: zod.z.record(zod.z.unknown()).optional().describe("Metadata from Noiseaware."),
2745
+ minut_metadata: zod.z.record(zod.z.unknown()).optional().describe("Metadata from Minut.")
2668
2746
  }).describe(
2669
2747
  "Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected."
2670
2748
  );
@@ -2677,9 +2755,11 @@ var lock_locked_event = device_event.extend({
2677
2755
  "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action."
2678
2756
  ),
2679
2757
  method: lock_method.describe(
2680
- "Method by which a lock device was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device."
2758
+ "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."
2681
2759
  )
2682
- }).describe("A lock was locked.");
2760
+ }).describe(
2761
+ "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked."
2762
+ );
2683
2763
  var lock_unlocked_event = device_event.extend({
2684
2764
  event_type: zod.z.literal("lock.unlocked"),
2685
2765
  access_code_id: zod.z.string().uuid().optional().describe(
@@ -2689,16 +2769,18 @@ var lock_unlocked_event = device_event.extend({
2689
2769
  "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action."
2690
2770
  ),
2691
2771
  method: lock_method.describe(
2692
- "Method by which a lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device."
2772
+ "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."
2693
2773
  )
2694
- }).describe("A lock was unlocked.");
2774
+ }).describe(
2775
+ "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked."
2776
+ );
2695
2777
  var lock_access_denied_event = device_event.extend({
2696
2778
  event_type: zod.z.literal("lock.access_denied"),
2697
2779
  access_code_id: zod.z.string().uuid().optional().describe(
2698
2780
  "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts."
2699
2781
  )
2700
2782
  }).describe(
2701
- "The lock denied access to a user after one or more consecutive invalid attempts to unlock the device."
2783
+ "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."
2702
2784
  );
2703
2785
  var thermostat_climate_preset_activated_event = device_event.extend({
2704
2786
  event_type: zod.z.literal("thermostat.climate_preset_activated"),
@@ -2709,13 +2791,13 @@ var thermostat_climate_preset_activated_event = device_event.extend({
2709
2791
  "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated."
2710
2792
  ),
2711
2793
  is_fallback_climate_preset: zod.z.boolean().describe(
2712
- "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."
2794
+ "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)."
2713
2795
  )
2714
2796
  }).describe(
2715
2797
  "A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated."
2716
2798
  );
2717
2799
  var thermostat_manually_adjusted_method = zod.z.enum(["seam", "external"]).describe(
2718
- "Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat."
2800
+ "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)."
2719
2801
  );
2720
2802
  var thermostat_manually_adjusted_event = device_event.extend({
2721
2803
  event_type: zod.z.literal("thermostat.manually_adjusted"),
@@ -2729,11 +2811,17 @@ var thermostat_manually_adjusted_event = device_event.extend({
2729
2811
  cooling_set_point_fahrenheit: true,
2730
2812
  heating_set_point_fahrenheit: true
2731
2813
  })
2732
- ).describe("A thermostat was adjusted manually.");
2814
+ ).describe(
2815
+ "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually."
2816
+ );
2733
2817
  var temperature_threshold_exceeded_event = device_event.extend({
2734
2818
  event_type: zod.z.literal("thermostat.temperature_threshold_exceeded"),
2735
- temperature_celsius: zod.z.number().describe("Temperature, in \xB0C, reported by the thermostat."),
2736
- temperature_fahrenheit: zod.z.number().describe("Temperature, in \xB0F, reported by the thermostat."),
2819
+ temperature_celsius: zod.z.number().describe(
2820
+ "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2821
+ ),
2822
+ temperature_fahrenheit: zod.z.number().describe(
2823
+ "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2824
+ ),
2737
2825
  upper_limit_celsius: zod.z.number().nullable().describe(
2738
2826
  "Upper temperature limit, in \xB0C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2739
2827
  ),
@@ -2747,14 +2835,18 @@ var temperature_threshold_exceeded_event = device_event.extend({
2747
2835
  "Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2748
2836
  )
2749
2837
  }).describe(
2750
- "A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2838
+ "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)."
2751
2839
  );
2752
2840
  var temperature_threshold_no_longer_exceeded_event = device_event.extend({
2753
2841
  event_type: zod.z.literal(
2754
2842
  "thermostat.temperature_threshold_no_longer_exceeded"
2755
2843
  ),
2756
- temperature_celsius: zod.z.number().describe("Temperature, in \xB0C, reported by the thermostat."),
2757
- temperature_fahrenheit: zod.z.number().describe("Temperature, in \xB0F, reported by the thermostat."),
2844
+ temperature_celsius: zod.z.number().describe(
2845
+ "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2846
+ ),
2847
+ temperature_fahrenheit: zod.z.number().describe(
2848
+ "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2849
+ ),
2758
2850
  upper_limit_celsius: zod.z.number().nullable().describe(
2759
2851
  "Upper temperature limit, in \xB0C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2760
2852
  ),
@@ -2768,7 +2860,7 @@ var temperature_threshold_no_longer_exceeded_event = device_event.extend({
2768
2860
  "Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2769
2861
  )
2770
2862
  }).describe(
2771
- "A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2863
+ "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)."
2772
2864
  );
2773
2865
  var device_events = [
2774
2866
  device_connected_event,
@@ -2803,26 +2895,22 @@ var device_events = [
2803
2895
  temperature_threshold_no_longer_exceeded_event
2804
2896
  ];
2805
2897
  var enrollment_automation_event = common_event.extend({
2806
- enrollment_automation_id: zod.z.string().uuid().describe(`
2807
- ---
2808
- title: Enrollment Automation ID
2809
- ---
2810
- ID of the enrollment automation.
2811
- `)
2898
+ enrollment_automation_id: zod.z.string().uuid().describe(
2899
+ "ID of the [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)."
2900
+ )
2812
2901
  });
2813
2902
  var enrollment_automation_deleted_event = enrollment_automation_event.extend({
2814
2903
  event_type: zod.z.literal("enrollment_automation.deleted")
2815
- }).describe("An enrollment automation was deleted.");
2904
+ }).describe(
2905
+ "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."
2906
+ );
2816
2907
  var enrollment_automation_events = [
2817
2908
  enrollment_automation_deleted_event
2818
2909
  ];
2819
2910
  var phone_event = common_event.extend({
2820
- device_id: zod.z.string().uuid().describe(`
2821
- ---
2822
- title: Device ID
2823
- ---
2824
- ID of the device.
2825
- `)
2911
+ device_id: zod.z.string().uuid().describe(
2912
+ "ID of the [device](https://docs.seam.co/latest/core-concepts/devices)."
2913
+ )
2826
2914
  });
2827
2915
  var phone_deactivated_event = phone_event.extend({
2828
2916
  event_type: zod.z.literal("phone.deactivated")
@@ -2939,13 +3027,191 @@ var openapi_default = {
2939
3027
  type: "object"
2940
3028
  },
2941
3029
  {
2942
- properties: {
2943
- error_code: { type: "string" },
2944
- is_device_error: { enum: [true], type: "boolean" },
2945
- message: { type: "string" }
2946
- },
2947
- required: ["message", "is_device_error", "error_code"],
2948
- type: "object"
3030
+ description: "Error associated with the `device`.",
3031
+ oneOf: [
3032
+ {
3033
+ description: "Device is offline",
3034
+ properties: {
3035
+ error_code: {
3036
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3037
+ enum: ["device_offline"],
3038
+ type: "string"
3039
+ },
3040
+ is_device_error: { enum: [true], type: "boolean" },
3041
+ message: { type: "string" }
3042
+ },
3043
+ required: ["message", "is_device_error", "error_code"],
3044
+ type: "object"
3045
+ },
3046
+ {
3047
+ description: "Device has been removed",
3048
+ properties: {
3049
+ error_code: {
3050
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3051
+ enum: ["device_removed"],
3052
+ type: "string"
3053
+ },
3054
+ is_device_error: { enum: [true], type: "boolean" },
3055
+ message: { type: "string" }
3056
+ },
3057
+ required: ["message", "is_device_error", "error_code"],
3058
+ type: "object"
3059
+ },
3060
+ {
3061
+ description: "Account is disconnected",
3062
+ properties: {
3063
+ error_code: {
3064
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3065
+ enum: ["account_disconnected"],
3066
+ type: "string"
3067
+ },
3068
+ is_device_error: { enum: [true], type: "boolean" },
3069
+ message: { type: "string" }
3070
+ },
3071
+ required: ["message", "is_device_error", "error_code"],
3072
+ type: "object"
3073
+ },
3074
+ {
3075
+ description: "Hub is disconnected",
3076
+ properties: {
3077
+ error_code: {
3078
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3079
+ enum: ["hub_disconnected"],
3080
+ type: "string"
3081
+ },
3082
+ is_device_error: { enum: [true], type: "boolean" },
3083
+ message: { type: "string" }
3084
+ },
3085
+ required: ["message", "is_device_error", "error_code"],
3086
+ type: "object"
3087
+ },
3088
+ {
3089
+ description: "Device is disconnected",
3090
+ properties: {
3091
+ error_code: {
3092
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3093
+ enum: ["device_disconnected"],
3094
+ type: "string"
3095
+ },
3096
+ is_device_error: { enum: [true], type: "boolean" },
3097
+ message: { type: "string" }
3098
+ },
3099
+ required: ["message", "is_device_error", "error_code"],
3100
+ type: "object"
3101
+ },
3102
+ {
3103
+ description: "The backup access code pool is empty.",
3104
+ properties: {
3105
+ error_code: {
3106
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3107
+ enum: ["empty_backup_access_code_pool"],
3108
+ type: "string"
3109
+ },
3110
+ is_device_error: { enum: [true], type: "boolean" },
3111
+ message: { type: "string" }
3112
+ },
3113
+ required: ["message", "is_device_error", "error_code"],
3114
+ type: "object"
3115
+ },
3116
+ {
3117
+ description: "User is not authorized to use the August Lock.",
3118
+ properties: {
3119
+ error_code: {
3120
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3121
+ enum: ["august_lock_not_authorized"],
3122
+ type: "string"
3123
+ },
3124
+ is_device_error: { enum: [true], type: "boolean" },
3125
+ message: { type: "string" }
3126
+ },
3127
+ required: ["message", "is_device_error", "error_code"],
3128
+ type: "object"
3129
+ },
3130
+ {
3131
+ description: "Lock is not connected to the Seam Bridge.",
3132
+ properties: {
3133
+ error_code: {
3134
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3135
+ enum: ["august_lock_missing_bridge"],
3136
+ type: "string"
3137
+ },
3138
+ is_device_error: { enum: [true], type: "boolean" },
3139
+ message: { type: "string" }
3140
+ },
3141
+ required: ["message", "is_device_error", "error_code"],
3142
+ type: "object"
3143
+ },
3144
+ {
3145
+ description: "Salto site user limit reached.",
3146
+ properties: {
3147
+ error_code: {
3148
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3149
+ enum: ["salto_site_user_limit_reached"],
3150
+ type: "string"
3151
+ },
3152
+ is_device_error: { enum: [true], type: "boolean" },
3153
+ message: { type: "string" }
3154
+ },
3155
+ required: ["message", "is_device_error", "error_code"],
3156
+ type: "object"
3157
+ },
3158
+ {
3159
+ description: "Lock is not paired with a Gateway.",
3160
+ properties: {
3161
+ error_code: {
3162
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3163
+ enum: ["ttlock_lock_not_paired_to_gateway"],
3164
+ type: "string"
3165
+ },
3166
+ is_device_error: { enum: [true], type: "boolean" },
3167
+ message: { type: "string" }
3168
+ },
3169
+ required: ["message", "is_device_error", "error_code"],
3170
+ type: "object"
3171
+ },
3172
+ {
3173
+ description: "Missing device credentials.",
3174
+ properties: {
3175
+ error_code: {
3176
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3177
+ enum: ["missing_device_credentials"],
3178
+ type: "string"
3179
+ },
3180
+ is_device_error: { enum: [true], type: "boolean" },
3181
+ message: { type: "string" }
3182
+ },
3183
+ required: ["message", "is_device_error", "error_code"],
3184
+ type: "object"
3185
+ },
3186
+ {
3187
+ description: "The auxiliary heat is running.",
3188
+ properties: {
3189
+ error_code: {
3190
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3191
+ enum: ["auxiliary_heat_running"],
3192
+ type: "string"
3193
+ },
3194
+ is_device_error: { enum: [true], type: "boolean" },
3195
+ message: { type: "string" }
3196
+ },
3197
+ required: ["message", "is_device_error", "error_code"],
3198
+ type: "object"
3199
+ },
3200
+ {
3201
+ description: "Subscription required to connect.",
3202
+ properties: {
3203
+ error_code: {
3204
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
3205
+ enum: ["subscription_required"],
3206
+ type: "string"
3207
+ },
3208
+ is_device_error: { enum: [true], type: "boolean" },
3209
+ message: { type: "string" }
3210
+ },
3211
+ required: ["message", "is_device_error", "error_code"],
3212
+ type: "object"
3213
+ }
3214
+ ]
2949
3215
  },
2950
3216
  {
2951
3217
  properties: {
@@ -6995,18 +7261,196 @@ var openapi_default = {
6995
7261
  items: {
6996
7262
  oneOf: [
6997
7263
  {
6998
- properties: {
6999
- error_code: { type: "string" },
7000
- is_device_error: { enum: [true], type: "boolean" },
7001
- message: { type: "string" }
7002
- },
7003
- required: ["message", "is_device_error", "error_code"],
7004
- type: "object"
7005
- },
7006
- {
7007
- properties: {
7008
- error_code: { type: "string" },
7009
- is_connected_account_error: {
7264
+ description: "Error associated with the `device`.",
7265
+ oneOf: [
7266
+ {
7267
+ description: "Device is offline",
7268
+ properties: {
7269
+ error_code: {
7270
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7271
+ enum: ["device_offline"],
7272
+ type: "string"
7273
+ },
7274
+ is_device_error: { enum: [true], type: "boolean" },
7275
+ message: { type: "string" }
7276
+ },
7277
+ required: ["message", "is_device_error", "error_code"],
7278
+ type: "object"
7279
+ },
7280
+ {
7281
+ description: "Device has been removed",
7282
+ properties: {
7283
+ error_code: {
7284
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7285
+ enum: ["device_removed"],
7286
+ type: "string"
7287
+ },
7288
+ is_device_error: { enum: [true], type: "boolean" },
7289
+ message: { type: "string" }
7290
+ },
7291
+ required: ["message", "is_device_error", "error_code"],
7292
+ type: "object"
7293
+ },
7294
+ {
7295
+ description: "Account is disconnected",
7296
+ properties: {
7297
+ error_code: {
7298
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7299
+ enum: ["account_disconnected"],
7300
+ type: "string"
7301
+ },
7302
+ is_device_error: { enum: [true], type: "boolean" },
7303
+ message: { type: "string" }
7304
+ },
7305
+ required: ["message", "is_device_error", "error_code"],
7306
+ type: "object"
7307
+ },
7308
+ {
7309
+ description: "Hub is disconnected",
7310
+ properties: {
7311
+ error_code: {
7312
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7313
+ enum: ["hub_disconnected"],
7314
+ type: "string"
7315
+ },
7316
+ is_device_error: { enum: [true], type: "boolean" },
7317
+ message: { type: "string" }
7318
+ },
7319
+ required: ["message", "is_device_error", "error_code"],
7320
+ type: "object"
7321
+ },
7322
+ {
7323
+ description: "Device is disconnected",
7324
+ properties: {
7325
+ error_code: {
7326
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7327
+ enum: ["device_disconnected"],
7328
+ type: "string"
7329
+ },
7330
+ is_device_error: { enum: [true], type: "boolean" },
7331
+ message: { type: "string" }
7332
+ },
7333
+ required: ["message", "is_device_error", "error_code"],
7334
+ type: "object"
7335
+ },
7336
+ {
7337
+ description: "The backup access code pool is empty.",
7338
+ properties: {
7339
+ error_code: {
7340
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7341
+ enum: ["empty_backup_access_code_pool"],
7342
+ type: "string"
7343
+ },
7344
+ is_device_error: { enum: [true], type: "boolean" },
7345
+ message: { type: "string" }
7346
+ },
7347
+ required: ["message", "is_device_error", "error_code"],
7348
+ type: "object"
7349
+ },
7350
+ {
7351
+ description: "User is not authorized to use the August Lock.",
7352
+ properties: {
7353
+ error_code: {
7354
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7355
+ enum: ["august_lock_not_authorized"],
7356
+ type: "string"
7357
+ },
7358
+ is_device_error: { enum: [true], type: "boolean" },
7359
+ message: { type: "string" }
7360
+ },
7361
+ required: ["message", "is_device_error", "error_code"],
7362
+ type: "object"
7363
+ },
7364
+ {
7365
+ description: "Lock is not connected to the Seam Bridge.",
7366
+ properties: {
7367
+ error_code: {
7368
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7369
+ enum: ["august_lock_missing_bridge"],
7370
+ type: "string"
7371
+ },
7372
+ is_device_error: { enum: [true], type: "boolean" },
7373
+ message: { type: "string" }
7374
+ },
7375
+ required: ["message", "is_device_error", "error_code"],
7376
+ type: "object"
7377
+ },
7378
+ {
7379
+ description: "Salto site user limit reached.",
7380
+ properties: {
7381
+ error_code: {
7382
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7383
+ enum: ["salto_site_user_limit_reached"],
7384
+ type: "string"
7385
+ },
7386
+ is_device_error: { enum: [true], type: "boolean" },
7387
+ message: { type: "string" }
7388
+ },
7389
+ required: ["message", "is_device_error", "error_code"],
7390
+ type: "object"
7391
+ },
7392
+ {
7393
+ description: "Lock is not paired with a Gateway.",
7394
+ properties: {
7395
+ error_code: {
7396
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7397
+ enum: ["ttlock_lock_not_paired_to_gateway"],
7398
+ type: "string"
7399
+ },
7400
+ is_device_error: { enum: [true], type: "boolean" },
7401
+ message: { type: "string" }
7402
+ },
7403
+ required: ["message", "is_device_error", "error_code"],
7404
+ type: "object"
7405
+ },
7406
+ {
7407
+ description: "Missing device credentials.",
7408
+ properties: {
7409
+ error_code: {
7410
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7411
+ enum: ["missing_device_credentials"],
7412
+ type: "string"
7413
+ },
7414
+ is_device_error: { enum: [true], type: "boolean" },
7415
+ message: { type: "string" }
7416
+ },
7417
+ required: ["message", "is_device_error", "error_code"],
7418
+ type: "object"
7419
+ },
7420
+ {
7421
+ description: "The auxiliary heat is running.",
7422
+ properties: {
7423
+ error_code: {
7424
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7425
+ enum: ["auxiliary_heat_running"],
7426
+ type: "string"
7427
+ },
7428
+ is_device_error: { enum: [true], type: "boolean" },
7429
+ message: { type: "string" }
7430
+ },
7431
+ required: ["message", "is_device_error", "error_code"],
7432
+ type: "object"
7433
+ },
7434
+ {
7435
+ description: "Subscription required to connect.",
7436
+ properties: {
7437
+ error_code: {
7438
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
7439
+ enum: ["subscription_required"],
7440
+ type: "string"
7441
+ },
7442
+ is_device_error: { enum: [true], type: "boolean" },
7443
+ message: { type: "string" }
7444
+ },
7445
+ required: ["message", "is_device_error", "error_code"],
7446
+ type: "object"
7447
+ }
7448
+ ]
7449
+ },
7450
+ {
7451
+ properties: {
7452
+ error_code: { type: "string" },
7453
+ is_connected_account_error: {
7010
7454
  enum: [true],
7011
7455
  type: "boolean"
7012
7456
  },
@@ -8404,30 +8848,27 @@ var openapi_default = {
8404
8848
  discriminator: { propertyName: "event_type" },
8405
8849
  oneOf: [
8406
8850
  {
8407
- description: "An access code was created.",
8851
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.",
8408
8852
  properties: {
8409
8853
  access_code_id: {
8410
- description: "The ID of the access code.",
8854
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8411
8855
  format: "uuid",
8412
- type: "string",
8413
- "x-title": "Access Code ID"
8856
+ type: "string"
8414
8857
  },
8415
8858
  connected_account_id: {
8416
- description: "The ID of the connected account.",
8859
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8417
8860
  format: "uuid",
8418
- type: "string",
8419
- "x-title": "Connected Account ID"
8861
+ type: "string"
8420
8862
  },
8421
8863
  created_at: {
8422
- description: "Time at which the event was created.",
8864
+ description: "Date and time at which the event was created.",
8423
8865
  format: "date-time",
8424
8866
  type: "string"
8425
8867
  },
8426
8868
  device_id: {
8427
- description: "The ID of the device.",
8869
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8428
8870
  format: "uuid",
8429
- type: "string",
8430
- "x-title": "Device ID"
8871
+ type: "string"
8431
8872
  },
8432
8873
  event_id: {
8433
8874
  description: "ID of the event.",
@@ -8436,7 +8877,7 @@ var openapi_default = {
8436
8877
  },
8437
8878
  event_type: { enum: ["access_code.created"], type: "string" },
8438
8879
  occurred_at: {
8439
- description: "Time when the event occurred.",
8880
+ description: "Date and time at which the event occurred.",
8440
8881
  format: "date-time",
8441
8882
  type: "string"
8442
8883
  },
@@ -8459,30 +8900,27 @@ var openapi_default = {
8459
8900
  type: "object"
8460
8901
  },
8461
8902
  {
8462
- description: "An access code was changed.",
8903
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.",
8463
8904
  properties: {
8464
8905
  access_code_id: {
8465
- description: "The ID of the access code.",
8906
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8466
8907
  format: "uuid",
8467
- type: "string",
8468
- "x-title": "Access Code ID"
8908
+ type: "string"
8469
8909
  },
8470
8910
  connected_account_id: {
8471
- description: "The ID of the connected account.",
8911
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8472
8912
  format: "uuid",
8473
- type: "string",
8474
- "x-title": "Connected Account ID"
8913
+ type: "string"
8475
8914
  },
8476
8915
  created_at: {
8477
- description: "Time at which the event was created.",
8916
+ description: "Date and time at which the event was created.",
8478
8917
  format: "date-time",
8479
8918
  type: "string"
8480
8919
  },
8481
8920
  device_id: {
8482
- description: "The ID of the device.",
8921
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8483
8922
  format: "uuid",
8484
- type: "string",
8485
- "x-title": "Device ID"
8923
+ type: "string"
8486
8924
  },
8487
8925
  event_id: {
8488
8926
  description: "ID of the event.",
@@ -8491,7 +8929,7 @@ var openapi_default = {
8491
8929
  },
8492
8930
  event_type: { enum: ["access_code.changed"], type: "string" },
8493
8931
  occurred_at: {
8494
- description: "Time when the event occurred.",
8932
+ description: "Date and time at which the event occurred.",
8495
8933
  format: "date-time",
8496
8934
  type: "string"
8497
8935
  },
@@ -8514,35 +8952,31 @@ var openapi_default = {
8514
8952
  type: "object"
8515
8953
  },
8516
8954
  {
8517
- description: "An access code was natively scheduled on a device.",
8955
+ 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.",
8518
8956
  properties: {
8519
8957
  access_code_id: {
8520
- description: "The ID of the access code.",
8958
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8521
8959
  format: "uuid",
8522
- type: "string",
8523
- "x-title": "Access Code ID"
8960
+ type: "string"
8524
8961
  },
8525
8962
  code: {
8526
- description: "The code of the access code.",
8527
- type: "string",
8528
- "x-title": "Access Code"
8963
+ description: "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8964
+ type: "string"
8529
8965
  },
8530
8966
  connected_account_id: {
8531
- description: "The ID of the connected account.",
8967
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8532
8968
  format: "uuid",
8533
- type: "string",
8534
- "x-title": "Connected Account ID"
8969
+ type: "string"
8535
8970
  },
8536
8971
  created_at: {
8537
- description: "Time at which the event was created.",
8972
+ description: "Date and time at which the event was created.",
8538
8973
  format: "date-time",
8539
8974
  type: "string"
8540
8975
  },
8541
8976
  device_id: {
8542
- description: "The ID of the device.",
8977
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8543
8978
  format: "uuid",
8544
- type: "string",
8545
- "x-title": "Device ID"
8979
+ type: "string"
8546
8980
  },
8547
8981
  event_id: {
8548
8982
  description: "ID of the event.",
@@ -8554,7 +8988,7 @@ var openapi_default = {
8554
8988
  type: "string"
8555
8989
  },
8556
8990
  occurred_at: {
8557
- description: "Time when the event occurred.",
8991
+ description: "Date and time at which the event occurred.",
8558
8992
  format: "date-time",
8559
8993
  type: "string"
8560
8994
  },
@@ -8578,35 +9012,31 @@ var openapi_default = {
8578
9012
  type: "object"
8579
9013
  },
8580
9014
  {
8581
- description: "An access code was set on a device.",
9015
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.",
8582
9016
  properties: {
8583
9017
  access_code_id: {
8584
- description: "The ID of the access code.",
9018
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8585
9019
  format: "uuid",
8586
- type: "string",
8587
- "x-title": "Access Code ID"
9020
+ type: "string"
8588
9021
  },
8589
9022
  code: {
8590
- description: "The code of the access code.",
8591
- type: "string",
8592
- "x-title": "Access Code"
9023
+ description: "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9024
+ type: "string"
8593
9025
  },
8594
9026
  connected_account_id: {
8595
- description: "The ID of the connected account.",
9027
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8596
9028
  format: "uuid",
8597
- type: "string",
8598
- "x-title": "Connected Account ID"
9029
+ type: "string"
8599
9030
  },
8600
9031
  created_at: {
8601
- description: "Time at which the event was created.",
9032
+ description: "Date and time at which the event was created.",
8602
9033
  format: "date-time",
8603
9034
  type: "string"
8604
9035
  },
8605
9036
  device_id: {
8606
- description: "The ID of the device.",
9037
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8607
9038
  format: "uuid",
8608
- type: "string",
8609
- "x-title": "Device ID"
9039
+ type: "string"
8610
9040
  },
8611
9041
  event_id: {
8612
9042
  description: "ID of the event.",
@@ -8618,7 +9048,7 @@ var openapi_default = {
8618
9048
  type: "string"
8619
9049
  },
8620
9050
  occurred_at: {
8621
- description: "Time when the event occurred.",
9051
+ description: "Date and time at which the event occurred.",
8622
9052
  format: "date-time",
8623
9053
  type: "string"
8624
9054
  },
@@ -8642,30 +9072,27 @@ var openapi_default = {
8642
9072
  type: "object"
8643
9073
  },
8644
9074
  {
8645
- description: "An access code was removed from a device.",
9075
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.",
8646
9076
  properties: {
8647
9077
  access_code_id: {
8648
- description: "The ID of the access code.",
9078
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8649
9079
  format: "uuid",
8650
- type: "string",
8651
- "x-title": "Access Code ID"
9080
+ type: "string"
8652
9081
  },
8653
9082
  connected_account_id: {
8654
- description: "The ID of the connected account.",
9083
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8655
9084
  format: "uuid",
8656
- type: "string",
8657
- "x-title": "Connected Account ID"
9085
+ type: "string"
8658
9086
  },
8659
9087
  created_at: {
8660
- description: "Time at which the event was created.",
9088
+ description: "Date and time at which the event was created.",
8661
9089
  format: "date-time",
8662
9090
  type: "string"
8663
9091
  },
8664
9092
  device_id: {
8665
- description: "The ID of the device.",
9093
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8666
9094
  format: "uuid",
8667
- type: "string",
8668
- "x-title": "Device ID"
9095
+ type: "string"
8669
9096
  },
8670
9097
  event_id: {
8671
9098
  description: "ID of the event.",
@@ -8677,7 +9104,7 @@ var openapi_default = {
8677
9104
  type: "string"
8678
9105
  },
8679
9106
  occurred_at: {
8680
- description: "Time when the event occurred.",
9107
+ description: "Date and time at which the event occurred.",
8681
9108
  format: "date-time",
8682
9109
  type: "string"
8683
9110
  },
@@ -8700,30 +9127,27 @@ var openapi_default = {
8700
9127
  type: "object"
8701
9128
  },
8702
9129
  {
8703
- description: "There was an unusually long delay in setting an access code on a device.",
9130
+ 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.",
8704
9131
  properties: {
8705
9132
  access_code_id: {
8706
- description: "The ID of the access code.",
9133
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8707
9134
  format: "uuid",
8708
- type: "string",
8709
- "x-title": "Access Code ID"
9135
+ type: "string"
8710
9136
  },
8711
9137
  connected_account_id: {
8712
- description: "The ID of the connected account.",
9138
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8713
9139
  format: "uuid",
8714
- type: "string",
8715
- "x-title": "Connected Account ID"
9140
+ type: "string"
8716
9141
  },
8717
9142
  created_at: {
8718
- description: "Time at which the event was created.",
9143
+ description: "Date and time at which the event was created.",
8719
9144
  format: "date-time",
8720
9145
  type: "string"
8721
9146
  },
8722
9147
  device_id: {
8723
- description: "The ID of the device.",
9148
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8724
9149
  format: "uuid",
8725
- type: "string",
8726
- "x-title": "Device ID"
9150
+ type: "string"
8727
9151
  },
8728
9152
  event_id: {
8729
9153
  description: "ID of the event.",
@@ -8735,7 +9159,7 @@ var openapi_default = {
8735
9159
  type: "string"
8736
9160
  },
8737
9161
  occurred_at: {
8738
- description: "Time when the event occurred.",
9162
+ description: "Date and time at which the event occurred.",
8739
9163
  format: "date-time",
8740
9164
  type: "string"
8741
9165
  },
@@ -8758,30 +9182,27 @@ var openapi_default = {
8758
9182
  type: "object"
8759
9183
  },
8760
9184
  {
8761
- description: "An access code failed to be set on a device.",
9185
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.",
8762
9186
  properties: {
8763
9187
  access_code_id: {
8764
- description: "The ID of the access code.",
9188
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8765
9189
  format: "uuid",
8766
- type: "string",
8767
- "x-title": "Access Code ID"
9190
+ type: "string"
8768
9191
  },
8769
9192
  connected_account_id: {
8770
- description: "The ID of the connected account.",
9193
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8771
9194
  format: "uuid",
8772
- type: "string",
8773
- "x-title": "Connected Account ID"
9195
+ type: "string"
8774
9196
  },
8775
9197
  created_at: {
8776
- description: "Time at which the event was created.",
9198
+ description: "Date and time at which the event was created.",
8777
9199
  format: "date-time",
8778
9200
  type: "string"
8779
9201
  },
8780
9202
  device_id: {
8781
- description: "The ID of the device.",
9203
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8782
9204
  format: "uuid",
8783
- type: "string",
8784
- "x-title": "Device ID"
9205
+ type: "string"
8785
9206
  },
8786
9207
  event_id: {
8787
9208
  description: "ID of the event.",
@@ -8793,7 +9214,7 @@ var openapi_default = {
8793
9214
  type: "string"
8794
9215
  },
8795
9216
  occurred_at: {
8796
- description: "Time when the event occurred.",
9217
+ description: "Date and time at which the event occurred.",
8797
9218
  format: "date-time",
8798
9219
  type: "string"
8799
9220
  },
@@ -8816,36 +9237,32 @@ var openapi_default = {
8816
9237
  type: "object"
8817
9238
  },
8818
9239
  {
8819
- description: "An access code was deleted.",
9240
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.",
8820
9241
  properties: {
8821
9242
  access_code_id: {
8822
- description: "The ID of the access code.",
9243
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8823
9244
  format: "uuid",
8824
- type: "string",
8825
- "x-title": "Access Code ID"
9245
+ type: "string"
8826
9246
  },
8827
9247
  code: {
8828
- description: "The code of the access code.",
9248
+ description: "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8829
9249
  nullable: true,
8830
- type: "string",
8831
- "x-title": "Access Code"
9250
+ type: "string"
8832
9251
  },
8833
9252
  connected_account_id: {
8834
- description: "The ID of the connected account.",
9253
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8835
9254
  format: "uuid",
8836
- type: "string",
8837
- "x-title": "Connected Account ID"
9255
+ type: "string"
8838
9256
  },
8839
9257
  created_at: {
8840
- description: "Time at which the event was created.",
9258
+ description: "Date and time at which the event was created.",
8841
9259
  format: "date-time",
8842
9260
  type: "string"
8843
9261
  },
8844
9262
  device_id: {
8845
- description: "The ID of the device.",
9263
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8846
9264
  format: "uuid",
8847
- type: "string",
8848
- "x-title": "Device ID"
9265
+ type: "string"
8849
9266
  },
8850
9267
  event_id: {
8851
9268
  description: "ID of the event.",
@@ -8854,7 +9271,7 @@ var openapi_default = {
8854
9271
  },
8855
9272
  event_type: { enum: ["access_code.deleted"], type: "string" },
8856
9273
  occurred_at: {
8857
- description: "Time when the event occurred.",
9274
+ description: "Date and time at which the event occurred.",
8858
9275
  format: "date-time",
8859
9276
  type: "string"
8860
9277
  },
@@ -8878,30 +9295,27 @@ var openapi_default = {
8878
9295
  type: "object"
8879
9296
  },
8880
9297
  {
8881
- description: "There was an unusually long delay in removing an access code from a device.",
9298
+ 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.",
8882
9299
  properties: {
8883
9300
  access_code_id: {
8884
- description: "The ID of the access code.",
9301
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8885
9302
  format: "uuid",
8886
- type: "string",
8887
- "x-title": "Access Code ID"
9303
+ type: "string"
8888
9304
  },
8889
9305
  connected_account_id: {
8890
- description: "The ID of the connected account.",
9306
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8891
9307
  format: "uuid",
8892
- type: "string",
8893
- "x-title": "Connected Account ID"
9308
+ type: "string"
8894
9309
  },
8895
9310
  created_at: {
8896
- description: "Time at which the event was created.",
9311
+ description: "Date and time at which the event was created.",
8897
9312
  format: "date-time",
8898
9313
  type: "string"
8899
9314
  },
8900
9315
  device_id: {
8901
- description: "The ID of the device.",
9316
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8902
9317
  format: "uuid",
8903
- type: "string",
8904
- "x-title": "Device ID"
9318
+ type: "string"
8905
9319
  },
8906
9320
  event_id: {
8907
9321
  description: "ID of the event.",
@@ -8913,7 +9327,7 @@ var openapi_default = {
8913
9327
  type: "string"
8914
9328
  },
8915
9329
  occurred_at: {
8916
- description: "Time when the event occurred.",
9330
+ description: "Date and time at which the event occurred.",
8917
9331
  format: "date-time",
8918
9332
  type: "string"
8919
9333
  },
@@ -8936,30 +9350,27 @@ var openapi_default = {
8936
9350
  type: "object"
8937
9351
  },
8938
9352
  {
8939
- description: "An access code failed to be removed from a device.",
9353
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.",
8940
9354
  properties: {
8941
9355
  access_code_id: {
8942
- description: "The ID of the access code.",
9356
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8943
9357
  format: "uuid",
8944
- type: "string",
8945
- "x-title": "Access Code ID"
9358
+ type: "string"
8946
9359
  },
8947
9360
  connected_account_id: {
8948
- description: "The ID of the connected account.",
9361
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8949
9362
  format: "uuid",
8950
- type: "string",
8951
- "x-title": "Connected Account ID"
9363
+ type: "string"
8952
9364
  },
8953
9365
  created_at: {
8954
- description: "Time at which the event was created.",
9366
+ description: "Date and time at which the event was created.",
8955
9367
  format: "date-time",
8956
9368
  type: "string"
8957
9369
  },
8958
9370
  device_id: {
8959
- description: "The ID of the device.",
9371
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8960
9372
  format: "uuid",
8961
- type: "string",
8962
- "x-title": "Device ID"
9373
+ type: "string"
8963
9374
  },
8964
9375
  event_id: {
8965
9376
  description: "ID of the event.",
@@ -8971,7 +9382,7 @@ var openapi_default = {
8971
9382
  type: "string"
8972
9383
  },
8973
9384
  occurred_at: {
8974
- description: "Time when the event occurred.",
9385
+ description: "Date and time at which the event occurred.",
8975
9386
  format: "date-time",
8976
9387
  type: "string"
8977
9388
  },
@@ -8994,30 +9405,27 @@ var openapi_default = {
8994
9405
  type: "object"
8995
9406
  },
8996
9407
  {
8997
- description: "An access code was modified external to Seam.",
9408
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.",
8998
9409
  properties: {
8999
9410
  access_code_id: {
9000
- description: "The ID of the access code.",
9411
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9001
9412
  format: "uuid",
9002
- type: "string",
9003
- "x-title": "Access Code ID"
9413
+ type: "string"
9004
9414
  },
9005
9415
  connected_account_id: {
9006
- description: "The ID of the connected account.",
9416
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9007
9417
  format: "uuid",
9008
- type: "string",
9009
- "x-title": "Connected Account ID"
9418
+ type: "string"
9010
9419
  },
9011
9420
  created_at: {
9012
- description: "Time at which the event was created.",
9421
+ description: "Date and time at which the event was created.",
9013
9422
  format: "date-time",
9014
9423
  type: "string"
9015
9424
  },
9016
9425
  device_id: {
9017
- description: "The ID of the device.",
9426
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9018
9427
  format: "uuid",
9019
- type: "string",
9020
- "x-title": "Device ID"
9428
+ type: "string"
9021
9429
  },
9022
9430
  event_id: {
9023
9431
  description: "ID of the event.",
@@ -9029,7 +9437,7 @@ var openapi_default = {
9029
9437
  type: "string"
9030
9438
  },
9031
9439
  occurred_at: {
9032
- description: "Time when the event occurred.",
9440
+ description: "Date and time at which the event occurred.",
9033
9441
  format: "date-time",
9034
9442
  type: "string"
9035
9443
  },
@@ -9052,30 +9460,27 @@ var openapi_default = {
9052
9460
  type: "object"
9053
9461
  },
9054
9462
  {
9055
- description: "An access code was deleted external to Seam.",
9463
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.",
9056
9464
  properties: {
9057
9465
  access_code_id: {
9058
- description: "The ID of the access code.",
9466
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9059
9467
  format: "uuid",
9060
- type: "string",
9061
- "x-title": "Access Code ID"
9468
+ type: "string"
9062
9469
  },
9063
9470
  connected_account_id: {
9064
- description: "The ID of the connected account.",
9471
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9065
9472
  format: "uuid",
9066
- type: "string",
9067
- "x-title": "Connected Account ID"
9473
+ type: "string"
9068
9474
  },
9069
9475
  created_at: {
9070
- description: "Time at which the event was created.",
9476
+ description: "Date and time at which the event was created.",
9071
9477
  format: "date-time",
9072
9478
  type: "string"
9073
9479
  },
9074
9480
  device_id: {
9075
- description: "The ID of the device.",
9481
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9076
9482
  format: "uuid",
9077
- type: "string",
9078
- "x-title": "Device ID"
9483
+ type: "string"
9079
9484
  },
9080
9485
  event_id: {
9081
9486
  description: "ID of the event.",
@@ -9087,7 +9492,7 @@ var openapi_default = {
9087
9492
  type: "string"
9088
9493
  },
9089
9494
  occurred_at: {
9090
- description: "Time when the event occurred.",
9495
+ description: "Date and time at which the event occurred.",
9091
9496
  format: "date-time",
9092
9497
  type: "string"
9093
9498
  },
@@ -9110,31 +9515,28 @@ var openapi_default = {
9110
9515
  type: "object"
9111
9516
  },
9112
9517
  {
9113
- description: "A backup access code was pulled from the backup access code pool and set on a device.",
9518
+ 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.",
9114
9519
  properties: {
9115
9520
  access_code_id: {
9116
- description: "The ID of the access code.",
9521
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9117
9522
  format: "uuid",
9118
- type: "string",
9119
- "x-title": "Access Code ID"
9523
+ type: "string"
9120
9524
  },
9121
9525
  backup_access_code_id: { type: "string" },
9122
9526
  connected_account_id: {
9123
- description: "The ID of the connected account.",
9527
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9124
9528
  format: "uuid",
9125
- type: "string",
9126
- "x-title": "Connected Account ID"
9529
+ type: "string"
9127
9530
  },
9128
9531
  created_at: {
9129
- description: "Time at which the event was created.",
9532
+ description: "Date and time at which the event was created.",
9130
9533
  format: "date-time",
9131
9534
  type: "string"
9132
9535
  },
9133
9536
  device_id: {
9134
- description: "The ID of the device.",
9537
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9135
9538
  format: "uuid",
9136
- type: "string",
9137
- "x-title": "Device ID"
9539
+ type: "string"
9138
9540
  },
9139
9541
  event_id: {
9140
9542
  description: "ID of the event.",
@@ -9146,7 +9548,7 @@ var openapi_default = {
9146
9548
  type: "string"
9147
9549
  },
9148
9550
  occurred_at: {
9149
- description: "Time when the event occurred.",
9551
+ description: "Date and time at which the event occurred.",
9150
9552
  format: "date-time",
9151
9553
  type: "string"
9152
9554
  },
@@ -9170,30 +9572,27 @@ var openapi_default = {
9170
9572
  type: "object"
9171
9573
  },
9172
9574
  {
9173
- description: "An unmanaged access code was successfully converted to a managed access code.",
9575
+ 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.",
9174
9576
  properties: {
9175
9577
  access_code_id: {
9176
- description: "The ID of the access code.",
9578
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9177
9579
  format: "uuid",
9178
- type: "string",
9179
- "x-title": "Access Code ID"
9580
+ type: "string"
9180
9581
  },
9181
9582
  connected_account_id: {
9182
- description: "The ID of the connected account.",
9583
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9183
9584
  format: "uuid",
9184
- type: "string",
9185
- "x-title": "Connected Account ID"
9585
+ type: "string"
9186
9586
  },
9187
9587
  created_at: {
9188
- description: "Time at which the event was created.",
9588
+ description: "Date and time at which the event was created.",
9189
9589
  format: "date-time",
9190
9590
  type: "string"
9191
9591
  },
9192
9592
  device_id: {
9193
- description: "The ID of the device.",
9593
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9194
9594
  format: "uuid",
9195
- type: "string",
9196
- "x-title": "Device ID"
9595
+ type: "string"
9197
9596
  },
9198
9597
  event_id: {
9199
9598
  description: "ID of the event.",
@@ -9205,7 +9604,7 @@ var openapi_default = {
9205
9604
  type: "string"
9206
9605
  },
9207
9606
  occurred_at: {
9208
- description: "Time when the event occurred.",
9607
+ description: "Date and time at which the event occurred.",
9209
9608
  format: "date-time",
9210
9609
  type: "string"
9211
9610
  },
@@ -9228,30 +9627,27 @@ var openapi_default = {
9228
9627
  type: "object"
9229
9628
  },
9230
9629
  {
9231
- description: "An unmanaged access code failed to be converted to a managed access code.",
9630
+ 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.",
9232
9631
  properties: {
9233
9632
  access_code_id: {
9234
- description: "The ID of the access code.",
9633
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9235
9634
  format: "uuid",
9236
- type: "string",
9237
- "x-title": "Access Code ID"
9635
+ type: "string"
9238
9636
  },
9239
9637
  connected_account_id: {
9240
- description: "The ID of the connected account.",
9638
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9241
9639
  format: "uuid",
9242
- type: "string",
9243
- "x-title": "Connected Account ID"
9640
+ type: "string"
9244
9641
  },
9245
9642
  created_at: {
9246
- description: "Time at which the event was created.",
9643
+ description: "Date and time at which the event was created.",
9247
9644
  format: "date-time",
9248
9645
  type: "string"
9249
9646
  },
9250
9647
  device_id: {
9251
- description: "The ID of the device.",
9648
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9252
9649
  format: "uuid",
9253
- type: "string",
9254
- "x-title": "Device ID"
9650
+ type: "string"
9255
9651
  },
9256
9652
  event_id: {
9257
9653
  description: "ID of the event.",
@@ -9263,7 +9659,7 @@ var openapi_default = {
9263
9659
  type: "string"
9264
9660
  },
9265
9661
  occurred_at: {
9266
- description: "Time when the event occurred.",
9662
+ description: "Date and time at which the event occurred.",
9267
9663
  format: "date-time",
9268
9664
  type: "string"
9269
9665
  },
@@ -9286,30 +9682,27 @@ var openapi_default = {
9286
9682
  type: "object"
9287
9683
  },
9288
9684
  {
9289
- description: "An unmanaged access code was created on a device.",
9685
+ 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.",
9290
9686
  properties: {
9291
9687
  access_code_id: {
9292
- description: "The ID of the access code.",
9688
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9293
9689
  format: "uuid",
9294
- type: "string",
9295
- "x-title": "Access Code ID"
9690
+ type: "string"
9296
9691
  },
9297
9692
  connected_account_id: {
9298
- description: "The ID of the connected account.",
9693
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9299
9694
  format: "uuid",
9300
- type: "string",
9301
- "x-title": "Connected Account ID"
9695
+ type: "string"
9302
9696
  },
9303
9697
  created_at: {
9304
- description: "Time at which the event was created.",
9698
+ description: "Date and time at which the event was created.",
9305
9699
  format: "date-time",
9306
9700
  type: "string"
9307
9701
  },
9308
9702
  device_id: {
9309
- description: "The ID of the device.",
9703
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9310
9704
  format: "uuid",
9311
- type: "string",
9312
- "x-title": "Device ID"
9705
+ type: "string"
9313
9706
  },
9314
9707
  event_id: {
9315
9708
  description: "ID of the event.",
@@ -9321,7 +9714,7 @@ var openapi_default = {
9321
9714
  type: "string"
9322
9715
  },
9323
9716
  occurred_at: {
9324
- description: "Time when the event occurred.",
9717
+ description: "Date and time at which the event occurred.",
9325
9718
  format: "date-time",
9326
9719
  type: "string"
9327
9720
  },
@@ -9344,30 +9737,27 @@ var openapi_default = {
9344
9737
  type: "object"
9345
9738
  },
9346
9739
  {
9347
- description: "An unmanaged access code was removed from a device.",
9740
+ 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.",
9348
9741
  properties: {
9349
9742
  access_code_id: {
9350
- description: "The ID of the access code.",
9743
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9351
9744
  format: "uuid",
9352
- type: "string",
9353
- "x-title": "Access Code ID"
9745
+ type: "string"
9354
9746
  },
9355
9747
  connected_account_id: {
9356
- description: "The ID of the connected account.",
9748
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9357
9749
  format: "uuid",
9358
- type: "string",
9359
- "x-title": "Connected Account ID"
9750
+ type: "string"
9360
9751
  },
9361
9752
  created_at: {
9362
- description: "Time at which the event was created.",
9753
+ description: "Date and time at which the event was created.",
9363
9754
  format: "date-time",
9364
9755
  type: "string"
9365
9756
  },
9366
9757
  device_id: {
9367
- description: "The ID of the device.",
9758
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9368
9759
  format: "uuid",
9369
- type: "string",
9370
- "x-title": "Device ID"
9760
+ type: "string"
9371
9761
  },
9372
9762
  event_id: {
9373
9763
  description: "ID of the event.",
@@ -9379,7 +9769,7 @@ var openapi_default = {
9379
9769
  type: "string"
9380
9770
  },
9381
9771
  occurred_at: {
9382
- description: "Time when the event occurred.",
9772
+ description: "Date and time at which the event occurred.",
9383
9773
  format: "date-time",
9384
9774
  type: "string"
9385
9775
  },
@@ -9402,22 +9792,20 @@ var openapi_default = {
9402
9792
  type: "object"
9403
9793
  },
9404
9794
  {
9405
- description: "An ACS system was connected.",
9795
+ description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.",
9406
9796
  properties: {
9407
9797
  acs_system_id: {
9408
- description: "ID of the ACS system.",
9798
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9409
9799
  format: "uuid",
9410
- type: "string",
9411
- "x-title": "ACS System ID"
9800
+ type: "string"
9412
9801
  },
9413
9802
  connected_account_id: {
9414
- description: "ID of the connected account.",
9803
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9415
9804
  format: "uuid",
9416
- type: "string",
9417
- "x-title": "Connected Account ID"
9805
+ type: "string"
9418
9806
  },
9419
9807
  created_at: {
9420
- description: "Time at which the event was created.",
9808
+ description: "Date and time at which the event was created.",
9421
9809
  format: "date-time",
9422
9810
  type: "string"
9423
9811
  },
@@ -9428,7 +9816,7 @@ var openapi_default = {
9428
9816
  },
9429
9817
  event_type: { enum: ["acs_system.connected"], type: "string" },
9430
9818
  occurred_at: {
9431
- description: "Time when the event occurred.",
9819
+ description: "Date and time at which the event occurred.",
9432
9820
  format: "date-time",
9433
9821
  type: "string"
9434
9822
  },
@@ -9449,22 +9837,20 @@ var openapi_default = {
9449
9837
  type: "object"
9450
9838
  },
9451
9839
  {
9452
- description: "An ACS system was added.",
9840
+ description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.",
9453
9841
  properties: {
9454
9842
  acs_system_id: {
9455
- description: "ID of the ACS system.",
9843
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9456
9844
  format: "uuid",
9457
- type: "string",
9458
- "x-title": "ACS System ID"
9845
+ type: "string"
9459
9846
  },
9460
9847
  connected_account_id: {
9461
- description: "ID of the connected account.",
9848
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9462
9849
  format: "uuid",
9463
- type: "string",
9464
- "x-title": "Connected Account ID"
9850
+ type: "string"
9465
9851
  },
9466
9852
  created_at: {
9467
- description: "Time at which the event was created.",
9853
+ description: "Date and time at which the event was created.",
9468
9854
  format: "date-time",
9469
9855
  type: "string"
9470
9856
  },
@@ -9475,7 +9861,7 @@ var openapi_default = {
9475
9861
  },
9476
9862
  event_type: { enum: ["acs_system.added"], type: "string" },
9477
9863
  occurred_at: {
9478
- description: "Time when the event occurred.",
9864
+ description: "Date and time at which the event occurred.",
9479
9865
  format: "date-time",
9480
9866
  type: "string"
9481
9867
  },
@@ -9496,22 +9882,20 @@ var openapi_default = {
9496
9882
  type: "object"
9497
9883
  },
9498
9884
  {
9499
- description: "An ACS system was disconnected.",
9885
+ description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.",
9500
9886
  properties: {
9501
9887
  acs_system_id: {
9502
- description: "ID of the ACS system.",
9888
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9503
9889
  format: "uuid",
9504
- type: "string",
9505
- "x-title": "ACS System ID"
9890
+ type: "string"
9506
9891
  },
9507
9892
  connected_account_id: {
9508
- description: "ID of the connected account.",
9893
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9509
9894
  format: "uuid",
9510
- type: "string",
9511
- "x-title": "Connected Account ID"
9895
+ type: "string"
9512
9896
  },
9513
9897
  created_at: {
9514
- description: "Time at which the event was created.",
9898
+ description: "Date and time at which the event was created.",
9515
9899
  format: "date-time",
9516
9900
  type: "string"
9517
9901
  },
@@ -9522,7 +9906,7 @@ var openapi_default = {
9522
9906
  },
9523
9907
  event_type: { enum: ["acs_system.disconnected"], type: "string" },
9524
9908
  occurred_at: {
9525
- description: "Time when the event occurred.",
9909
+ description: "Date and time at which the event occurred.",
9526
9910
  format: "date-time",
9527
9911
  type: "string"
9528
9912
  },
@@ -9543,23 +9927,21 @@ var openapi_default = {
9543
9927
  type: "object"
9544
9928
  },
9545
9929
  {
9546
- description: "An ACS credential was deleted.",
9930
+ description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.",
9547
9931
  properties: {
9548
9932
  acs_credential_id: { format: "uuid", type: "string" },
9549
9933
  acs_system_id: {
9550
- description: "ID of the ACS system.",
9934
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9551
9935
  format: "uuid",
9552
- type: "string",
9553
- "x-title": "ACS System ID"
9936
+ type: "string"
9554
9937
  },
9555
9938
  connected_account_id: {
9556
- description: "ID of the connected account.",
9939
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9557
9940
  format: "uuid",
9558
- type: "string",
9559
- "x-title": "Connected Account ID"
9941
+ type: "string"
9560
9942
  },
9561
9943
  created_at: {
9562
- description: "Time at which the event was created.",
9944
+ description: "Date and time at which the event was created.",
9563
9945
  format: "date-time",
9564
9946
  type: "string"
9565
9947
  },
@@ -9570,7 +9952,7 @@ var openapi_default = {
9570
9952
  },
9571
9953
  event_type: { enum: ["acs_credential.deleted"], type: "string" },
9572
9954
  occurred_at: {
9573
- description: "Time when the event occurred.",
9955
+ description: "Date and time at which the event occurred.",
9574
9956
  format: "date-time",
9575
9957
  type: "string"
9576
9958
  },
@@ -9592,23 +9974,21 @@ var openapi_default = {
9592
9974
  type: "object"
9593
9975
  },
9594
9976
  {
9595
- description: "An ACS credential was issued.",
9977
+ description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.",
9596
9978
  properties: {
9597
9979
  acs_credential_id: { format: "uuid", type: "string" },
9598
9980
  acs_system_id: {
9599
- description: "ID of the ACS system.",
9981
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9600
9982
  format: "uuid",
9601
- type: "string",
9602
- "x-title": "ACS System ID"
9983
+ type: "string"
9603
9984
  },
9604
9985
  connected_account_id: {
9605
- description: "ID of the connected account.",
9986
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9606
9987
  format: "uuid",
9607
- type: "string",
9608
- "x-title": "Connected Account ID"
9988
+ type: "string"
9609
9989
  },
9610
9990
  created_at: {
9611
- description: "Time at which the event was created.",
9991
+ description: "Date and time at which the event was created.",
9612
9992
  format: "date-time",
9613
9993
  type: "string"
9614
9994
  },
@@ -9619,7 +9999,7 @@ var openapi_default = {
9619
9999
  },
9620
10000
  event_type: { enum: ["acs_credential.issued"], type: "string" },
9621
10001
  occurred_at: {
9622
- description: "Time when the event occurred.",
10002
+ description: "Date and time at which the event occurred.",
9623
10003
  format: "date-time",
9624
10004
  type: "string"
9625
10005
  },
@@ -9641,23 +10021,21 @@ var openapi_default = {
9641
10021
  type: "object"
9642
10022
  },
9643
10023
  {
9644
- description: "An ACS user was deleted.",
10024
+ description: "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.",
9645
10025
  properties: {
9646
10026
  acs_system_id: {
9647
- description: "ID of the ACS system.",
10027
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9648
10028
  format: "uuid",
9649
- type: "string",
9650
- "x-title": "ACS System ID"
10029
+ type: "string"
9651
10030
  },
9652
10031
  acs_user_id: { format: "uuid", type: "string" },
9653
10032
  connected_account_id: {
9654
- description: "ID of the connected account.",
10033
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9655
10034
  format: "uuid",
9656
- type: "string",
9657
- "x-title": "Connected Account ID"
10035
+ type: "string"
9658
10036
  },
9659
10037
  created_at: {
9660
- description: "Time at which the event was created.",
10038
+ description: "Date and time at which the event was created.",
9661
10039
  format: "date-time",
9662
10040
  type: "string"
9663
10041
  },
@@ -9668,7 +10046,7 @@ var openapi_default = {
9668
10046
  },
9669
10047
  event_type: { enum: ["acs_user.deleted"], type: "string" },
9670
10048
  occurred_at: {
9671
- description: "Time when the event occurred.",
10049
+ description: "Date and time at which the event occurred.",
9672
10050
  format: "date-time",
9673
10051
  type: "string"
9674
10052
  },
@@ -9690,27 +10068,25 @@ var openapi_default = {
9690
10068
  type: "object"
9691
10069
  },
9692
10070
  {
9693
- description: "An ACS encoder was added.",
10071
+ description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.",
9694
10072
  properties: {
9695
10073
  acs_encoder_id: {
9696
- description: "ID of the ACS encoder.",
10074
+ description: "ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
9697
10075
  format: "uuid",
9698
10076
  type: "string"
9699
10077
  },
9700
10078
  acs_system_id: {
9701
- description: "ID of the ACS system.",
10079
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9702
10080
  format: "uuid",
9703
- type: "string",
9704
- "x-title": "ACS System ID"
10081
+ type: "string"
9705
10082
  },
9706
10083
  connected_account_id: {
9707
- description: "ID of the connected account.",
10084
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9708
10085
  format: "uuid",
9709
- type: "string",
9710
- "x-title": "Connected Account ID"
10086
+ type: "string"
9711
10087
  },
9712
10088
  created_at: {
9713
- description: "Time at which the event was created.",
10089
+ description: "Date and time at which the event was created.",
9714
10090
  format: "date-time",
9715
10091
  type: "string"
9716
10092
  },
@@ -9721,7 +10097,7 @@ var openapi_default = {
9721
10097
  },
9722
10098
  event_type: { enum: ["acs_encoder.added"], type: "string" },
9723
10099
  occurred_at: {
9724
- description: "Time when the event occurred.",
10100
+ description: "Date and time at which the event occurred.",
9725
10101
  format: "date-time",
9726
10102
  type: "string"
9727
10103
  },
@@ -9743,27 +10119,25 @@ var openapi_default = {
9743
10119
  type: "object"
9744
10120
  },
9745
10121
  {
9746
- description: "An ACS encoder was removed.",
10122
+ description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.",
9747
10123
  properties: {
9748
10124
  acs_encoder_id: {
9749
- description: "ID of the ACS encoder.",
10125
+ description: "ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
9750
10126
  format: "uuid",
9751
10127
  type: "string"
9752
10128
  },
9753
10129
  acs_system_id: {
9754
- description: "ID of the ACS system.",
10130
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9755
10131
  format: "uuid",
9756
- type: "string",
9757
- "x-title": "ACS System ID"
10132
+ type: "string"
9758
10133
  },
9759
10134
  connected_account_id: {
9760
- description: "ID of the connected account.",
10135
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9761
10136
  format: "uuid",
9762
- type: "string",
9763
- "x-title": "Connected Account ID"
10137
+ type: "string"
9764
10138
  },
9765
10139
  created_at: {
9766
- description: "Time at which the event was created.",
10140
+ description: "Date and time at which the event was created.",
9767
10141
  format: "date-time",
9768
10142
  type: "string"
9769
10143
  },
@@ -9774,7 +10148,7 @@ var openapi_default = {
9774
10148
  },
9775
10149
  event_type: { enum: ["acs_encoder.removed"], type: "string" },
9776
10150
  occurred_at: {
9777
- description: "Time when the event occurred.",
10151
+ description: "Date and time at which the event occurred.",
9778
10152
  format: "date-time",
9779
10153
  type: "string"
9780
10154
  },
@@ -9796,16 +10170,15 @@ var openapi_default = {
9796
10170
  type: "object"
9797
10171
  },
9798
10172
  {
9799
- description: "A client session was deleted.",
10173
+ description: "A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.",
9800
10174
  properties: {
9801
10175
  client_session_id: {
9802
- description: "ID of the client session.",
10176
+ description: "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
9803
10177
  format: "uuid",
9804
- type: "string",
9805
- "x-title": "Client Session ID"
10178
+ type: "string"
9806
10179
  },
9807
10180
  created_at: {
9808
- description: "Time at which the event was created.",
10181
+ description: "Date and time at which the event was created.",
9809
10182
  format: "date-time",
9810
10183
  type: "string"
9811
10184
  },
@@ -9816,7 +10189,7 @@ var openapi_default = {
9816
10189
  },
9817
10190
  event_type: { enum: ["client_session.deleted"], type: "string" },
9818
10191
  occurred_at: {
9819
- description: "Time when the event occurred.",
10192
+ description: "Date and time at which the event occurred.",
9820
10193
  format: "date-time",
9821
10194
  type: "string"
9822
10195
  },
@@ -9837,22 +10210,20 @@ var openapi_default = {
9837
10210
  type: "object"
9838
10211
  },
9839
10212
  {
9840
- description: "A connected account was connected for the first time, was reconnected after being disconnected.",
10213
+ 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.",
9841
10214
  properties: {
9842
10215
  connect_webview_id: {
9843
- description: "ID of the connect webview.",
10216
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
9844
10217
  format: "uuid",
9845
- type: "string",
9846
- "x-title": "Connect Webview ID"
10218
+ type: "string"
9847
10219
  },
9848
10220
  connected_account_id: {
9849
- description: "ID of the connected account.",
10221
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9850
10222
  format: "uuid",
9851
- type: "string",
9852
- "x-title": "Connected Account ID"
10223
+ type: "string"
9853
10224
  },
9854
10225
  created_at: {
9855
- description: "Time at which the event was created.",
10226
+ description: "Date and time at which the event was created.",
9856
10227
  format: "date-time",
9857
10228
  type: "string"
9858
10229
  },
@@ -9866,7 +10237,7 @@ var openapi_default = {
9866
10237
  type: "string"
9867
10238
  },
9868
10239
  occurred_at: {
9869
- description: "Time when the event occurred.",
10240
+ description: "Date and time at which the event occurred.",
9870
10241
  format: "date-time",
9871
10242
  type: "string"
9872
10243
  },
@@ -9888,22 +10259,20 @@ var openapi_default = {
9888
10259
  type: "object"
9889
10260
  },
9890
10261
  {
9891
- description: "A connected account was created.",
10262
+ description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.",
9892
10263
  properties: {
9893
10264
  connect_webview_id: {
9894
- description: "ID of the connect webview.",
10265
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
9895
10266
  format: "uuid",
9896
- type: "string",
9897
- "x-title": "Connect Webview ID"
10267
+ type: "string"
9898
10268
  },
9899
10269
  connected_account_id: {
9900
- description: "ID of the connected account.",
10270
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9901
10271
  format: "uuid",
9902
- type: "string",
9903
- "x-title": "Connected Account ID"
10272
+ type: "string"
9904
10273
  },
9905
10274
  created_at: {
9906
- description: "Time at which the event was created.",
10275
+ description: "Date and time at which the event was created.",
9907
10276
  format: "date-time",
9908
10277
  type: "string"
9909
10278
  },
@@ -9917,7 +10286,7 @@ var openapi_default = {
9917
10286
  type: "string"
9918
10287
  },
9919
10288
  occurred_at: {
9920
- description: "Time when the event occurred.",
10289
+ description: "Date and time at which the event occurred.",
9921
10290
  format: "date-time",
9922
10291
  type: "string"
9923
10292
  },
@@ -9940,22 +10309,20 @@ var openapi_default = {
9940
10309
  },
9941
10310
  {
9942
10311
  deprecated: true,
9943
- description: "A connected account had a successful connect webview login.",
10312
+ description: "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).",
9944
10313
  properties: {
9945
10314
  connect_webview_id: {
9946
- description: "ID of the connect webview.",
10315
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
9947
10316
  format: "uuid",
9948
- type: "string",
9949
- "x-title": "Connect Webview ID"
10317
+ type: "string"
9950
10318
  },
9951
10319
  connected_account_id: {
9952
- description: "ID of the connected account.",
10320
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9953
10321
  format: "uuid",
9954
- type: "string",
9955
- "x-title": "Connected Account ID"
10322
+ type: "string"
9956
10323
  },
9957
10324
  created_at: {
9958
- description: "Time at which the event was created.",
10325
+ description: "Date and time at which the event was created.",
9959
10326
  format: "date-time",
9960
10327
  type: "string"
9961
10328
  },
@@ -9969,7 +10336,7 @@ var openapi_default = {
9969
10336
  type: "string"
9970
10337
  },
9971
10338
  occurred_at: {
9972
- description: "Time when the event occurred.",
10339
+ description: "Date and time at which the event occurred.",
9973
10340
  format: "date-time",
9974
10341
  type: "string"
9975
10342
  },
@@ -9992,16 +10359,15 @@ var openapi_default = {
9992
10359
  "x-deprecated": "Use `connect_webview.login_succeeded`."
9993
10360
  },
9994
10361
  {
9995
- description: "A connected account was disconnected.",
10362
+ description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.",
9996
10363
  properties: {
9997
10364
  connected_account_id: {
9998
- description: "ID of the connected account.",
10365
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9999
10366
  format: "uuid",
10000
- type: "string",
10001
- "x-title": "Connected Account ID"
10367
+ type: "string"
10002
10368
  },
10003
10369
  created_at: {
10004
- description: "Time at which the event was created.",
10370
+ description: "Date and time at which the event was created.",
10005
10371
  format: "date-time",
10006
10372
  type: "string"
10007
10373
  },
@@ -10015,7 +10381,7 @@ var openapi_default = {
10015
10381
  type: "string"
10016
10382
  },
10017
10383
  occurred_at: {
10018
- description: "Time when the event occurred.",
10384
+ description: "Date and time at which the event occurred.",
10019
10385
  format: "date-time",
10020
10386
  type: "string"
10021
10387
  },
@@ -10036,16 +10402,15 @@ var openapi_default = {
10036
10402
  type: "object"
10037
10403
  },
10038
10404
  {
10039
- description: "A connected account completed the first sync with Seam and devices are now available.",
10405
+ 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.",
10040
10406
  properties: {
10041
10407
  connected_account_id: {
10042
- description: "ID of the connected account.",
10408
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10043
10409
  format: "uuid",
10044
- type: "string",
10045
- "x-title": "Connected Account ID"
10410
+ type: "string"
10046
10411
  },
10047
10412
  created_at: {
10048
- description: "Time at which the event was created.",
10413
+ description: "Date and time at which the event was created.",
10049
10414
  format: "date-time",
10050
10415
  type: "string"
10051
10416
  },
@@ -10059,7 +10424,7 @@ var openapi_default = {
10059
10424
  type: "string"
10060
10425
  },
10061
10426
  occurred_at: {
10062
- description: "Time when the event occurred.",
10427
+ description: "Date and time at which the event occurred.",
10063
10428
  format: "date-time",
10064
10429
  type: "string"
10065
10430
  },
@@ -10080,16 +10445,15 @@ var openapi_default = {
10080
10445
  type: "object"
10081
10446
  },
10082
10447
  {
10083
- description: "A connected account was deleted.",
10448
+ description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.",
10084
10449
  properties: {
10085
10450
  connected_account_id: {
10086
- description: "ID of the connected account.",
10451
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10087
10452
  format: "uuid",
10088
- type: "string",
10089
- "x-title": "Connected Account ID"
10453
+ type: "string"
10090
10454
  },
10091
10455
  created_at: {
10092
- description: "Time at which the event was created.",
10456
+ description: "Date and time at which the event was created.",
10093
10457
  format: "date-time",
10094
10458
  type: "string"
10095
10459
  },
@@ -10103,7 +10467,7 @@ var openapi_default = {
10103
10467
  type: "string"
10104
10468
  },
10105
10469
  occurred_at: {
10106
- description: "Time when the event occurred.",
10470
+ description: "Date and time at which the event occurred.",
10107
10471
  format: "date-time",
10108
10472
  type: "string"
10109
10473
  },
@@ -10124,16 +10488,15 @@ var openapi_default = {
10124
10488
  type: "object"
10125
10489
  },
10126
10490
  {
10127
- description: "A connected account completed the first sync after reconnection with Seam and devices are now available.",
10491
+ 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.",
10128
10492
  properties: {
10129
10493
  connected_account_id: {
10130
- description: "ID of the connected account.",
10494
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10131
10495
  format: "uuid",
10132
- type: "string",
10133
- "x-title": "Connected Account ID"
10496
+ type: "string"
10134
10497
  },
10135
10498
  created_at: {
10136
- description: "Time at which the event was created.",
10499
+ description: "Date and time at which the event was created.",
10137
10500
  format: "date-time",
10138
10501
  type: "string"
10139
10502
  },
@@ -10149,7 +10512,7 @@ var openapi_default = {
10149
10512
  type: "string"
10150
10513
  },
10151
10514
  occurred_at: {
10152
- description: "Time when the event occurred.",
10515
+ description: "Date and time at which the event occurred.",
10153
10516
  format: "date-time",
10154
10517
  type: "string"
10155
10518
  },
@@ -10170,21 +10533,16 @@ var openapi_default = {
10170
10533
  type: "object"
10171
10534
  },
10172
10535
  {
10173
- description: "A lock door action attempt succeeded.",
10536
+ description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
10174
10537
  properties: {
10175
10538
  action_attempt_id: {
10176
- description: "The ID of the action attempt.",
10539
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10177
10540
  format: "uuid",
10178
- type: "string",
10179
- "x-title": "Action Attempt ID"
10180
- },
10181
- action_type: {
10182
- description: "The type of action.",
10183
- type: "string",
10184
- "x-title": "Action Type"
10541
+ type: "string"
10185
10542
  },
10543
+ action_type: { description: "Type of action.", type: "string" },
10186
10544
  created_at: {
10187
- description: "Time at which the event was created.",
10545
+ description: "Date and time at which the event was created.",
10188
10546
  format: "date-time",
10189
10547
  type: "string"
10190
10548
  },
@@ -10198,15 +10556,11 @@ var openapi_default = {
10198
10556
  type: "string"
10199
10557
  },
10200
10558
  occurred_at: {
10201
- description: "Time when the event occurred.",
10559
+ description: "Date and time at which the event occurred.",
10202
10560
  format: "date-time",
10203
10561
  type: "string"
10204
10562
  },
10205
- status: {
10206
- description: "The status of the action.",
10207
- type: "string",
10208
- "x-title": "Status"
10209
- },
10563
+ status: { description: "Status of the action.", type: "string" },
10210
10564
  workspace_id: {
10211
10565
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10212
10566
  format: "uuid",
@@ -10226,21 +10580,16 @@ var openapi_default = {
10226
10580
  type: "object"
10227
10581
  },
10228
10582
  {
10229
- description: "A lock door action attempt failed.",
10583
+ description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
10230
10584
  properties: {
10231
10585
  action_attempt_id: {
10232
- description: "The ID of the action attempt.",
10586
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10233
10587
  format: "uuid",
10234
- type: "string",
10235
- "x-title": "Action Attempt ID"
10236
- },
10237
- action_type: {
10238
- description: "The type of action.",
10239
- type: "string",
10240
- "x-title": "Action Type"
10588
+ type: "string"
10241
10589
  },
10590
+ action_type: { description: "Type of action.", type: "string" },
10242
10591
  created_at: {
10243
- description: "Time at which the event was created.",
10592
+ description: "Date and time at which the event was created.",
10244
10593
  format: "date-time",
10245
10594
  type: "string"
10246
10595
  },
@@ -10254,15 +10603,11 @@ var openapi_default = {
10254
10603
  type: "string"
10255
10604
  },
10256
10605
  occurred_at: {
10257
- description: "Time when the event occurred.",
10606
+ description: "Date and time at which the event occurred.",
10258
10607
  format: "date-time",
10259
10608
  type: "string"
10260
10609
  },
10261
- status: {
10262
- description: "The status of the action.",
10263
- type: "string",
10264
- "x-title": "Status"
10265
- },
10610
+ status: { description: "Status of the action.", type: "string" },
10266
10611
  workspace_id: {
10267
10612
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10268
10613
  format: "uuid",
@@ -10282,21 +10627,16 @@ var openapi_default = {
10282
10627
  type: "object"
10283
10628
  },
10284
10629
  {
10285
- description: "An unlock door action attempt succeeded.",
10630
+ description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
10286
10631
  properties: {
10287
10632
  action_attempt_id: {
10288
- description: "The ID of the action attempt.",
10633
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10289
10634
  format: "uuid",
10290
- type: "string",
10291
- "x-title": "Action Attempt ID"
10292
- },
10293
- action_type: {
10294
- description: "The type of action.",
10295
- type: "string",
10296
- "x-title": "Action Type"
10635
+ type: "string"
10297
10636
  },
10637
+ action_type: { description: "Type of action.", type: "string" },
10298
10638
  created_at: {
10299
- description: "Time at which the event was created.",
10639
+ description: "Date and time at which the event was created.",
10300
10640
  format: "date-time",
10301
10641
  type: "string"
10302
10642
  },
@@ -10310,15 +10650,11 @@ var openapi_default = {
10310
10650
  type: "string"
10311
10651
  },
10312
10652
  occurred_at: {
10313
- description: "Time when the event occurred.",
10653
+ description: "Date and time at which the event occurred.",
10314
10654
  format: "date-time",
10315
10655
  type: "string"
10316
10656
  },
10317
- status: {
10318
- description: "The status of the action.",
10319
- type: "string",
10320
- "x-title": "Status"
10321
- },
10657
+ status: { description: "Status of the action.", type: "string" },
10322
10658
  workspace_id: {
10323
10659
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10324
10660
  format: "uuid",
@@ -10338,21 +10674,16 @@ var openapi_default = {
10338
10674
  type: "object"
10339
10675
  },
10340
10676
  {
10341
- description: "An unlock door action attempt failed.",
10677
+ description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
10342
10678
  properties: {
10343
10679
  action_attempt_id: {
10344
- description: "The ID of the action attempt.",
10680
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10345
10681
  format: "uuid",
10346
- type: "string",
10347
- "x-title": "Action Attempt ID"
10348
- },
10349
- action_type: {
10350
- description: "The type of action.",
10351
- type: "string",
10352
- "x-title": "Action Type"
10682
+ type: "string"
10353
10683
  },
10684
+ action_type: { description: "Type of action.", type: "string" },
10354
10685
  created_at: {
10355
- description: "Time at which the event was created.",
10686
+ description: "Date and time at which the event was created.",
10356
10687
  format: "date-time",
10357
10688
  type: "string"
10358
10689
  },
@@ -10366,15 +10697,11 @@ var openapi_default = {
10366
10697
  type: "string"
10367
10698
  },
10368
10699
  occurred_at: {
10369
- description: "Time when the event occurred.",
10700
+ description: "Date and time at which the event occurred.",
10370
10701
  format: "date-time",
10371
10702
  type: "string"
10372
10703
  },
10373
- status: {
10374
- description: "The status of the action.",
10375
- type: "string",
10376
- "x-title": "Status"
10377
- },
10704
+ status: { description: "Status of the action.", type: "string" },
10378
10705
  workspace_id: {
10379
10706
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10380
10707
  format: "uuid",
@@ -10394,22 +10721,20 @@ var openapi_default = {
10394
10721
  type: "object"
10395
10722
  },
10396
10723
  {
10397
- description: "A connect webview had a successful login.",
10724
+ description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.",
10398
10725
  properties: {
10399
10726
  connect_webview_id: {
10400
- description: "ID of the connect webview.",
10727
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
10401
10728
  format: "uuid",
10402
- type: "string",
10403
- "x-title": "Connect Webview ID"
10729
+ type: "string"
10404
10730
  },
10405
10731
  connected_account_id: {
10406
- description: "ID of the connected account.",
10732
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10407
10733
  format: "uuid",
10408
- type: "string",
10409
- "x-title": "Connected Account ID"
10734
+ type: "string"
10410
10735
  },
10411
10736
  created_at: {
10412
- description: "Time at which the event was created.",
10737
+ description: "Date and time at which the event was created.",
10413
10738
  format: "date-time",
10414
10739
  type: "string"
10415
10740
  },
@@ -10423,7 +10748,7 @@ var openapi_default = {
10423
10748
  type: "string"
10424
10749
  },
10425
10750
  occurred_at: {
10426
- description: "Time when the event occurred.",
10751
+ description: "Date and time at which the event occurred.",
10427
10752
  format: "date-time",
10428
10753
  type: "string"
10429
10754
  },
@@ -10445,16 +10770,15 @@ var openapi_default = {
10445
10770
  type: "object"
10446
10771
  },
10447
10772
  {
10448
- description: "A connect webview had a failed login.",
10773
+ description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.",
10449
10774
  properties: {
10450
10775
  connect_webview_id: {
10451
- description: "ID of the connect webview.",
10776
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
10452
10777
  format: "uuid",
10453
- type: "string",
10454
- "x-title": "Connect Webview ID"
10778
+ type: "string"
10455
10779
  },
10456
10780
  created_at: {
10457
- description: "Time at which the event was created.",
10781
+ description: "Date and time at which the event was created.",
10458
10782
  format: "date-time",
10459
10783
  type: "string"
10460
10784
  },
@@ -10468,7 +10792,7 @@ var openapi_default = {
10468
10792
  type: "string"
10469
10793
  },
10470
10794
  occurred_at: {
10471
- description: "Time when the event occurred.",
10795
+ description: "Date and time at which the event occurred.",
10472
10796
  format: "date-time",
10473
10797
  type: "string"
10474
10798
  },
@@ -10489,7 +10813,7 @@ var openapi_default = {
10489
10813
  type: "object"
10490
10814
  },
10491
10815
  {
10492
- description: "A new device was connected to Seam.",
10816
+ 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.",
10493
10817
  properties: {
10494
10818
  connected_account_id: {
10495
10819
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10497,7 +10821,7 @@ var openapi_default = {
10497
10821
  type: "string"
10498
10822
  },
10499
10823
  created_at: {
10500
- description: "Time at which the event was created.",
10824
+ description: "Date and time at which the event was created.",
10501
10825
  format: "date-time",
10502
10826
  type: "string"
10503
10827
  },
@@ -10513,7 +10837,7 @@ var openapi_default = {
10513
10837
  },
10514
10838
  event_type: { enum: ["device.connected"], type: "string" },
10515
10839
  occurred_at: {
10516
- description: "Time when the event occurred.",
10840
+ description: "Date and time at which the event occurred.",
10517
10841
  format: "date-time",
10518
10842
  type: "string"
10519
10843
  },
@@ -10535,7 +10859,7 @@ var openapi_default = {
10535
10859
  type: "object"
10536
10860
  },
10537
10861
  {
10538
- description: "A device was added or reconnected to Seam.",
10862
+ 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.",
10539
10863
  properties: {
10540
10864
  connected_account_id: {
10541
10865
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10543,7 +10867,7 @@ var openapi_default = {
10543
10867
  type: "string"
10544
10868
  },
10545
10869
  created_at: {
10546
- description: "Time at which the event was created.",
10870
+ description: "Date and time at which the event was created.",
10547
10871
  format: "date-time",
10548
10872
  type: "string"
10549
10873
  },
@@ -10559,7 +10883,7 @@ var openapi_default = {
10559
10883
  },
10560
10884
  event_type: { enum: ["device.added"], type: "string" },
10561
10885
  occurred_at: {
10562
- description: "Time when the event occurred.",
10886
+ description: "Date and time at which the event occurred.",
10563
10887
  format: "date-time",
10564
10888
  type: "string"
10565
10889
  },
@@ -10589,7 +10913,7 @@ var openapi_default = {
10589
10913
  type: "string"
10590
10914
  },
10591
10915
  created_at: {
10592
- description: "Time at which the event was created.",
10916
+ description: "Date and time at which the event was created.",
10593
10917
  format: "date-time",
10594
10918
  type: "string"
10595
10919
  },
@@ -10608,7 +10932,7 @@ var openapi_default = {
10608
10932
  type: "string"
10609
10933
  },
10610
10934
  occurred_at: {
10611
- description: "Time when the event occurred.",
10935
+ description: "Date and time at which the event occurred.",
10612
10936
  format: "date-time",
10613
10937
  type: "string"
10614
10938
  },
@@ -10638,7 +10962,7 @@ var openapi_default = {
10638
10962
  type: "string"
10639
10963
  },
10640
10964
  created_at: {
10641
- description: "Time at which the event was created.",
10965
+ description: "Date and time at which the event was created.",
10642
10966
  format: "date-time",
10643
10967
  type: "string"
10644
10968
  },
@@ -10657,7 +10981,7 @@ var openapi_default = {
10657
10981
  type: "string"
10658
10982
  },
10659
10983
  occurred_at: {
10660
- description: "Time when the event occurred.",
10984
+ description: "Date and time at which the event occurred.",
10661
10985
  format: "date-time",
10662
10986
  type: "string"
10663
10987
  },
@@ -10679,7 +11003,7 @@ var openapi_default = {
10679
11003
  type: "object"
10680
11004
  },
10681
11005
  {
10682
- description: "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.",
11006
+ 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`.",
10683
11007
  properties: {
10684
11008
  connected_account_id: {
10685
11009
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10687,7 +11011,7 @@ var openapi_default = {
10687
11011
  type: "string"
10688
11012
  },
10689
11013
  created_at: {
10690
- description: "Time at which the event was created.",
11014
+ description: "Date and time at which the event was created.",
10691
11015
  format: "date-time",
10692
11016
  type: "string"
10693
11017
  },
@@ -10706,7 +11030,7 @@ var openapi_default = {
10706
11030
  type: "string"
10707
11031
  },
10708
11032
  occurred_at: {
10709
- description: "Time when the event occurred.",
11033
+ description: "Date and time at which the event occurred.",
10710
11034
  format: "date-time",
10711
11035
  type: "string"
10712
11036
  },
@@ -10728,7 +11052,7 @@ var openapi_default = {
10728
11052
  type: "object"
10729
11053
  },
10730
11054
  {
10731
- description: "A device was disconnected from Seam.",
11055
+ 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`.",
10732
11056
  properties: {
10733
11057
  connected_account_id: {
10734
11058
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10736,7 +11060,7 @@ var openapi_default = {
10736
11060
  type: "string"
10737
11061
  },
10738
11062
  created_at: {
10739
- description: "Time at which the event was created.",
11063
+ description: "Date and time at which the event was created.",
10740
11064
  format: "date-time",
10741
11065
  type: "string"
10742
11066
  },
@@ -10761,7 +11085,7 @@ var openapi_default = {
10761
11085
  },
10762
11086
  event_type: { enum: ["device.disconnected"], type: "string" },
10763
11087
  occurred_at: {
10764
- description: "Time when the event occurred.",
11088
+ description: "Date and time at which the event occurred.",
10765
11089
  format: "date-time",
10766
11090
  type: "string"
10767
11091
  },
@@ -10784,7 +11108,7 @@ var openapi_default = {
10784
11108
  type: "object"
10785
11109
  },
10786
11110
  {
10787
- description: "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.",
11111
+ 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`.",
10788
11112
  properties: {
10789
11113
  connected_account_id: {
10790
11114
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10792,7 +11116,7 @@ var openapi_default = {
10792
11116
  type: "string"
10793
11117
  },
10794
11118
  created_at: {
10795
- description: "Time at which the event was created.",
11119
+ description: "Date and time at which the event was created.",
10796
11120
  format: "date-time",
10797
11121
  type: "string"
10798
11122
  },
@@ -10820,7 +11144,7 @@ var openapi_default = {
10820
11144
  type: "string"
10821
11145
  },
10822
11146
  occurred_at: {
10823
- description: "Time when the event occurred.",
11147
+ description: "Date and time at which the event occurred.",
10824
11148
  format: "date-time",
10825
11149
  type: "string"
10826
11150
  },
@@ -10843,7 +11167,7 @@ var openapi_default = {
10843
11167
  type: "object"
10844
11168
  },
10845
11169
  {
10846
- description: "A device detected that it was tampered with, for example, opened or moved.",
11170
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.",
10847
11171
  properties: {
10848
11172
  connected_account_id: {
10849
11173
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10851,7 +11175,7 @@ var openapi_default = {
10851
11175
  type: "string"
10852
11176
  },
10853
11177
  created_at: {
10854
- description: "Time at which the event was created.",
11178
+ description: "Date and time at which the event was created.",
10855
11179
  format: "date-time",
10856
11180
  type: "string"
10857
11181
  },
@@ -10867,7 +11191,7 @@ var openapi_default = {
10867
11191
  },
10868
11192
  event_type: { enum: ["device.tampered"], type: "string" },
10869
11193
  occurred_at: {
10870
- description: "Time when the event occurred.",
11194
+ description: "Date and time at which the event occurred.",
10871
11195
  format: "date-time",
10872
11196
  type: "string"
10873
11197
  },
@@ -10889,7 +11213,7 @@ var openapi_default = {
10889
11213
  type: "object"
10890
11214
  },
10891
11215
  {
10892
- description: "A device battery level dropped below the low threshold.",
11216
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.",
10893
11217
  properties: {
10894
11218
  battery_level: {
10895
11219
  description: "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.",
@@ -10904,7 +11228,7 @@ var openapi_default = {
10904
11228
  type: "string"
10905
11229
  },
10906
11230
  created_at: {
10907
- description: "Time at which the event was created.",
11231
+ description: "Date and time at which the event was created.",
10908
11232
  format: "date-time",
10909
11233
  type: "string"
10910
11234
  },
@@ -10920,7 +11244,7 @@ var openapi_default = {
10920
11244
  },
10921
11245
  event_type: { enum: ["device.low_battery"], type: "string" },
10922
11246
  occurred_at: {
10923
- description: "Time when the event occurred.",
11247
+ description: "Date and time at which the event occurred.",
10924
11248
  format: "date-time",
10925
11249
  type: "string"
10926
11250
  },
@@ -10943,7 +11267,7 @@ var openapi_default = {
10943
11267
  type: "object"
10944
11268
  },
10945
11269
  {
10946
- description: "A device battery status changed since the last `battery_status_changed` event.",
11270
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.",
10947
11271
  properties: {
10948
11272
  battery_level: {
10949
11273
  description: "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.",
@@ -10963,7 +11287,7 @@ var openapi_default = {
10963
11287
  type: "string"
10964
11288
  },
10965
11289
  created_at: {
10966
- description: "Time at which the event was created.",
11290
+ description: "Date and time at which the event was created.",
10967
11291
  format: "date-time",
10968
11292
  type: "string"
10969
11293
  },
@@ -10982,7 +11306,7 @@ var openapi_default = {
10982
11306
  type: "string"
10983
11307
  },
10984
11308
  occurred_at: {
10985
- description: "Time when the event occurred.",
11309
+ description: "Date and time at which the event occurred.",
10986
11310
  format: "date-time",
10987
11311
  type: "string"
10988
11312
  },
@@ -11006,7 +11330,7 @@ var openapi_default = {
11006
11330
  type: "object"
11007
11331
  },
11008
11332
  {
11009
- description: "A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
11333
+ 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).",
11010
11334
  properties: {
11011
11335
  connected_account_id: {
11012
11336
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11014,7 +11338,7 @@ var openapi_default = {
11014
11338
  type: "string"
11015
11339
  },
11016
11340
  created_at: {
11017
- description: "Time at which the event was created.",
11341
+ description: "Date and time at which the event was created.",
11018
11342
  format: "date-time",
11019
11343
  type: "string"
11020
11344
  },
@@ -11030,7 +11354,7 @@ var openapi_default = {
11030
11354
  },
11031
11355
  event_type: { enum: ["device.removed"], type: "string" },
11032
11356
  occurred_at: {
11033
- description: "Time when the event occurred.",
11357
+ description: "Date and time at which the event occurred.",
11034
11358
  format: "date-time",
11035
11359
  type: "string"
11036
11360
  },
@@ -11052,7 +11376,7 @@ var openapi_default = {
11052
11376
  type: "object"
11053
11377
  },
11054
11378
  {
11055
- description: "A device was [deleted](https://docs.seam.co/latest/api/devices/delete).",
11379
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.",
11056
11380
  properties: {
11057
11381
  connected_account_id: {
11058
11382
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11060,7 +11384,7 @@ var openapi_default = {
11060
11384
  type: "string"
11061
11385
  },
11062
11386
  created_at: {
11063
- description: "Time at which the event was created.",
11387
+ description: "Date and time at which the event was created.",
11064
11388
  format: "date-time",
11065
11389
  type: "string"
11066
11390
  },
@@ -11076,7 +11400,7 @@ var openapi_default = {
11076
11400
  },
11077
11401
  event_type: { enum: ["device.deleted"], type: "string" },
11078
11402
  occurred_at: {
11079
- description: "Time when the event occurred.",
11403
+ description: "Date and time at which the event occurred.",
11080
11404
  format: "date-time",
11081
11405
  type: "string"
11082
11406
  },
@@ -11098,7 +11422,7 @@ var openapi_default = {
11098
11422
  type: "object"
11099
11423
  },
11100
11424
  {
11101
- description: "Seam detected that a device is using a third-party integration that will interfere with Seam device management.",
11425
+ 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.",
11102
11426
  properties: {
11103
11427
  connected_account_id: {
11104
11428
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11106,7 +11430,7 @@ var openapi_default = {
11106
11430
  type: "string"
11107
11431
  },
11108
11432
  created_at: {
11109
- description: "Time at which the event was created.",
11433
+ description: "Date and time at which the event was created.",
11110
11434
  format: "date-time",
11111
11435
  type: "string"
11112
11436
  },
@@ -11125,7 +11449,7 @@ var openapi_default = {
11125
11449
  type: "string"
11126
11450
  },
11127
11451
  occurred_at: {
11128
- description: "Time when the event occurred.",
11452
+ description: "Date and time at which the event occurred.",
11129
11453
  format: "date-time",
11130
11454
  type: "string"
11131
11455
  },
@@ -11147,7 +11471,7 @@ var openapi_default = {
11147
11471
  type: "object"
11148
11472
  },
11149
11473
  {
11150
- description: "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.",
11474
+ 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.",
11151
11475
  properties: {
11152
11476
  connected_account_id: {
11153
11477
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11155,7 +11479,7 @@ var openapi_default = {
11155
11479
  type: "string"
11156
11480
  },
11157
11481
  created_at: {
11158
- description: "Time at which the event was created.",
11482
+ description: "Date and time at which the event was created.",
11159
11483
  format: "date-time",
11160
11484
  type: "string"
11161
11485
  },
@@ -11174,7 +11498,7 @@ var openapi_default = {
11174
11498
  type: "string"
11175
11499
  },
11176
11500
  occurred_at: {
11177
- description: "Time when the event occurred.",
11501
+ description: "Date and time at which the event occurred.",
11178
11502
  format: "date-time",
11179
11503
  type: "string"
11180
11504
  },
@@ -11196,7 +11520,7 @@ var openapi_default = {
11196
11520
  type: "object"
11197
11521
  },
11198
11522
  {
11199
- description: "A Salto device activated privacy mode.",
11523
+ description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.",
11200
11524
  properties: {
11201
11525
  connected_account_id: {
11202
11526
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11204,7 +11528,7 @@ var openapi_default = {
11204
11528
  type: "string"
11205
11529
  },
11206
11530
  created_at: {
11207
- description: "Time at which the event was created.",
11531
+ description: "Date and time at which the event was created.",
11208
11532
  format: "date-time",
11209
11533
  type: "string"
11210
11534
  },
@@ -11223,7 +11547,7 @@ var openapi_default = {
11223
11547
  type: "string"
11224
11548
  },
11225
11549
  occurred_at: {
11226
- description: "Time when the event occurred.",
11550
+ description: "Date and time at which the event occurred.",
11227
11551
  format: "date-time",
11228
11552
  type: "string"
11229
11553
  },
@@ -11245,7 +11569,7 @@ var openapi_default = {
11245
11569
  type: "object"
11246
11570
  },
11247
11571
  {
11248
- description: "A Salto device deactivated privacy mode.",
11572
+ description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.",
11249
11573
  properties: {
11250
11574
  connected_account_id: {
11251
11575
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11253,7 +11577,7 @@ var openapi_default = {
11253
11577
  type: "string"
11254
11578
  },
11255
11579
  created_at: {
11256
- description: "Time at which the event was created.",
11580
+ description: "Date and time at which the event was created.",
11257
11581
  format: "date-time",
11258
11582
  type: "string"
11259
11583
  },
@@ -11272,7 +11596,7 @@ var openapi_default = {
11272
11596
  type: "string"
11273
11597
  },
11274
11598
  occurred_at: {
11275
- description: "Time when the event occurred.",
11599
+ description: "Date and time at which the event occurred.",
11276
11600
  format: "date-time",
11277
11601
  type: "string"
11278
11602
  },
@@ -11294,7 +11618,7 @@ var openapi_default = {
11294
11618
  type: "object"
11295
11619
  },
11296
11620
  {
11297
- description: "Seam detected a flaky device connection.",
11621
+ description: "Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.",
11298
11622
  properties: {
11299
11623
  connected_account_id: {
11300
11624
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11302,7 +11626,7 @@ var openapi_default = {
11302
11626
  type: "string"
11303
11627
  },
11304
11628
  created_at: {
11305
- description: "Time at which the event was created.",
11629
+ description: "Date and time at which the event was created.",
11306
11630
  format: "date-time",
11307
11631
  type: "string"
11308
11632
  },
@@ -11321,7 +11645,7 @@ var openapi_default = {
11321
11645
  type: "string"
11322
11646
  },
11323
11647
  occurred_at: {
11324
- description: "Time when the event occurred.",
11648
+ description: "Date and time at which the event occurred.",
11325
11649
  format: "date-time",
11326
11650
  type: "string"
11327
11651
  },
@@ -11343,7 +11667,7 @@ var openapi_default = {
11343
11667
  type: "object"
11344
11668
  },
11345
11669
  {
11346
- description: "Seam detected that a previously-flaky device connection stabilized.",
11670
+ description: "Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.",
11347
11671
  properties: {
11348
11672
  connected_account_id: {
11349
11673
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11351,7 +11675,7 @@ var openapi_default = {
11351
11675
  type: "string"
11352
11676
  },
11353
11677
  created_at: {
11354
- description: "Time at which the event was created.",
11678
+ description: "Date and time at which the event was created.",
11355
11679
  format: "date-time",
11356
11680
  type: "string"
11357
11681
  },
@@ -11370,7 +11694,7 @@ var openapi_default = {
11370
11694
  type: "string"
11371
11695
  },
11372
11696
  occurred_at: {
11373
- description: "Time when the event occurred.",
11697
+ description: "Date and time at which the event occurred.",
11374
11698
  format: "date-time",
11375
11699
  type: "string"
11376
11700
  },
@@ -11392,7 +11716,7 @@ var openapi_default = {
11392
11716
  type: "object"
11393
11717
  },
11394
11718
  {
11395
- description: "A third-party subscription is required to use all device features.",
11719
+ description: "A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.",
11396
11720
  properties: {
11397
11721
  connected_account_id: {
11398
11722
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11400,7 +11724,7 @@ var openapi_default = {
11400
11724
  type: "string"
11401
11725
  },
11402
11726
  created_at: {
11403
- description: "Time at which the event was created.",
11727
+ description: "Date and time at which the event was created.",
11404
11728
  format: "date-time",
11405
11729
  type: "string"
11406
11730
  },
@@ -11419,7 +11743,7 @@ var openapi_default = {
11419
11743
  type: "string"
11420
11744
  },
11421
11745
  occurred_at: {
11422
- description: "Time when the event occurred.",
11746
+ description: "Date and time at which the event occurred.",
11423
11747
  format: "date-time",
11424
11748
  type: "string"
11425
11749
  },
@@ -11441,7 +11765,7 @@ var openapi_default = {
11441
11765
  type: "object"
11442
11766
  },
11443
11767
  {
11444
- description: "A third-party subscription is active or no longer required to use all device features.",
11768
+ description: "A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.",
11445
11769
  properties: {
11446
11770
  connected_account_id: {
11447
11771
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11449,7 +11773,7 @@ var openapi_default = {
11449
11773
  type: "string"
11450
11774
  },
11451
11775
  created_at: {
11452
- description: "Time at which the event was created.",
11776
+ description: "Date and time at which the event was created.",
11453
11777
  format: "date-time",
11454
11778
  type: "string"
11455
11779
  },
@@ -11468,7 +11792,7 @@ var openapi_default = {
11468
11792
  type: "string"
11469
11793
  },
11470
11794
  occurred_at: {
11471
- description: "Time when the event occurred.",
11795
+ description: "Date and time at which the event occurred.",
11472
11796
  format: "date-time",
11473
11797
  type: "string"
11474
11798
  },
@@ -11490,7 +11814,7 @@ var openapi_default = {
11490
11814
  type: "object"
11491
11815
  },
11492
11816
  {
11493
- description: "An accessory keypad was connected to a device.",
11817
+ description: "An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).",
11494
11818
  properties: {
11495
11819
  connected_account_id: {
11496
11820
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11498,7 +11822,7 @@ var openapi_default = {
11498
11822
  type: "string"
11499
11823
  },
11500
11824
  created_at: {
11501
- description: "Time at which the event was created.",
11825
+ description: "Date and time at which the event was created.",
11502
11826
  format: "date-time",
11503
11827
  type: "string"
11504
11828
  },
@@ -11517,7 +11841,7 @@ var openapi_default = {
11517
11841
  type: "string"
11518
11842
  },
11519
11843
  occurred_at: {
11520
- description: "Time when the event occurred.",
11844
+ description: "Date and time at which the event occurred.",
11521
11845
  format: "date-time",
11522
11846
  type: "string"
11523
11847
  },
@@ -11539,7 +11863,7 @@ var openapi_default = {
11539
11863
  type: "object"
11540
11864
  },
11541
11865
  {
11542
- description: "An accessory keypad was disconnected from a device.",
11866
+ description: "An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).",
11543
11867
  properties: {
11544
11868
  connected_account_id: {
11545
11869
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11547,7 +11871,7 @@ var openapi_default = {
11547
11871
  type: "string"
11548
11872
  },
11549
11873
  created_at: {
11550
- description: "Time at which the event was created.",
11874
+ description: "Date and time at which the event was created.",
11551
11875
  format: "date-time",
11552
11876
  type: "string"
11553
11877
  },
@@ -11566,7 +11890,7 @@ var openapi_default = {
11566
11890
  type: "string"
11567
11891
  },
11568
11892
  occurred_at: {
11569
- description: "Time when the event occurred.",
11893
+ description: "Date and time at which the event occurred.",
11570
11894
  format: "date-time",
11571
11895
  type: "string"
11572
11896
  },
@@ -11596,7 +11920,7 @@ var openapi_default = {
11596
11920
  type: "string"
11597
11921
  },
11598
11922
  created_at: {
11599
- description: "Time at which the event was created.",
11923
+ description: "Date and time at which the event was created.",
11600
11924
  format: "date-time",
11601
11925
  type: "string"
11602
11926
  },
@@ -11617,8 +11941,7 @@ var openapi_default = {
11617
11941
  minut_metadata: {
11618
11942
  additionalProperties: {},
11619
11943
  description: "Metadata from Minut.",
11620
- type: "object",
11621
- "x-title": "Minut Metadata"
11944
+ type: "object"
11622
11945
  },
11623
11946
  noise_level_decibels: {
11624
11947
  description: "Detected noise level in decibels.",
@@ -11642,11 +11965,10 @@ var openapi_default = {
11642
11965
  noiseaware_metadata: {
11643
11966
  additionalProperties: {},
11644
11967
  description: "Metadata from Noiseaware.",
11645
- type: "object",
11646
- "x-title": "Noiseaware Metadata"
11968
+ type: "object"
11647
11969
  },
11648
11970
  occurred_at: {
11649
- description: "Time when the event occurred.",
11971
+ description: "Date and time at which the event occurred.",
11650
11972
  format: "date-time",
11651
11973
  type: "string"
11652
11974
  },
@@ -11668,7 +11990,7 @@ var openapi_default = {
11668
11990
  type: "object"
11669
11991
  },
11670
11992
  {
11671
- description: "A lock was locked.",
11993
+ description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.",
11672
11994
  properties: {
11673
11995
  access_code_id: {
11674
11996
  description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.",
@@ -11686,7 +12008,7 @@ var openapi_default = {
11686
12008
  type: "string"
11687
12009
  },
11688
12010
  created_at: {
11689
- description: "Time at which the event was created.",
12011
+ description: "Date and time at which the event was created.",
11690
12012
  format: "date-time",
11691
12013
  type: "string"
11692
12014
  },
@@ -11702,12 +12024,12 @@ var openapi_default = {
11702
12024
  },
11703
12025
  event_type: { enum: ["lock.locked"], type: "string" },
11704
12026
  method: {
11705
- description: "Method by which a lock device was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.",
12027
+ description: "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.",
11706
12028
  enum: ["keycode", "manual", "automatic", "unknown", "seamapi"],
11707
12029
  type: "string"
11708
12030
  },
11709
12031
  occurred_at: {
11710
- description: "Time when the event occurred.",
12032
+ description: "Date and time at which the event occurred.",
11711
12033
  format: "date-time",
11712
12034
  type: "string"
11713
12035
  },
@@ -11730,7 +12052,7 @@ var openapi_default = {
11730
12052
  type: "object"
11731
12053
  },
11732
12054
  {
11733
- description: "A lock was unlocked.",
12055
+ description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.",
11734
12056
  properties: {
11735
12057
  access_code_id: {
11736
12058
  description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.",
@@ -11748,7 +12070,7 @@ var openapi_default = {
11748
12070
  type: "string"
11749
12071
  },
11750
12072
  created_at: {
11751
- description: "Time at which the event was created.",
12073
+ description: "Date and time at which the event was created.",
11752
12074
  format: "date-time",
11753
12075
  type: "string"
11754
12076
  },
@@ -11764,12 +12086,12 @@ var openapi_default = {
11764
12086
  },
11765
12087
  event_type: { enum: ["lock.unlocked"], type: "string" },
11766
12088
  method: {
11767
- description: "Method by which a lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.",
12089
+ description: "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.",
11768
12090
  enum: ["keycode", "manual", "automatic", "unknown", "seamapi"],
11769
12091
  type: "string"
11770
12092
  },
11771
12093
  occurred_at: {
11772
- description: "Time when the event occurred.",
12094
+ description: "Date and time at which the event occurred.",
11773
12095
  format: "date-time",
11774
12096
  type: "string"
11775
12097
  },
@@ -11792,7 +12114,7 @@ var openapi_default = {
11792
12114
  type: "object"
11793
12115
  },
11794
12116
  {
11795
- description: "The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.",
12117
+ 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.",
11796
12118
  properties: {
11797
12119
  access_code_id: {
11798
12120
  description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.",
@@ -11805,7 +12127,7 @@ var openapi_default = {
11805
12127
  type: "string"
11806
12128
  },
11807
12129
  created_at: {
11808
- description: "Time at which the event was created.",
12130
+ description: "Date and time at which the event was created.",
11809
12131
  format: "date-time",
11810
12132
  type: "string"
11811
12133
  },
@@ -11821,7 +12143,7 @@ var openapi_default = {
11821
12143
  },
11822
12144
  event_type: { enum: ["lock.access_denied"], type: "string" },
11823
12145
  occurred_at: {
11824
- description: "Time when the event occurred.",
12146
+ description: "Date and time at which the event occurred.",
11825
12147
  format: "date-time",
11826
12148
  type: "string"
11827
12149
  },
@@ -11855,7 +12177,7 @@ var openapi_default = {
11855
12177
  type: "string"
11856
12178
  },
11857
12179
  created_at: {
11858
- description: "Time at which the event was created.",
12180
+ description: "Date and time at which the event was created.",
11859
12181
  format: "date-time",
11860
12182
  type: "string"
11861
12183
  },
@@ -11874,11 +12196,11 @@ var openapi_default = {
11874
12196
  type: "string"
11875
12197
  },
11876
12198
  is_fallback_climate_preset: {
11877
- description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.",
12199
+ description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
11878
12200
  type: "boolean"
11879
12201
  },
11880
12202
  occurred_at: {
11881
- description: "Time when the event occurred.",
12203
+ description: "Date and time at which the event occurred.",
11882
12204
  format: "date-time",
11883
12205
  type: "string"
11884
12206
  },
@@ -11909,7 +12231,7 @@ var openapi_default = {
11909
12231
  type: "object"
11910
12232
  },
11911
12233
  {
11912
- description: "A thermostat was adjusted manually.",
12234
+ description: "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.",
11913
12235
  properties: {
11914
12236
  connected_account_id: {
11915
12237
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11927,7 +12249,7 @@ var openapi_default = {
11927
12249
  type: "number"
11928
12250
  },
11929
12251
  created_at: {
11930
- description: "Time at which the event was created.",
12252
+ description: "Date and time at which the event was created.",
11931
12253
  format: "date-time",
11932
12254
  type: "string"
11933
12255
  },
@@ -11966,12 +12288,12 @@ var openapi_default = {
11966
12288
  type: "string"
11967
12289
  },
11968
12290
  method: {
11969
- description: "Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.",
12291
+ description: "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).",
11970
12292
  enum: ["seam", "external"],
11971
12293
  type: "string"
11972
12294
  },
11973
12295
  occurred_at: {
11974
- description: "Time when the event occurred.",
12296
+ description: "Date and time at which the event occurred.",
11975
12297
  format: "date-time",
11976
12298
  type: "string"
11977
12299
  },
@@ -11994,7 +12316,7 @@ var openapi_default = {
11994
12316
  type: "object"
11995
12317
  },
11996
12318
  {
11997
- description: "A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
12319
+ 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).",
11998
12320
  properties: {
11999
12321
  connected_account_id: {
12000
12322
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -12002,7 +12324,7 @@ var openapi_default = {
12002
12324
  type: "string"
12003
12325
  },
12004
12326
  created_at: {
12005
- description: "Time at which the event was created.",
12327
+ description: "Date and time at which the event was created.",
12006
12328
  format: "date-time",
12007
12329
  type: "string"
12008
12330
  },
@@ -12033,17 +12355,17 @@ var openapi_default = {
12033
12355
  type: "number"
12034
12356
  },
12035
12357
  occurred_at: {
12036
- description: "Time when the event occurred.",
12358
+ description: "Date and time at which the event occurred.",
12037
12359
  format: "date-time",
12038
12360
  type: "string"
12039
12361
  },
12040
12362
  temperature_celsius: {
12041
- description: "Temperature, in \xB0C, reported by the thermostat.",
12363
+ description: "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12042
12364
  format: "float",
12043
12365
  type: "number"
12044
12366
  },
12045
12367
  temperature_fahrenheit: {
12046
- description: "Temperature, in \xB0F, reported by the thermostat.",
12368
+ description: "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12047
12369
  format: "float",
12048
12370
  type: "number"
12049
12371
  },
@@ -12083,7 +12405,7 @@ var openapi_default = {
12083
12405
  type: "object"
12084
12406
  },
12085
12407
  {
12086
- description: "A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
12408
+ 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).",
12087
12409
  properties: {
12088
12410
  connected_account_id: {
12089
12411
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -12091,7 +12413,7 @@ var openapi_default = {
12091
12413
  type: "string"
12092
12414
  },
12093
12415
  created_at: {
12094
- description: "Time at which the event was created.",
12416
+ description: "Date and time at which the event was created.",
12095
12417
  format: "date-time",
12096
12418
  type: "string"
12097
12419
  },
@@ -12122,17 +12444,17 @@ var openapi_default = {
12122
12444
  type: "number"
12123
12445
  },
12124
12446
  occurred_at: {
12125
- description: "Time when the event occurred.",
12447
+ description: "Date and time at which the event occurred.",
12126
12448
  format: "date-time",
12127
12449
  type: "string"
12128
12450
  },
12129
12451
  temperature_celsius: {
12130
- description: "Temperature, in \xB0C, reported by the thermostat.",
12452
+ description: "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12131
12453
  format: "float",
12132
12454
  type: "number"
12133
12455
  },
12134
12456
  temperature_fahrenheit: {
12135
- description: "Temperature, in \xB0F, reported by the thermostat.",
12457
+ description: "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12136
12458
  format: "float",
12137
12459
  type: "number"
12138
12460
  },
@@ -12172,18 +12494,17 @@ var openapi_default = {
12172
12494
  type: "object"
12173
12495
  },
12174
12496
  {
12175
- description: "An enrollment automation was deleted.",
12497
+ 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.",
12176
12498
  properties: {
12177
12499
  created_at: {
12178
- description: "Time at which the event was created.",
12500
+ description: "Date and time at which the event was created.",
12179
12501
  format: "date-time",
12180
12502
  type: "string"
12181
12503
  },
12182
12504
  enrollment_automation_id: {
12183
- description: "ID of the enrollment automation.",
12505
+ description: "ID of the [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).",
12184
12506
  format: "uuid",
12185
- type: "string",
12186
- "x-title": "Enrollment Automation ID"
12507
+ type: "string"
12187
12508
  },
12188
12509
  event_id: {
12189
12510
  description: "ID of the event.",
@@ -12195,7 +12516,7 @@ var openapi_default = {
12195
12516
  type: "string"
12196
12517
  },
12197
12518
  occurred_at: {
12198
- description: "Time when the event occurred.",
12519
+ description: "Date and time at which the event occurred.",
12199
12520
  format: "date-time",
12200
12521
  type: "string"
12201
12522
  },
@@ -12219,15 +12540,14 @@ var openapi_default = {
12219
12540
  description: "A phone device was deactivated.",
12220
12541
  properties: {
12221
12542
  created_at: {
12222
- description: "Time at which the event was created.",
12543
+ description: "Date and time at which the event was created.",
12223
12544
  format: "date-time",
12224
12545
  type: "string"
12225
12546
  },
12226
12547
  device_id: {
12227
- description: "ID of the device.",
12548
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
12228
12549
  format: "uuid",
12229
- type: "string",
12230
- "x-title": "Device ID"
12550
+ type: "string"
12231
12551
  },
12232
12552
  event_id: {
12233
12553
  description: "ID of the event.",
@@ -12236,7 +12556,7 @@ var openapi_default = {
12236
12556
  },
12237
12557
  event_type: { enum: ["phone.deactivated"], type: "string" },
12238
12558
  occurred_at: {
12239
- description: "Time when the event occurred.",
12559
+ description: "Date and time at which the event occurred.",
12240
12560
  format: "date-time",
12241
12561
  type: "string"
12242
12562
  },
@@ -12342,13 +12662,191 @@ var openapi_default = {
12342
12662
  items: {
12343
12663
  oneOf: [
12344
12664
  {
12345
- properties: {
12346
- error_code: { type: "string" },
12347
- is_device_error: { enum: [true], type: "boolean" },
12348
- message: { type: "string" }
12349
- },
12350
- required: ["message", "is_device_error", "error_code"],
12351
- type: "object"
12665
+ description: "Error associated with the `device`.",
12666
+ oneOf: [
12667
+ {
12668
+ description: "Device is offline",
12669
+ properties: {
12670
+ error_code: {
12671
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12672
+ enum: ["device_offline"],
12673
+ type: "string"
12674
+ },
12675
+ is_device_error: { enum: [true], type: "boolean" },
12676
+ message: { type: "string" }
12677
+ },
12678
+ required: ["message", "is_device_error", "error_code"],
12679
+ type: "object"
12680
+ },
12681
+ {
12682
+ description: "Device has been removed",
12683
+ properties: {
12684
+ error_code: {
12685
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12686
+ enum: ["device_removed"],
12687
+ type: "string"
12688
+ },
12689
+ is_device_error: { enum: [true], type: "boolean" },
12690
+ message: { type: "string" }
12691
+ },
12692
+ required: ["message", "is_device_error", "error_code"],
12693
+ type: "object"
12694
+ },
12695
+ {
12696
+ description: "Account is disconnected",
12697
+ properties: {
12698
+ error_code: {
12699
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12700
+ enum: ["account_disconnected"],
12701
+ type: "string"
12702
+ },
12703
+ is_device_error: { enum: [true], type: "boolean" },
12704
+ message: { type: "string" }
12705
+ },
12706
+ required: ["message", "is_device_error", "error_code"],
12707
+ type: "object"
12708
+ },
12709
+ {
12710
+ description: "Hub is disconnected",
12711
+ properties: {
12712
+ error_code: {
12713
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12714
+ enum: ["hub_disconnected"],
12715
+ type: "string"
12716
+ },
12717
+ is_device_error: { enum: [true], type: "boolean" },
12718
+ message: { type: "string" }
12719
+ },
12720
+ required: ["message", "is_device_error", "error_code"],
12721
+ type: "object"
12722
+ },
12723
+ {
12724
+ description: "Device is disconnected",
12725
+ properties: {
12726
+ error_code: {
12727
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12728
+ enum: ["device_disconnected"],
12729
+ type: "string"
12730
+ },
12731
+ is_device_error: { enum: [true], type: "boolean" },
12732
+ message: { type: "string" }
12733
+ },
12734
+ required: ["message", "is_device_error", "error_code"],
12735
+ type: "object"
12736
+ },
12737
+ {
12738
+ description: "The backup access code pool is empty.",
12739
+ properties: {
12740
+ error_code: {
12741
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12742
+ enum: ["empty_backup_access_code_pool"],
12743
+ type: "string"
12744
+ },
12745
+ is_device_error: { enum: [true], type: "boolean" },
12746
+ message: { type: "string" }
12747
+ },
12748
+ required: ["message", "is_device_error", "error_code"],
12749
+ type: "object"
12750
+ },
12751
+ {
12752
+ description: "User is not authorized to use the August Lock.",
12753
+ properties: {
12754
+ error_code: {
12755
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12756
+ enum: ["august_lock_not_authorized"],
12757
+ type: "string"
12758
+ },
12759
+ is_device_error: { enum: [true], type: "boolean" },
12760
+ message: { type: "string" }
12761
+ },
12762
+ required: ["message", "is_device_error", "error_code"],
12763
+ type: "object"
12764
+ },
12765
+ {
12766
+ description: "Lock is not connected to the Seam Bridge.",
12767
+ properties: {
12768
+ error_code: {
12769
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12770
+ enum: ["august_lock_missing_bridge"],
12771
+ type: "string"
12772
+ },
12773
+ is_device_error: { enum: [true], type: "boolean" },
12774
+ message: { type: "string" }
12775
+ },
12776
+ required: ["message", "is_device_error", "error_code"],
12777
+ type: "object"
12778
+ },
12779
+ {
12780
+ description: "Salto site user limit reached.",
12781
+ properties: {
12782
+ error_code: {
12783
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12784
+ enum: ["salto_site_user_limit_reached"],
12785
+ type: "string"
12786
+ },
12787
+ is_device_error: { enum: [true], type: "boolean" },
12788
+ message: { type: "string" }
12789
+ },
12790
+ required: ["message", "is_device_error", "error_code"],
12791
+ type: "object"
12792
+ },
12793
+ {
12794
+ description: "Lock is not paired with a Gateway.",
12795
+ properties: {
12796
+ error_code: {
12797
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12798
+ enum: ["ttlock_lock_not_paired_to_gateway"],
12799
+ type: "string"
12800
+ },
12801
+ is_device_error: { enum: [true], type: "boolean" },
12802
+ message: { type: "string" }
12803
+ },
12804
+ required: ["message", "is_device_error", "error_code"],
12805
+ type: "object"
12806
+ },
12807
+ {
12808
+ description: "Missing device credentials.",
12809
+ properties: {
12810
+ error_code: {
12811
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12812
+ enum: ["missing_device_credentials"],
12813
+ type: "string"
12814
+ },
12815
+ is_device_error: { enum: [true], type: "boolean" },
12816
+ message: { type: "string" }
12817
+ },
12818
+ required: ["message", "is_device_error", "error_code"],
12819
+ type: "object"
12820
+ },
12821
+ {
12822
+ description: "The auxiliary heat is running.",
12823
+ properties: {
12824
+ error_code: {
12825
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12826
+ enum: ["auxiliary_heat_running"],
12827
+ type: "string"
12828
+ },
12829
+ is_device_error: { enum: [true], type: "boolean" },
12830
+ message: { type: "string" }
12831
+ },
12832
+ required: ["message", "is_device_error", "error_code"],
12833
+ type: "object"
12834
+ },
12835
+ {
12836
+ description: "Subscription required to connect.",
12837
+ properties: {
12838
+ error_code: {
12839
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
12840
+ enum: ["subscription_required"],
12841
+ type: "string"
12842
+ },
12843
+ is_device_error: { enum: [true], type: "boolean" },
12844
+ message: { type: "string" }
12845
+ },
12846
+ required: ["message", "is_device_error", "error_code"],
12847
+ type: "object"
12848
+ }
12849
+ ]
12352
12850
  },
12353
12851
  {
12354
12852
  properties: {
@@ -12573,13 +13071,191 @@ var openapi_default = {
12573
13071
  type: "object"
12574
13072
  },
12575
13073
  {
12576
- properties: {
12577
- error_code: { type: "string" },
12578
- is_device_error: { enum: [true], type: "boolean" },
12579
- message: { type: "string" }
12580
- },
12581
- required: ["message", "is_device_error", "error_code"],
12582
- type: "object"
13074
+ description: "Error associated with the `device`.",
13075
+ oneOf: [
13076
+ {
13077
+ description: "Device is offline",
13078
+ properties: {
13079
+ error_code: {
13080
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13081
+ enum: ["device_offline"],
13082
+ type: "string"
13083
+ },
13084
+ is_device_error: { enum: [true], type: "boolean" },
13085
+ message: { type: "string" }
13086
+ },
13087
+ required: ["message", "is_device_error", "error_code"],
13088
+ type: "object"
13089
+ },
13090
+ {
13091
+ description: "Device has been removed",
13092
+ properties: {
13093
+ error_code: {
13094
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13095
+ enum: ["device_removed"],
13096
+ type: "string"
13097
+ },
13098
+ is_device_error: { enum: [true], type: "boolean" },
13099
+ message: { type: "string" }
13100
+ },
13101
+ required: ["message", "is_device_error", "error_code"],
13102
+ type: "object"
13103
+ },
13104
+ {
13105
+ description: "Account is disconnected",
13106
+ properties: {
13107
+ error_code: {
13108
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13109
+ enum: ["account_disconnected"],
13110
+ type: "string"
13111
+ },
13112
+ is_device_error: { enum: [true], type: "boolean" },
13113
+ message: { type: "string" }
13114
+ },
13115
+ required: ["message", "is_device_error", "error_code"],
13116
+ type: "object"
13117
+ },
13118
+ {
13119
+ description: "Hub is disconnected",
13120
+ properties: {
13121
+ error_code: {
13122
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13123
+ enum: ["hub_disconnected"],
13124
+ type: "string"
13125
+ },
13126
+ is_device_error: { enum: [true], type: "boolean" },
13127
+ message: { type: "string" }
13128
+ },
13129
+ required: ["message", "is_device_error", "error_code"],
13130
+ type: "object"
13131
+ },
13132
+ {
13133
+ description: "Device is disconnected",
13134
+ properties: {
13135
+ error_code: {
13136
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13137
+ enum: ["device_disconnected"],
13138
+ type: "string"
13139
+ },
13140
+ is_device_error: { enum: [true], type: "boolean" },
13141
+ message: { type: "string" }
13142
+ },
13143
+ required: ["message", "is_device_error", "error_code"],
13144
+ type: "object"
13145
+ },
13146
+ {
13147
+ description: "The backup access code pool is empty.",
13148
+ properties: {
13149
+ error_code: {
13150
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13151
+ enum: ["empty_backup_access_code_pool"],
13152
+ type: "string"
13153
+ },
13154
+ is_device_error: { enum: [true], type: "boolean" },
13155
+ message: { type: "string" }
13156
+ },
13157
+ required: ["message", "is_device_error", "error_code"],
13158
+ type: "object"
13159
+ },
13160
+ {
13161
+ description: "User is not authorized to use the August Lock.",
13162
+ properties: {
13163
+ error_code: {
13164
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13165
+ enum: ["august_lock_not_authorized"],
13166
+ type: "string"
13167
+ },
13168
+ is_device_error: { enum: [true], type: "boolean" },
13169
+ message: { type: "string" }
13170
+ },
13171
+ required: ["message", "is_device_error", "error_code"],
13172
+ type: "object"
13173
+ },
13174
+ {
13175
+ description: "Lock is not connected to the Seam Bridge.",
13176
+ properties: {
13177
+ error_code: {
13178
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13179
+ enum: ["august_lock_missing_bridge"],
13180
+ type: "string"
13181
+ },
13182
+ is_device_error: { enum: [true], type: "boolean" },
13183
+ message: { type: "string" }
13184
+ },
13185
+ required: ["message", "is_device_error", "error_code"],
13186
+ type: "object"
13187
+ },
13188
+ {
13189
+ description: "Salto site user limit reached.",
13190
+ properties: {
13191
+ error_code: {
13192
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13193
+ enum: ["salto_site_user_limit_reached"],
13194
+ type: "string"
13195
+ },
13196
+ is_device_error: { enum: [true], type: "boolean" },
13197
+ message: { type: "string" }
13198
+ },
13199
+ required: ["message", "is_device_error", "error_code"],
13200
+ type: "object"
13201
+ },
13202
+ {
13203
+ description: "Lock is not paired with a Gateway.",
13204
+ properties: {
13205
+ error_code: {
13206
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13207
+ enum: ["ttlock_lock_not_paired_to_gateway"],
13208
+ type: "string"
13209
+ },
13210
+ is_device_error: { enum: [true], type: "boolean" },
13211
+ message: { type: "string" }
13212
+ },
13213
+ required: ["message", "is_device_error", "error_code"],
13214
+ type: "object"
13215
+ },
13216
+ {
13217
+ description: "Missing device credentials.",
13218
+ properties: {
13219
+ error_code: {
13220
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13221
+ enum: ["missing_device_credentials"],
13222
+ type: "string"
13223
+ },
13224
+ is_device_error: { enum: [true], type: "boolean" },
13225
+ message: { type: "string" }
13226
+ },
13227
+ required: ["message", "is_device_error", "error_code"],
13228
+ type: "object"
13229
+ },
13230
+ {
13231
+ description: "The auxiliary heat is running.",
13232
+ properties: {
13233
+ error_code: {
13234
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13235
+ enum: ["auxiliary_heat_running"],
13236
+ type: "string"
13237
+ },
13238
+ is_device_error: { enum: [true], type: "boolean" },
13239
+ message: { type: "string" }
13240
+ },
13241
+ required: ["message", "is_device_error", "error_code"],
13242
+ type: "object"
13243
+ },
13244
+ {
13245
+ description: "Subscription required to connect.",
13246
+ properties: {
13247
+ error_code: {
13248
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13249
+ enum: ["subscription_required"],
13250
+ type: "string"
13251
+ },
13252
+ is_device_error: { enum: [true], type: "boolean" },
13253
+ message: { type: "string" }
13254
+ },
13255
+ required: ["message", "is_device_error", "error_code"],
13256
+ type: "object"
13257
+ }
13258
+ ]
12583
13259
  },
12584
13260
  {
12585
13261
  properties: {
@@ -12745,13 +13421,191 @@ var openapi_default = {
12745
13421
  items: {
12746
13422
  oneOf: [
12747
13423
  {
12748
- properties: {
12749
- error_code: { type: "string" },
12750
- is_device_error: { enum: [true], type: "boolean" },
12751
- message: { type: "string" }
12752
- },
12753
- required: ["message", "is_device_error", "error_code"],
12754
- type: "object"
13424
+ description: "Error associated with the `device`.",
13425
+ oneOf: [
13426
+ {
13427
+ description: "Device is offline",
13428
+ properties: {
13429
+ error_code: {
13430
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13431
+ enum: ["device_offline"],
13432
+ type: "string"
13433
+ },
13434
+ is_device_error: { enum: [true], type: "boolean" },
13435
+ message: { type: "string" }
13436
+ },
13437
+ required: ["message", "is_device_error", "error_code"],
13438
+ type: "object"
13439
+ },
13440
+ {
13441
+ description: "Device has been removed",
13442
+ properties: {
13443
+ error_code: {
13444
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13445
+ enum: ["device_removed"],
13446
+ type: "string"
13447
+ },
13448
+ is_device_error: { enum: [true], type: "boolean" },
13449
+ message: { type: "string" }
13450
+ },
13451
+ required: ["message", "is_device_error", "error_code"],
13452
+ type: "object"
13453
+ },
13454
+ {
13455
+ description: "Account is disconnected",
13456
+ properties: {
13457
+ error_code: {
13458
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13459
+ enum: ["account_disconnected"],
13460
+ type: "string"
13461
+ },
13462
+ is_device_error: { enum: [true], type: "boolean" },
13463
+ message: { type: "string" }
13464
+ },
13465
+ required: ["message", "is_device_error", "error_code"],
13466
+ type: "object"
13467
+ },
13468
+ {
13469
+ description: "Hub is disconnected",
13470
+ properties: {
13471
+ error_code: {
13472
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13473
+ enum: ["hub_disconnected"],
13474
+ type: "string"
13475
+ },
13476
+ is_device_error: { enum: [true], type: "boolean" },
13477
+ message: { type: "string" }
13478
+ },
13479
+ required: ["message", "is_device_error", "error_code"],
13480
+ type: "object"
13481
+ },
13482
+ {
13483
+ description: "Device is disconnected",
13484
+ properties: {
13485
+ error_code: {
13486
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13487
+ enum: ["device_disconnected"],
13488
+ type: "string"
13489
+ },
13490
+ is_device_error: { enum: [true], type: "boolean" },
13491
+ message: { type: "string" }
13492
+ },
13493
+ required: ["message", "is_device_error", "error_code"],
13494
+ type: "object"
13495
+ },
13496
+ {
13497
+ description: "The backup access code pool is empty.",
13498
+ properties: {
13499
+ error_code: {
13500
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13501
+ enum: ["empty_backup_access_code_pool"],
13502
+ type: "string"
13503
+ },
13504
+ is_device_error: { enum: [true], type: "boolean" },
13505
+ message: { type: "string" }
13506
+ },
13507
+ required: ["message", "is_device_error", "error_code"],
13508
+ type: "object"
13509
+ },
13510
+ {
13511
+ description: "User is not authorized to use the August Lock.",
13512
+ properties: {
13513
+ error_code: {
13514
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13515
+ enum: ["august_lock_not_authorized"],
13516
+ type: "string"
13517
+ },
13518
+ is_device_error: { enum: [true], type: "boolean" },
13519
+ message: { type: "string" }
13520
+ },
13521
+ required: ["message", "is_device_error", "error_code"],
13522
+ type: "object"
13523
+ },
13524
+ {
13525
+ description: "Lock is not connected to the Seam Bridge.",
13526
+ properties: {
13527
+ error_code: {
13528
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13529
+ enum: ["august_lock_missing_bridge"],
13530
+ type: "string"
13531
+ },
13532
+ is_device_error: { enum: [true], type: "boolean" },
13533
+ message: { type: "string" }
13534
+ },
13535
+ required: ["message", "is_device_error", "error_code"],
13536
+ type: "object"
13537
+ },
13538
+ {
13539
+ description: "Salto site user limit reached.",
13540
+ properties: {
13541
+ error_code: {
13542
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13543
+ enum: ["salto_site_user_limit_reached"],
13544
+ type: "string"
13545
+ },
13546
+ is_device_error: { enum: [true], type: "boolean" },
13547
+ message: { type: "string" }
13548
+ },
13549
+ required: ["message", "is_device_error", "error_code"],
13550
+ type: "object"
13551
+ },
13552
+ {
13553
+ description: "Lock is not paired with a Gateway.",
13554
+ properties: {
13555
+ error_code: {
13556
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13557
+ enum: ["ttlock_lock_not_paired_to_gateway"],
13558
+ type: "string"
13559
+ },
13560
+ is_device_error: { enum: [true], type: "boolean" },
13561
+ message: { type: "string" }
13562
+ },
13563
+ required: ["message", "is_device_error", "error_code"],
13564
+ type: "object"
13565
+ },
13566
+ {
13567
+ description: "Missing device credentials.",
13568
+ properties: {
13569
+ error_code: {
13570
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13571
+ enum: ["missing_device_credentials"],
13572
+ type: "string"
13573
+ },
13574
+ is_device_error: { enum: [true], type: "boolean" },
13575
+ message: { type: "string" }
13576
+ },
13577
+ required: ["message", "is_device_error", "error_code"],
13578
+ type: "object"
13579
+ },
13580
+ {
13581
+ description: "The auxiliary heat is running.",
13582
+ properties: {
13583
+ error_code: {
13584
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13585
+ enum: ["auxiliary_heat_running"],
13586
+ type: "string"
13587
+ },
13588
+ is_device_error: { enum: [true], type: "boolean" },
13589
+ message: { type: "string" }
13590
+ },
13591
+ required: ["message", "is_device_error", "error_code"],
13592
+ type: "object"
13593
+ },
13594
+ {
13595
+ description: "Subscription required to connect.",
13596
+ properties: {
13597
+ error_code: {
13598
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
13599
+ enum: ["subscription_required"],
13600
+ type: "string"
13601
+ },
13602
+ is_device_error: { enum: [true], type: "boolean" },
13603
+ message: { type: "string" }
13604
+ },
13605
+ required: ["message", "is_device_error", "error_code"],
13606
+ type: "object"
13607
+ }
13608
+ ]
12755
13609
  },
12756
13610
  {
12757
13611
  properties: {