@seamapi/types 1.322.3 → 1.324.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 (56) hide show
  1. package/dist/connect.cjs +743 -742
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +559 -653
  4. package/lib/seam/connect/models/acs/acs-user.d.ts +53 -0
  5. package/lib/seam/connect/models/acs/acs-user.js +23 -0
  6. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  7. package/lib/seam/connect/models/events/access-codes.js +32 -41
  8. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  9. package/lib/seam/connect/models/events/acs/common.js +9 -12
  10. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  11. package/lib/seam/connect/models/events/acs/credentials.js +2 -2
  12. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  13. package/lib/seam/connect/models/events/acs/encoders.js +6 -3
  14. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -1
  15. package/lib/seam/connect/models/events/acs/systems.js +3 -3
  16. package/lib/seam/connect/models/events/acs/systems.js.map +1 -1
  17. package/lib/seam/connect/models/events/acs/users.js +5 -3
  18. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  19. package/lib/seam/connect/models/events/action-attempts.js +10 -22
  20. package/lib/seam/connect/models/events/action-attempts.js.map +1 -1
  21. package/lib/seam/connect/models/events/client-sessions.js +5 -7
  22. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  23. package/lib/seam/connect/models/events/common.js +5 -2
  24. package/lib/seam/connect/models/events/common.js.map +1 -1
  25. package/lib/seam/connect/models/events/connect-webviews.js +10 -14
  26. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  27. package/lib/seam/connect/models/events/connected-accounts.js +15 -19
  28. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  29. package/lib/seam/connect/models/events/devices.js +43 -47
  30. package/lib/seam/connect/models/events/devices.js.map +1 -1
  31. package/lib/seam/connect/models/events/enrollment-automations.js +5 -7
  32. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  33. package/lib/seam/connect/models/events/phones.js +4 -6
  34. package/lib/seam/connect/models/events/phones.js.map +1 -1
  35. package/lib/seam/connect/openapi.d.ts +34 -150
  36. package/lib/seam/connect/openapi.js +410 -463
  37. package/lib/seam/connect/openapi.js.map +1 -1
  38. package/lib/seam/connect/route-types.d.ts +525 -503
  39. package/package.json +1 -1
  40. package/src/lib/seam/connect/models/acs/acs-user.ts +35 -0
  41. package/src/lib/seam/connect/models/events/access-codes.ts +64 -41
  42. package/src/lib/seam/connect/models/events/acs/common.ts +13 -12
  43. package/src/lib/seam/connect/models/events/acs/credentials.ts +6 -2
  44. package/src/lib/seam/connect/models/events/acs/encoders.ts +12 -3
  45. package/src/lib/seam/connect/models/events/acs/systems.ts +9 -3
  46. package/src/lib/seam/connect/models/events/acs/users.ts +10 -4
  47. package/src/lib/seam/connect/models/events/action-attempts.ts +20 -22
  48. package/src/lib/seam/connect/models/events/client-sessions.ts +9 -7
  49. package/src/lib/seam/connect/models/events/common.ts +5 -2
  50. package/src/lib/seam/connect/models/events/connect-webviews.ts +18 -14
  51. package/src/lib/seam/connect/models/events/connected-accounts.ts +25 -19
  52. package/src/lib/seam/connect/models/events/devices.ts +75 -47
  53. package/src/lib/seam/connect/models/events/enrollment-automations.ts +9 -7
  54. package/src/lib/seam/connect/models/events/phones.ts +6 -6
  55. package/src/lib/seam/connect/openapi.ts +568 -463
  56. package/src/lib/seam/connect/route-types.ts +525 -503
package/dist/connect.cjs CHANGED
@@ -1738,6 +1738,24 @@ zod.z.object({
1738
1738
  salto_ks_user_not_subscribed: acs_users_salto_ks_user_not_subscribed.optional().nullable()
1739
1739
  });
1740
1740
  var acs_users_warnings = zod.z.union([acs_users_being_deleted, acs_users_salto_ks_user_not_subscribed]).describe("Warning associated with the `acs_user`.");
1741
+ var common_acs_user_modification = zod.z.object({
1742
+ created_at: zod.z.string().datetime().describe("Date and time at which this modification was requested."),
1743
+ message: zod.z.string().describe("Detailed description of the modification.")
1744
+ });
1745
+ var acs_user_suspension_state_modification = common_acs_user_modification.extend({
1746
+ modification_code: zod.z.literal("suspension_state")
1747
+ }).describe(
1748
+ "Indicates that the acs_user's is_suspended state was updated on Seam and will soon be applied on the user on the ACS System"
1749
+ );
1750
+ var acs_user_profile_modification = common_acs_user_modification.extend({
1751
+ modification_code: zod.z.literal("profile")
1752
+ }).describe(
1753
+ "Indicates that the acs_user's profile details (name, email, phone) were updated on Seam and will soon be applied on the user on the ACS System"
1754
+ );
1755
+ zod.z.object({
1756
+ suspension_state: acs_user_suspension_state_modification.optional().nullable(),
1757
+ profile: acs_user_profile_modification.optional().nullable()
1758
+ });
1741
1759
  var user_fields = zod.z.object({
1742
1760
  full_name: zod.z.string().optional().describe("Full name of the `acs_user`."),
1743
1761
  email: zod.z.string().email().optional().describe(`
@@ -2186,104 +2204,116 @@ var common_event = zod.z.object({
2186
2204
  workspace_id: zod.z.string().uuid().describe(
2187
2205
  "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces)."
2188
2206
  ),
2189
- created_at: zod.z.string().datetime().describe("Time at which the event was created."),
2190
- occurred_at: zod.z.string().datetime().describe("Time when the event occurred.")
2207
+ created_at: zod.z.string().datetime().describe("Date and time at which the event was created."),
2208
+ occurred_at: zod.z.string().datetime().describe("Date and time at which the event occurred.")
2191
2209
  });
2192
2210
 
2193
2211
  // src/lib/seam/connect/models/events/access-codes.ts
2194
2212
  var access_code_event = common_event.extend({
2195
- access_code_id: zod.z.string().uuid().describe(`
2196
- ---
2197
- title: Access Code ID
2198
- ---
2199
- The ID of the access code.
2200
- `),
2201
- device_id: zod.z.string().uuid().describe(`
2202
- ---
2203
- title: Device ID
2204
- ---
2205
- The ID of the device.
2206
- `),
2207
- connected_account_id: zod.z.string().uuid().describe(`
2208
- ---
2209
- title: Connected Account ID
2210
- ---
2211
- The ID of the connected account.
2212
- `)
2213
+ access_code_id: zod.z.string().uuid().describe(
2214
+ "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
2215
+ ),
2216
+ device_id: zod.z.string().uuid().describe(
2217
+ "ID of the [device](https://docs.seam.co/latest/core-concepts/devices)."
2218
+ ),
2219
+ connected_account_id: zod.z.string().uuid().describe(
2220
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2221
+ )
2213
2222
  });
2214
- var code = zod.z.string().describe(`
2215
- ---
2216
- title: Access Code
2217
- ---
2218
- The code of the access code.
2219
- `);
2223
+ var code = zod.z.string().describe(
2224
+ "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
2225
+ );
2220
2226
  var access_code_created_event = access_code_event.extend({
2221
2227
  event_type: zod.z.literal("access_code.created")
2222
- }).describe("An access code was created.");
2228
+ }).describe(
2229
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created."
2230
+ );
2223
2231
  var access_code_changed_event = access_code_event.extend({
2224
2232
  event_type: zod.z.literal("access_code.changed")
2225
- }).describe("An access code was changed.");
2233
+ }).describe(
2234
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed."
2235
+ );
2226
2236
  var access_code_scheduled_on_device_event = access_code_event.extend({
2227
2237
  event_type: zod.z.literal("access_code.scheduled_on_device"),
2228
2238
  code
2229
- }).describe("An access code was natively scheduled on a device.");
2239
+ }).describe(
2240
+ "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."
2241
+ );
2230
2242
  var access_code_set_on_device_event = access_code_event.extend({
2231
2243
  event_type: zod.z.literal("access_code.set_on_device"),
2232
2244
  code
2233
- }).describe("An access code was set on a device.");
2245
+ }).describe(
2246
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device."
2247
+ );
2234
2248
  var access_code_removed_from_device_event = access_code_event.extend({
2235
2249
  event_type: zod.z.literal("access_code.removed_from_device")
2236
- }).describe("An access code was removed from a device.");
2250
+ }).describe(
2251
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device."
2252
+ );
2237
2253
  var access_code_delay_in_setting_on_device_event = access_code_event.extend({
2238
2254
  event_type: zod.z.literal("access_code.delay_in_setting_on_device")
2239
2255
  }).describe(
2240
- "There was an unusually long delay in setting an access code on a device."
2256
+ "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."
2241
2257
  );
2242
2258
  var access_code_failed_to_set_on_device_event = access_code_event.extend({
2243
2259
  event_type: zod.z.literal("access_code.failed_to_set_on_device")
2244
- }).describe("An access code failed to be set on a device.");
2260
+ }).describe(
2261
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device."
2262
+ );
2245
2263
  var access_code_deleted_event = access_code_event.extend({
2246
2264
  event_type: zod.z.literal("access_code.deleted"),
2247
2265
  code: code.nullable()
2248
- }).describe("An access code was deleted.");
2266
+ }).describe(
2267
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted."
2268
+ );
2249
2269
  var access_code_delay_in_removing_from_device_event = access_code_event.extend({
2250
2270
  event_type: zod.z.literal("access_code.delay_in_removing_from_device")
2251
2271
  }).describe(
2252
- "There was an unusually long delay in removing an access code from a device."
2272
+ "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."
2253
2273
  );
2254
2274
  var access_code_failed_to_remove_from_device_event = access_code_event.extend({
2255
2275
  event_type: zod.z.literal("access_code.failed_to_remove_from_device")
2256
- }).describe("An access code failed to be removed from a device.");
2276
+ }).describe(
2277
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device."
2278
+ );
2257
2279
  var access_code_modified_external_to_seam_event = access_code_event.extend({
2258
2280
  event_type: zod.z.literal("access_code.modified_external_to_seam")
2259
- }).describe("An access code was modified external to Seam.");
2281
+ }).describe(
2282
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam."
2283
+ );
2260
2284
  var access_code_deleted_external_to_seam_event = access_code_event.extend({
2261
2285
  event_type: zod.z.literal("access_code.deleted_external_to_seam")
2262
- }).describe("An access code was deleted external to Seam.");
2286
+ }).describe(
2287
+ "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam."
2288
+ );
2263
2289
  var access_code_backup_access_code_pulled_event = access_code_event.extend({
2264
2290
  event_type: zod.z.literal("access_code.backup_access_code_pulled"),
2265
2291
  backup_access_code_id: zod.z.string()
2266
2292
  }).describe(
2267
- "A backup access code was pulled from the backup access code pool and set on a device."
2293
+ "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."
2268
2294
  );
2269
2295
  var unmanaged_access_code_converted_to_managed_event = access_code_event.extend({
2270
2296
  event_type: zod.z.literal("access_code.unmanaged.converted_to_managed")
2271
2297
  }).describe(
2272
- "An unmanaged access code was successfully converted to a managed access code."
2298
+ "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."
2273
2299
  );
2274
2300
  var unmanaged_access_code_failed_to_convert_to_managed_event = access_code_event.extend({
2275
2301
  event_type: zod.z.literal(
2276
2302
  "access_code.unmanaged.failed_to_convert_to_managed"
2277
2303
  )
2278
2304
  }).describe(
2279
- "An unmanaged access code failed to be converted to a managed access code."
2305
+ "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."
2280
2306
  );
2281
2307
  var unmanaged_access_code_created_event = access_code_event.extend({
2282
2308
  event_type: zod.z.literal("access_code.unmanaged.created")
2283
- }).describe("An unmanaged access code was created on a device.");
2309
+ }).describe(
2310
+ "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device."
2311
+ );
2284
2312
  var unmanaged_access_code_removed_event = access_code_event.extend({
2285
2313
  event_type: zod.z.literal("access_code.unmanaged.removed")
2286
- }).describe("An unmanaged access code was removed from a device.");
2314
+ }).describe(
2315
+ "An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device."
2316
+ );
2287
2317
  var access_code_events = [
2288
2318
  access_code_created_event,
2289
2319
  access_code_changed_event,
@@ -2304,18 +2334,12 @@ var access_code_events = [
2304
2334
  unmanaged_access_code_removed_event
2305
2335
  ];
2306
2336
  var common_acs_event = common_event.extend({
2307
- connected_account_id: zod.z.string().uuid().optional().describe(`
2308
- ---
2309
- title: Connected Account ID
2310
- ---
2311
- ID of the connected account.
2312
- `),
2313
- acs_system_id: zod.z.string().uuid().describe(`
2314
- ---
2315
- title: ACS System ID
2316
- ---
2317
- ID of the ACS system.
2318
- `)
2337
+ connected_account_id: zod.z.string().uuid().optional().describe(
2338
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2339
+ ),
2340
+ acs_system_id: zod.z.string().uuid().describe(
2341
+ "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems)."
2342
+ )
2319
2343
  });
2320
2344
 
2321
2345
  // src/lib/seam/connect/models/events/acs/credentials.ts
@@ -2324,23 +2348,33 @@ var acs_credential_event = common_acs_event.extend({
2324
2348
  });
2325
2349
  var acs_credential_deleted_event = acs_credential_event.extend({
2326
2350
  event_type: zod.z.literal("acs_credential.deleted")
2327
- }).describe("An ACS credential was deleted.");
2351
+ }).describe(
2352
+ "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted."
2353
+ );
2328
2354
  var acs_credential_issued = acs_credential_event.extend({
2329
2355
  event_type: zod.z.literal("acs_credential.issued")
2330
- }).describe("An ACS credential was issued.");
2356
+ }).describe(
2357
+ "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued."
2358
+ );
2331
2359
  var acs_credential_events = [
2332
2360
  acs_credential_deleted_event,
2333
2361
  acs_credential_issued
2334
2362
  ];
2335
2363
  var acs_encoder_event = common_acs_event.extend({
2336
- acs_encoder_id: zod.z.string().uuid().describe("ID of the ACS encoder.")
2364
+ acs_encoder_id: zod.z.string().uuid().describe(
2365
+ "ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
2366
+ )
2337
2367
  });
2338
2368
  var acs_encoder_added_event = acs_encoder_event.extend({
2339
2369
  event_type: zod.z.literal("acs_encoder.added")
2340
- }).describe("An ACS encoder was added.");
2370
+ }).describe(
2371
+ "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added."
2372
+ );
2341
2373
  var acs_encoder_removed_event = acs_encoder_event.extend({
2342
2374
  event_type: zod.z.literal("acs_encoder.removed")
2343
- }).describe("An ACS encoder was removed.");
2375
+ }).describe(
2376
+ "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed."
2377
+ );
2344
2378
  var acs_encoder_events = [
2345
2379
  acs_encoder_added_event,
2346
2380
  acs_encoder_removed_event
@@ -2348,13 +2382,19 @@ var acs_encoder_events = [
2348
2382
  var acs_system_event = common_acs_event.extend({});
2349
2383
  var acs_system_connected_event = acs_system_event.extend({
2350
2384
  event_type: zod.z.literal("acs_system.connected")
2351
- }).describe("An ACS system was connected.");
2385
+ }).describe(
2386
+ "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected."
2387
+ );
2352
2388
  var acs_system_disconnected_event = acs_system_event.extend({
2353
2389
  event_type: zod.z.literal("acs_system.disconnected")
2354
- }).describe("An ACS system was disconnected.");
2390
+ }).describe(
2391
+ "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected."
2392
+ );
2355
2393
  var acs_system_added_event = acs_system_event.extend({
2356
2394
  event_type: zod.z.literal("acs_system.added")
2357
- }).describe("An ACS system was added.");
2395
+ }).describe(
2396
+ "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added."
2397
+ );
2358
2398
  var acs_system_events = [
2359
2399
  acs_system_connected_event,
2360
2400
  acs_system_added_event,
@@ -2362,10 +2402,14 @@ var acs_system_events = [
2362
2402
  ];
2363
2403
  var acs_user_event = common_acs_event.extend({
2364
2404
  acs_user_id: zod.z.string().uuid()
2365
- });
2405
+ }).describe(
2406
+ "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2407
+ );
2366
2408
  var acs_user_deleted_event = acs_user_event.extend({
2367
2409
  event_type: zod.z.literal("acs_user.deleted")
2368
- }).describe("An ACS user was deleted.");
2410
+ }).describe(
2411
+ "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted."
2412
+ );
2369
2413
  var acs_user_events = [acs_user_deleted_event];
2370
2414
 
2371
2415
  // src/lib/seam/connect/models/events/acs/index.ts
@@ -2376,37 +2420,32 @@ var acs_events = [
2376
2420
  ...acs_encoder_events
2377
2421
  ];
2378
2422
  var action_attempt_event = common_event.extend({
2379
- action_attempt_id: zod.z.string().uuid().describe(`
2380
- ---
2381
- title: Action Attempt ID
2382
- ---
2383
- The ID of the action attempt.
2384
- `),
2385
- action_type: zod.z.string().describe(`
2386
- ---
2387
- title: Action Type
2388
- ---
2389
- The type of action.
2390
- `),
2391
- status: zod.z.string().describe(`
2392
- ---
2393
- title: Status
2394
- ---
2395
- The status of the action.
2396
- `)
2423
+ action_attempt_id: zod.z.string().uuid().describe(
2424
+ "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts)."
2425
+ ),
2426
+ action_type: zod.z.string().describe("Type of action."),
2427
+ status: zod.z.string().describe("Status of the action.")
2397
2428
  });
2398
2429
  var action_attempt_lock_door_succeeded_event = action_attempt_event.extend({
2399
2430
  event_type: zod.z.literal("action_attempt.lock_door.succeeded")
2400
- }).describe("A lock door action attempt succeeded.");
2431
+ }).describe(
2432
+ "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded."
2433
+ );
2401
2434
  var action_attempt_lock_door_failed_event = action_attempt_event.extend({
2402
2435
  event_type: zod.z.literal("action_attempt.lock_door.failed")
2403
- }).describe("A lock door action attempt failed.");
2436
+ }).describe(
2437
+ "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed."
2438
+ );
2404
2439
  var action_attempt_unlock_door_succeeded_event = action_attempt_event.extend({
2405
2440
  event_type: zod.z.literal("action_attempt.unlock_door.succeeded")
2406
- }).describe("An unlock door action attempt succeeded.");
2441
+ }).describe(
2442
+ "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded."
2443
+ );
2407
2444
  var action_attempt_unlock_door_failed_event = action_attempt_event.extend({
2408
2445
  event_type: zod.z.literal("action_attempt.unlock_door.failed")
2409
- }).describe("An unlock door action attempt failed.");
2446
+ }).describe(
2447
+ "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed."
2448
+ );
2410
2449
  var action_attempt_events = [
2411
2450
  action_attempt_lock_door_succeeded_event,
2412
2451
  action_attempt_lock_door_failed_event,
@@ -2414,66 +2453,59 @@ var action_attempt_events = [
2414
2453
  action_attempt_unlock_door_failed_event
2415
2454
  ];
2416
2455
  var client_session_event = common_event.extend({
2417
- client_session_id: zod.z.string().uuid().describe(`
2418
- ---
2419
- title: Client Session ID
2420
- ---
2421
- ID of the client session.
2422
- `)
2456
+ client_session_id: zod.z.string().uuid().describe(
2457
+ "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
2458
+ )
2423
2459
  });
2424
2460
  var client_session_deleted_event = client_session_event.extend({
2425
2461
  event_type: zod.z.literal("client_session.deleted")
2426
- }).describe("A client session was deleted.");
2462
+ }).describe(
2463
+ "A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted."
2464
+ );
2427
2465
  var client_session_events = [client_session_deleted_event];
2428
2466
  var connect_webview_event = common_event.extend({
2429
- connect_webview_id: zod.z.string().uuid().describe(`
2430
- ---
2431
- title: Connect Webview ID
2432
- ---
2433
- ID of the connect webview.
2434
- `)
2467
+ connect_webview_id: zod.z.string().uuid().describe(
2468
+ "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)."
2469
+ )
2435
2470
  });
2436
- var connected_account_id = zod.z.string().uuid().describe(`
2437
- ---
2438
- title: Connected Account ID
2439
- ---
2440
- ID of the connected account.
2441
- `);
2471
+ var connected_account_id = zod.z.string().uuid().describe(
2472
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2473
+ );
2442
2474
  var connect_webview_login_succeeded_event = connect_webview_event.extend({
2443
2475
  event_type: zod.z.literal("connect_webview.login_succeeded"),
2444
2476
  connected_account_id
2445
- }).describe("A connect webview had a successful login.");
2477
+ }).describe(
2478
+ "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded."
2479
+ );
2446
2480
  var connect_webview_login_failed_event = connect_webview_event.extend({
2447
2481
  event_type: zod.z.literal("connect_webview.login_failed")
2448
- }).describe("A connect webview had a failed login.");
2482
+ }).describe(
2483
+ "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed."
2484
+ );
2449
2485
  var connect_webview_events = [
2450
2486
  connect_webview_login_succeeded_event,
2451
2487
  connect_webview_login_failed_event
2452
2488
  ];
2453
2489
  var connected_account_event = common_event.extend({
2454
- connected_account_id: zod.z.string().uuid().describe(`
2455
- ---
2456
- title: Connected Account ID
2457
- ---
2458
- ID of the connected account.
2459
- `)
2490
+ connected_account_id: zod.z.string().uuid().describe(
2491
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2492
+ )
2460
2493
  });
2461
- var connect_webview_id = zod.z.string().uuid().describe(`
2462
- ---
2463
- title: Connect Webview ID
2464
- ---
2465
- ID of the connect webview.
2466
- `);
2494
+ var connect_webview_id = zod.z.string().uuid().describe(
2495
+ "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews)."
2496
+ );
2467
2497
  var connected_account_connected_event = connected_account_event.extend({
2468
2498
  event_type: zod.z.literal("connected_account.connected"),
2469
2499
  connect_webview_id
2470
2500
  }).describe(
2471
- "A connected account was connected for the first time, was reconnected after being disconnected."
2501
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected."
2472
2502
  );
2473
2503
  var connected_account_created_event = connected_account_event.extend({
2474
2504
  event_type: zod.z.literal("connected_account.created"),
2475
2505
  connect_webview_id
2476
- }).describe("A connected account was created.");
2506
+ }).describe(
2507
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created."
2508
+ );
2477
2509
  var connected_account_successful_login_event = connected_account_event.extend({
2478
2510
  event_type: zod.z.literal("connected_account.successful_login"),
2479
2511
  connect_webview_id
@@ -2481,24 +2513,28 @@ var connected_account_successful_login_event = connected_account_event.extend({
2481
2513
  ---
2482
2514
  deprecated: Use \`connect_webview.login_succeeded\`.
2483
2515
  ---
2484
- A connected account had a successful connect webview login.`);
2516
+ 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).`);
2485
2517
  var connected_account_disconnected_event = connected_account_event.extend({
2486
2518
  event_type: zod.z.literal("connected_account.disconnected")
2487
- }).describe("A connected account was disconnected.");
2519
+ }).describe(
2520
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected."
2521
+ );
2488
2522
  var connected_account_completed_first_sync_event = connected_account_event.extend({
2489
2523
  event_type: zod.z.literal("connected_account.completed_first_sync")
2490
2524
  }).describe(
2491
- "A connected account completed the first sync with Seam and devices are now available."
2525
+ "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."
2492
2526
  );
2493
2527
  var connected_account_deleted_event = connected_account_event.extend({
2494
2528
  event_type: zod.z.literal("connected_account.deleted")
2495
- }).describe("A connected account was deleted.");
2529
+ }).describe(
2530
+ "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted."
2531
+ );
2496
2532
  var connected_account_completed_first_sync_after_reconnection_event = connected_account_event.extend({
2497
2533
  event_type: zod.z.literal(
2498
2534
  "connected_account.completed_first_sync_after_reconnection"
2499
2535
  )
2500
2536
  }).describe(
2501
- "A connected account completed the first sync after reconnection with Seam and devices are now available."
2537
+ "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."
2502
2538
  );
2503
2539
  var connected_account_events = [
2504
2540
  connected_account_connected_event,
@@ -2523,14 +2559,18 @@ var device_battery_status = zod.z.enum(["critical", "low", "good", "full"]).desc
2523
2559
  );
2524
2560
  var disconnection_error_code = zod.z.enum(["account_disconnected", "hub_disconnected", "device_disconnected"]).describe("Error code associated with the disconnection event, if any.");
2525
2561
  var lock_method = zod.z.enum(["keycode", "manual", "automatic", "unknown", "seamapi"]).describe(
2526
- "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."
2562
+ "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."
2527
2563
  );
2528
2564
  var device_connected_event = device_event.extend({
2529
2565
  event_type: zod.z.literal("device.connected")
2530
- }).describe("A new device was connected to Seam.");
2566
+ }).describe(
2567
+ "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."
2568
+ );
2531
2569
  var device_added_event = device_event.extend({
2532
2570
  event_type: zod.z.literal("device.added")
2533
- }).describe("A device was added or reconnected to Seam.");
2571
+ }).describe(
2572
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed."
2573
+ );
2534
2574
  var device_converted_to_unmanaged_event = device_event.extend({
2535
2575
  event_type: zod.z.literal("device.converted_to_unmanaged")
2536
2576
  }).describe(
@@ -2544,86 +2584,100 @@ var unmanaged_device_converted_to_managed_event = device_event.extend({
2544
2584
  var unmanaged_device_connected_event = device_event.extend({
2545
2585
  event_type: zod.z.literal("device.unmanaged.connected")
2546
2586
  }).describe(
2547
- "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam."
2587
+ "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`."
2548
2588
  );
2549
2589
  var device_disconnected_event = device_event.extend({
2550
2590
  event_type: zod.z.literal("device.disconnected"),
2551
2591
  error_code: disconnection_error_code
2552
- }).describe("A device was disconnected from Seam.");
2592
+ }).describe(
2593
+ "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`."
2594
+ );
2553
2595
  var unmanaged_device_disconnected_event = device_event.extend({
2554
2596
  event_type: zod.z.literal("device.unmanaged.disconnected"),
2555
2597
  error_code: disconnection_error_code
2556
2598
  }).describe(
2557
- "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam."
2599
+ "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`."
2558
2600
  );
2559
2601
  var device_tampered_event = device_event.extend({
2560
2602
  event_type: zod.z.literal("device.tampered")
2561
2603
  }).describe(
2562
- "A device detected that it was tampered with, for example, opened or moved."
2604
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved."
2563
2605
  );
2564
2606
  var device_low_battery_event = device_event.extend({
2565
2607
  event_type: zod.z.literal("device.low_battery"),
2566
2608
  battery_level
2567
- }).describe("A device battery level dropped below the low threshold.");
2609
+ }).describe(
2610
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold."
2611
+ );
2568
2612
  var device_battery_status_changed_event = device_event.extend({
2569
2613
  event_type: zod.z.literal("device.battery_status_changed"),
2570
2614
  battery_status: device_battery_status,
2571
2615
  battery_level
2572
2616
  }).describe(
2573
- "A device battery status changed since the last `battery_status_changed` event."
2617
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event."
2574
2618
  );
2575
2619
  var device_removed_event = device_event.extend({
2576
2620
  event_type: zod.z.literal("device.removed")
2577
2621
  }).describe(
2578
- "A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts)."
2622
+ "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)."
2579
2623
  );
2580
2624
  var device_deleted_event = device_event.extend({
2581
2625
  event_type: zod.z.literal("device.deleted")
2582
2626
  }).describe(
2583
- "A device was [deleted](https://docs.seam.co/latest/api/devices/delete)."
2627
+ "A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted."
2584
2628
  );
2585
2629
  var device_third_party_integration_detected_event = device_event.extend({
2586
2630
  event_type: zod.z.literal("device.third_party_integration_detected")
2587
2631
  }).describe(
2588
- "Seam detected that a device is using a third-party integration that will interfere with Seam device management."
2632
+ "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."
2589
2633
  );
2590
2634
  var device_third_party_integration_no_longer_detected_event = device_event.extend({
2591
2635
  event_type: zod.z.literal(
2592
2636
  "device.third_party_integration_no_longer_detected"
2593
2637
  )
2594
2638
  }).describe(
2595
- "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management."
2639
+ "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."
2596
2640
  );
2597
2641
  var device_salto_privacy_mode_activated_event = device_event.extend({
2598
2642
  event_type: zod.z.literal("device.salto.privacy_mode_activated")
2599
- }).describe("A Salto device activated privacy mode.");
2643
+ }).describe(
2644
+ "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode."
2645
+ );
2600
2646
  var device_salto_privacy_mode_deactivated_event = device_event.extend({
2601
2647
  event_type: zod.z.literal("device.salto.privacy_mode_deactivated")
2602
- }).describe("A Salto device deactivated privacy mode.");
2648
+ }).describe(
2649
+ "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode."
2650
+ );
2603
2651
  var device_connection_became_flaky_event = device_event.extend({
2604
2652
  event_type: zod.z.literal("device.connection_became_flaky")
2605
- }).describe("Seam detected a flaky device connection.");
2653
+ }).describe(
2654
+ "Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection."
2655
+ );
2606
2656
  var device_connection_stabilized_event = device_event.extend({
2607
2657
  event_type: zod.z.literal("device.connection_stabilized")
2608
2658
  }).describe(
2609
- "Seam detected that a previously-flaky device connection stabilized."
2659
+ "Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized."
2610
2660
  );
2611
2661
  var device_error_subscription_required_event = device_event.extend({
2612
2662
  event_type: zod.z.literal("device.error.subscription_required")
2613
2663
  }).describe(
2614
- "A third-party subscription is required to use all device features."
2664
+ "A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features."
2615
2665
  );
2616
2666
  var device_error_subscription_required_resolved_event = device_event.extend({
2617
2667
  event_type: zod.z.literal("device.error.subscription_required.resolved")
2618
2668
  }).describe(
2619
- "A third-party subscription is active or no longer required to use all device features."
2669
+ "A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features."
2620
2670
  );
2621
2671
  var device_accessory_keypad_connected_event = device_event.extend({
2622
2672
  event_type: zod.z.literal("device.accessory_keypad_connected")
2623
- }).describe("An accessory keypad was connected to a device.");
2673
+ }).describe(
2674
+ "An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices)."
2675
+ );
2624
2676
  var device_accessory_keypad_disconnected_event = device_event.extend({
2625
2677
  event_type: zod.z.literal("device.accessory_keypad_disconnected")
2626
- }).describe("An accessory keypad was disconnected from a device.");
2678
+ }).describe(
2679
+ "An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices)."
2680
+ );
2627
2681
  var noise_sensor_noise_threshold_triggered_event = device_event.extend({
2628
2682
  event_type: zod.z.literal("noise_sensor.noise_threshold_triggered"),
2629
2683
  noise_level_decibels: zod.z.number().optional().describe("Detected noise level in decibels."),
@@ -2635,18 +2689,8 @@ var noise_sensor_noise_threshold_triggered_event = device_event.extend({
2635
2689
  "Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered."
2636
2690
  ),
2637
2691
  // TODO: remove metadata from this event
2638
- noiseaware_metadata: zod.z.record(zod.z.unknown()).optional().describe(`
2639
- ---
2640
- title: Noiseaware Metadata
2641
- ---
2642
- Metadata from Noiseaware.
2643
- `),
2644
- minut_metadata: zod.z.record(zod.z.unknown()).optional().describe(`
2645
- ---
2646
- title: Minut Metadata
2647
- ---
2648
- Metadata from Minut.
2649
- `)
2692
+ noiseaware_metadata: zod.z.record(zod.z.unknown()).optional().describe("Metadata from Noiseaware."),
2693
+ minut_metadata: zod.z.record(zod.z.unknown()).optional().describe("Metadata from Minut.")
2650
2694
  }).describe(
2651
2695
  "Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected."
2652
2696
  );
@@ -2659,9 +2703,11 @@ var lock_locked_event = device_event.extend({
2659
2703
  "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action."
2660
2704
  ),
2661
2705
  method: lock_method.describe(
2662
- "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."
2706
+ "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."
2663
2707
  )
2664
- }).describe("A lock was locked.");
2708
+ }).describe(
2709
+ "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked."
2710
+ );
2665
2711
  var lock_unlocked_event = device_event.extend({
2666
2712
  event_type: zod.z.literal("lock.unlocked"),
2667
2713
  access_code_id: zod.z.string().uuid().optional().describe(
@@ -2671,16 +2717,18 @@ var lock_unlocked_event = device_event.extend({
2671
2717
  "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action."
2672
2718
  ),
2673
2719
  method: lock_method.describe(
2674
- "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."
2720
+ "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."
2675
2721
  )
2676
- }).describe("A lock was unlocked.");
2722
+ }).describe(
2723
+ "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked."
2724
+ );
2677
2725
  var lock_access_denied_event = device_event.extend({
2678
2726
  event_type: zod.z.literal("lock.access_denied"),
2679
2727
  access_code_id: zod.z.string().uuid().optional().describe(
2680
2728
  "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts."
2681
2729
  )
2682
2730
  }).describe(
2683
- "The lock denied access to a user after one or more consecutive invalid attempts to unlock the device."
2731
+ "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."
2684
2732
  );
2685
2733
  var thermostat_climate_preset_activated_event = device_event.extend({
2686
2734
  event_type: zod.z.literal("thermostat.climate_preset_activated"),
@@ -2691,13 +2739,13 @@ var thermostat_climate_preset_activated_event = device_event.extend({
2691
2739
  "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated."
2692
2740
  ),
2693
2741
  is_fallback_climate_preset: zod.z.boolean().describe(
2694
- "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."
2742
+ "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)."
2695
2743
  )
2696
2744
  }).describe(
2697
2745
  "A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated."
2698
2746
  );
2699
2747
  var thermostat_manually_adjusted_method = zod.z.enum(["seam", "external"]).describe(
2700
- "Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat."
2748
+ "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)."
2701
2749
  );
2702
2750
  var thermostat_manually_adjusted_event = device_event.extend({
2703
2751
  event_type: zod.z.literal("thermostat.manually_adjusted"),
@@ -2711,11 +2759,17 @@ var thermostat_manually_adjusted_event = device_event.extend({
2711
2759
  cooling_set_point_fahrenheit: true,
2712
2760
  heating_set_point_fahrenheit: true
2713
2761
  })
2714
- ).describe("A thermostat was adjusted manually.");
2762
+ ).describe(
2763
+ "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually."
2764
+ );
2715
2765
  var temperature_threshold_exceeded_event = device_event.extend({
2716
2766
  event_type: zod.z.literal("thermostat.temperature_threshold_exceeded"),
2717
- temperature_celsius: zod.z.number().describe("Temperature, in \xB0C, reported by the thermostat."),
2718
- temperature_fahrenheit: zod.z.number().describe("Temperature, in \xB0F, reported by the thermostat."),
2767
+ temperature_celsius: zod.z.number().describe(
2768
+ "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2769
+ ),
2770
+ temperature_fahrenheit: zod.z.number().describe(
2771
+ "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2772
+ ),
2719
2773
  upper_limit_celsius: zod.z.number().nullable().describe(
2720
2774
  "Upper temperature limit, in \xB0C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2721
2775
  ),
@@ -2729,14 +2783,18 @@ var temperature_threshold_exceeded_event = device_event.extend({
2729
2783
  "Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2730
2784
  )
2731
2785
  }).describe(
2732
- "A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2786
+ "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)."
2733
2787
  );
2734
2788
  var temperature_threshold_no_longer_exceeded_event = device_event.extend({
2735
2789
  event_type: zod.z.literal(
2736
2790
  "thermostat.temperature_threshold_no_longer_exceeded"
2737
2791
  ),
2738
- temperature_celsius: zod.z.number().describe("Temperature, in \xB0C, reported by the thermostat."),
2739
- temperature_fahrenheit: zod.z.number().describe("Temperature, in \xB0F, reported by the thermostat."),
2792
+ temperature_celsius: zod.z.number().describe(
2793
+ "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2794
+ ),
2795
+ temperature_fahrenheit: zod.z.number().describe(
2796
+ "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats)."
2797
+ ),
2740
2798
  upper_limit_celsius: zod.z.number().nullable().describe(
2741
2799
  "Upper temperature limit, in \xB0C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2742
2800
  ),
@@ -2750,7 +2808,7 @@ var temperature_threshold_no_longer_exceeded_event = device_event.extend({
2750
2808
  "Lower temperature limit, in \xB0F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2751
2809
  )
2752
2810
  }).describe(
2753
- "A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds)."
2811
+ "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)."
2754
2812
  );
2755
2813
  var device_events = [
2756
2814
  device_connected_event,
@@ -2785,26 +2843,22 @@ var device_events = [
2785
2843
  temperature_threshold_no_longer_exceeded_event
2786
2844
  ];
2787
2845
  var enrollment_automation_event = common_event.extend({
2788
- enrollment_automation_id: zod.z.string().uuid().describe(`
2789
- ---
2790
- title: Enrollment Automation ID
2791
- ---
2792
- ID of the enrollment automation.
2793
- `)
2846
+ enrollment_automation_id: zod.z.string().uuid().describe(
2847
+ "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)."
2848
+ )
2794
2849
  });
2795
2850
  var enrollment_automation_deleted_event = enrollment_automation_event.extend({
2796
2851
  event_type: zod.z.literal("enrollment_automation.deleted")
2797
- }).describe("An enrollment automation was deleted.");
2852
+ }).describe(
2853
+ "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."
2854
+ );
2798
2855
  var enrollment_automation_events = [
2799
2856
  enrollment_automation_deleted_event
2800
2857
  ];
2801
2858
  var phone_event = common_event.extend({
2802
- device_id: zod.z.string().uuid().describe(`
2803
- ---
2804
- title: Device ID
2805
- ---
2806
- ID of the device.
2807
- `)
2859
+ device_id: zod.z.string().uuid().describe(
2860
+ "ID of the [device](https://docs.seam.co/latest/core-concepts/devices)."
2861
+ )
2808
2862
  });
2809
2863
  var phone_deactivated_event = phone_event.extend({
2810
2864
  event_type: zod.z.literal("phone.deactivated")
@@ -8386,30 +8440,27 @@ var openapi_default = {
8386
8440
  discriminator: { propertyName: "event_type" },
8387
8441
  oneOf: [
8388
8442
  {
8389
- description: "An access code was created.",
8443
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.",
8390
8444
  properties: {
8391
8445
  access_code_id: {
8392
- description: "The ID of the access code.",
8446
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8393
8447
  format: "uuid",
8394
- type: "string",
8395
- "x-title": "Access Code ID"
8448
+ type: "string"
8396
8449
  },
8397
8450
  connected_account_id: {
8398
- description: "The ID of the connected account.",
8451
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8399
8452
  format: "uuid",
8400
- type: "string",
8401
- "x-title": "Connected Account ID"
8453
+ type: "string"
8402
8454
  },
8403
8455
  created_at: {
8404
- description: "Time at which the event was created.",
8456
+ description: "Date and time at which the event was created.",
8405
8457
  format: "date-time",
8406
8458
  type: "string"
8407
8459
  },
8408
8460
  device_id: {
8409
- description: "The ID of the device.",
8461
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8410
8462
  format: "uuid",
8411
- type: "string",
8412
- "x-title": "Device ID"
8463
+ type: "string"
8413
8464
  },
8414
8465
  event_id: {
8415
8466
  description: "ID of the event.",
@@ -8418,7 +8469,7 @@ var openapi_default = {
8418
8469
  },
8419
8470
  event_type: { enum: ["access_code.created"], type: "string" },
8420
8471
  occurred_at: {
8421
- description: "Time when the event occurred.",
8472
+ description: "Date and time at which the event occurred.",
8422
8473
  format: "date-time",
8423
8474
  type: "string"
8424
8475
  },
@@ -8441,30 +8492,27 @@ var openapi_default = {
8441
8492
  type: "object"
8442
8493
  },
8443
8494
  {
8444
- description: "An access code was changed.",
8495
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.",
8445
8496
  properties: {
8446
8497
  access_code_id: {
8447
- description: "The ID of the access code.",
8498
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8448
8499
  format: "uuid",
8449
- type: "string",
8450
- "x-title": "Access Code ID"
8500
+ type: "string"
8451
8501
  },
8452
8502
  connected_account_id: {
8453
- description: "The ID of the connected account.",
8503
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8454
8504
  format: "uuid",
8455
- type: "string",
8456
- "x-title": "Connected Account ID"
8505
+ type: "string"
8457
8506
  },
8458
8507
  created_at: {
8459
- description: "Time at which the event was created.",
8508
+ description: "Date and time at which the event was created.",
8460
8509
  format: "date-time",
8461
8510
  type: "string"
8462
8511
  },
8463
8512
  device_id: {
8464
- description: "The ID of the device.",
8513
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8465
8514
  format: "uuid",
8466
- type: "string",
8467
- "x-title": "Device ID"
8515
+ type: "string"
8468
8516
  },
8469
8517
  event_id: {
8470
8518
  description: "ID of the event.",
@@ -8473,7 +8521,7 @@ var openapi_default = {
8473
8521
  },
8474
8522
  event_type: { enum: ["access_code.changed"], type: "string" },
8475
8523
  occurred_at: {
8476
- description: "Time when the event occurred.",
8524
+ description: "Date and time at which the event occurred.",
8477
8525
  format: "date-time",
8478
8526
  type: "string"
8479
8527
  },
@@ -8496,35 +8544,31 @@ var openapi_default = {
8496
8544
  type: "object"
8497
8545
  },
8498
8546
  {
8499
- description: "An access code was natively scheduled on a device.",
8547
+ 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.",
8500
8548
  properties: {
8501
8549
  access_code_id: {
8502
- description: "The ID of the access code.",
8550
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8503
8551
  format: "uuid",
8504
- type: "string",
8505
- "x-title": "Access Code ID"
8552
+ type: "string"
8506
8553
  },
8507
8554
  code: {
8508
- description: "The code of the access code.",
8509
- type: "string",
8510
- "x-title": "Access Code"
8555
+ description: "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8556
+ type: "string"
8511
8557
  },
8512
8558
  connected_account_id: {
8513
- description: "The ID of the connected account.",
8559
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8514
8560
  format: "uuid",
8515
- type: "string",
8516
- "x-title": "Connected Account ID"
8561
+ type: "string"
8517
8562
  },
8518
8563
  created_at: {
8519
- description: "Time at which the event was created.",
8564
+ description: "Date and time at which the event was created.",
8520
8565
  format: "date-time",
8521
8566
  type: "string"
8522
8567
  },
8523
8568
  device_id: {
8524
- description: "The ID of the device.",
8569
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8525
8570
  format: "uuid",
8526
- type: "string",
8527
- "x-title": "Device ID"
8571
+ type: "string"
8528
8572
  },
8529
8573
  event_id: {
8530
8574
  description: "ID of the event.",
@@ -8536,7 +8580,7 @@ var openapi_default = {
8536
8580
  type: "string"
8537
8581
  },
8538
8582
  occurred_at: {
8539
- description: "Time when the event occurred.",
8583
+ description: "Date and time at which the event occurred.",
8540
8584
  format: "date-time",
8541
8585
  type: "string"
8542
8586
  },
@@ -8560,35 +8604,31 @@ var openapi_default = {
8560
8604
  type: "object"
8561
8605
  },
8562
8606
  {
8563
- description: "An access code was set on a device.",
8607
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.",
8564
8608
  properties: {
8565
8609
  access_code_id: {
8566
- description: "The ID of the access code.",
8610
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8567
8611
  format: "uuid",
8568
- type: "string",
8569
- "x-title": "Access Code ID"
8612
+ type: "string"
8570
8613
  },
8571
8614
  code: {
8572
- description: "The code of the access code.",
8573
- type: "string",
8574
- "x-title": "Access Code"
8615
+ description: "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8616
+ type: "string"
8575
8617
  },
8576
8618
  connected_account_id: {
8577
- description: "The ID of the connected account.",
8619
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8578
8620
  format: "uuid",
8579
- type: "string",
8580
- "x-title": "Connected Account ID"
8621
+ type: "string"
8581
8622
  },
8582
8623
  created_at: {
8583
- description: "Time at which the event was created.",
8624
+ description: "Date and time at which the event was created.",
8584
8625
  format: "date-time",
8585
8626
  type: "string"
8586
8627
  },
8587
8628
  device_id: {
8588
- description: "The ID of the device.",
8629
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8589
8630
  format: "uuid",
8590
- type: "string",
8591
- "x-title": "Device ID"
8631
+ type: "string"
8592
8632
  },
8593
8633
  event_id: {
8594
8634
  description: "ID of the event.",
@@ -8600,7 +8640,7 @@ var openapi_default = {
8600
8640
  type: "string"
8601
8641
  },
8602
8642
  occurred_at: {
8603
- description: "Time when the event occurred.",
8643
+ description: "Date and time at which the event occurred.",
8604
8644
  format: "date-time",
8605
8645
  type: "string"
8606
8646
  },
@@ -8624,30 +8664,27 @@ var openapi_default = {
8624
8664
  type: "object"
8625
8665
  },
8626
8666
  {
8627
- description: "An access code was removed from a device.",
8667
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.",
8628
8668
  properties: {
8629
8669
  access_code_id: {
8630
- description: "The ID of the access code.",
8670
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8631
8671
  format: "uuid",
8632
- type: "string",
8633
- "x-title": "Access Code ID"
8672
+ type: "string"
8634
8673
  },
8635
8674
  connected_account_id: {
8636
- description: "The ID of the connected account.",
8675
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8637
8676
  format: "uuid",
8638
- type: "string",
8639
- "x-title": "Connected Account ID"
8677
+ type: "string"
8640
8678
  },
8641
8679
  created_at: {
8642
- description: "Time at which the event was created.",
8680
+ description: "Date and time at which the event was created.",
8643
8681
  format: "date-time",
8644
8682
  type: "string"
8645
8683
  },
8646
8684
  device_id: {
8647
- description: "The ID of the device.",
8685
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8648
8686
  format: "uuid",
8649
- type: "string",
8650
- "x-title": "Device ID"
8687
+ type: "string"
8651
8688
  },
8652
8689
  event_id: {
8653
8690
  description: "ID of the event.",
@@ -8659,7 +8696,7 @@ var openapi_default = {
8659
8696
  type: "string"
8660
8697
  },
8661
8698
  occurred_at: {
8662
- description: "Time when the event occurred.",
8699
+ description: "Date and time at which the event occurred.",
8663
8700
  format: "date-time",
8664
8701
  type: "string"
8665
8702
  },
@@ -8682,30 +8719,27 @@ var openapi_default = {
8682
8719
  type: "object"
8683
8720
  },
8684
8721
  {
8685
- description: "There was an unusually long delay in setting an access code on a device.",
8722
+ 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.",
8686
8723
  properties: {
8687
8724
  access_code_id: {
8688
- description: "The ID of the access code.",
8725
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8689
8726
  format: "uuid",
8690
- type: "string",
8691
- "x-title": "Access Code ID"
8727
+ type: "string"
8692
8728
  },
8693
8729
  connected_account_id: {
8694
- description: "The ID of the connected account.",
8730
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8695
8731
  format: "uuid",
8696
- type: "string",
8697
- "x-title": "Connected Account ID"
8732
+ type: "string"
8698
8733
  },
8699
8734
  created_at: {
8700
- description: "Time at which the event was created.",
8735
+ description: "Date and time at which the event was created.",
8701
8736
  format: "date-time",
8702
8737
  type: "string"
8703
8738
  },
8704
8739
  device_id: {
8705
- description: "The ID of the device.",
8740
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8706
8741
  format: "uuid",
8707
- type: "string",
8708
- "x-title": "Device ID"
8742
+ type: "string"
8709
8743
  },
8710
8744
  event_id: {
8711
8745
  description: "ID of the event.",
@@ -8717,7 +8751,7 @@ var openapi_default = {
8717
8751
  type: "string"
8718
8752
  },
8719
8753
  occurred_at: {
8720
- description: "Time when the event occurred.",
8754
+ description: "Date and time at which the event occurred.",
8721
8755
  format: "date-time",
8722
8756
  type: "string"
8723
8757
  },
@@ -8740,30 +8774,27 @@ var openapi_default = {
8740
8774
  type: "object"
8741
8775
  },
8742
8776
  {
8743
- description: "An access code failed to be set on a device.",
8777
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.",
8744
8778
  properties: {
8745
8779
  access_code_id: {
8746
- description: "The ID of the access code.",
8780
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8747
8781
  format: "uuid",
8748
- type: "string",
8749
- "x-title": "Access Code ID"
8782
+ type: "string"
8750
8783
  },
8751
8784
  connected_account_id: {
8752
- description: "The ID of the connected account.",
8785
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8753
8786
  format: "uuid",
8754
- type: "string",
8755
- "x-title": "Connected Account ID"
8787
+ type: "string"
8756
8788
  },
8757
8789
  created_at: {
8758
- description: "Time at which the event was created.",
8790
+ description: "Date and time at which the event was created.",
8759
8791
  format: "date-time",
8760
8792
  type: "string"
8761
8793
  },
8762
8794
  device_id: {
8763
- description: "The ID of the device.",
8795
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8764
8796
  format: "uuid",
8765
- type: "string",
8766
- "x-title": "Device ID"
8797
+ type: "string"
8767
8798
  },
8768
8799
  event_id: {
8769
8800
  description: "ID of the event.",
@@ -8775,7 +8806,7 @@ var openapi_default = {
8775
8806
  type: "string"
8776
8807
  },
8777
8808
  occurred_at: {
8778
- description: "Time when the event occurred.",
8809
+ description: "Date and time at which the event occurred.",
8779
8810
  format: "date-time",
8780
8811
  type: "string"
8781
8812
  },
@@ -8798,36 +8829,32 @@ var openapi_default = {
8798
8829
  type: "object"
8799
8830
  },
8800
8831
  {
8801
- description: "An access code was deleted.",
8832
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.",
8802
8833
  properties: {
8803
8834
  access_code_id: {
8804
- description: "The ID of the access code.",
8835
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8805
8836
  format: "uuid",
8806
- type: "string",
8807
- "x-title": "Access Code ID"
8837
+ type: "string"
8808
8838
  },
8809
8839
  code: {
8810
- description: "The code of the access code.",
8840
+ description: "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8811
8841
  nullable: true,
8812
- type: "string",
8813
- "x-title": "Access Code"
8842
+ type: "string"
8814
8843
  },
8815
8844
  connected_account_id: {
8816
- description: "The ID of the connected account.",
8845
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8817
8846
  format: "uuid",
8818
- type: "string",
8819
- "x-title": "Connected Account ID"
8847
+ type: "string"
8820
8848
  },
8821
8849
  created_at: {
8822
- description: "Time at which the event was created.",
8850
+ description: "Date and time at which the event was created.",
8823
8851
  format: "date-time",
8824
8852
  type: "string"
8825
8853
  },
8826
8854
  device_id: {
8827
- description: "The ID of the device.",
8855
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8828
8856
  format: "uuid",
8829
- type: "string",
8830
- "x-title": "Device ID"
8857
+ type: "string"
8831
8858
  },
8832
8859
  event_id: {
8833
8860
  description: "ID of the event.",
@@ -8836,7 +8863,7 @@ var openapi_default = {
8836
8863
  },
8837
8864
  event_type: { enum: ["access_code.deleted"], type: "string" },
8838
8865
  occurred_at: {
8839
- description: "Time when the event occurred.",
8866
+ description: "Date and time at which the event occurred.",
8840
8867
  format: "date-time",
8841
8868
  type: "string"
8842
8869
  },
@@ -8860,30 +8887,27 @@ var openapi_default = {
8860
8887
  type: "object"
8861
8888
  },
8862
8889
  {
8863
- description: "There was an unusually long delay in removing an access code from a device.",
8890
+ 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.",
8864
8891
  properties: {
8865
8892
  access_code_id: {
8866
- description: "The ID of the access code.",
8893
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8867
8894
  format: "uuid",
8868
- type: "string",
8869
- "x-title": "Access Code ID"
8895
+ type: "string"
8870
8896
  },
8871
8897
  connected_account_id: {
8872
- description: "The ID of the connected account.",
8898
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8873
8899
  format: "uuid",
8874
- type: "string",
8875
- "x-title": "Connected Account ID"
8900
+ type: "string"
8876
8901
  },
8877
8902
  created_at: {
8878
- description: "Time at which the event was created.",
8903
+ description: "Date and time at which the event was created.",
8879
8904
  format: "date-time",
8880
8905
  type: "string"
8881
8906
  },
8882
8907
  device_id: {
8883
- description: "The ID of the device.",
8908
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8884
8909
  format: "uuid",
8885
- type: "string",
8886
- "x-title": "Device ID"
8910
+ type: "string"
8887
8911
  },
8888
8912
  event_id: {
8889
8913
  description: "ID of the event.",
@@ -8895,7 +8919,7 @@ var openapi_default = {
8895
8919
  type: "string"
8896
8920
  },
8897
8921
  occurred_at: {
8898
- description: "Time when the event occurred.",
8922
+ description: "Date and time at which the event occurred.",
8899
8923
  format: "date-time",
8900
8924
  type: "string"
8901
8925
  },
@@ -8918,30 +8942,27 @@ var openapi_default = {
8918
8942
  type: "object"
8919
8943
  },
8920
8944
  {
8921
- description: "An access code failed to be removed from a device.",
8945
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.",
8922
8946
  properties: {
8923
8947
  access_code_id: {
8924
- description: "The ID of the access code.",
8948
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8925
8949
  format: "uuid",
8926
- type: "string",
8927
- "x-title": "Access Code ID"
8950
+ type: "string"
8928
8951
  },
8929
8952
  connected_account_id: {
8930
- description: "The ID of the connected account.",
8953
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8931
8954
  format: "uuid",
8932
- type: "string",
8933
- "x-title": "Connected Account ID"
8955
+ type: "string"
8934
8956
  },
8935
8957
  created_at: {
8936
- description: "Time at which the event was created.",
8958
+ description: "Date and time at which the event was created.",
8937
8959
  format: "date-time",
8938
8960
  type: "string"
8939
8961
  },
8940
8962
  device_id: {
8941
- description: "The ID of the device.",
8963
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
8942
8964
  format: "uuid",
8943
- type: "string",
8944
- "x-title": "Device ID"
8965
+ type: "string"
8945
8966
  },
8946
8967
  event_id: {
8947
8968
  description: "ID of the event.",
@@ -8953,7 +8974,7 @@ var openapi_default = {
8953
8974
  type: "string"
8954
8975
  },
8955
8976
  occurred_at: {
8956
- description: "Time when the event occurred.",
8977
+ description: "Date and time at which the event occurred.",
8957
8978
  format: "date-time",
8958
8979
  type: "string"
8959
8980
  },
@@ -8976,30 +8997,27 @@ var openapi_default = {
8976
8997
  type: "object"
8977
8998
  },
8978
8999
  {
8979
- description: "An access code was modified external to Seam.",
9000
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.",
8980
9001
  properties: {
8981
9002
  access_code_id: {
8982
- description: "The ID of the access code.",
9003
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
8983
9004
  format: "uuid",
8984
- type: "string",
8985
- "x-title": "Access Code ID"
9005
+ type: "string"
8986
9006
  },
8987
9007
  connected_account_id: {
8988
- description: "The ID of the connected account.",
9008
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
8989
9009
  format: "uuid",
8990
- type: "string",
8991
- "x-title": "Connected Account ID"
9010
+ type: "string"
8992
9011
  },
8993
9012
  created_at: {
8994
- description: "Time at which the event was created.",
9013
+ description: "Date and time at which the event was created.",
8995
9014
  format: "date-time",
8996
9015
  type: "string"
8997
9016
  },
8998
9017
  device_id: {
8999
- description: "The ID of the device.",
9018
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9000
9019
  format: "uuid",
9001
- type: "string",
9002
- "x-title": "Device ID"
9020
+ type: "string"
9003
9021
  },
9004
9022
  event_id: {
9005
9023
  description: "ID of the event.",
@@ -9011,7 +9029,7 @@ var openapi_default = {
9011
9029
  type: "string"
9012
9030
  },
9013
9031
  occurred_at: {
9014
- description: "Time when the event occurred.",
9032
+ description: "Date and time at which the event occurred.",
9015
9033
  format: "date-time",
9016
9034
  type: "string"
9017
9035
  },
@@ -9034,30 +9052,27 @@ var openapi_default = {
9034
9052
  type: "object"
9035
9053
  },
9036
9054
  {
9037
- description: "An access code was deleted external to Seam.",
9055
+ description: "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.",
9038
9056
  properties: {
9039
9057
  access_code_id: {
9040
- description: "The ID of the access code.",
9058
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9041
9059
  format: "uuid",
9042
- type: "string",
9043
- "x-title": "Access Code ID"
9060
+ type: "string"
9044
9061
  },
9045
9062
  connected_account_id: {
9046
- description: "The ID of the connected account.",
9063
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9047
9064
  format: "uuid",
9048
- type: "string",
9049
- "x-title": "Connected Account ID"
9065
+ type: "string"
9050
9066
  },
9051
9067
  created_at: {
9052
- description: "Time at which the event was created.",
9068
+ description: "Date and time at which the event was created.",
9053
9069
  format: "date-time",
9054
9070
  type: "string"
9055
9071
  },
9056
9072
  device_id: {
9057
- description: "The ID of the device.",
9073
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9058
9074
  format: "uuid",
9059
- type: "string",
9060
- "x-title": "Device ID"
9075
+ type: "string"
9061
9076
  },
9062
9077
  event_id: {
9063
9078
  description: "ID of the event.",
@@ -9069,7 +9084,7 @@ var openapi_default = {
9069
9084
  type: "string"
9070
9085
  },
9071
9086
  occurred_at: {
9072
- description: "Time when the event occurred.",
9087
+ description: "Date and time at which the event occurred.",
9073
9088
  format: "date-time",
9074
9089
  type: "string"
9075
9090
  },
@@ -9092,31 +9107,28 @@ var openapi_default = {
9092
9107
  type: "object"
9093
9108
  },
9094
9109
  {
9095
- description: "A backup access code was pulled from the backup access code pool and set on a device.",
9110
+ 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.",
9096
9111
  properties: {
9097
9112
  access_code_id: {
9098
- description: "The ID of the access code.",
9113
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9099
9114
  format: "uuid",
9100
- type: "string",
9101
- "x-title": "Access Code ID"
9115
+ type: "string"
9102
9116
  },
9103
9117
  backup_access_code_id: { type: "string" },
9104
9118
  connected_account_id: {
9105
- description: "The ID of the connected account.",
9119
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9106
9120
  format: "uuid",
9107
- type: "string",
9108
- "x-title": "Connected Account ID"
9121
+ type: "string"
9109
9122
  },
9110
9123
  created_at: {
9111
- description: "Time at which the event was created.",
9124
+ description: "Date and time at which the event was created.",
9112
9125
  format: "date-time",
9113
9126
  type: "string"
9114
9127
  },
9115
9128
  device_id: {
9116
- description: "The ID of the device.",
9129
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9117
9130
  format: "uuid",
9118
- type: "string",
9119
- "x-title": "Device ID"
9131
+ type: "string"
9120
9132
  },
9121
9133
  event_id: {
9122
9134
  description: "ID of the event.",
@@ -9128,7 +9140,7 @@ var openapi_default = {
9128
9140
  type: "string"
9129
9141
  },
9130
9142
  occurred_at: {
9131
- description: "Time when the event occurred.",
9143
+ description: "Date and time at which the event occurred.",
9132
9144
  format: "date-time",
9133
9145
  type: "string"
9134
9146
  },
@@ -9152,30 +9164,27 @@ var openapi_default = {
9152
9164
  type: "object"
9153
9165
  },
9154
9166
  {
9155
- description: "An unmanaged access code was successfully converted to a managed access code.",
9167
+ 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.",
9156
9168
  properties: {
9157
9169
  access_code_id: {
9158
- description: "The ID of the access code.",
9170
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9159
9171
  format: "uuid",
9160
- type: "string",
9161
- "x-title": "Access Code ID"
9172
+ type: "string"
9162
9173
  },
9163
9174
  connected_account_id: {
9164
- description: "The ID of the connected account.",
9175
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9165
9176
  format: "uuid",
9166
- type: "string",
9167
- "x-title": "Connected Account ID"
9177
+ type: "string"
9168
9178
  },
9169
9179
  created_at: {
9170
- description: "Time at which the event was created.",
9180
+ description: "Date and time at which the event was created.",
9171
9181
  format: "date-time",
9172
9182
  type: "string"
9173
9183
  },
9174
9184
  device_id: {
9175
- description: "The ID of the device.",
9185
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9176
9186
  format: "uuid",
9177
- type: "string",
9178
- "x-title": "Device ID"
9187
+ type: "string"
9179
9188
  },
9180
9189
  event_id: {
9181
9190
  description: "ID of the event.",
@@ -9187,7 +9196,7 @@ var openapi_default = {
9187
9196
  type: "string"
9188
9197
  },
9189
9198
  occurred_at: {
9190
- description: "Time when the event occurred.",
9199
+ description: "Date and time at which the event occurred.",
9191
9200
  format: "date-time",
9192
9201
  type: "string"
9193
9202
  },
@@ -9210,30 +9219,27 @@ var openapi_default = {
9210
9219
  type: "object"
9211
9220
  },
9212
9221
  {
9213
- description: "An unmanaged access code failed to be converted to a managed access code.",
9222
+ 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.",
9214
9223
  properties: {
9215
9224
  access_code_id: {
9216
- description: "The ID of the access code.",
9225
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9217
9226
  format: "uuid",
9218
- type: "string",
9219
- "x-title": "Access Code ID"
9227
+ type: "string"
9220
9228
  },
9221
9229
  connected_account_id: {
9222
- description: "The ID of the connected account.",
9230
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9223
9231
  format: "uuid",
9224
- type: "string",
9225
- "x-title": "Connected Account ID"
9232
+ type: "string"
9226
9233
  },
9227
9234
  created_at: {
9228
- description: "Time at which the event was created.",
9235
+ description: "Date and time at which the event was created.",
9229
9236
  format: "date-time",
9230
9237
  type: "string"
9231
9238
  },
9232
9239
  device_id: {
9233
- description: "The ID of the device.",
9240
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9234
9241
  format: "uuid",
9235
- type: "string",
9236
- "x-title": "Device ID"
9242
+ type: "string"
9237
9243
  },
9238
9244
  event_id: {
9239
9245
  description: "ID of the event.",
@@ -9245,7 +9251,7 @@ var openapi_default = {
9245
9251
  type: "string"
9246
9252
  },
9247
9253
  occurred_at: {
9248
- description: "Time when the event occurred.",
9254
+ description: "Date and time at which the event occurred.",
9249
9255
  format: "date-time",
9250
9256
  type: "string"
9251
9257
  },
@@ -9268,30 +9274,27 @@ var openapi_default = {
9268
9274
  type: "object"
9269
9275
  },
9270
9276
  {
9271
- description: "An unmanaged access code was created on a device.",
9277
+ 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.",
9272
9278
  properties: {
9273
9279
  access_code_id: {
9274
- description: "The ID of the access code.",
9280
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9275
9281
  format: "uuid",
9276
- type: "string",
9277
- "x-title": "Access Code ID"
9282
+ type: "string"
9278
9283
  },
9279
9284
  connected_account_id: {
9280
- description: "The ID of the connected account.",
9285
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9281
9286
  format: "uuid",
9282
- type: "string",
9283
- "x-title": "Connected Account ID"
9287
+ type: "string"
9284
9288
  },
9285
9289
  created_at: {
9286
- description: "Time at which the event was created.",
9290
+ description: "Date and time at which the event was created.",
9287
9291
  format: "date-time",
9288
9292
  type: "string"
9289
9293
  },
9290
9294
  device_id: {
9291
- description: "The ID of the device.",
9295
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9292
9296
  format: "uuid",
9293
- type: "string",
9294
- "x-title": "Device ID"
9297
+ type: "string"
9295
9298
  },
9296
9299
  event_id: {
9297
9300
  description: "ID of the event.",
@@ -9303,7 +9306,7 @@ var openapi_default = {
9303
9306
  type: "string"
9304
9307
  },
9305
9308
  occurred_at: {
9306
- description: "Time when the event occurred.",
9309
+ description: "Date and time at which the event occurred.",
9307
9310
  format: "date-time",
9308
9311
  type: "string"
9309
9312
  },
@@ -9326,30 +9329,27 @@ var openapi_default = {
9326
9329
  type: "object"
9327
9330
  },
9328
9331
  {
9329
- description: "An unmanaged access code was removed from a device.",
9332
+ 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.",
9330
9333
  properties: {
9331
9334
  access_code_id: {
9332
- description: "The ID of the access code.",
9335
+ description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
9333
9336
  format: "uuid",
9334
- type: "string",
9335
- "x-title": "Access Code ID"
9337
+ type: "string"
9336
9338
  },
9337
9339
  connected_account_id: {
9338
- description: "The ID of the connected account.",
9340
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9339
9341
  format: "uuid",
9340
- type: "string",
9341
- "x-title": "Connected Account ID"
9342
+ type: "string"
9342
9343
  },
9343
9344
  created_at: {
9344
- description: "Time at which the event was created.",
9345
+ description: "Date and time at which the event was created.",
9345
9346
  format: "date-time",
9346
9347
  type: "string"
9347
9348
  },
9348
9349
  device_id: {
9349
- description: "The ID of the device.",
9350
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
9350
9351
  format: "uuid",
9351
- type: "string",
9352
- "x-title": "Device ID"
9352
+ type: "string"
9353
9353
  },
9354
9354
  event_id: {
9355
9355
  description: "ID of the event.",
@@ -9361,7 +9361,7 @@ var openapi_default = {
9361
9361
  type: "string"
9362
9362
  },
9363
9363
  occurred_at: {
9364
- description: "Time when the event occurred.",
9364
+ description: "Date and time at which the event occurred.",
9365
9365
  format: "date-time",
9366
9366
  type: "string"
9367
9367
  },
@@ -9384,22 +9384,20 @@ var openapi_default = {
9384
9384
  type: "object"
9385
9385
  },
9386
9386
  {
9387
- description: "An ACS system was connected.",
9387
+ description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.",
9388
9388
  properties: {
9389
9389
  acs_system_id: {
9390
- description: "ID of the ACS system.",
9390
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9391
9391
  format: "uuid",
9392
- type: "string",
9393
- "x-title": "ACS System ID"
9392
+ type: "string"
9394
9393
  },
9395
9394
  connected_account_id: {
9396
- description: "ID of the connected account.",
9395
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9397
9396
  format: "uuid",
9398
- type: "string",
9399
- "x-title": "Connected Account ID"
9397
+ type: "string"
9400
9398
  },
9401
9399
  created_at: {
9402
- description: "Time at which the event was created.",
9400
+ description: "Date and time at which the event was created.",
9403
9401
  format: "date-time",
9404
9402
  type: "string"
9405
9403
  },
@@ -9410,7 +9408,7 @@ var openapi_default = {
9410
9408
  },
9411
9409
  event_type: { enum: ["acs_system.connected"], type: "string" },
9412
9410
  occurred_at: {
9413
- description: "Time when the event occurred.",
9411
+ description: "Date and time at which the event occurred.",
9414
9412
  format: "date-time",
9415
9413
  type: "string"
9416
9414
  },
@@ -9431,22 +9429,20 @@ var openapi_default = {
9431
9429
  type: "object"
9432
9430
  },
9433
9431
  {
9434
- description: "An ACS system was added.",
9432
+ description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.",
9435
9433
  properties: {
9436
9434
  acs_system_id: {
9437
- description: "ID of the ACS system.",
9435
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9438
9436
  format: "uuid",
9439
- type: "string",
9440
- "x-title": "ACS System ID"
9437
+ type: "string"
9441
9438
  },
9442
9439
  connected_account_id: {
9443
- description: "ID of the connected account.",
9440
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9444
9441
  format: "uuid",
9445
- type: "string",
9446
- "x-title": "Connected Account ID"
9442
+ type: "string"
9447
9443
  },
9448
9444
  created_at: {
9449
- description: "Time at which the event was created.",
9445
+ description: "Date and time at which the event was created.",
9450
9446
  format: "date-time",
9451
9447
  type: "string"
9452
9448
  },
@@ -9457,7 +9453,7 @@ var openapi_default = {
9457
9453
  },
9458
9454
  event_type: { enum: ["acs_system.added"], type: "string" },
9459
9455
  occurred_at: {
9460
- description: "Time when the event occurred.",
9456
+ description: "Date and time at which the event occurred.",
9461
9457
  format: "date-time",
9462
9458
  type: "string"
9463
9459
  },
@@ -9478,22 +9474,20 @@ var openapi_default = {
9478
9474
  type: "object"
9479
9475
  },
9480
9476
  {
9481
- description: "An ACS system was disconnected.",
9477
+ description: "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.",
9482
9478
  properties: {
9483
9479
  acs_system_id: {
9484
- description: "ID of the ACS system.",
9480
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9485
9481
  format: "uuid",
9486
- type: "string",
9487
- "x-title": "ACS System ID"
9482
+ type: "string"
9488
9483
  },
9489
9484
  connected_account_id: {
9490
- description: "ID of the connected account.",
9485
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9491
9486
  format: "uuid",
9492
- type: "string",
9493
- "x-title": "Connected Account ID"
9487
+ type: "string"
9494
9488
  },
9495
9489
  created_at: {
9496
- description: "Time at which the event was created.",
9490
+ description: "Date and time at which the event was created.",
9497
9491
  format: "date-time",
9498
9492
  type: "string"
9499
9493
  },
@@ -9504,7 +9498,7 @@ var openapi_default = {
9504
9498
  },
9505
9499
  event_type: { enum: ["acs_system.disconnected"], type: "string" },
9506
9500
  occurred_at: {
9507
- description: "Time when the event occurred.",
9501
+ description: "Date and time at which the event occurred.",
9508
9502
  format: "date-time",
9509
9503
  type: "string"
9510
9504
  },
@@ -9525,23 +9519,21 @@ var openapi_default = {
9525
9519
  type: "object"
9526
9520
  },
9527
9521
  {
9528
- description: "An ACS credential was deleted.",
9522
+ description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.",
9529
9523
  properties: {
9530
9524
  acs_credential_id: { format: "uuid", type: "string" },
9531
9525
  acs_system_id: {
9532
- description: "ID of the ACS system.",
9526
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9533
9527
  format: "uuid",
9534
- type: "string",
9535
- "x-title": "ACS System ID"
9528
+ type: "string"
9536
9529
  },
9537
9530
  connected_account_id: {
9538
- description: "ID of the connected account.",
9531
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9539
9532
  format: "uuid",
9540
- type: "string",
9541
- "x-title": "Connected Account ID"
9533
+ type: "string"
9542
9534
  },
9543
9535
  created_at: {
9544
- description: "Time at which the event was created.",
9536
+ description: "Date and time at which the event was created.",
9545
9537
  format: "date-time",
9546
9538
  type: "string"
9547
9539
  },
@@ -9552,7 +9544,7 @@ var openapi_default = {
9552
9544
  },
9553
9545
  event_type: { enum: ["acs_credential.deleted"], type: "string" },
9554
9546
  occurred_at: {
9555
- description: "Time when the event occurred.",
9547
+ description: "Date and time at which the event occurred.",
9556
9548
  format: "date-time",
9557
9549
  type: "string"
9558
9550
  },
@@ -9574,23 +9566,21 @@ var openapi_default = {
9574
9566
  type: "object"
9575
9567
  },
9576
9568
  {
9577
- description: "An ACS credential was issued.",
9569
+ description: "An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.",
9578
9570
  properties: {
9579
9571
  acs_credential_id: { format: "uuid", type: "string" },
9580
9572
  acs_system_id: {
9581
- description: "ID of the ACS system.",
9573
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9582
9574
  format: "uuid",
9583
- type: "string",
9584
- "x-title": "ACS System ID"
9575
+ type: "string"
9585
9576
  },
9586
9577
  connected_account_id: {
9587
- description: "ID of the connected account.",
9578
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9588
9579
  format: "uuid",
9589
- type: "string",
9590
- "x-title": "Connected Account ID"
9580
+ type: "string"
9591
9581
  },
9592
9582
  created_at: {
9593
- description: "Time at which the event was created.",
9583
+ description: "Date and time at which the event was created.",
9594
9584
  format: "date-time",
9595
9585
  type: "string"
9596
9586
  },
@@ -9601,7 +9591,7 @@ var openapi_default = {
9601
9591
  },
9602
9592
  event_type: { enum: ["acs_credential.issued"], type: "string" },
9603
9593
  occurred_at: {
9604
- description: "Time when the event occurred.",
9594
+ description: "Date and time at which the event occurred.",
9605
9595
  format: "date-time",
9606
9596
  type: "string"
9607
9597
  },
@@ -9623,23 +9613,21 @@ var openapi_default = {
9623
9613
  type: "object"
9624
9614
  },
9625
9615
  {
9626
- description: "An ACS user was deleted.",
9616
+ description: "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.",
9627
9617
  properties: {
9628
9618
  acs_system_id: {
9629
- description: "ID of the ACS system.",
9619
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9630
9620
  format: "uuid",
9631
- type: "string",
9632
- "x-title": "ACS System ID"
9621
+ type: "string"
9633
9622
  },
9634
9623
  acs_user_id: { format: "uuid", type: "string" },
9635
9624
  connected_account_id: {
9636
- description: "ID of the connected account.",
9625
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9637
9626
  format: "uuid",
9638
- type: "string",
9639
- "x-title": "Connected Account ID"
9627
+ type: "string"
9640
9628
  },
9641
9629
  created_at: {
9642
- description: "Time at which the event was created.",
9630
+ description: "Date and time at which the event was created.",
9643
9631
  format: "date-time",
9644
9632
  type: "string"
9645
9633
  },
@@ -9650,7 +9638,7 @@ var openapi_default = {
9650
9638
  },
9651
9639
  event_type: { enum: ["acs_user.deleted"], type: "string" },
9652
9640
  occurred_at: {
9653
- description: "Time when the event occurred.",
9641
+ description: "Date and time at which the event occurred.",
9654
9642
  format: "date-time",
9655
9643
  type: "string"
9656
9644
  },
@@ -9672,27 +9660,25 @@ var openapi_default = {
9672
9660
  type: "object"
9673
9661
  },
9674
9662
  {
9675
- description: "An ACS encoder was added.",
9663
+ description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.",
9676
9664
  properties: {
9677
9665
  acs_encoder_id: {
9678
- description: "ID of the ACS encoder.",
9666
+ description: "ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
9679
9667
  format: "uuid",
9680
9668
  type: "string"
9681
9669
  },
9682
9670
  acs_system_id: {
9683
- description: "ID of the ACS system.",
9671
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9684
9672
  format: "uuid",
9685
- type: "string",
9686
- "x-title": "ACS System ID"
9673
+ type: "string"
9687
9674
  },
9688
9675
  connected_account_id: {
9689
- description: "ID of the connected account.",
9676
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9690
9677
  format: "uuid",
9691
- type: "string",
9692
- "x-title": "Connected Account ID"
9678
+ type: "string"
9693
9679
  },
9694
9680
  created_at: {
9695
- description: "Time at which the event was created.",
9681
+ description: "Date and time at which the event was created.",
9696
9682
  format: "date-time",
9697
9683
  type: "string"
9698
9684
  },
@@ -9703,7 +9689,7 @@ var openapi_default = {
9703
9689
  },
9704
9690
  event_type: { enum: ["acs_encoder.added"], type: "string" },
9705
9691
  occurred_at: {
9706
- description: "Time when the event occurred.",
9692
+ description: "Date and time at which the event occurred.",
9707
9693
  format: "date-time",
9708
9694
  type: "string"
9709
9695
  },
@@ -9725,27 +9711,25 @@ var openapi_default = {
9725
9711
  type: "object"
9726
9712
  },
9727
9713
  {
9728
- description: "An ACS encoder was removed.",
9714
+ description: "An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.",
9729
9715
  properties: {
9730
9716
  acs_encoder_id: {
9731
- description: "ID of the ACS encoder.",
9717
+ description: "ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
9732
9718
  format: "uuid",
9733
9719
  type: "string"
9734
9720
  },
9735
9721
  acs_system_id: {
9736
- description: "ID of the ACS system.",
9722
+ description: "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).",
9737
9723
  format: "uuid",
9738
- type: "string",
9739
- "x-title": "ACS System ID"
9724
+ type: "string"
9740
9725
  },
9741
9726
  connected_account_id: {
9742
- description: "ID of the connected account.",
9727
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9743
9728
  format: "uuid",
9744
- type: "string",
9745
- "x-title": "Connected Account ID"
9729
+ type: "string"
9746
9730
  },
9747
9731
  created_at: {
9748
- description: "Time at which the event was created.",
9732
+ description: "Date and time at which the event was created.",
9749
9733
  format: "date-time",
9750
9734
  type: "string"
9751
9735
  },
@@ -9756,7 +9740,7 @@ var openapi_default = {
9756
9740
  },
9757
9741
  event_type: { enum: ["acs_encoder.removed"], type: "string" },
9758
9742
  occurred_at: {
9759
- description: "Time when the event occurred.",
9743
+ description: "Date and time at which the event occurred.",
9760
9744
  format: "date-time",
9761
9745
  type: "string"
9762
9746
  },
@@ -9778,16 +9762,15 @@ var openapi_default = {
9778
9762
  type: "object"
9779
9763
  },
9780
9764
  {
9781
- description: "A client session was deleted.",
9765
+ description: "A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.",
9782
9766
  properties: {
9783
9767
  client_session_id: {
9784
- description: "ID of the client session.",
9768
+ description: "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
9785
9769
  format: "uuid",
9786
- type: "string",
9787
- "x-title": "Client Session ID"
9770
+ type: "string"
9788
9771
  },
9789
9772
  created_at: {
9790
- description: "Time at which the event was created.",
9773
+ description: "Date and time at which the event was created.",
9791
9774
  format: "date-time",
9792
9775
  type: "string"
9793
9776
  },
@@ -9798,7 +9781,7 @@ var openapi_default = {
9798
9781
  },
9799
9782
  event_type: { enum: ["client_session.deleted"], type: "string" },
9800
9783
  occurred_at: {
9801
- description: "Time when the event occurred.",
9784
+ description: "Date and time at which the event occurred.",
9802
9785
  format: "date-time",
9803
9786
  type: "string"
9804
9787
  },
@@ -9819,22 +9802,20 @@ var openapi_default = {
9819
9802
  type: "object"
9820
9803
  },
9821
9804
  {
9822
- description: "A connected account was connected for the first time, was reconnected after being disconnected.",
9805
+ 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.",
9823
9806
  properties: {
9824
9807
  connect_webview_id: {
9825
- description: "ID of the connect webview.",
9808
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
9826
9809
  format: "uuid",
9827
- type: "string",
9828
- "x-title": "Connect Webview ID"
9810
+ type: "string"
9829
9811
  },
9830
9812
  connected_account_id: {
9831
- description: "ID of the connected account.",
9813
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9832
9814
  format: "uuid",
9833
- type: "string",
9834
- "x-title": "Connected Account ID"
9815
+ type: "string"
9835
9816
  },
9836
9817
  created_at: {
9837
- description: "Time at which the event was created.",
9818
+ description: "Date and time at which the event was created.",
9838
9819
  format: "date-time",
9839
9820
  type: "string"
9840
9821
  },
@@ -9848,7 +9829,7 @@ var openapi_default = {
9848
9829
  type: "string"
9849
9830
  },
9850
9831
  occurred_at: {
9851
- description: "Time when the event occurred.",
9832
+ description: "Date and time at which the event occurred.",
9852
9833
  format: "date-time",
9853
9834
  type: "string"
9854
9835
  },
@@ -9870,22 +9851,20 @@ var openapi_default = {
9870
9851
  type: "object"
9871
9852
  },
9872
9853
  {
9873
- description: "A connected account was created.",
9854
+ description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.",
9874
9855
  properties: {
9875
9856
  connect_webview_id: {
9876
- description: "ID of the connect webview.",
9857
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
9877
9858
  format: "uuid",
9878
- type: "string",
9879
- "x-title": "Connect Webview ID"
9859
+ type: "string"
9880
9860
  },
9881
9861
  connected_account_id: {
9882
- description: "ID of the connected account.",
9862
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9883
9863
  format: "uuid",
9884
- type: "string",
9885
- "x-title": "Connected Account ID"
9864
+ type: "string"
9886
9865
  },
9887
9866
  created_at: {
9888
- description: "Time at which the event was created.",
9867
+ description: "Date and time at which the event was created.",
9889
9868
  format: "date-time",
9890
9869
  type: "string"
9891
9870
  },
@@ -9899,7 +9878,7 @@ var openapi_default = {
9899
9878
  type: "string"
9900
9879
  },
9901
9880
  occurred_at: {
9902
- description: "Time when the event occurred.",
9881
+ description: "Date and time at which the event occurred.",
9903
9882
  format: "date-time",
9904
9883
  type: "string"
9905
9884
  },
@@ -9922,22 +9901,20 @@ var openapi_default = {
9922
9901
  },
9923
9902
  {
9924
9903
  deprecated: true,
9925
- description: "A connected account had a successful connect webview login.",
9904
+ 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).",
9926
9905
  properties: {
9927
9906
  connect_webview_id: {
9928
- description: "ID of the connect webview.",
9907
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
9929
9908
  format: "uuid",
9930
- type: "string",
9931
- "x-title": "Connect Webview ID"
9909
+ type: "string"
9932
9910
  },
9933
9911
  connected_account_id: {
9934
- description: "ID of the connected account.",
9912
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9935
9913
  format: "uuid",
9936
- type: "string",
9937
- "x-title": "Connected Account ID"
9914
+ type: "string"
9938
9915
  },
9939
9916
  created_at: {
9940
- description: "Time at which the event was created.",
9917
+ description: "Date and time at which the event was created.",
9941
9918
  format: "date-time",
9942
9919
  type: "string"
9943
9920
  },
@@ -9951,7 +9928,7 @@ var openapi_default = {
9951
9928
  type: "string"
9952
9929
  },
9953
9930
  occurred_at: {
9954
- description: "Time when the event occurred.",
9931
+ description: "Date and time at which the event occurred.",
9955
9932
  format: "date-time",
9956
9933
  type: "string"
9957
9934
  },
@@ -9974,16 +9951,15 @@ var openapi_default = {
9974
9951
  "x-deprecated": "Use `connect_webview.login_succeeded`."
9975
9952
  },
9976
9953
  {
9977
- description: "A connected account was disconnected.",
9954
+ description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.",
9978
9955
  properties: {
9979
9956
  connected_account_id: {
9980
- description: "ID of the connected account.",
9957
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
9981
9958
  format: "uuid",
9982
- type: "string",
9983
- "x-title": "Connected Account ID"
9959
+ type: "string"
9984
9960
  },
9985
9961
  created_at: {
9986
- description: "Time at which the event was created.",
9962
+ description: "Date and time at which the event was created.",
9987
9963
  format: "date-time",
9988
9964
  type: "string"
9989
9965
  },
@@ -9997,7 +9973,7 @@ var openapi_default = {
9997
9973
  type: "string"
9998
9974
  },
9999
9975
  occurred_at: {
10000
- description: "Time when the event occurred.",
9976
+ description: "Date and time at which the event occurred.",
10001
9977
  format: "date-time",
10002
9978
  type: "string"
10003
9979
  },
@@ -10018,16 +9994,15 @@ var openapi_default = {
10018
9994
  type: "object"
10019
9995
  },
10020
9996
  {
10021
- description: "A connected account completed the first sync with Seam and devices are now available.",
9997
+ 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.",
10022
9998
  properties: {
10023
9999
  connected_account_id: {
10024
- description: "ID of the connected account.",
10000
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10025
10001
  format: "uuid",
10026
- type: "string",
10027
- "x-title": "Connected Account ID"
10002
+ type: "string"
10028
10003
  },
10029
10004
  created_at: {
10030
- description: "Time at which the event was created.",
10005
+ description: "Date and time at which the event was created.",
10031
10006
  format: "date-time",
10032
10007
  type: "string"
10033
10008
  },
@@ -10041,7 +10016,7 @@ var openapi_default = {
10041
10016
  type: "string"
10042
10017
  },
10043
10018
  occurred_at: {
10044
- description: "Time when the event occurred.",
10019
+ description: "Date and time at which the event occurred.",
10045
10020
  format: "date-time",
10046
10021
  type: "string"
10047
10022
  },
@@ -10062,16 +10037,15 @@ var openapi_default = {
10062
10037
  type: "object"
10063
10038
  },
10064
10039
  {
10065
- description: "A connected account was deleted.",
10040
+ description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.",
10066
10041
  properties: {
10067
10042
  connected_account_id: {
10068
- description: "ID of the connected account.",
10043
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10069
10044
  format: "uuid",
10070
- type: "string",
10071
- "x-title": "Connected Account ID"
10045
+ type: "string"
10072
10046
  },
10073
10047
  created_at: {
10074
- description: "Time at which the event was created.",
10048
+ description: "Date and time at which the event was created.",
10075
10049
  format: "date-time",
10076
10050
  type: "string"
10077
10051
  },
@@ -10085,7 +10059,7 @@ var openapi_default = {
10085
10059
  type: "string"
10086
10060
  },
10087
10061
  occurred_at: {
10088
- description: "Time when the event occurred.",
10062
+ description: "Date and time at which the event occurred.",
10089
10063
  format: "date-time",
10090
10064
  type: "string"
10091
10065
  },
@@ -10106,16 +10080,15 @@ var openapi_default = {
10106
10080
  type: "object"
10107
10081
  },
10108
10082
  {
10109
- description: "A connected account completed the first sync after reconnection with Seam and devices are now available.",
10083
+ 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.",
10110
10084
  properties: {
10111
10085
  connected_account_id: {
10112
- description: "ID of the connected account.",
10086
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10113
10087
  format: "uuid",
10114
- type: "string",
10115
- "x-title": "Connected Account ID"
10088
+ type: "string"
10116
10089
  },
10117
10090
  created_at: {
10118
- description: "Time at which the event was created.",
10091
+ description: "Date and time at which the event was created.",
10119
10092
  format: "date-time",
10120
10093
  type: "string"
10121
10094
  },
@@ -10131,7 +10104,7 @@ var openapi_default = {
10131
10104
  type: "string"
10132
10105
  },
10133
10106
  occurred_at: {
10134
- description: "Time when the event occurred.",
10107
+ description: "Date and time at which the event occurred.",
10135
10108
  format: "date-time",
10136
10109
  type: "string"
10137
10110
  },
@@ -10152,21 +10125,16 @@ var openapi_default = {
10152
10125
  type: "object"
10153
10126
  },
10154
10127
  {
10155
- description: "A lock door action attempt succeeded.",
10128
+ description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
10156
10129
  properties: {
10157
10130
  action_attempt_id: {
10158
- description: "The ID of the action attempt.",
10131
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10159
10132
  format: "uuid",
10160
- type: "string",
10161
- "x-title": "Action Attempt ID"
10162
- },
10163
- action_type: {
10164
- description: "The type of action.",
10165
- type: "string",
10166
- "x-title": "Action Type"
10133
+ type: "string"
10167
10134
  },
10135
+ action_type: { description: "Type of action.", type: "string" },
10168
10136
  created_at: {
10169
- description: "Time at which the event was created.",
10137
+ description: "Date and time at which the event was created.",
10170
10138
  format: "date-time",
10171
10139
  type: "string"
10172
10140
  },
@@ -10180,15 +10148,11 @@ var openapi_default = {
10180
10148
  type: "string"
10181
10149
  },
10182
10150
  occurred_at: {
10183
- description: "Time when the event occurred.",
10151
+ description: "Date and time at which the event occurred.",
10184
10152
  format: "date-time",
10185
10153
  type: "string"
10186
10154
  },
10187
- status: {
10188
- description: "The status of the action.",
10189
- type: "string",
10190
- "x-title": "Status"
10191
- },
10155
+ status: { description: "Status of the action.", type: "string" },
10192
10156
  workspace_id: {
10193
10157
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10194
10158
  format: "uuid",
@@ -10208,21 +10172,16 @@ var openapi_default = {
10208
10172
  type: "object"
10209
10173
  },
10210
10174
  {
10211
- description: "A lock door action attempt failed.",
10175
+ description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
10212
10176
  properties: {
10213
10177
  action_attempt_id: {
10214
- description: "The ID of the action attempt.",
10178
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10215
10179
  format: "uuid",
10216
- type: "string",
10217
- "x-title": "Action Attempt ID"
10218
- },
10219
- action_type: {
10220
- description: "The type of action.",
10221
- type: "string",
10222
- "x-title": "Action Type"
10180
+ type: "string"
10223
10181
  },
10182
+ action_type: { description: "Type of action.", type: "string" },
10224
10183
  created_at: {
10225
- description: "Time at which the event was created.",
10184
+ description: "Date and time at which the event was created.",
10226
10185
  format: "date-time",
10227
10186
  type: "string"
10228
10187
  },
@@ -10236,15 +10195,11 @@ var openapi_default = {
10236
10195
  type: "string"
10237
10196
  },
10238
10197
  occurred_at: {
10239
- description: "Time when the event occurred.",
10198
+ description: "Date and time at which the event occurred.",
10240
10199
  format: "date-time",
10241
10200
  type: "string"
10242
10201
  },
10243
- status: {
10244
- description: "The status of the action.",
10245
- type: "string",
10246
- "x-title": "Status"
10247
- },
10202
+ status: { description: "Status of the action.", type: "string" },
10248
10203
  workspace_id: {
10249
10204
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10250
10205
  format: "uuid",
@@ -10264,21 +10219,16 @@ var openapi_default = {
10264
10219
  type: "object"
10265
10220
  },
10266
10221
  {
10267
- description: "An unlock door action attempt succeeded.",
10222
+ description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
10268
10223
  properties: {
10269
10224
  action_attempt_id: {
10270
- description: "The ID of the action attempt.",
10225
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10271
10226
  format: "uuid",
10272
- type: "string",
10273
- "x-title": "Action Attempt ID"
10274
- },
10275
- action_type: {
10276
- description: "The type of action.",
10277
- type: "string",
10278
- "x-title": "Action Type"
10227
+ type: "string"
10279
10228
  },
10229
+ action_type: { description: "Type of action.", type: "string" },
10280
10230
  created_at: {
10281
- description: "Time at which the event was created.",
10231
+ description: "Date and time at which the event was created.",
10282
10232
  format: "date-time",
10283
10233
  type: "string"
10284
10234
  },
@@ -10292,15 +10242,11 @@ var openapi_default = {
10292
10242
  type: "string"
10293
10243
  },
10294
10244
  occurred_at: {
10295
- description: "Time when the event occurred.",
10245
+ description: "Date and time at which the event occurred.",
10296
10246
  format: "date-time",
10297
10247
  type: "string"
10298
10248
  },
10299
- status: {
10300
- description: "The status of the action.",
10301
- type: "string",
10302
- "x-title": "Status"
10303
- },
10249
+ status: { description: "Status of the action.", type: "string" },
10304
10250
  workspace_id: {
10305
10251
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10306
10252
  format: "uuid",
@@ -10320,21 +10266,16 @@ var openapi_default = {
10320
10266
  type: "object"
10321
10267
  },
10322
10268
  {
10323
- description: "An unlock door action attempt failed.",
10269
+ description: "An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.",
10324
10270
  properties: {
10325
10271
  action_attempt_id: {
10326
- description: "The ID of the action attempt.",
10272
+ description: "ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
10327
10273
  format: "uuid",
10328
- type: "string",
10329
- "x-title": "Action Attempt ID"
10330
- },
10331
- action_type: {
10332
- description: "The type of action.",
10333
- type: "string",
10334
- "x-title": "Action Type"
10274
+ type: "string"
10335
10275
  },
10276
+ action_type: { description: "Type of action.", type: "string" },
10336
10277
  created_at: {
10337
- description: "Time at which the event was created.",
10278
+ description: "Date and time at which the event was created.",
10338
10279
  format: "date-time",
10339
10280
  type: "string"
10340
10281
  },
@@ -10348,15 +10289,11 @@ var openapi_default = {
10348
10289
  type: "string"
10349
10290
  },
10350
10291
  occurred_at: {
10351
- description: "Time when the event occurred.",
10292
+ description: "Date and time at which the event occurred.",
10352
10293
  format: "date-time",
10353
10294
  type: "string"
10354
10295
  },
10355
- status: {
10356
- description: "The status of the action.",
10357
- type: "string",
10358
- "x-title": "Status"
10359
- },
10296
+ status: { description: "Status of the action.", type: "string" },
10360
10297
  workspace_id: {
10361
10298
  description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
10362
10299
  format: "uuid",
@@ -10376,22 +10313,20 @@ var openapi_default = {
10376
10313
  type: "object"
10377
10314
  },
10378
10315
  {
10379
- description: "A connect webview had a successful login.",
10316
+ description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.",
10380
10317
  properties: {
10381
10318
  connect_webview_id: {
10382
- description: "ID of the connect webview.",
10319
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
10383
10320
  format: "uuid",
10384
- type: "string",
10385
- "x-title": "Connect Webview ID"
10321
+ type: "string"
10386
10322
  },
10387
10323
  connected_account_id: {
10388
- description: "ID of the connected account.",
10324
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10389
10325
  format: "uuid",
10390
- type: "string",
10391
- "x-title": "Connected Account ID"
10326
+ type: "string"
10392
10327
  },
10393
10328
  created_at: {
10394
- description: "Time at which the event was created.",
10329
+ description: "Date and time at which the event was created.",
10395
10330
  format: "date-time",
10396
10331
  type: "string"
10397
10332
  },
@@ -10405,7 +10340,7 @@ var openapi_default = {
10405
10340
  type: "string"
10406
10341
  },
10407
10342
  occurred_at: {
10408
- description: "Time when the event occurred.",
10343
+ description: "Date and time at which the event occurred.",
10409
10344
  format: "date-time",
10410
10345
  type: "string"
10411
10346
  },
@@ -10427,16 +10362,15 @@ var openapi_default = {
10427
10362
  type: "object"
10428
10363
  },
10429
10364
  {
10430
- description: "A connect webview had a failed login.",
10365
+ description: "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.",
10431
10366
  properties: {
10432
10367
  connect_webview_id: {
10433
- description: "ID of the connect webview.",
10368
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).",
10434
10369
  format: "uuid",
10435
- type: "string",
10436
- "x-title": "Connect Webview ID"
10370
+ type: "string"
10437
10371
  },
10438
10372
  created_at: {
10439
- description: "Time at which the event was created.",
10373
+ description: "Date and time at which the event was created.",
10440
10374
  format: "date-time",
10441
10375
  type: "string"
10442
10376
  },
@@ -10450,7 +10384,7 @@ var openapi_default = {
10450
10384
  type: "string"
10451
10385
  },
10452
10386
  occurred_at: {
10453
- description: "Time when the event occurred.",
10387
+ description: "Date and time at which the event occurred.",
10454
10388
  format: "date-time",
10455
10389
  type: "string"
10456
10390
  },
@@ -10471,7 +10405,7 @@ var openapi_default = {
10471
10405
  type: "object"
10472
10406
  },
10473
10407
  {
10474
- description: "A new device was connected to Seam.",
10408
+ 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.",
10475
10409
  properties: {
10476
10410
  connected_account_id: {
10477
10411
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10479,7 +10413,7 @@ var openapi_default = {
10479
10413
  type: "string"
10480
10414
  },
10481
10415
  created_at: {
10482
- description: "Time at which the event was created.",
10416
+ description: "Date and time at which the event was created.",
10483
10417
  format: "date-time",
10484
10418
  type: "string"
10485
10419
  },
@@ -10495,7 +10429,7 @@ var openapi_default = {
10495
10429
  },
10496
10430
  event_type: { enum: ["device.connected"], type: "string" },
10497
10431
  occurred_at: {
10498
- description: "Time when the event occurred.",
10432
+ description: "Date and time at which the event occurred.",
10499
10433
  format: "date-time",
10500
10434
  type: "string"
10501
10435
  },
@@ -10517,7 +10451,7 @@ var openapi_default = {
10517
10451
  type: "object"
10518
10452
  },
10519
10453
  {
10520
- description: "A device was added or reconnected to Seam.",
10454
+ 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.",
10521
10455
  properties: {
10522
10456
  connected_account_id: {
10523
10457
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10525,7 +10459,7 @@ var openapi_default = {
10525
10459
  type: "string"
10526
10460
  },
10527
10461
  created_at: {
10528
- description: "Time at which the event was created.",
10462
+ description: "Date and time at which the event was created.",
10529
10463
  format: "date-time",
10530
10464
  type: "string"
10531
10465
  },
@@ -10541,7 +10475,7 @@ var openapi_default = {
10541
10475
  },
10542
10476
  event_type: { enum: ["device.added"], type: "string" },
10543
10477
  occurred_at: {
10544
- description: "Time when the event occurred.",
10478
+ description: "Date and time at which the event occurred.",
10545
10479
  format: "date-time",
10546
10480
  type: "string"
10547
10481
  },
@@ -10571,7 +10505,7 @@ var openapi_default = {
10571
10505
  type: "string"
10572
10506
  },
10573
10507
  created_at: {
10574
- description: "Time at which the event was created.",
10508
+ description: "Date and time at which the event was created.",
10575
10509
  format: "date-time",
10576
10510
  type: "string"
10577
10511
  },
@@ -10590,7 +10524,7 @@ var openapi_default = {
10590
10524
  type: "string"
10591
10525
  },
10592
10526
  occurred_at: {
10593
- description: "Time when the event occurred.",
10527
+ description: "Date and time at which the event occurred.",
10594
10528
  format: "date-time",
10595
10529
  type: "string"
10596
10530
  },
@@ -10620,7 +10554,7 @@ var openapi_default = {
10620
10554
  type: "string"
10621
10555
  },
10622
10556
  created_at: {
10623
- description: "Time at which the event was created.",
10557
+ description: "Date and time at which the event was created.",
10624
10558
  format: "date-time",
10625
10559
  type: "string"
10626
10560
  },
@@ -10639,7 +10573,7 @@ var openapi_default = {
10639
10573
  type: "string"
10640
10574
  },
10641
10575
  occurred_at: {
10642
- description: "Time when the event occurred.",
10576
+ description: "Date and time at which the event occurred.",
10643
10577
  format: "date-time",
10644
10578
  type: "string"
10645
10579
  },
@@ -10661,7 +10595,7 @@ var openapi_default = {
10661
10595
  type: "object"
10662
10596
  },
10663
10597
  {
10664
- description: "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.",
10598
+ 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`.",
10665
10599
  properties: {
10666
10600
  connected_account_id: {
10667
10601
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10669,7 +10603,7 @@ var openapi_default = {
10669
10603
  type: "string"
10670
10604
  },
10671
10605
  created_at: {
10672
- description: "Time at which the event was created.",
10606
+ description: "Date and time at which the event was created.",
10673
10607
  format: "date-time",
10674
10608
  type: "string"
10675
10609
  },
@@ -10688,7 +10622,7 @@ var openapi_default = {
10688
10622
  type: "string"
10689
10623
  },
10690
10624
  occurred_at: {
10691
- description: "Time when the event occurred.",
10625
+ description: "Date and time at which the event occurred.",
10692
10626
  format: "date-time",
10693
10627
  type: "string"
10694
10628
  },
@@ -10710,7 +10644,7 @@ var openapi_default = {
10710
10644
  type: "object"
10711
10645
  },
10712
10646
  {
10713
- description: "A device was disconnected from Seam.",
10647
+ 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`.",
10714
10648
  properties: {
10715
10649
  connected_account_id: {
10716
10650
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10718,7 +10652,7 @@ var openapi_default = {
10718
10652
  type: "string"
10719
10653
  },
10720
10654
  created_at: {
10721
- description: "Time at which the event was created.",
10655
+ description: "Date and time at which the event was created.",
10722
10656
  format: "date-time",
10723
10657
  type: "string"
10724
10658
  },
@@ -10743,7 +10677,7 @@ var openapi_default = {
10743
10677
  },
10744
10678
  event_type: { enum: ["device.disconnected"], type: "string" },
10745
10679
  occurred_at: {
10746
- description: "Time when the event occurred.",
10680
+ description: "Date and time at which the event occurred.",
10747
10681
  format: "date-time",
10748
10682
  type: "string"
10749
10683
  },
@@ -10766,7 +10700,7 @@ var openapi_default = {
10766
10700
  type: "object"
10767
10701
  },
10768
10702
  {
10769
- description: "An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.",
10703
+ 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`.",
10770
10704
  properties: {
10771
10705
  connected_account_id: {
10772
10706
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10774,7 +10708,7 @@ var openapi_default = {
10774
10708
  type: "string"
10775
10709
  },
10776
10710
  created_at: {
10777
- description: "Time at which the event was created.",
10711
+ description: "Date and time at which the event was created.",
10778
10712
  format: "date-time",
10779
10713
  type: "string"
10780
10714
  },
@@ -10802,7 +10736,7 @@ var openapi_default = {
10802
10736
  type: "string"
10803
10737
  },
10804
10738
  occurred_at: {
10805
- description: "Time when the event occurred.",
10739
+ description: "Date and time at which the event occurred.",
10806
10740
  format: "date-time",
10807
10741
  type: "string"
10808
10742
  },
@@ -10825,7 +10759,7 @@ var openapi_default = {
10825
10759
  type: "object"
10826
10760
  },
10827
10761
  {
10828
- description: "A device detected that it was tampered with, for example, opened or moved.",
10762
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.",
10829
10763
  properties: {
10830
10764
  connected_account_id: {
10831
10765
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10833,7 +10767,7 @@ var openapi_default = {
10833
10767
  type: "string"
10834
10768
  },
10835
10769
  created_at: {
10836
- description: "Time at which the event was created.",
10770
+ description: "Date and time at which the event was created.",
10837
10771
  format: "date-time",
10838
10772
  type: "string"
10839
10773
  },
@@ -10849,7 +10783,7 @@ var openapi_default = {
10849
10783
  },
10850
10784
  event_type: { enum: ["device.tampered"], type: "string" },
10851
10785
  occurred_at: {
10852
- description: "Time when the event occurred.",
10786
+ description: "Date and time at which the event occurred.",
10853
10787
  format: "date-time",
10854
10788
  type: "string"
10855
10789
  },
@@ -10871,7 +10805,7 @@ var openapi_default = {
10871
10805
  type: "object"
10872
10806
  },
10873
10807
  {
10874
- description: "A device battery level dropped below the low threshold.",
10808
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.",
10875
10809
  properties: {
10876
10810
  battery_level: {
10877
10811
  description: "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.",
@@ -10886,7 +10820,7 @@ var openapi_default = {
10886
10820
  type: "string"
10887
10821
  },
10888
10822
  created_at: {
10889
- description: "Time at which the event was created.",
10823
+ description: "Date and time at which the event was created.",
10890
10824
  format: "date-time",
10891
10825
  type: "string"
10892
10826
  },
@@ -10902,7 +10836,7 @@ var openapi_default = {
10902
10836
  },
10903
10837
  event_type: { enum: ["device.low_battery"], type: "string" },
10904
10838
  occurred_at: {
10905
- description: "Time when the event occurred.",
10839
+ description: "Date and time at which the event occurred.",
10906
10840
  format: "date-time",
10907
10841
  type: "string"
10908
10842
  },
@@ -10925,7 +10859,7 @@ var openapi_default = {
10925
10859
  type: "object"
10926
10860
  },
10927
10861
  {
10928
- description: "A device battery status changed since the last `battery_status_changed` event.",
10862
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.",
10929
10863
  properties: {
10930
10864
  battery_level: {
10931
10865
  description: "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.",
@@ -10945,7 +10879,7 @@ var openapi_default = {
10945
10879
  type: "string"
10946
10880
  },
10947
10881
  created_at: {
10948
- description: "Time at which the event was created.",
10882
+ description: "Date and time at which the event was created.",
10949
10883
  format: "date-time",
10950
10884
  type: "string"
10951
10885
  },
@@ -10964,7 +10898,7 @@ var openapi_default = {
10964
10898
  type: "string"
10965
10899
  },
10966
10900
  occurred_at: {
10967
- description: "Time when the event occurred.",
10901
+ description: "Date and time at which the event occurred.",
10968
10902
  format: "date-time",
10969
10903
  type: "string"
10970
10904
  },
@@ -10988,7 +10922,7 @@ var openapi_default = {
10988
10922
  type: "object"
10989
10923
  },
10990
10924
  {
10991
- description: "A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
10925
+ 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).",
10992
10926
  properties: {
10993
10927
  connected_account_id: {
10994
10928
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -10996,7 +10930,7 @@ var openapi_default = {
10996
10930
  type: "string"
10997
10931
  },
10998
10932
  created_at: {
10999
- description: "Time at which the event was created.",
10933
+ description: "Date and time at which the event was created.",
11000
10934
  format: "date-time",
11001
10935
  type: "string"
11002
10936
  },
@@ -11012,7 +10946,7 @@ var openapi_default = {
11012
10946
  },
11013
10947
  event_type: { enum: ["device.removed"], type: "string" },
11014
10948
  occurred_at: {
11015
- description: "Time when the event occurred.",
10949
+ description: "Date and time at which the event occurred.",
11016
10950
  format: "date-time",
11017
10951
  type: "string"
11018
10952
  },
@@ -11034,7 +10968,7 @@ var openapi_default = {
11034
10968
  type: "object"
11035
10969
  },
11036
10970
  {
11037
- description: "A device was [deleted](https://docs.seam.co/latest/api/devices/delete).",
10971
+ description: "A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.",
11038
10972
  properties: {
11039
10973
  connected_account_id: {
11040
10974
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11042,7 +10976,7 @@ var openapi_default = {
11042
10976
  type: "string"
11043
10977
  },
11044
10978
  created_at: {
11045
- description: "Time at which the event was created.",
10979
+ description: "Date and time at which the event was created.",
11046
10980
  format: "date-time",
11047
10981
  type: "string"
11048
10982
  },
@@ -11058,7 +10992,7 @@ var openapi_default = {
11058
10992
  },
11059
10993
  event_type: { enum: ["device.deleted"], type: "string" },
11060
10994
  occurred_at: {
11061
- description: "Time when the event occurred.",
10995
+ description: "Date and time at which the event occurred.",
11062
10996
  format: "date-time",
11063
10997
  type: "string"
11064
10998
  },
@@ -11080,7 +11014,7 @@ var openapi_default = {
11080
11014
  type: "object"
11081
11015
  },
11082
11016
  {
11083
- description: "Seam detected that a device is using a third-party integration that will interfere with Seam device management.",
11017
+ 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.",
11084
11018
  properties: {
11085
11019
  connected_account_id: {
11086
11020
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11088,7 +11022,7 @@ var openapi_default = {
11088
11022
  type: "string"
11089
11023
  },
11090
11024
  created_at: {
11091
- description: "Time at which the event was created.",
11025
+ description: "Date and time at which the event was created.",
11092
11026
  format: "date-time",
11093
11027
  type: "string"
11094
11028
  },
@@ -11107,7 +11041,7 @@ var openapi_default = {
11107
11041
  type: "string"
11108
11042
  },
11109
11043
  occurred_at: {
11110
- description: "Time when the event occurred.",
11044
+ description: "Date and time at which the event occurred.",
11111
11045
  format: "date-time",
11112
11046
  type: "string"
11113
11047
  },
@@ -11129,7 +11063,7 @@ var openapi_default = {
11129
11063
  type: "object"
11130
11064
  },
11131
11065
  {
11132
- description: "Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.",
11066
+ 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.",
11133
11067
  properties: {
11134
11068
  connected_account_id: {
11135
11069
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11137,7 +11071,7 @@ var openapi_default = {
11137
11071
  type: "string"
11138
11072
  },
11139
11073
  created_at: {
11140
- description: "Time at which the event was created.",
11074
+ description: "Date and time at which the event was created.",
11141
11075
  format: "date-time",
11142
11076
  type: "string"
11143
11077
  },
@@ -11156,7 +11090,7 @@ var openapi_default = {
11156
11090
  type: "string"
11157
11091
  },
11158
11092
  occurred_at: {
11159
- description: "Time when the event occurred.",
11093
+ description: "Date and time at which the event occurred.",
11160
11094
  format: "date-time",
11161
11095
  type: "string"
11162
11096
  },
@@ -11178,7 +11112,7 @@ var openapi_default = {
11178
11112
  type: "object"
11179
11113
  },
11180
11114
  {
11181
- description: "A Salto device activated privacy mode.",
11115
+ description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.",
11182
11116
  properties: {
11183
11117
  connected_account_id: {
11184
11118
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11186,7 +11120,7 @@ var openapi_default = {
11186
11120
  type: "string"
11187
11121
  },
11188
11122
  created_at: {
11189
- description: "Time at which the event was created.",
11123
+ description: "Date and time at which the event was created.",
11190
11124
  format: "date-time",
11191
11125
  type: "string"
11192
11126
  },
@@ -11205,7 +11139,7 @@ var openapi_default = {
11205
11139
  type: "string"
11206
11140
  },
11207
11141
  occurred_at: {
11208
- description: "Time when the event occurred.",
11142
+ description: "Date and time at which the event occurred.",
11209
11143
  format: "date-time",
11210
11144
  type: "string"
11211
11145
  },
@@ -11227,7 +11161,7 @@ var openapi_default = {
11227
11161
  type: "object"
11228
11162
  },
11229
11163
  {
11230
- description: "A Salto device deactivated privacy mode.",
11164
+ description: "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.",
11231
11165
  properties: {
11232
11166
  connected_account_id: {
11233
11167
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11235,7 +11169,7 @@ var openapi_default = {
11235
11169
  type: "string"
11236
11170
  },
11237
11171
  created_at: {
11238
- description: "Time at which the event was created.",
11172
+ description: "Date and time at which the event was created.",
11239
11173
  format: "date-time",
11240
11174
  type: "string"
11241
11175
  },
@@ -11254,7 +11188,7 @@ var openapi_default = {
11254
11188
  type: "string"
11255
11189
  },
11256
11190
  occurred_at: {
11257
- description: "Time when the event occurred.",
11191
+ description: "Date and time at which the event occurred.",
11258
11192
  format: "date-time",
11259
11193
  type: "string"
11260
11194
  },
@@ -11276,7 +11210,7 @@ var openapi_default = {
11276
11210
  type: "object"
11277
11211
  },
11278
11212
  {
11279
- description: "Seam detected a flaky device connection.",
11213
+ description: "Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.",
11280
11214
  properties: {
11281
11215
  connected_account_id: {
11282
11216
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11284,7 +11218,7 @@ var openapi_default = {
11284
11218
  type: "string"
11285
11219
  },
11286
11220
  created_at: {
11287
- description: "Time at which the event was created.",
11221
+ description: "Date and time at which the event was created.",
11288
11222
  format: "date-time",
11289
11223
  type: "string"
11290
11224
  },
@@ -11303,7 +11237,7 @@ var openapi_default = {
11303
11237
  type: "string"
11304
11238
  },
11305
11239
  occurred_at: {
11306
- description: "Time when the event occurred.",
11240
+ description: "Date and time at which the event occurred.",
11307
11241
  format: "date-time",
11308
11242
  type: "string"
11309
11243
  },
@@ -11325,7 +11259,7 @@ var openapi_default = {
11325
11259
  type: "object"
11326
11260
  },
11327
11261
  {
11328
- description: "Seam detected that a previously-flaky device connection stabilized.",
11262
+ description: "Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.",
11329
11263
  properties: {
11330
11264
  connected_account_id: {
11331
11265
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11333,7 +11267,7 @@ var openapi_default = {
11333
11267
  type: "string"
11334
11268
  },
11335
11269
  created_at: {
11336
- description: "Time at which the event was created.",
11270
+ description: "Date and time at which the event was created.",
11337
11271
  format: "date-time",
11338
11272
  type: "string"
11339
11273
  },
@@ -11352,7 +11286,7 @@ var openapi_default = {
11352
11286
  type: "string"
11353
11287
  },
11354
11288
  occurred_at: {
11355
- description: "Time when the event occurred.",
11289
+ description: "Date and time at which the event occurred.",
11356
11290
  format: "date-time",
11357
11291
  type: "string"
11358
11292
  },
@@ -11374,7 +11308,7 @@ var openapi_default = {
11374
11308
  type: "object"
11375
11309
  },
11376
11310
  {
11377
- description: "A third-party subscription is required to use all device features.",
11311
+ description: "A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.",
11378
11312
  properties: {
11379
11313
  connected_account_id: {
11380
11314
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11382,7 +11316,7 @@ var openapi_default = {
11382
11316
  type: "string"
11383
11317
  },
11384
11318
  created_at: {
11385
- description: "Time at which the event was created.",
11319
+ description: "Date and time at which the event was created.",
11386
11320
  format: "date-time",
11387
11321
  type: "string"
11388
11322
  },
@@ -11401,7 +11335,7 @@ var openapi_default = {
11401
11335
  type: "string"
11402
11336
  },
11403
11337
  occurred_at: {
11404
- description: "Time when the event occurred.",
11338
+ description: "Date and time at which the event occurred.",
11405
11339
  format: "date-time",
11406
11340
  type: "string"
11407
11341
  },
@@ -11423,7 +11357,7 @@ var openapi_default = {
11423
11357
  type: "object"
11424
11358
  },
11425
11359
  {
11426
- description: "A third-party subscription is active or no longer required to use all device features.",
11360
+ description: "A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.",
11427
11361
  properties: {
11428
11362
  connected_account_id: {
11429
11363
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11431,7 +11365,7 @@ var openapi_default = {
11431
11365
  type: "string"
11432
11366
  },
11433
11367
  created_at: {
11434
- description: "Time at which the event was created.",
11368
+ description: "Date and time at which the event was created.",
11435
11369
  format: "date-time",
11436
11370
  type: "string"
11437
11371
  },
@@ -11450,7 +11384,7 @@ var openapi_default = {
11450
11384
  type: "string"
11451
11385
  },
11452
11386
  occurred_at: {
11453
- description: "Time when the event occurred.",
11387
+ description: "Date and time at which the event occurred.",
11454
11388
  format: "date-time",
11455
11389
  type: "string"
11456
11390
  },
@@ -11472,7 +11406,7 @@ var openapi_default = {
11472
11406
  type: "object"
11473
11407
  },
11474
11408
  {
11475
- description: "An accessory keypad was connected to a device.",
11409
+ description: "An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).",
11476
11410
  properties: {
11477
11411
  connected_account_id: {
11478
11412
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11480,7 +11414,7 @@ var openapi_default = {
11480
11414
  type: "string"
11481
11415
  },
11482
11416
  created_at: {
11483
- description: "Time at which the event was created.",
11417
+ description: "Date and time at which the event was created.",
11484
11418
  format: "date-time",
11485
11419
  type: "string"
11486
11420
  },
@@ -11499,7 +11433,7 @@ var openapi_default = {
11499
11433
  type: "string"
11500
11434
  },
11501
11435
  occurred_at: {
11502
- description: "Time when the event occurred.",
11436
+ description: "Date and time at which the event occurred.",
11503
11437
  format: "date-time",
11504
11438
  type: "string"
11505
11439
  },
@@ -11521,7 +11455,7 @@ var openapi_default = {
11521
11455
  type: "object"
11522
11456
  },
11523
11457
  {
11524
- description: "An accessory keypad was disconnected from a device.",
11458
+ description: "An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).",
11525
11459
  properties: {
11526
11460
  connected_account_id: {
11527
11461
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11529,7 +11463,7 @@ var openapi_default = {
11529
11463
  type: "string"
11530
11464
  },
11531
11465
  created_at: {
11532
- description: "Time at which the event was created.",
11466
+ description: "Date and time at which the event was created.",
11533
11467
  format: "date-time",
11534
11468
  type: "string"
11535
11469
  },
@@ -11548,7 +11482,7 @@ var openapi_default = {
11548
11482
  type: "string"
11549
11483
  },
11550
11484
  occurred_at: {
11551
- description: "Time when the event occurred.",
11485
+ description: "Date and time at which the event occurred.",
11552
11486
  format: "date-time",
11553
11487
  type: "string"
11554
11488
  },
@@ -11578,7 +11512,7 @@ var openapi_default = {
11578
11512
  type: "string"
11579
11513
  },
11580
11514
  created_at: {
11581
- description: "Time at which the event was created.",
11515
+ description: "Date and time at which the event was created.",
11582
11516
  format: "date-time",
11583
11517
  type: "string"
11584
11518
  },
@@ -11599,8 +11533,7 @@ var openapi_default = {
11599
11533
  minut_metadata: {
11600
11534
  additionalProperties: {},
11601
11535
  description: "Metadata from Minut.",
11602
- type: "object",
11603
- "x-title": "Minut Metadata"
11536
+ type: "object"
11604
11537
  },
11605
11538
  noise_level_decibels: {
11606
11539
  description: "Detected noise level in decibels.",
@@ -11624,11 +11557,10 @@ var openapi_default = {
11624
11557
  noiseaware_metadata: {
11625
11558
  additionalProperties: {},
11626
11559
  description: "Metadata from Noiseaware.",
11627
- type: "object",
11628
- "x-title": "Noiseaware Metadata"
11560
+ type: "object"
11629
11561
  },
11630
11562
  occurred_at: {
11631
- description: "Time when the event occurred.",
11563
+ description: "Date and time at which the event occurred.",
11632
11564
  format: "date-time",
11633
11565
  type: "string"
11634
11566
  },
@@ -11650,7 +11582,7 @@ var openapi_default = {
11650
11582
  type: "object"
11651
11583
  },
11652
11584
  {
11653
- description: "A lock was locked.",
11585
+ description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.",
11654
11586
  properties: {
11655
11587
  access_code_id: {
11656
11588
  description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.",
@@ -11668,7 +11600,7 @@ var openapi_default = {
11668
11600
  type: "string"
11669
11601
  },
11670
11602
  created_at: {
11671
- description: "Time at which the event was created.",
11603
+ description: "Date and time at which the event was created.",
11672
11604
  format: "date-time",
11673
11605
  type: "string"
11674
11606
  },
@@ -11684,12 +11616,12 @@ var openapi_default = {
11684
11616
  },
11685
11617
  event_type: { enum: ["lock.locked"], type: "string" },
11686
11618
  method: {
11687
- 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.",
11619
+ 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.",
11688
11620
  enum: ["keycode", "manual", "automatic", "unknown", "seamapi"],
11689
11621
  type: "string"
11690
11622
  },
11691
11623
  occurred_at: {
11692
- description: "Time when the event occurred.",
11624
+ description: "Date and time at which the event occurred.",
11693
11625
  format: "date-time",
11694
11626
  type: "string"
11695
11627
  },
@@ -11712,7 +11644,7 @@ var openapi_default = {
11712
11644
  type: "object"
11713
11645
  },
11714
11646
  {
11715
- description: "A lock was unlocked.",
11647
+ description: "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.",
11716
11648
  properties: {
11717
11649
  access_code_id: {
11718
11650
  description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.",
@@ -11730,7 +11662,7 @@ var openapi_default = {
11730
11662
  type: "string"
11731
11663
  },
11732
11664
  created_at: {
11733
- description: "Time at which the event was created.",
11665
+ description: "Date and time at which the event was created.",
11734
11666
  format: "date-time",
11735
11667
  type: "string"
11736
11668
  },
@@ -11746,12 +11678,12 @@ var openapi_default = {
11746
11678
  },
11747
11679
  event_type: { enum: ["lock.unlocked"], type: "string" },
11748
11680
  method: {
11749
- 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.",
11681
+ 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.",
11750
11682
  enum: ["keycode", "manual", "automatic", "unknown", "seamapi"],
11751
11683
  type: "string"
11752
11684
  },
11753
11685
  occurred_at: {
11754
- description: "Time when the event occurred.",
11686
+ description: "Date and time at which the event occurred.",
11755
11687
  format: "date-time",
11756
11688
  type: "string"
11757
11689
  },
@@ -11774,7 +11706,7 @@ var openapi_default = {
11774
11706
  type: "object"
11775
11707
  },
11776
11708
  {
11777
- description: "The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.",
11709
+ 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.",
11778
11710
  properties: {
11779
11711
  access_code_id: {
11780
11712
  description: "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.",
@@ -11787,7 +11719,7 @@ var openapi_default = {
11787
11719
  type: "string"
11788
11720
  },
11789
11721
  created_at: {
11790
- description: "Time at which the event was created.",
11722
+ description: "Date and time at which the event was created.",
11791
11723
  format: "date-time",
11792
11724
  type: "string"
11793
11725
  },
@@ -11803,7 +11735,7 @@ var openapi_default = {
11803
11735
  },
11804
11736
  event_type: { enum: ["lock.access_denied"], type: "string" },
11805
11737
  occurred_at: {
11806
- description: "Time when the event occurred.",
11738
+ description: "Date and time at which the event occurred.",
11807
11739
  format: "date-time",
11808
11740
  type: "string"
11809
11741
  },
@@ -11837,7 +11769,7 @@ var openapi_default = {
11837
11769
  type: "string"
11838
11770
  },
11839
11771
  created_at: {
11840
- description: "Time at which the event was created.",
11772
+ description: "Date and time at which the event was created.",
11841
11773
  format: "date-time",
11842
11774
  type: "string"
11843
11775
  },
@@ -11856,11 +11788,11 @@ var openapi_default = {
11856
11788
  type: "string"
11857
11789
  },
11858
11790
  is_fallback_climate_preset: {
11859
- 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.",
11791
+ 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).",
11860
11792
  type: "boolean"
11861
11793
  },
11862
11794
  occurred_at: {
11863
- description: "Time when the event occurred.",
11795
+ description: "Date and time at which the event occurred.",
11864
11796
  format: "date-time",
11865
11797
  type: "string"
11866
11798
  },
@@ -11891,7 +11823,7 @@ var openapi_default = {
11891
11823
  type: "object"
11892
11824
  },
11893
11825
  {
11894
- description: "A thermostat was adjusted manually.",
11826
+ description: "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.",
11895
11827
  properties: {
11896
11828
  connected_account_id: {
11897
11829
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11909,7 +11841,7 @@ var openapi_default = {
11909
11841
  type: "number"
11910
11842
  },
11911
11843
  created_at: {
11912
- description: "Time at which the event was created.",
11844
+ description: "Date and time at which the event was created.",
11913
11845
  format: "date-time",
11914
11846
  type: "string"
11915
11847
  },
@@ -11948,12 +11880,12 @@ var openapi_default = {
11948
11880
  type: "string"
11949
11881
  },
11950
11882
  method: {
11951
- 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.",
11883
+ 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).",
11952
11884
  enum: ["seam", "external"],
11953
11885
  type: "string"
11954
11886
  },
11955
11887
  occurred_at: {
11956
- description: "Time when the event occurred.",
11888
+ description: "Date and time at which the event occurred.",
11957
11889
  format: "date-time",
11958
11890
  type: "string"
11959
11891
  },
@@ -11976,7 +11908,7 @@ var openapi_default = {
11976
11908
  type: "object"
11977
11909
  },
11978
11910
  {
11979
- description: "A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
11911
+ 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).",
11980
11912
  properties: {
11981
11913
  connected_account_id: {
11982
11914
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -11984,7 +11916,7 @@ var openapi_default = {
11984
11916
  type: "string"
11985
11917
  },
11986
11918
  created_at: {
11987
- description: "Time at which the event was created.",
11919
+ description: "Date and time at which the event was created.",
11988
11920
  format: "date-time",
11989
11921
  type: "string"
11990
11922
  },
@@ -12015,17 +11947,17 @@ var openapi_default = {
12015
11947
  type: "number"
12016
11948
  },
12017
11949
  occurred_at: {
12018
- description: "Time when the event occurred.",
11950
+ description: "Date and time at which the event occurred.",
12019
11951
  format: "date-time",
12020
11952
  type: "string"
12021
11953
  },
12022
11954
  temperature_celsius: {
12023
- description: "Temperature, in \xB0C, reported by the thermostat.",
11955
+ description: "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12024
11956
  format: "float",
12025
11957
  type: "number"
12026
11958
  },
12027
11959
  temperature_fahrenheit: {
12028
- description: "Temperature, in \xB0F, reported by the thermostat.",
11960
+ description: "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12029
11961
  format: "float",
12030
11962
  type: "number"
12031
11963
  },
@@ -12065,7 +11997,7 @@ var openapi_default = {
12065
11997
  type: "object"
12066
11998
  },
12067
11999
  {
12068
- 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).",
12000
+ 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).",
12069
12001
  properties: {
12070
12002
  connected_account_id: {
12071
12003
  description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
@@ -12073,7 +12005,7 @@ var openapi_default = {
12073
12005
  type: "string"
12074
12006
  },
12075
12007
  created_at: {
12076
- description: "Time at which the event was created.",
12008
+ description: "Date and time at which the event was created.",
12077
12009
  format: "date-time",
12078
12010
  type: "string"
12079
12011
  },
@@ -12104,17 +12036,17 @@ var openapi_default = {
12104
12036
  type: "number"
12105
12037
  },
12106
12038
  occurred_at: {
12107
- description: "Time when the event occurred.",
12039
+ description: "Date and time at which the event occurred.",
12108
12040
  format: "date-time",
12109
12041
  type: "string"
12110
12042
  },
12111
12043
  temperature_celsius: {
12112
- description: "Temperature, in \xB0C, reported by the thermostat.",
12044
+ description: "Temperature, in \xB0C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12113
12045
  format: "float",
12114
12046
  type: "number"
12115
12047
  },
12116
12048
  temperature_fahrenheit: {
12117
- description: "Temperature, in \xB0F, reported by the thermostat.",
12049
+ description: "Temperature, in \xB0F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
12118
12050
  format: "float",
12119
12051
  type: "number"
12120
12052
  },
@@ -12154,18 +12086,17 @@ var openapi_default = {
12154
12086
  type: "object"
12155
12087
  },
12156
12088
  {
12157
- description: "An enrollment automation was deleted.",
12089
+ 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.",
12158
12090
  properties: {
12159
12091
  created_at: {
12160
- description: "Time at which the event was created.",
12092
+ description: "Date and time at which the event was created.",
12161
12093
  format: "date-time",
12162
12094
  type: "string"
12163
12095
  },
12164
12096
  enrollment_automation_id: {
12165
- description: "ID of the enrollment automation.",
12097
+ 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).",
12166
12098
  format: "uuid",
12167
- type: "string",
12168
- "x-title": "Enrollment Automation ID"
12099
+ type: "string"
12169
12100
  },
12170
12101
  event_id: {
12171
12102
  description: "ID of the event.",
@@ -12177,7 +12108,7 @@ var openapi_default = {
12177
12108
  type: "string"
12178
12109
  },
12179
12110
  occurred_at: {
12180
- description: "Time when the event occurred.",
12111
+ description: "Date and time at which the event occurred.",
12181
12112
  format: "date-time",
12182
12113
  type: "string"
12183
12114
  },
@@ -12201,15 +12132,14 @@ var openapi_default = {
12201
12132
  description: "A phone device was deactivated.",
12202
12133
  properties: {
12203
12134
  created_at: {
12204
- description: "Time at which the event was created.",
12135
+ description: "Date and time at which the event was created.",
12205
12136
  format: "date-time",
12206
12137
  type: "string"
12207
12138
  },
12208
12139
  device_id: {
12209
- description: "ID of the device.",
12140
+ description: "ID of the [device](https://docs.seam.co/latest/core-concepts/devices).",
12210
12141
  format: "uuid",
12211
- type: "string",
12212
- "x-title": "Device ID"
12142
+ type: "string"
12213
12143
  },
12214
12144
  event_id: {
12215
12145
  description: "ID of the event.",
@@ -12218,7 +12148,7 @@ var openapi_default = {
12218
12148
  },
12219
12149
  event_type: { enum: ["phone.deactivated"], type: "string" },
12220
12150
  occurred_at: {
12221
- description: "Time when the event occurred.",
12151
+ description: "Date and time at which the event occurred.",
12222
12152
  format: "date-time",
12223
12153
  type: "string"
12224
12154
  },
@@ -16743,6 +16673,7 @@ var openapi_default = {
16743
16673
  },
16744
16674
  "/acs/encoders/encode_credential": {
16745
16675
  post: {
16676
+ description: "Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
16746
16677
  operationId: "acsEncodersEncodeCredentialPost",
16747
16678
  requestBody: {
16748
16679
  content: {
@@ -16750,12 +16681,12 @@ var openapi_default = {
16750
16681
  schema: {
16751
16682
  properties: {
16752
16683
  acs_credential_id: {
16753
- description: "ID of the acs_credential to encode on a physical card.",
16684
+ description: "ID of the `acs_credential` to encode onto a card.",
16754
16685
  format: "uuid",
16755
16686
  type: "string"
16756
16687
  },
16757
16688
  acs_encoder_id: {
16758
- description: "ID of the acs_encoder to use for the encoding.",
16689
+ description: "ID of the `acs_encoder` to use to encode the `acs_credential`.",
16759
16690
  format: "uuid",
16760
16691
  type: "string"
16761
16692
  }
@@ -16798,11 +16729,12 @@ var openapi_default = {
16798
16729
  "x-fern-sdk-method-name": "encode_credential",
16799
16730
  "x-fern-sdk-return-value": "action_attempt",
16800
16731
  "x-response-key": "action_attempt",
16801
- "x-undocumented": "Encoders are in alpha."
16732
+ "x-title": "Encode a Credential"
16802
16733
  }
16803
16734
  },
16804
16735
  "/acs/encoders/list": {
16805
16736
  post: {
16737
+ description: "Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
16806
16738
  operationId: "acsEncodersListPost",
16807
16739
  requestBody: {
16808
16740
  content: {
@@ -16811,8 +16743,17 @@ var openapi_default = {
16811
16743
  oneOf: [
16812
16744
  {
16813
16745
  properties: {
16814
- acs_system_id: { format: "uuid", type: "string" },
16815
- limit: { default: 500, format: "float", type: "number" }
16746
+ acs_system_id: {
16747
+ description: "ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.",
16748
+ format: "uuid",
16749
+ type: "string"
16750
+ },
16751
+ limit: {
16752
+ default: 500,
16753
+ description: "Number of `acs_encoders` to return.",
16754
+ format: "float",
16755
+ type: "number"
16756
+ }
16816
16757
  },
16817
16758
  required: ["acs_system_id"],
16818
16759
  type: "object"
@@ -16820,10 +16761,16 @@ var openapi_default = {
16820
16761
  {
16821
16762
  properties: {
16822
16763
  acs_system_ids: {
16764
+ description: "IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.",
16823
16765
  items: { format: "uuid", type: "string" },
16824
16766
  type: "array"
16825
16767
  },
16826
- limit: { default: 500, format: "float", type: "number" }
16768
+ limit: {
16769
+ default: 500,
16770
+ description: "Number of `acs_encoders` to return.",
16771
+ format: "float",
16772
+ type: "number"
16773
+ }
16827
16774
  },
16828
16775
  required: ["acs_system_ids"],
16829
16776
  type: "object"
@@ -16831,10 +16778,16 @@ var openapi_default = {
16831
16778
  {
16832
16779
  properties: {
16833
16780
  acs_encoder_ids: {
16781
+ description: "IDs of the `acs_encoder`s that you want to retrieve.",
16834
16782
  items: { format: "uuid", type: "string" },
16835
16783
  type: "array"
16836
16784
  },
16837
- limit: { default: 500, format: "float", type: "number" }
16785
+ limit: {
16786
+ default: 500,
16787
+ description: "Number of `acs_encoders` to return.",
16788
+ format: "float",
16789
+ type: "number"
16790
+ }
16838
16791
  },
16839
16792
  required: ["acs_encoder_ids"],
16840
16793
  type: "object"
@@ -16938,11 +16891,12 @@ var openapi_default = {
16938
16891
  "x-fern-sdk-method-name": "list",
16939
16892
  "x-fern-sdk-return-value": "acs_encoders",
16940
16893
  "x-response-key": "acs_encoders",
16941
- "x-undocumented": "Encoders are in alpha."
16894
+ "x-title": "List Encoders"
16942
16895
  }
16943
16896
  },
16944
16897
  "/acs/encoders/scan_credential": {
16945
16898
  post: {
16899
+ description: "Scans an encoded [acs_credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
16946
16900
  operationId: "acsEncodersScanCredentialPost",
16947
16901
  requestBody: {
16948
16902
  content: {
@@ -16950,7 +16904,7 @@ var openapi_default = {
16950
16904
  schema: {
16951
16905
  properties: {
16952
16906
  acs_encoder_id: {
16953
- description: "ID of the acs_encoder to use for the scan.",
16907
+ description: "ID of the `acs_encoder` to use for the scan.",
16954
16908
  format: "uuid",
16955
16909
  type: "string"
16956
16910
  }
@@ -16993,11 +16947,12 @@ var openapi_default = {
16993
16947
  "x-fern-sdk-method-name": "scan_credential",
16994
16948
  "x-fern-sdk-return-value": "action_attempt",
16995
16949
  "x-response-key": "action_attempt",
16996
- "x-undocumented": "Encoders are in alpha."
16950
+ "x-title": "Scan a Credential"
16997
16951
  }
16998
16952
  },
16999
16953
  "/acs/encoders/simulate/next_credential_encode_will_fail": {
17000
16954
  post: {
16955
+ description: "Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
17001
16956
  operationId: "acsEncodersSimulateNextCredentialEncodeWillFailPost",
17002
16957
  requestBody: {
17003
16958
  content: {
@@ -17007,9 +16962,14 @@ var openapi_default = {
17007
16962
  {
17008
16963
  additionalProperties: false,
17009
16964
  properties: {
17010
- acs_encoder_id: { format: "uuid", type: "string" },
16965
+ acs_encoder_id: {
16966
+ description: "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.",
16967
+ format: "uuid",
16968
+ type: "string"
16969
+ },
17011
16970
  error_code: {
17012
16971
  default: "no_credential_on_encoder",
16972
+ description: "Code of the error to simulate.",
17013
16973
  enum: ["no_credential_on_encoder"],
17014
16974
  type: "string"
17015
16975
  }
@@ -17020,9 +16980,18 @@ var openapi_default = {
17020
16980
  {
17021
16981
  additionalProperties: false,
17022
16982
  properties: {
17023
- acs_credential_id: { format: "uuid", type: "string" },
17024
- acs_encoder_id: { format: "uuid", type: "string" },
16983
+ acs_credential_id: {
16984
+ description: "ID of the `acs_credential` that will fail to be encoded onto a card in the next request.",
16985
+ format: "uuid",
16986
+ type: "string"
16987
+ },
16988
+ acs_encoder_id: {
16989
+ description: "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.",
16990
+ format: "uuid",
16991
+ type: "string"
16992
+ },
17025
16993
  error_code: {
16994
+ description: "Code of the error to simulate.",
17026
16995
  enum: ["uncategorized_error", "action_attempt_expired"],
17027
16996
  type: "string"
17028
16997
  }
@@ -17061,11 +17030,12 @@ var openapi_default = {
17061
17030
  "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
17062
17031
  "x-fern-sdk-method-name": "next_credential_encode_will_fail",
17063
17032
  "x-response-key": null,
17064
- "x-undocumented": "Encoder simulations are in alpha."
17033
+ "x-title": "Simulate that the Next Credential Encoding Will Fail"
17065
17034
  }
17066
17035
  },
17067
17036
  "/acs/encoders/simulate/next_credential_encode_will_succeed": {
17068
17037
  post: {
17038
+ description: "Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
17069
17039
  operationId: "acsEncodersSimulateNextCredentialEncodeWillSucceedPost",
17070
17040
  requestBody: {
17071
17041
  content: {
@@ -17073,9 +17043,14 @@ var openapi_default = {
17073
17043
  schema: {
17074
17044
  additionalProperties: false,
17075
17045
  properties: {
17076
- acs_encoder_id: { format: "uuid", type: "string" },
17046
+ acs_encoder_id: {
17047
+ description: "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.",
17048
+ format: "uuid",
17049
+ type: "string"
17050
+ },
17077
17051
  scenario: {
17078
17052
  default: "credential_is_issued",
17053
+ description: "Scenario to simulate.",
17079
17054
  enum: ["credential_is_issued"],
17080
17055
  type: "string"
17081
17056
  }
@@ -17112,11 +17087,12 @@ var openapi_default = {
17112
17087
  "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
17113
17088
  "x-fern-sdk-method-name": "next_credential_encode_will_succeed",
17114
17089
  "x-response-key": null,
17115
- "x-undocumented": "Encoder simulations are in alpha."
17090
+ "x-title": "Simulate that the Next Credential Encoding Will Succeed"
17116
17091
  }
17117
17092
  },
17118
17093
  "/acs/encoders/simulate/next_credential_scan_will_fail": {
17119
17094
  post: {
17095
+ description: "Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
17120
17096
  operationId: "acsEncodersSimulateNextCredentialScanWillFailPost",
17121
17097
  requestBody: {
17122
17098
  content: {
@@ -17126,7 +17102,11 @@ var openapi_default = {
17126
17102
  {
17127
17103
  additionalProperties: false,
17128
17104
  properties: {
17129
- acs_encoder_id: { format: "uuid", type: "string" },
17105
+ acs_encoder_id: {
17106
+ description: "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.",
17107
+ format: "uuid",
17108
+ type: "string"
17109
+ },
17130
17110
  error_code: {
17131
17111
  default: "no_credential_on_encoder",
17132
17112
  enum: ["no_credential_on_encoder"],
@@ -17143,7 +17123,11 @@ var openapi_default = {
17143
17123
  format: "uuid",
17144
17124
  type: "string"
17145
17125
  },
17146
- acs_encoder_id: { format: "uuid", type: "string" },
17126
+ acs_encoder_id: {
17127
+ description: "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.",
17128
+ format: "uuid",
17129
+ type: "string"
17130
+ },
17147
17131
  error_code: {
17148
17132
  enum: ["uncategorized_error", "action_attempt_expired"],
17149
17133
  type: "string"
@@ -17183,11 +17167,12 @@ var openapi_default = {
17183
17167
  "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
17184
17168
  "x-fern-sdk-method-name": "next_credential_scan_will_fail",
17185
17169
  "x-response-key": null,
17186
- "x-undocumented": "Encoder simulations are in alpha."
17170
+ "x-title": "Simulate that the Next Credential Scan Will Fail"
17187
17171
  }
17188
17172
  },
17189
17173
  "/acs/encoders/simulate/next_credential_scan_will_succeed": {
17190
17174
  post: {
17175
+ description: "Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
17191
17176
  operationId: "acsEncodersSimulateNextCredentialScanWillSucceedPost",
17192
17177
  requestBody: {
17193
17178
  content: {
@@ -17198,12 +17183,18 @@ var openapi_default = {
17198
17183
  additionalProperties: false,
17199
17184
  properties: {
17200
17185
  acs_credential_id_on_seam: {
17186
+ description: "ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.",
17187
+ format: "uuid",
17188
+ type: "string"
17189
+ },
17190
+ acs_encoder_id: {
17191
+ description: "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.",
17201
17192
  format: "uuid",
17202
17193
  type: "string"
17203
17194
  },
17204
- acs_encoder_id: { format: "uuid", type: "string" },
17205
17195
  scenario: {
17206
17196
  default: "credential_exists_on_seam",
17197
+ description: "Scenario to simulate.",
17207
17198
  enum: [
17208
17199
  "credential_exists_on_seam",
17209
17200
  "credential_on_encoder_needs_update"
@@ -17217,8 +17208,13 @@ var openapi_default = {
17217
17208
  {
17218
17209
  additionalProperties: false,
17219
17210
  properties: {
17220
- acs_encoder_id: { format: "uuid", type: "string" },
17211
+ acs_encoder_id: {
17212
+ description: "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.",
17213
+ format: "uuid",
17214
+ type: "string"
17215
+ },
17221
17216
  scenario: {
17217
+ description: "Scenario to simulate.",
17222
17218
  enum: ["credential_does_not_exist_on_seam"],
17223
17219
  type: "string"
17224
17220
  }
@@ -17229,8 +17225,13 @@ var openapi_default = {
17229
17225
  {
17230
17226
  additionalProperties: false,
17231
17227
  properties: {
17232
- acs_encoder_id: { format: "uuid", type: "string" },
17228
+ acs_encoder_id: {
17229
+ description: "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.",
17230
+ format: "uuid",
17231
+ type: "string"
17232
+ },
17233
17233
  scenario: {
17234
+ description: "Scenario to simulate.",
17234
17235
  enum: ["credential_on_encoder_is_empty"],
17235
17236
  type: "string"
17236
17237
  }
@@ -17269,7 +17270,7 @@ var openapi_default = {
17269
17270
  "x-fern-sdk-group-name": ["acs", "encoders", "simulate"],
17270
17271
  "x-fern-sdk-method-name": "next_credential_scan_will_succeed",
17271
17272
  "x-response-key": null,
17272
- "x-undocumented": "Encoder simulations are in alpha."
17273
+ "x-title": "Simulate that the Next Credential Scan Will Succeed"
17273
17274
  }
17274
17275
  },
17275
17276
  "/acs/entrances/get": {