@seamapi/types 1.323.0 → 1.325.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/dist/connect.cjs +1627 -773
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3829 -1177
  4. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +257 -5
  5. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +257 -5
  6. package/lib/seam/connect/models/acs/acs-system.d.ts +10 -10
  7. package/lib/seam/connect/models/devices/device.d.ts +419 -11
  8. package/lib/seam/connect/models/devices/device.js +103 -3
  9. package/lib/seam/connect/models/devices/device.js.map +1 -1
  10. package/lib/seam/connect/models/devices/phone.d.ts +258 -6
  11. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +258 -6
  12. package/lib/seam/connect/models/events/access-codes.js +32 -41
  13. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  14. package/lib/seam/connect/models/events/acs/common.js +9 -12
  15. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  16. package/lib/seam/connect/models/events/acs/credentials.js +2 -2
  17. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  18. package/lib/seam/connect/models/events/acs/encoders.js +6 -3
  19. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -1
  20. package/lib/seam/connect/models/events/acs/systems.js +3 -3
  21. package/lib/seam/connect/models/events/acs/systems.js.map +1 -1
  22. package/lib/seam/connect/models/events/acs/users.js +5 -3
  23. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  24. package/lib/seam/connect/models/events/action-attempts.js +10 -22
  25. package/lib/seam/connect/models/events/action-attempts.js.map +1 -1
  26. package/lib/seam/connect/models/events/client-sessions.js +5 -7
  27. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  28. package/lib/seam/connect/models/events/common.js +5 -2
  29. package/lib/seam/connect/models/events/common.js.map +1 -1
  30. package/lib/seam/connect/models/events/connect-webviews.js +10 -14
  31. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  32. package/lib/seam/connect/models/events/connected-accounts.js +15 -19
  33. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  34. package/lib/seam/connect/models/events/devices.js +43 -47
  35. package/lib/seam/connect/models/events/devices.js.map +1 -1
  36. package/lib/seam/connect/models/events/enrollment-automations.js +5 -7
  37. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  38. package/lib/seam/connect/models/events/phones.js +4 -6
  39. package/lib/seam/connect/models/events/phones.js.map +1 -1
  40. package/lib/seam/connect/openapi.d.ts +124 -222
  41. package/lib/seam/connect/openapi.js +1241 -475
  42. package/lib/seam/connect/openapi.js.map +1 -1
  43. package/lib/seam/connect/route-types.d.ts +2131 -545
  44. package/package.json +1 -1
  45. package/src/lib/seam/connect/models/devices/device.ts +118 -3
  46. package/src/lib/seam/connect/models/events/access-codes.ts +64 -41
  47. package/src/lib/seam/connect/models/events/acs/common.ts +13 -12
  48. package/src/lib/seam/connect/models/events/acs/credentials.ts +6 -2
  49. package/src/lib/seam/connect/models/events/acs/encoders.ts +12 -3
  50. package/src/lib/seam/connect/models/events/acs/systems.ts +9 -3
  51. package/src/lib/seam/connect/models/events/acs/users.ts +10 -4
  52. package/src/lib/seam/connect/models/events/action-attempts.ts +20 -22
  53. package/src/lib/seam/connect/models/events/client-sessions.ts +9 -7
  54. package/src/lib/seam/connect/models/events/common.ts +5 -2
  55. package/src/lib/seam/connect/models/events/connect-webviews.ts +18 -14
  56. package/src/lib/seam/connect/models/events/connected-accounts.ts +25 -19
  57. package/src/lib/seam/connect/models/events/devices.ts +75 -47
  58. package/src/lib/seam/connect/models/events/enrollment-automations.ts +9 -7
  59. package/src/lib/seam/connect/models/events/phones.ts +6 -6
  60. package/src/lib/seam/connect/openapi.ts +1449 -475
  61. package/src/lib/seam/connect/route-types.ts +2580 -630
@@ -48,13 +48,191 @@ export default {
48
48
  type: 'object',
49
49
  },
50
50
  {
51
- properties: {
52
- error_code: { type: 'string' },
53
- is_device_error: { enum: [true], type: 'boolean' },
54
- message: { type: 'string' },
55
- },
56
- required: ['message', 'is_device_error', 'error_code'],
57
- type: 'object',
51
+ description: 'Error associated with the `device`.',
52
+ oneOf: [
53
+ {
54
+ description: 'Device is offline',
55
+ properties: {
56
+ error_code: {
57
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
58
+ enum: ['device_offline'],
59
+ type: 'string',
60
+ },
61
+ is_device_error: { enum: [true], type: 'boolean' },
62
+ message: { type: 'string' },
63
+ },
64
+ required: ['message', 'is_device_error', 'error_code'],
65
+ type: 'object',
66
+ },
67
+ {
68
+ description: 'Device has been removed',
69
+ properties: {
70
+ error_code: {
71
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
72
+ enum: ['device_removed'],
73
+ type: 'string',
74
+ },
75
+ is_device_error: { enum: [true], type: 'boolean' },
76
+ message: { type: 'string' },
77
+ },
78
+ required: ['message', 'is_device_error', 'error_code'],
79
+ type: 'object',
80
+ },
81
+ {
82
+ description: 'Account is disconnected',
83
+ properties: {
84
+ error_code: {
85
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
86
+ enum: ['account_disconnected'],
87
+ type: 'string',
88
+ },
89
+ is_device_error: { enum: [true], type: 'boolean' },
90
+ message: { type: 'string' },
91
+ },
92
+ required: ['message', 'is_device_error', 'error_code'],
93
+ type: 'object',
94
+ },
95
+ {
96
+ description: 'Hub is disconnected',
97
+ properties: {
98
+ error_code: {
99
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
100
+ enum: ['hub_disconnected'],
101
+ type: 'string',
102
+ },
103
+ is_device_error: { enum: [true], type: 'boolean' },
104
+ message: { type: 'string' },
105
+ },
106
+ required: ['message', 'is_device_error', 'error_code'],
107
+ type: 'object',
108
+ },
109
+ {
110
+ description: 'Device is disconnected',
111
+ properties: {
112
+ error_code: {
113
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
114
+ enum: ['device_disconnected'],
115
+ type: 'string',
116
+ },
117
+ is_device_error: { enum: [true], type: 'boolean' },
118
+ message: { type: 'string' },
119
+ },
120
+ required: ['message', 'is_device_error', 'error_code'],
121
+ type: 'object',
122
+ },
123
+ {
124
+ description: 'The backup access code pool is empty.',
125
+ properties: {
126
+ error_code: {
127
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
128
+ enum: ['empty_backup_access_code_pool'],
129
+ type: 'string',
130
+ },
131
+ is_device_error: { enum: [true], type: 'boolean' },
132
+ message: { type: 'string' },
133
+ },
134
+ required: ['message', 'is_device_error', 'error_code'],
135
+ type: 'object',
136
+ },
137
+ {
138
+ description: 'User is not authorized to use the August Lock.',
139
+ properties: {
140
+ error_code: {
141
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
142
+ enum: ['august_lock_not_authorized'],
143
+ type: 'string',
144
+ },
145
+ is_device_error: { enum: [true], type: 'boolean' },
146
+ message: { type: 'string' },
147
+ },
148
+ required: ['message', 'is_device_error', 'error_code'],
149
+ type: 'object',
150
+ },
151
+ {
152
+ description: 'Lock is not connected to the Seam Bridge.',
153
+ properties: {
154
+ error_code: {
155
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
156
+ enum: ['august_lock_missing_bridge'],
157
+ type: 'string',
158
+ },
159
+ is_device_error: { enum: [true], type: 'boolean' },
160
+ message: { type: 'string' },
161
+ },
162
+ required: ['message', 'is_device_error', 'error_code'],
163
+ type: 'object',
164
+ },
165
+ {
166
+ description: 'Salto site user limit reached.',
167
+ properties: {
168
+ error_code: {
169
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
170
+ enum: ['salto_site_user_limit_reached'],
171
+ type: 'string',
172
+ },
173
+ is_device_error: { enum: [true], type: 'boolean' },
174
+ message: { type: 'string' },
175
+ },
176
+ required: ['message', 'is_device_error', 'error_code'],
177
+ type: 'object',
178
+ },
179
+ {
180
+ description: 'Lock is not paired with a Gateway.',
181
+ properties: {
182
+ error_code: {
183
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
184
+ enum: ['ttlock_lock_not_paired_to_gateway'],
185
+ type: 'string',
186
+ },
187
+ is_device_error: { enum: [true], type: 'boolean' },
188
+ message: { type: 'string' },
189
+ },
190
+ required: ['message', 'is_device_error', 'error_code'],
191
+ type: 'object',
192
+ },
193
+ {
194
+ description: 'Missing device credentials.',
195
+ properties: {
196
+ error_code: {
197
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
198
+ enum: ['missing_device_credentials'],
199
+ type: 'string',
200
+ },
201
+ is_device_error: { enum: [true], type: 'boolean' },
202
+ message: { type: 'string' },
203
+ },
204
+ required: ['message', 'is_device_error', 'error_code'],
205
+ type: 'object',
206
+ },
207
+ {
208
+ description: 'The auxiliary heat is running.',
209
+ properties: {
210
+ error_code: {
211
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
212
+ enum: ['auxiliary_heat_running'],
213
+ type: 'string',
214
+ },
215
+ is_device_error: { enum: [true], type: 'boolean' },
216
+ message: { type: 'string' },
217
+ },
218
+ required: ['message', 'is_device_error', 'error_code'],
219
+ type: 'object',
220
+ },
221
+ {
222
+ description: 'Subscription required to connect.',
223
+ properties: {
224
+ error_code: {
225
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
226
+ enum: ['subscription_required'],
227
+ type: 'string',
228
+ },
229
+ is_device_error: { enum: [true], type: 'boolean' },
230
+ message: { type: 'string' },
231
+ },
232
+ required: ['message', 'is_device_error', 'error_code'],
233
+ type: 'object',
234
+ },
235
+ ],
58
236
  },
59
237
  {
60
238
  properties: {
@@ -4104,13 +4282,191 @@ export default {
4104
4282
  items: {
4105
4283
  oneOf: [
4106
4284
  {
4107
- properties: {
4108
- error_code: { type: 'string' },
4109
- is_device_error: { enum: [true], type: 'boolean' },
4110
- message: { type: 'string' },
4111
- },
4112
- required: ['message', 'is_device_error', 'error_code'],
4113
- type: 'object',
4285
+ description: 'Error associated with the `device`.',
4286
+ oneOf: [
4287
+ {
4288
+ description: 'Device is offline',
4289
+ properties: {
4290
+ error_code: {
4291
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4292
+ enum: ['device_offline'],
4293
+ type: 'string',
4294
+ },
4295
+ is_device_error: { enum: [true], type: 'boolean' },
4296
+ message: { type: 'string' },
4297
+ },
4298
+ required: ['message', 'is_device_error', 'error_code'],
4299
+ type: 'object',
4300
+ },
4301
+ {
4302
+ description: 'Device has been removed',
4303
+ properties: {
4304
+ error_code: {
4305
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4306
+ enum: ['device_removed'],
4307
+ type: 'string',
4308
+ },
4309
+ is_device_error: { enum: [true], type: 'boolean' },
4310
+ message: { type: 'string' },
4311
+ },
4312
+ required: ['message', 'is_device_error', 'error_code'],
4313
+ type: 'object',
4314
+ },
4315
+ {
4316
+ description: 'Account is disconnected',
4317
+ properties: {
4318
+ error_code: {
4319
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4320
+ enum: ['account_disconnected'],
4321
+ type: 'string',
4322
+ },
4323
+ is_device_error: { enum: [true], type: 'boolean' },
4324
+ message: { type: 'string' },
4325
+ },
4326
+ required: ['message', 'is_device_error', 'error_code'],
4327
+ type: 'object',
4328
+ },
4329
+ {
4330
+ description: 'Hub is disconnected',
4331
+ properties: {
4332
+ error_code: {
4333
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4334
+ enum: ['hub_disconnected'],
4335
+ type: 'string',
4336
+ },
4337
+ is_device_error: { enum: [true], type: 'boolean' },
4338
+ message: { type: 'string' },
4339
+ },
4340
+ required: ['message', 'is_device_error', 'error_code'],
4341
+ type: 'object',
4342
+ },
4343
+ {
4344
+ description: 'Device is disconnected',
4345
+ properties: {
4346
+ error_code: {
4347
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4348
+ enum: ['device_disconnected'],
4349
+ type: 'string',
4350
+ },
4351
+ is_device_error: { enum: [true], type: 'boolean' },
4352
+ message: { type: 'string' },
4353
+ },
4354
+ required: ['message', 'is_device_error', 'error_code'],
4355
+ type: 'object',
4356
+ },
4357
+ {
4358
+ description: 'The backup access code pool is empty.',
4359
+ properties: {
4360
+ error_code: {
4361
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4362
+ enum: ['empty_backup_access_code_pool'],
4363
+ type: 'string',
4364
+ },
4365
+ is_device_error: { enum: [true], type: 'boolean' },
4366
+ message: { type: 'string' },
4367
+ },
4368
+ required: ['message', 'is_device_error', 'error_code'],
4369
+ type: 'object',
4370
+ },
4371
+ {
4372
+ description: 'User is not authorized to use the August Lock.',
4373
+ properties: {
4374
+ error_code: {
4375
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4376
+ enum: ['august_lock_not_authorized'],
4377
+ type: 'string',
4378
+ },
4379
+ is_device_error: { enum: [true], type: 'boolean' },
4380
+ message: { type: 'string' },
4381
+ },
4382
+ required: ['message', 'is_device_error', 'error_code'],
4383
+ type: 'object',
4384
+ },
4385
+ {
4386
+ description: 'Lock is not connected to the Seam Bridge.',
4387
+ properties: {
4388
+ error_code: {
4389
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4390
+ enum: ['august_lock_missing_bridge'],
4391
+ type: 'string',
4392
+ },
4393
+ is_device_error: { enum: [true], type: 'boolean' },
4394
+ message: { type: 'string' },
4395
+ },
4396
+ required: ['message', 'is_device_error', 'error_code'],
4397
+ type: 'object',
4398
+ },
4399
+ {
4400
+ description: 'Salto site user limit reached.',
4401
+ properties: {
4402
+ error_code: {
4403
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4404
+ enum: ['salto_site_user_limit_reached'],
4405
+ type: 'string',
4406
+ },
4407
+ is_device_error: { enum: [true], type: 'boolean' },
4408
+ message: { type: 'string' },
4409
+ },
4410
+ required: ['message', 'is_device_error', 'error_code'],
4411
+ type: 'object',
4412
+ },
4413
+ {
4414
+ description: 'Lock is not paired with a Gateway.',
4415
+ properties: {
4416
+ error_code: {
4417
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4418
+ enum: ['ttlock_lock_not_paired_to_gateway'],
4419
+ type: 'string',
4420
+ },
4421
+ is_device_error: { enum: [true], type: 'boolean' },
4422
+ message: { type: 'string' },
4423
+ },
4424
+ required: ['message', 'is_device_error', 'error_code'],
4425
+ type: 'object',
4426
+ },
4427
+ {
4428
+ description: 'Missing device credentials.',
4429
+ properties: {
4430
+ error_code: {
4431
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4432
+ enum: ['missing_device_credentials'],
4433
+ type: 'string',
4434
+ },
4435
+ is_device_error: { enum: [true], type: 'boolean' },
4436
+ message: { type: 'string' },
4437
+ },
4438
+ required: ['message', 'is_device_error', 'error_code'],
4439
+ type: 'object',
4440
+ },
4441
+ {
4442
+ description: 'The auxiliary heat is running.',
4443
+ properties: {
4444
+ error_code: {
4445
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4446
+ enum: ['auxiliary_heat_running'],
4447
+ type: 'string',
4448
+ },
4449
+ is_device_error: { enum: [true], type: 'boolean' },
4450
+ message: { type: 'string' },
4451
+ },
4452
+ required: ['message', 'is_device_error', 'error_code'],
4453
+ type: 'object',
4454
+ },
4455
+ {
4456
+ description: 'Subscription required to connect.',
4457
+ properties: {
4458
+ error_code: {
4459
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4460
+ enum: ['subscription_required'],
4461
+ type: 'string',
4462
+ },
4463
+ is_device_error: { enum: [true], type: 'boolean' },
4464
+ message: { type: 'string' },
4465
+ },
4466
+ required: ['message', 'is_device_error', 'error_code'],
4467
+ type: 'object',
4468
+ },
4469
+ ],
4114
4470
  },
4115
4471
  {
4116
4472
  properties: {
@@ -5513,30 +5869,27 @@ export default {
5513
5869
  discriminator: { propertyName: 'event_type' },
5514
5870
  oneOf: [
5515
5871
  {
5516
- description: 'An access code was created.',
5872
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.',
5517
5873
  properties: {
5518
5874
  access_code_id: {
5519
- description: 'The ID of the access code.',
5875
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5520
5876
  format: 'uuid',
5521
5877
  type: 'string',
5522
- 'x-title': 'Access Code ID',
5523
5878
  },
5524
5879
  connected_account_id: {
5525
- description: 'The ID of the connected account.',
5880
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5526
5881
  format: 'uuid',
5527
5882
  type: 'string',
5528
- 'x-title': 'Connected Account ID',
5529
5883
  },
5530
5884
  created_at: {
5531
- description: 'Time at which the event was created.',
5885
+ description: 'Date and time at which the event was created.',
5532
5886
  format: 'date-time',
5533
5887
  type: 'string',
5534
5888
  },
5535
5889
  device_id: {
5536
- description: 'The ID of the device.',
5890
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5537
5891
  format: 'uuid',
5538
5892
  type: 'string',
5539
- 'x-title': 'Device ID',
5540
5893
  },
5541
5894
  event_id: {
5542
5895
  description: 'ID of the event.',
@@ -5545,7 +5898,7 @@ export default {
5545
5898
  },
5546
5899
  event_type: { enum: ['access_code.created'], type: 'string' },
5547
5900
  occurred_at: {
5548
- description: 'Time when the event occurred.',
5901
+ description: 'Date and time at which the event occurred.',
5549
5902
  format: 'date-time',
5550
5903
  type: 'string',
5551
5904
  },
@@ -5568,30 +5921,27 @@ export default {
5568
5921
  type: 'object',
5569
5922
  },
5570
5923
  {
5571
- description: 'An access code was changed.',
5924
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.',
5572
5925
  properties: {
5573
5926
  access_code_id: {
5574
- description: 'The ID of the access code.',
5927
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5575
5928
  format: 'uuid',
5576
5929
  type: 'string',
5577
- 'x-title': 'Access Code ID',
5578
5930
  },
5579
5931
  connected_account_id: {
5580
- description: 'The ID of the connected account.',
5932
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5581
5933
  format: 'uuid',
5582
5934
  type: 'string',
5583
- 'x-title': 'Connected Account ID',
5584
5935
  },
5585
5936
  created_at: {
5586
- description: 'Time at which the event was created.',
5937
+ description: 'Date and time at which the event was created.',
5587
5938
  format: 'date-time',
5588
5939
  type: 'string',
5589
5940
  },
5590
5941
  device_id: {
5591
- description: 'The ID of the device.',
5942
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5592
5943
  format: 'uuid',
5593
5944
  type: 'string',
5594
- 'x-title': 'Device ID',
5595
5945
  },
5596
5946
  event_id: {
5597
5947
  description: 'ID of the event.',
@@ -5600,7 +5950,7 @@ export default {
5600
5950
  },
5601
5951
  event_type: { enum: ['access_code.changed'], type: 'string' },
5602
5952
  occurred_at: {
5603
- description: 'Time when the event occurred.',
5953
+ description: 'Date and time at which the event occurred.',
5604
5954
  format: 'date-time',
5605
5955
  type: 'string',
5606
5956
  },
@@ -5623,35 +5973,31 @@ export default {
5623
5973
  type: 'object',
5624
5974
  },
5625
5975
  {
5626
- description: 'An access code was natively scheduled on a device.',
5976
+ 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.',
5627
5977
  properties: {
5628
5978
  access_code_id: {
5629
- description: 'The ID of the access code.',
5979
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5630
5980
  format: 'uuid',
5631
5981
  type: 'string',
5632
- 'x-title': 'Access Code ID',
5633
5982
  },
5634
5983
  code: {
5635
- description: 'The code of the access code.',
5984
+ description: 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5636
5985
  type: 'string',
5637
- 'x-title': 'Access Code',
5638
5986
  },
5639
5987
  connected_account_id: {
5640
- description: 'The ID of the connected account.',
5988
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5641
5989
  format: 'uuid',
5642
5990
  type: 'string',
5643
- 'x-title': 'Connected Account ID',
5644
5991
  },
5645
5992
  created_at: {
5646
- description: 'Time at which the event was created.',
5993
+ description: 'Date and time at which the event was created.',
5647
5994
  format: 'date-time',
5648
5995
  type: 'string',
5649
5996
  },
5650
5997
  device_id: {
5651
- description: 'The ID of the device.',
5998
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5652
5999
  format: 'uuid',
5653
6000
  type: 'string',
5654
- 'x-title': 'Device ID',
5655
6001
  },
5656
6002
  event_id: {
5657
6003
  description: 'ID of the event.',
@@ -5663,7 +6009,7 @@ export default {
5663
6009
  type: 'string',
5664
6010
  },
5665
6011
  occurred_at: {
5666
- description: 'Time when the event occurred.',
6012
+ description: 'Date and time at which the event occurred.',
5667
6013
  format: 'date-time',
5668
6014
  type: 'string',
5669
6015
  },
@@ -5687,35 +6033,31 @@ export default {
5687
6033
  type: 'object',
5688
6034
  },
5689
6035
  {
5690
- description: 'An access code was set on a device.',
6036
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.',
5691
6037
  properties: {
5692
6038
  access_code_id: {
5693
- description: 'The ID of the access code.',
6039
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5694
6040
  format: 'uuid',
5695
6041
  type: 'string',
5696
- 'x-title': 'Access Code ID',
5697
6042
  },
5698
6043
  code: {
5699
- description: 'The code of the access code.',
6044
+ description: 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5700
6045
  type: 'string',
5701
- 'x-title': 'Access Code',
5702
6046
  },
5703
6047
  connected_account_id: {
5704
- description: 'The ID of the connected account.',
6048
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5705
6049
  format: 'uuid',
5706
6050
  type: 'string',
5707
- 'x-title': 'Connected Account ID',
5708
6051
  },
5709
6052
  created_at: {
5710
- description: 'Time at which the event was created.',
6053
+ description: 'Date and time at which the event was created.',
5711
6054
  format: 'date-time',
5712
6055
  type: 'string',
5713
6056
  },
5714
6057
  device_id: {
5715
- description: 'The ID of the device.',
6058
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5716
6059
  format: 'uuid',
5717
6060
  type: 'string',
5718
- 'x-title': 'Device ID',
5719
6061
  },
5720
6062
  event_id: {
5721
6063
  description: 'ID of the event.',
@@ -5727,7 +6069,7 @@ export default {
5727
6069
  type: 'string',
5728
6070
  },
5729
6071
  occurred_at: {
5730
- description: 'Time when the event occurred.',
6072
+ description: 'Date and time at which the event occurred.',
5731
6073
  format: 'date-time',
5732
6074
  type: 'string',
5733
6075
  },
@@ -5751,30 +6093,27 @@ export default {
5751
6093
  type: 'object',
5752
6094
  },
5753
6095
  {
5754
- description: 'An access code was removed from a device.',
6096
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.',
5755
6097
  properties: {
5756
6098
  access_code_id: {
5757
- description: 'The ID of the access code.',
6099
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5758
6100
  format: 'uuid',
5759
6101
  type: 'string',
5760
- 'x-title': 'Access Code ID',
5761
6102
  },
5762
6103
  connected_account_id: {
5763
- description: 'The ID of the connected account.',
6104
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5764
6105
  format: 'uuid',
5765
6106
  type: 'string',
5766
- 'x-title': 'Connected Account ID',
5767
6107
  },
5768
6108
  created_at: {
5769
- description: 'Time at which the event was created.',
6109
+ description: 'Date and time at which the event was created.',
5770
6110
  format: 'date-time',
5771
6111
  type: 'string',
5772
6112
  },
5773
6113
  device_id: {
5774
- description: 'The ID of the device.',
6114
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5775
6115
  format: 'uuid',
5776
6116
  type: 'string',
5777
- 'x-title': 'Device ID',
5778
6117
  },
5779
6118
  event_id: {
5780
6119
  description: 'ID of the event.',
@@ -5786,7 +6125,7 @@ export default {
5786
6125
  type: 'string',
5787
6126
  },
5788
6127
  occurred_at: {
5789
- description: 'Time when the event occurred.',
6128
+ description: 'Date and time at which the event occurred.',
5790
6129
  format: 'date-time',
5791
6130
  type: 'string',
5792
6131
  },
@@ -5809,30 +6148,27 @@ export default {
5809
6148
  type: 'object',
5810
6149
  },
5811
6150
  {
5812
- description: 'There was an unusually long delay in setting an access code on a device.',
6151
+ 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.',
5813
6152
  properties: {
5814
6153
  access_code_id: {
5815
- description: 'The ID of the access code.',
6154
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5816
6155
  format: 'uuid',
5817
6156
  type: 'string',
5818
- 'x-title': 'Access Code ID',
5819
6157
  },
5820
6158
  connected_account_id: {
5821
- description: 'The ID of the connected account.',
6159
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5822
6160
  format: 'uuid',
5823
6161
  type: 'string',
5824
- 'x-title': 'Connected Account ID',
5825
6162
  },
5826
6163
  created_at: {
5827
- description: 'Time at which the event was created.',
6164
+ description: 'Date and time at which the event was created.',
5828
6165
  format: 'date-time',
5829
6166
  type: 'string',
5830
6167
  },
5831
6168
  device_id: {
5832
- description: 'The ID of the device.',
6169
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5833
6170
  format: 'uuid',
5834
6171
  type: 'string',
5835
- 'x-title': 'Device ID',
5836
6172
  },
5837
6173
  event_id: {
5838
6174
  description: 'ID of the event.',
@@ -5844,7 +6180,7 @@ export default {
5844
6180
  type: 'string',
5845
6181
  },
5846
6182
  occurred_at: {
5847
- description: 'Time when the event occurred.',
6183
+ description: 'Date and time at which the event occurred.',
5848
6184
  format: 'date-time',
5849
6185
  type: 'string',
5850
6186
  },
@@ -5867,30 +6203,27 @@ export default {
5867
6203
  type: 'object',
5868
6204
  },
5869
6205
  {
5870
- description: 'An access code failed to be set on a device.',
6206
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.',
5871
6207
  properties: {
5872
6208
  access_code_id: {
5873
- description: 'The ID of the access code.',
6209
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5874
6210
  format: 'uuid',
5875
6211
  type: 'string',
5876
- 'x-title': 'Access Code ID',
5877
6212
  },
5878
6213
  connected_account_id: {
5879
- description: 'The ID of the connected account.',
6214
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5880
6215
  format: 'uuid',
5881
6216
  type: 'string',
5882
- 'x-title': 'Connected Account ID',
5883
6217
  },
5884
6218
  created_at: {
5885
- description: 'Time at which the event was created.',
6219
+ description: 'Date and time at which the event was created.',
5886
6220
  format: 'date-time',
5887
6221
  type: 'string',
5888
6222
  },
5889
6223
  device_id: {
5890
- description: 'The ID of the device.',
6224
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5891
6225
  format: 'uuid',
5892
6226
  type: 'string',
5893
- 'x-title': 'Device ID',
5894
6227
  },
5895
6228
  event_id: {
5896
6229
  description: 'ID of the event.',
@@ -5902,7 +6235,7 @@ export default {
5902
6235
  type: 'string',
5903
6236
  },
5904
6237
  occurred_at: {
5905
- description: 'Time when the event occurred.',
6238
+ description: 'Date and time at which the event occurred.',
5906
6239
  format: 'date-time',
5907
6240
  type: 'string',
5908
6241
  },
@@ -5925,36 +6258,32 @@ export default {
5925
6258
  type: 'object',
5926
6259
  },
5927
6260
  {
5928
- description: 'An access code was deleted.',
6261
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.',
5929
6262
  properties: {
5930
6263
  access_code_id: {
5931
- description: 'The ID of the access code.',
6264
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5932
6265
  format: 'uuid',
5933
6266
  type: 'string',
5934
- 'x-title': 'Access Code ID',
5935
6267
  },
5936
6268
  code: {
5937
- description: 'The code of the access code.',
6269
+ description: 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5938
6270
  nullable: true,
5939
6271
  type: 'string',
5940
- 'x-title': 'Access Code',
5941
6272
  },
5942
6273
  connected_account_id: {
5943
- description: 'The ID of the connected account.',
6274
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5944
6275
  format: 'uuid',
5945
6276
  type: 'string',
5946
- 'x-title': 'Connected Account ID',
5947
6277
  },
5948
6278
  created_at: {
5949
- description: 'Time at which the event was created.',
6279
+ description: 'Date and time at which the event was created.',
5950
6280
  format: 'date-time',
5951
6281
  type: 'string',
5952
6282
  },
5953
6283
  device_id: {
5954
- description: 'The ID of the device.',
6284
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5955
6285
  format: 'uuid',
5956
6286
  type: 'string',
5957
- 'x-title': 'Device ID',
5958
6287
  },
5959
6288
  event_id: {
5960
6289
  description: 'ID of the event.',
@@ -5963,7 +6292,7 @@ export default {
5963
6292
  },
5964
6293
  event_type: { enum: ['access_code.deleted'], type: 'string' },
5965
6294
  occurred_at: {
5966
- description: 'Time when the event occurred.',
6295
+ description: 'Date and time at which the event occurred.',
5967
6296
  format: 'date-time',
5968
6297
  type: 'string',
5969
6298
  },
@@ -5987,30 +6316,27 @@ export default {
5987
6316
  type: 'object',
5988
6317
  },
5989
6318
  {
5990
- description: 'There was an unusually long delay in removing an access code from a device.',
6319
+ 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.',
5991
6320
  properties: {
5992
6321
  access_code_id: {
5993
- description: 'The ID of the access code.',
6322
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5994
6323
  format: 'uuid',
5995
6324
  type: 'string',
5996
- 'x-title': 'Access Code ID',
5997
6325
  },
5998
6326
  connected_account_id: {
5999
- description: 'The ID of the connected account.',
6327
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6000
6328
  format: 'uuid',
6001
6329
  type: 'string',
6002
- 'x-title': 'Connected Account ID',
6003
6330
  },
6004
6331
  created_at: {
6005
- description: 'Time at which the event was created.',
6332
+ description: 'Date and time at which the event was created.',
6006
6333
  format: 'date-time',
6007
6334
  type: 'string',
6008
6335
  },
6009
6336
  device_id: {
6010
- description: 'The ID of the device.',
6337
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6011
6338
  format: 'uuid',
6012
6339
  type: 'string',
6013
- 'x-title': 'Device ID',
6014
6340
  },
6015
6341
  event_id: {
6016
6342
  description: 'ID of the event.',
@@ -6022,7 +6348,7 @@ export default {
6022
6348
  type: 'string',
6023
6349
  },
6024
6350
  occurred_at: {
6025
- description: 'Time when the event occurred.',
6351
+ description: 'Date and time at which the event occurred.',
6026
6352
  format: 'date-time',
6027
6353
  type: 'string',
6028
6354
  },
@@ -6045,30 +6371,27 @@ export default {
6045
6371
  type: 'object',
6046
6372
  },
6047
6373
  {
6048
- description: 'An access code failed to be removed from a device.',
6374
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.',
6049
6375
  properties: {
6050
6376
  access_code_id: {
6051
- description: 'The ID of the access code.',
6377
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6052
6378
  format: 'uuid',
6053
6379
  type: 'string',
6054
- 'x-title': 'Access Code ID',
6055
6380
  },
6056
6381
  connected_account_id: {
6057
- description: 'The ID of the connected account.',
6382
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6058
6383
  format: 'uuid',
6059
6384
  type: 'string',
6060
- 'x-title': 'Connected Account ID',
6061
6385
  },
6062
6386
  created_at: {
6063
- description: 'Time at which the event was created.',
6387
+ description: 'Date and time at which the event was created.',
6064
6388
  format: 'date-time',
6065
6389
  type: 'string',
6066
6390
  },
6067
6391
  device_id: {
6068
- description: 'The ID of the device.',
6392
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6069
6393
  format: 'uuid',
6070
6394
  type: 'string',
6071
- 'x-title': 'Device ID',
6072
6395
  },
6073
6396
  event_id: {
6074
6397
  description: 'ID of the event.',
@@ -6080,7 +6403,7 @@ export default {
6080
6403
  type: 'string',
6081
6404
  },
6082
6405
  occurred_at: {
6083
- description: 'Time when the event occurred.',
6406
+ description: 'Date and time at which the event occurred.',
6084
6407
  format: 'date-time',
6085
6408
  type: 'string',
6086
6409
  },
@@ -6103,30 +6426,27 @@ export default {
6103
6426
  type: 'object',
6104
6427
  },
6105
6428
  {
6106
- description: 'An access code was modified external to Seam.',
6429
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.',
6107
6430
  properties: {
6108
6431
  access_code_id: {
6109
- description: 'The ID of the access code.',
6432
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6110
6433
  format: 'uuid',
6111
6434
  type: 'string',
6112
- 'x-title': 'Access Code ID',
6113
6435
  },
6114
6436
  connected_account_id: {
6115
- description: 'The ID of the connected account.',
6437
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6116
6438
  format: 'uuid',
6117
6439
  type: 'string',
6118
- 'x-title': 'Connected Account ID',
6119
6440
  },
6120
6441
  created_at: {
6121
- description: 'Time at which the event was created.',
6442
+ description: 'Date and time at which the event was created.',
6122
6443
  format: 'date-time',
6123
6444
  type: 'string',
6124
6445
  },
6125
6446
  device_id: {
6126
- description: 'The ID of the device.',
6447
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6127
6448
  format: 'uuid',
6128
6449
  type: 'string',
6129
- 'x-title': 'Device ID',
6130
6450
  },
6131
6451
  event_id: {
6132
6452
  description: 'ID of the event.',
@@ -6138,7 +6458,7 @@ export default {
6138
6458
  type: 'string',
6139
6459
  },
6140
6460
  occurred_at: {
6141
- description: 'Time when the event occurred.',
6461
+ description: 'Date and time at which the event occurred.',
6142
6462
  format: 'date-time',
6143
6463
  type: 'string',
6144
6464
  },
@@ -6161,30 +6481,27 @@ export default {
6161
6481
  type: 'object',
6162
6482
  },
6163
6483
  {
6164
- description: 'An access code was deleted external to Seam.',
6484
+ description: 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.',
6165
6485
  properties: {
6166
6486
  access_code_id: {
6167
- description: 'The ID of the access code.',
6487
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6168
6488
  format: 'uuid',
6169
6489
  type: 'string',
6170
- 'x-title': 'Access Code ID',
6171
6490
  },
6172
6491
  connected_account_id: {
6173
- description: 'The ID of the connected account.',
6492
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6174
6493
  format: 'uuid',
6175
6494
  type: 'string',
6176
- 'x-title': 'Connected Account ID',
6177
6495
  },
6178
6496
  created_at: {
6179
- description: 'Time at which the event was created.',
6497
+ description: 'Date and time at which the event was created.',
6180
6498
  format: 'date-time',
6181
6499
  type: 'string',
6182
6500
  },
6183
6501
  device_id: {
6184
- description: 'The ID of the device.',
6502
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6185
6503
  format: 'uuid',
6186
6504
  type: 'string',
6187
- 'x-title': 'Device ID',
6188
6505
  },
6189
6506
  event_id: {
6190
6507
  description: 'ID of the event.',
@@ -6196,7 +6513,7 @@ export default {
6196
6513
  type: 'string',
6197
6514
  },
6198
6515
  occurred_at: {
6199
- description: 'Time when the event occurred.',
6516
+ description: 'Date and time at which the event occurred.',
6200
6517
  format: 'date-time',
6201
6518
  type: 'string',
6202
6519
  },
@@ -6219,31 +6536,28 @@ export default {
6219
6536
  type: 'object',
6220
6537
  },
6221
6538
  {
6222
- description: 'A backup access code was pulled from the backup access code pool and set on a device.',
6539
+ 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.',
6223
6540
  properties: {
6224
6541
  access_code_id: {
6225
- description: 'The ID of the access code.',
6542
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6226
6543
  format: 'uuid',
6227
6544
  type: 'string',
6228
- 'x-title': 'Access Code ID',
6229
6545
  },
6230
6546
  backup_access_code_id: { type: 'string' },
6231
6547
  connected_account_id: {
6232
- description: 'The ID of the connected account.',
6548
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6233
6549
  format: 'uuid',
6234
6550
  type: 'string',
6235
- 'x-title': 'Connected Account ID',
6236
6551
  },
6237
6552
  created_at: {
6238
- description: 'Time at which the event was created.',
6553
+ description: 'Date and time at which the event was created.',
6239
6554
  format: 'date-time',
6240
6555
  type: 'string',
6241
6556
  },
6242
6557
  device_id: {
6243
- description: 'The ID of the device.',
6558
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6244
6559
  format: 'uuid',
6245
6560
  type: 'string',
6246
- 'x-title': 'Device ID',
6247
6561
  },
6248
6562
  event_id: {
6249
6563
  description: 'ID of the event.',
@@ -6255,7 +6569,7 @@ export default {
6255
6569
  type: 'string',
6256
6570
  },
6257
6571
  occurred_at: {
6258
- description: 'Time when the event occurred.',
6572
+ description: 'Date and time at which the event occurred.',
6259
6573
  format: 'date-time',
6260
6574
  type: 'string',
6261
6575
  },
@@ -6279,30 +6593,27 @@ export default {
6279
6593
  type: 'object',
6280
6594
  },
6281
6595
  {
6282
- description: 'An unmanaged access code was successfully converted to a managed access code.',
6596
+ 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.',
6283
6597
  properties: {
6284
6598
  access_code_id: {
6285
- description: 'The ID of the access code.',
6599
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6286
6600
  format: 'uuid',
6287
6601
  type: 'string',
6288
- 'x-title': 'Access Code ID',
6289
6602
  },
6290
6603
  connected_account_id: {
6291
- description: 'The ID of the connected account.',
6604
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6292
6605
  format: 'uuid',
6293
6606
  type: 'string',
6294
- 'x-title': 'Connected Account ID',
6295
6607
  },
6296
6608
  created_at: {
6297
- description: 'Time at which the event was created.',
6609
+ description: 'Date and time at which the event was created.',
6298
6610
  format: 'date-time',
6299
6611
  type: 'string',
6300
6612
  },
6301
6613
  device_id: {
6302
- description: 'The ID of the device.',
6614
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6303
6615
  format: 'uuid',
6304
6616
  type: 'string',
6305
- 'x-title': 'Device ID',
6306
6617
  },
6307
6618
  event_id: {
6308
6619
  description: 'ID of the event.',
@@ -6314,7 +6625,7 @@ export default {
6314
6625
  type: 'string',
6315
6626
  },
6316
6627
  occurred_at: {
6317
- description: 'Time when the event occurred.',
6628
+ description: 'Date and time at which the event occurred.',
6318
6629
  format: 'date-time',
6319
6630
  type: 'string',
6320
6631
  },
@@ -6337,30 +6648,27 @@ export default {
6337
6648
  type: 'object',
6338
6649
  },
6339
6650
  {
6340
- description: 'An unmanaged access code failed to be converted to a managed access code.',
6651
+ 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.',
6341
6652
  properties: {
6342
6653
  access_code_id: {
6343
- description: 'The ID of the access code.',
6654
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6344
6655
  format: 'uuid',
6345
6656
  type: 'string',
6346
- 'x-title': 'Access Code ID',
6347
6657
  },
6348
6658
  connected_account_id: {
6349
- description: 'The ID of the connected account.',
6659
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6350
6660
  format: 'uuid',
6351
6661
  type: 'string',
6352
- 'x-title': 'Connected Account ID',
6353
6662
  },
6354
6663
  created_at: {
6355
- description: 'Time at which the event was created.',
6664
+ description: 'Date and time at which the event was created.',
6356
6665
  format: 'date-time',
6357
6666
  type: 'string',
6358
6667
  },
6359
6668
  device_id: {
6360
- description: 'The ID of the device.',
6669
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6361
6670
  format: 'uuid',
6362
6671
  type: 'string',
6363
- 'x-title': 'Device ID',
6364
6672
  },
6365
6673
  event_id: {
6366
6674
  description: 'ID of the event.',
@@ -6372,7 +6680,7 @@ export default {
6372
6680
  type: 'string',
6373
6681
  },
6374
6682
  occurred_at: {
6375
- description: 'Time when the event occurred.',
6683
+ description: 'Date and time at which the event occurred.',
6376
6684
  format: 'date-time',
6377
6685
  type: 'string',
6378
6686
  },
@@ -6395,30 +6703,27 @@ export default {
6395
6703
  type: 'object',
6396
6704
  },
6397
6705
  {
6398
- description: 'An unmanaged access code was created on a device.',
6706
+ 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.',
6399
6707
  properties: {
6400
6708
  access_code_id: {
6401
- description: 'The ID of the access code.',
6709
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6402
6710
  format: 'uuid',
6403
6711
  type: 'string',
6404
- 'x-title': 'Access Code ID',
6405
6712
  },
6406
6713
  connected_account_id: {
6407
- description: 'The ID of the connected account.',
6714
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6408
6715
  format: 'uuid',
6409
6716
  type: 'string',
6410
- 'x-title': 'Connected Account ID',
6411
6717
  },
6412
6718
  created_at: {
6413
- description: 'Time at which the event was created.',
6719
+ description: 'Date and time at which the event was created.',
6414
6720
  format: 'date-time',
6415
6721
  type: 'string',
6416
6722
  },
6417
6723
  device_id: {
6418
- description: 'The ID of the device.',
6724
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6419
6725
  format: 'uuid',
6420
6726
  type: 'string',
6421
- 'x-title': 'Device ID',
6422
6727
  },
6423
6728
  event_id: {
6424
6729
  description: 'ID of the event.',
@@ -6430,7 +6735,7 @@ export default {
6430
6735
  type: 'string',
6431
6736
  },
6432
6737
  occurred_at: {
6433
- description: 'Time when the event occurred.',
6738
+ description: 'Date and time at which the event occurred.',
6434
6739
  format: 'date-time',
6435
6740
  type: 'string',
6436
6741
  },
@@ -6453,30 +6758,27 @@ export default {
6453
6758
  type: 'object',
6454
6759
  },
6455
6760
  {
6456
- description: 'An unmanaged access code was removed from a device.',
6761
+ 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.',
6457
6762
  properties: {
6458
6763
  access_code_id: {
6459
- description: 'The ID of the access code.',
6764
+ description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6460
6765
  format: 'uuid',
6461
6766
  type: 'string',
6462
- 'x-title': 'Access Code ID',
6463
6767
  },
6464
6768
  connected_account_id: {
6465
- description: 'The ID of the connected account.',
6769
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6466
6770
  format: 'uuid',
6467
6771
  type: 'string',
6468
- 'x-title': 'Connected Account ID',
6469
6772
  },
6470
6773
  created_at: {
6471
- description: 'Time at which the event was created.',
6774
+ description: 'Date and time at which the event was created.',
6472
6775
  format: 'date-time',
6473
6776
  type: 'string',
6474
6777
  },
6475
6778
  device_id: {
6476
- description: 'The ID of the device.',
6779
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6477
6780
  format: 'uuid',
6478
6781
  type: 'string',
6479
- 'x-title': 'Device ID',
6480
6782
  },
6481
6783
  event_id: {
6482
6784
  description: 'ID of the event.',
@@ -6488,7 +6790,7 @@ export default {
6488
6790
  type: 'string',
6489
6791
  },
6490
6792
  occurred_at: {
6491
- description: 'Time when the event occurred.',
6793
+ description: 'Date and time at which the event occurred.',
6492
6794
  format: 'date-time',
6493
6795
  type: 'string',
6494
6796
  },
@@ -6511,22 +6813,20 @@ export default {
6511
6813
  type: 'object',
6512
6814
  },
6513
6815
  {
6514
- description: 'An ACS system was connected.',
6816
+ description: 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.',
6515
6817
  properties: {
6516
6818
  acs_system_id: {
6517
- description: 'ID of the ACS system.',
6819
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6518
6820
  format: 'uuid',
6519
6821
  type: 'string',
6520
- 'x-title': 'ACS System ID',
6521
6822
  },
6522
6823
  connected_account_id: {
6523
- description: 'ID of the connected account.',
6824
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6524
6825
  format: 'uuid',
6525
6826
  type: 'string',
6526
- 'x-title': 'Connected Account ID',
6527
6827
  },
6528
6828
  created_at: {
6529
- description: 'Time at which the event was created.',
6829
+ description: 'Date and time at which the event was created.',
6530
6830
  format: 'date-time',
6531
6831
  type: 'string',
6532
6832
  },
@@ -6537,7 +6837,7 @@ export default {
6537
6837
  },
6538
6838
  event_type: { enum: ['acs_system.connected'], type: 'string' },
6539
6839
  occurred_at: {
6540
- description: 'Time when the event occurred.',
6840
+ description: 'Date and time at which the event occurred.',
6541
6841
  format: 'date-time',
6542
6842
  type: 'string',
6543
6843
  },
@@ -6558,22 +6858,20 @@ export default {
6558
6858
  type: 'object',
6559
6859
  },
6560
6860
  {
6561
- description: 'An ACS system was added.',
6861
+ description: 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.',
6562
6862
  properties: {
6563
6863
  acs_system_id: {
6564
- description: 'ID of the ACS system.',
6864
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6565
6865
  format: 'uuid',
6566
6866
  type: 'string',
6567
- 'x-title': 'ACS System ID',
6568
6867
  },
6569
6868
  connected_account_id: {
6570
- description: 'ID of the connected account.',
6869
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6571
6870
  format: 'uuid',
6572
6871
  type: 'string',
6573
- 'x-title': 'Connected Account ID',
6574
6872
  },
6575
6873
  created_at: {
6576
- description: 'Time at which the event was created.',
6874
+ description: 'Date and time at which the event was created.',
6577
6875
  format: 'date-time',
6578
6876
  type: 'string',
6579
6877
  },
@@ -6584,7 +6882,7 @@ export default {
6584
6882
  },
6585
6883
  event_type: { enum: ['acs_system.added'], type: 'string' },
6586
6884
  occurred_at: {
6587
- description: 'Time when the event occurred.',
6885
+ description: 'Date and time at which the event occurred.',
6588
6886
  format: 'date-time',
6589
6887
  type: 'string',
6590
6888
  },
@@ -6605,22 +6903,20 @@ export default {
6605
6903
  type: 'object',
6606
6904
  },
6607
6905
  {
6608
- description: 'An ACS system was disconnected.',
6906
+ description: 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.',
6609
6907
  properties: {
6610
6908
  acs_system_id: {
6611
- description: 'ID of the ACS system.',
6909
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6612
6910
  format: 'uuid',
6613
6911
  type: 'string',
6614
- 'x-title': 'ACS System ID',
6615
6912
  },
6616
6913
  connected_account_id: {
6617
- description: 'ID of the connected account.',
6914
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6618
6915
  format: 'uuid',
6619
6916
  type: 'string',
6620
- 'x-title': 'Connected Account ID',
6621
6917
  },
6622
6918
  created_at: {
6623
- description: 'Time at which the event was created.',
6919
+ description: 'Date and time at which the event was created.',
6624
6920
  format: 'date-time',
6625
6921
  type: 'string',
6626
6922
  },
@@ -6631,7 +6927,7 @@ export default {
6631
6927
  },
6632
6928
  event_type: { enum: ['acs_system.disconnected'], type: 'string' },
6633
6929
  occurred_at: {
6634
- description: 'Time when the event occurred.',
6930
+ description: 'Date and time at which the event occurred.',
6635
6931
  format: 'date-time',
6636
6932
  type: 'string',
6637
6933
  },
@@ -6652,23 +6948,21 @@ export default {
6652
6948
  type: 'object',
6653
6949
  },
6654
6950
  {
6655
- description: 'An ACS credential was deleted.',
6951
+ description: 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.',
6656
6952
  properties: {
6657
6953
  acs_credential_id: { format: 'uuid', type: 'string' },
6658
6954
  acs_system_id: {
6659
- description: 'ID of the ACS system.',
6955
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6660
6956
  format: 'uuid',
6661
6957
  type: 'string',
6662
- 'x-title': 'ACS System ID',
6663
6958
  },
6664
6959
  connected_account_id: {
6665
- description: 'ID of the connected account.',
6960
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6666
6961
  format: 'uuid',
6667
6962
  type: 'string',
6668
- 'x-title': 'Connected Account ID',
6669
6963
  },
6670
6964
  created_at: {
6671
- description: 'Time at which the event was created.',
6965
+ description: 'Date and time at which the event was created.',
6672
6966
  format: 'date-time',
6673
6967
  type: 'string',
6674
6968
  },
@@ -6679,7 +6973,7 @@ export default {
6679
6973
  },
6680
6974
  event_type: { enum: ['acs_credential.deleted'], type: 'string' },
6681
6975
  occurred_at: {
6682
- description: 'Time when the event occurred.',
6976
+ description: 'Date and time at which the event occurred.',
6683
6977
  format: 'date-time',
6684
6978
  type: 'string',
6685
6979
  },
@@ -6701,23 +6995,21 @@ export default {
6701
6995
  type: 'object',
6702
6996
  },
6703
6997
  {
6704
- description: 'An ACS credential was issued.',
6998
+ description: 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.',
6705
6999
  properties: {
6706
7000
  acs_credential_id: { format: 'uuid', type: 'string' },
6707
7001
  acs_system_id: {
6708
- description: 'ID of the ACS system.',
7002
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6709
7003
  format: 'uuid',
6710
7004
  type: 'string',
6711
- 'x-title': 'ACS System ID',
6712
7005
  },
6713
7006
  connected_account_id: {
6714
- description: 'ID of the connected account.',
7007
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6715
7008
  format: 'uuid',
6716
7009
  type: 'string',
6717
- 'x-title': 'Connected Account ID',
6718
7010
  },
6719
7011
  created_at: {
6720
- description: 'Time at which the event was created.',
7012
+ description: 'Date and time at which the event was created.',
6721
7013
  format: 'date-time',
6722
7014
  type: 'string',
6723
7015
  },
@@ -6728,7 +7020,7 @@ export default {
6728
7020
  },
6729
7021
  event_type: { enum: ['acs_credential.issued'], type: 'string' },
6730
7022
  occurred_at: {
6731
- description: 'Time when the event occurred.',
7023
+ description: 'Date and time at which the event occurred.',
6732
7024
  format: 'date-time',
6733
7025
  type: 'string',
6734
7026
  },
@@ -6750,23 +7042,21 @@ export default {
6750
7042
  type: 'object',
6751
7043
  },
6752
7044
  {
6753
- description: 'An ACS user was deleted.',
7045
+ description: 'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.',
6754
7046
  properties: {
6755
7047
  acs_system_id: {
6756
- description: 'ID of the ACS system.',
7048
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6757
7049
  format: 'uuid',
6758
7050
  type: 'string',
6759
- 'x-title': 'ACS System ID',
6760
7051
  },
6761
7052
  acs_user_id: { format: 'uuid', type: 'string' },
6762
7053
  connected_account_id: {
6763
- description: 'ID of the connected account.',
7054
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6764
7055
  format: 'uuid',
6765
7056
  type: 'string',
6766
- 'x-title': 'Connected Account ID',
6767
7057
  },
6768
7058
  created_at: {
6769
- description: 'Time at which the event was created.',
7059
+ description: 'Date and time at which the event was created.',
6770
7060
  format: 'date-time',
6771
7061
  type: 'string',
6772
7062
  },
@@ -6777,7 +7067,7 @@ export default {
6777
7067
  },
6778
7068
  event_type: { enum: ['acs_user.deleted'], type: 'string' },
6779
7069
  occurred_at: {
6780
- description: 'Time when the event occurred.',
7070
+ description: 'Date and time at which the event occurred.',
6781
7071
  format: 'date-time',
6782
7072
  type: 'string',
6783
7073
  },
@@ -6799,27 +7089,25 @@ export default {
6799
7089
  type: 'object',
6800
7090
  },
6801
7091
  {
6802
- description: 'An ACS encoder was added.',
7092
+ description: 'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.',
6803
7093
  properties: {
6804
7094
  acs_encoder_id: {
6805
- description: 'ID of the ACS encoder.',
7095
+ description: 'ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
6806
7096
  format: 'uuid',
6807
7097
  type: 'string',
6808
7098
  },
6809
7099
  acs_system_id: {
6810
- description: 'ID of the ACS system.',
7100
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6811
7101
  format: 'uuid',
6812
7102
  type: 'string',
6813
- 'x-title': 'ACS System ID',
6814
7103
  },
6815
7104
  connected_account_id: {
6816
- description: 'ID of the connected account.',
7105
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6817
7106
  format: 'uuid',
6818
7107
  type: 'string',
6819
- 'x-title': 'Connected Account ID',
6820
7108
  },
6821
7109
  created_at: {
6822
- description: 'Time at which the event was created.',
7110
+ description: 'Date and time at which the event was created.',
6823
7111
  format: 'date-time',
6824
7112
  type: 'string',
6825
7113
  },
@@ -6830,7 +7118,7 @@ export default {
6830
7118
  },
6831
7119
  event_type: { enum: ['acs_encoder.added'], type: 'string' },
6832
7120
  occurred_at: {
6833
- description: 'Time when the event occurred.',
7121
+ description: 'Date and time at which the event occurred.',
6834
7122
  format: 'date-time',
6835
7123
  type: 'string',
6836
7124
  },
@@ -6852,27 +7140,25 @@ export default {
6852
7140
  type: 'object',
6853
7141
  },
6854
7142
  {
6855
- description: 'An ACS encoder was removed.',
7143
+ description: 'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.',
6856
7144
  properties: {
6857
7145
  acs_encoder_id: {
6858
- description: 'ID of the ACS encoder.',
7146
+ description: 'ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
6859
7147
  format: 'uuid',
6860
7148
  type: 'string',
6861
7149
  },
6862
7150
  acs_system_id: {
6863
- description: 'ID of the ACS system.',
7151
+ description: 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6864
7152
  format: 'uuid',
6865
7153
  type: 'string',
6866
- 'x-title': 'ACS System ID',
6867
7154
  },
6868
7155
  connected_account_id: {
6869
- description: 'ID of the connected account.',
7156
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6870
7157
  format: 'uuid',
6871
7158
  type: 'string',
6872
- 'x-title': 'Connected Account ID',
6873
7159
  },
6874
7160
  created_at: {
6875
- description: 'Time at which the event was created.',
7161
+ description: 'Date and time at which the event was created.',
6876
7162
  format: 'date-time',
6877
7163
  type: 'string',
6878
7164
  },
@@ -6883,7 +7169,7 @@ export default {
6883
7169
  },
6884
7170
  event_type: { enum: ['acs_encoder.removed'], type: 'string' },
6885
7171
  occurred_at: {
6886
- description: 'Time when the event occurred.',
7172
+ description: 'Date and time at which the event occurred.',
6887
7173
  format: 'date-time',
6888
7174
  type: 'string',
6889
7175
  },
@@ -6905,16 +7191,15 @@ export default {
6905
7191
  type: 'object',
6906
7192
  },
6907
7193
  {
6908
- description: 'A client session was deleted.',
7194
+ description: 'A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.',
6909
7195
  properties: {
6910
7196
  client_session_id: {
6911
- description: 'ID of the client session.',
7197
+ description: 'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
6912
7198
  format: 'uuid',
6913
7199
  type: 'string',
6914
- 'x-title': 'Client Session ID',
6915
7200
  },
6916
7201
  created_at: {
6917
- description: 'Time at which the event was created.',
7202
+ description: 'Date and time at which the event was created.',
6918
7203
  format: 'date-time',
6919
7204
  type: 'string',
6920
7205
  },
@@ -6925,7 +7210,7 @@ export default {
6925
7210
  },
6926
7211
  event_type: { enum: ['client_session.deleted'], type: 'string' },
6927
7212
  occurred_at: {
6928
- description: 'Time when the event occurred.',
7213
+ description: 'Date and time at which the event occurred.',
6929
7214
  format: 'date-time',
6930
7215
  type: 'string',
6931
7216
  },
@@ -6946,22 +7231,20 @@ export default {
6946
7231
  type: 'object',
6947
7232
  },
6948
7233
  {
6949
- description: 'A connected account was connected for the first time, was reconnected after being disconnected.',
7234
+ 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.',
6950
7235
  properties: {
6951
7236
  connect_webview_id: {
6952
- description: 'ID of the connect webview.',
7237
+ description: 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
6953
7238
  format: 'uuid',
6954
7239
  type: 'string',
6955
- 'x-title': 'Connect Webview ID',
6956
7240
  },
6957
7241
  connected_account_id: {
6958
- description: 'ID of the connected account.',
7242
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6959
7243
  format: 'uuid',
6960
7244
  type: 'string',
6961
- 'x-title': 'Connected Account ID',
6962
7245
  },
6963
7246
  created_at: {
6964
- description: 'Time at which the event was created.',
7247
+ description: 'Date and time at which the event was created.',
6965
7248
  format: 'date-time',
6966
7249
  type: 'string',
6967
7250
  },
@@ -6975,7 +7258,7 @@ export default {
6975
7258
  type: 'string',
6976
7259
  },
6977
7260
  occurred_at: {
6978
- description: 'Time when the event occurred.',
7261
+ description: 'Date and time at which the event occurred.',
6979
7262
  format: 'date-time',
6980
7263
  type: 'string',
6981
7264
  },
@@ -6997,22 +7280,20 @@ export default {
6997
7280
  type: 'object',
6998
7281
  },
6999
7282
  {
7000
- description: 'A connected account was created.',
7283
+ description: 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.',
7001
7284
  properties: {
7002
7285
  connect_webview_id: {
7003
- description: 'ID of the connect webview.',
7286
+ description: 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7004
7287
  format: 'uuid',
7005
7288
  type: 'string',
7006
- 'x-title': 'Connect Webview ID',
7007
7289
  },
7008
7290
  connected_account_id: {
7009
- description: 'ID of the connected account.',
7291
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7010
7292
  format: 'uuid',
7011
7293
  type: 'string',
7012
- 'x-title': 'Connected Account ID',
7013
7294
  },
7014
7295
  created_at: {
7015
- description: 'Time at which the event was created.',
7296
+ description: 'Date and time at which the event was created.',
7016
7297
  format: 'date-time',
7017
7298
  type: 'string',
7018
7299
  },
@@ -7026,7 +7307,7 @@ export default {
7026
7307
  type: 'string',
7027
7308
  },
7028
7309
  occurred_at: {
7029
- description: 'Time when the event occurred.',
7310
+ description: 'Date and time at which the event occurred.',
7030
7311
  format: 'date-time',
7031
7312
  type: 'string',
7032
7313
  },
@@ -7049,22 +7330,20 @@ export default {
7049
7330
  },
7050
7331
  {
7051
7332
  deprecated: true,
7052
- description: 'A connected account had a successful connect webview login.',
7333
+ 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).',
7053
7334
  properties: {
7054
7335
  connect_webview_id: {
7055
- description: 'ID of the connect webview.',
7336
+ description: 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7056
7337
  format: 'uuid',
7057
7338
  type: 'string',
7058
- 'x-title': 'Connect Webview ID',
7059
7339
  },
7060
7340
  connected_account_id: {
7061
- description: 'ID of the connected account.',
7341
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7062
7342
  format: 'uuid',
7063
7343
  type: 'string',
7064
- 'x-title': 'Connected Account ID',
7065
7344
  },
7066
7345
  created_at: {
7067
- description: 'Time at which the event was created.',
7346
+ description: 'Date and time at which the event was created.',
7068
7347
  format: 'date-time',
7069
7348
  type: 'string',
7070
7349
  },
@@ -7078,7 +7357,7 @@ export default {
7078
7357
  type: 'string',
7079
7358
  },
7080
7359
  occurred_at: {
7081
- description: 'Time when the event occurred.',
7360
+ description: 'Date and time at which the event occurred.',
7082
7361
  format: 'date-time',
7083
7362
  type: 'string',
7084
7363
  },
@@ -7101,16 +7380,15 @@ export default {
7101
7380
  'x-deprecated': 'Use `connect_webview.login_succeeded`.',
7102
7381
  },
7103
7382
  {
7104
- description: 'A connected account was disconnected.',
7383
+ description: 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.',
7105
7384
  properties: {
7106
7385
  connected_account_id: {
7107
- description: 'ID of the connected account.',
7386
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7108
7387
  format: 'uuid',
7109
7388
  type: 'string',
7110
- 'x-title': 'Connected Account ID',
7111
7389
  },
7112
7390
  created_at: {
7113
- description: 'Time at which the event was created.',
7391
+ description: 'Date and time at which the event was created.',
7114
7392
  format: 'date-time',
7115
7393
  type: 'string',
7116
7394
  },
@@ -7124,7 +7402,7 @@ export default {
7124
7402
  type: 'string',
7125
7403
  },
7126
7404
  occurred_at: {
7127
- description: 'Time when the event occurred.',
7405
+ description: 'Date and time at which the event occurred.',
7128
7406
  format: 'date-time',
7129
7407
  type: 'string',
7130
7408
  },
@@ -7145,16 +7423,15 @@ export default {
7145
7423
  type: 'object',
7146
7424
  },
7147
7425
  {
7148
- description: 'A connected account completed the first sync with Seam and devices are now available.',
7426
+ 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.',
7149
7427
  properties: {
7150
7428
  connected_account_id: {
7151
- description: 'ID of the connected account.',
7429
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7152
7430
  format: 'uuid',
7153
7431
  type: 'string',
7154
- 'x-title': 'Connected Account ID',
7155
7432
  },
7156
7433
  created_at: {
7157
- description: 'Time at which the event was created.',
7434
+ description: 'Date and time at which the event was created.',
7158
7435
  format: 'date-time',
7159
7436
  type: 'string',
7160
7437
  },
@@ -7168,7 +7445,7 @@ export default {
7168
7445
  type: 'string',
7169
7446
  },
7170
7447
  occurred_at: {
7171
- description: 'Time when the event occurred.',
7448
+ description: 'Date and time at which the event occurred.',
7172
7449
  format: 'date-time',
7173
7450
  type: 'string',
7174
7451
  },
@@ -7189,16 +7466,15 @@ export default {
7189
7466
  type: 'object',
7190
7467
  },
7191
7468
  {
7192
- description: 'A connected account was deleted.',
7469
+ description: 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.',
7193
7470
  properties: {
7194
7471
  connected_account_id: {
7195
- description: 'ID of the connected account.',
7472
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7196
7473
  format: 'uuid',
7197
7474
  type: 'string',
7198
- 'x-title': 'Connected Account ID',
7199
7475
  },
7200
7476
  created_at: {
7201
- description: 'Time at which the event was created.',
7477
+ description: 'Date and time at which the event was created.',
7202
7478
  format: 'date-time',
7203
7479
  type: 'string',
7204
7480
  },
@@ -7212,7 +7488,7 @@ export default {
7212
7488
  type: 'string',
7213
7489
  },
7214
7490
  occurred_at: {
7215
- description: 'Time when the event occurred.',
7491
+ description: 'Date and time at which the event occurred.',
7216
7492
  format: 'date-time',
7217
7493
  type: 'string',
7218
7494
  },
@@ -7233,16 +7509,15 @@ export default {
7233
7509
  type: 'object',
7234
7510
  },
7235
7511
  {
7236
- description: 'A connected account completed the first sync after reconnection with Seam and devices are now available.',
7512
+ 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.',
7237
7513
  properties: {
7238
7514
  connected_account_id: {
7239
- description: 'ID of the connected account.',
7515
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7240
7516
  format: 'uuid',
7241
7517
  type: 'string',
7242
- 'x-title': 'Connected Account ID',
7243
7518
  },
7244
7519
  created_at: {
7245
- description: 'Time at which the event was created.',
7520
+ description: 'Date and time at which the event was created.',
7246
7521
  format: 'date-time',
7247
7522
  type: 'string',
7248
7523
  },
@@ -7258,7 +7533,7 @@ export default {
7258
7533
  type: 'string',
7259
7534
  },
7260
7535
  occurred_at: {
7261
- description: 'Time when the event occurred.',
7536
+ description: 'Date and time at which the event occurred.',
7262
7537
  format: 'date-time',
7263
7538
  type: 'string',
7264
7539
  },
@@ -7279,21 +7554,16 @@ export default {
7279
7554
  type: 'object',
7280
7555
  },
7281
7556
  {
7282
- description: 'A lock door action attempt succeeded.',
7557
+ description: 'A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.',
7283
7558
  properties: {
7284
7559
  action_attempt_id: {
7285
- description: 'The ID of the action attempt.',
7560
+ description: 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7286
7561
  format: 'uuid',
7287
7562
  type: 'string',
7288
- 'x-title': 'Action Attempt ID',
7289
- },
7290
- action_type: {
7291
- description: 'The type of action.',
7292
- type: 'string',
7293
- 'x-title': 'Action Type',
7294
7563
  },
7564
+ action_type: { description: 'Type of action.', type: 'string' },
7295
7565
  created_at: {
7296
- description: 'Time at which the event was created.',
7566
+ description: 'Date and time at which the event was created.',
7297
7567
  format: 'date-time',
7298
7568
  type: 'string',
7299
7569
  },
@@ -7307,15 +7577,11 @@ export default {
7307
7577
  type: 'string',
7308
7578
  },
7309
7579
  occurred_at: {
7310
- description: 'Time when the event occurred.',
7580
+ description: 'Date and time at which the event occurred.',
7311
7581
  format: 'date-time',
7312
7582
  type: 'string',
7313
7583
  },
7314
- status: {
7315
- description: 'The status of the action.',
7316
- type: 'string',
7317
- 'x-title': 'Status',
7318
- },
7584
+ status: { description: 'Status of the action.', type: 'string' },
7319
7585
  workspace_id: {
7320
7586
  description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7321
7587
  format: 'uuid',
@@ -7335,21 +7601,16 @@ export default {
7335
7601
  type: 'object',
7336
7602
  },
7337
7603
  {
7338
- description: 'A lock door action attempt failed.',
7604
+ description: 'A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.',
7339
7605
  properties: {
7340
7606
  action_attempt_id: {
7341
- description: 'The ID of the action attempt.',
7607
+ description: 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7342
7608
  format: 'uuid',
7343
7609
  type: 'string',
7344
- 'x-title': 'Action Attempt ID',
7345
- },
7346
- action_type: {
7347
- description: 'The type of action.',
7348
- type: 'string',
7349
- 'x-title': 'Action Type',
7350
7610
  },
7611
+ action_type: { description: 'Type of action.', type: 'string' },
7351
7612
  created_at: {
7352
- description: 'Time at which the event was created.',
7613
+ description: 'Date and time at which the event was created.',
7353
7614
  format: 'date-time',
7354
7615
  type: 'string',
7355
7616
  },
@@ -7363,15 +7624,11 @@ export default {
7363
7624
  type: 'string',
7364
7625
  },
7365
7626
  occurred_at: {
7366
- description: 'Time when the event occurred.',
7627
+ description: 'Date and time at which the event occurred.',
7367
7628
  format: 'date-time',
7368
7629
  type: 'string',
7369
7630
  },
7370
- status: {
7371
- description: 'The status of the action.',
7372
- type: 'string',
7373
- 'x-title': 'Status',
7374
- },
7631
+ status: { description: 'Status of the action.', type: 'string' },
7375
7632
  workspace_id: {
7376
7633
  description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7377
7634
  format: 'uuid',
@@ -7391,21 +7648,16 @@ export default {
7391
7648
  type: 'object',
7392
7649
  },
7393
7650
  {
7394
- description: 'An unlock door action attempt succeeded.',
7651
+ description: 'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.',
7395
7652
  properties: {
7396
7653
  action_attempt_id: {
7397
- description: 'The ID of the action attempt.',
7654
+ description: 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7398
7655
  format: 'uuid',
7399
7656
  type: 'string',
7400
- 'x-title': 'Action Attempt ID',
7401
- },
7402
- action_type: {
7403
- description: 'The type of action.',
7404
- type: 'string',
7405
- 'x-title': 'Action Type',
7406
7657
  },
7658
+ action_type: { description: 'Type of action.', type: 'string' },
7407
7659
  created_at: {
7408
- description: 'Time at which the event was created.',
7660
+ description: 'Date and time at which the event was created.',
7409
7661
  format: 'date-time',
7410
7662
  type: 'string',
7411
7663
  },
@@ -7419,15 +7671,11 @@ export default {
7419
7671
  type: 'string',
7420
7672
  },
7421
7673
  occurred_at: {
7422
- description: 'Time when the event occurred.',
7674
+ description: 'Date and time at which the event occurred.',
7423
7675
  format: 'date-time',
7424
7676
  type: 'string',
7425
7677
  },
7426
- status: {
7427
- description: 'The status of the action.',
7428
- type: 'string',
7429
- 'x-title': 'Status',
7430
- },
7678
+ status: { description: 'Status of the action.', type: 'string' },
7431
7679
  workspace_id: {
7432
7680
  description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7433
7681
  format: 'uuid',
@@ -7447,21 +7695,16 @@ export default {
7447
7695
  type: 'object',
7448
7696
  },
7449
7697
  {
7450
- description: 'An unlock door action attempt failed.',
7698
+ description: 'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.',
7451
7699
  properties: {
7452
7700
  action_attempt_id: {
7453
- description: 'The ID of the action attempt.',
7701
+ description: 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7454
7702
  format: 'uuid',
7455
7703
  type: 'string',
7456
- 'x-title': 'Action Attempt ID',
7457
- },
7458
- action_type: {
7459
- description: 'The type of action.',
7460
- type: 'string',
7461
- 'x-title': 'Action Type',
7462
7704
  },
7705
+ action_type: { description: 'Type of action.', type: 'string' },
7463
7706
  created_at: {
7464
- description: 'Time at which the event was created.',
7707
+ description: 'Date and time at which the event was created.',
7465
7708
  format: 'date-time',
7466
7709
  type: 'string',
7467
7710
  },
@@ -7475,15 +7718,11 @@ export default {
7475
7718
  type: 'string',
7476
7719
  },
7477
7720
  occurred_at: {
7478
- description: 'Time when the event occurred.',
7721
+ description: 'Date and time at which the event occurred.',
7479
7722
  format: 'date-time',
7480
7723
  type: 'string',
7481
7724
  },
7482
- status: {
7483
- description: 'The status of the action.',
7484
- type: 'string',
7485
- 'x-title': 'Status',
7486
- },
7725
+ status: { description: 'Status of the action.', type: 'string' },
7487
7726
  workspace_id: {
7488
7727
  description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7489
7728
  format: 'uuid',
@@ -7503,22 +7742,20 @@ export default {
7503
7742
  type: 'object',
7504
7743
  },
7505
7744
  {
7506
- description: 'A connect webview had a successful login.',
7745
+ description: 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.',
7507
7746
  properties: {
7508
7747
  connect_webview_id: {
7509
- description: 'ID of the connect webview.',
7748
+ description: 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7510
7749
  format: 'uuid',
7511
7750
  type: 'string',
7512
- 'x-title': 'Connect Webview ID',
7513
7751
  },
7514
7752
  connected_account_id: {
7515
- description: 'ID of the connected account.',
7753
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7516
7754
  format: 'uuid',
7517
7755
  type: 'string',
7518
- 'x-title': 'Connected Account ID',
7519
7756
  },
7520
7757
  created_at: {
7521
- description: 'Time at which the event was created.',
7758
+ description: 'Date and time at which the event was created.',
7522
7759
  format: 'date-time',
7523
7760
  type: 'string',
7524
7761
  },
@@ -7532,7 +7769,7 @@ export default {
7532
7769
  type: 'string',
7533
7770
  },
7534
7771
  occurred_at: {
7535
- description: 'Time when the event occurred.',
7772
+ description: 'Date and time at which the event occurred.',
7536
7773
  format: 'date-time',
7537
7774
  type: 'string',
7538
7775
  },
@@ -7554,16 +7791,15 @@ export default {
7554
7791
  type: 'object',
7555
7792
  },
7556
7793
  {
7557
- description: 'A connect webview had a failed login.',
7794
+ description: 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.',
7558
7795
  properties: {
7559
7796
  connect_webview_id: {
7560
- description: 'ID of the connect webview.',
7797
+ description: 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7561
7798
  format: 'uuid',
7562
7799
  type: 'string',
7563
- 'x-title': 'Connect Webview ID',
7564
7800
  },
7565
7801
  created_at: {
7566
- description: 'Time at which the event was created.',
7802
+ description: 'Date and time at which the event was created.',
7567
7803
  format: 'date-time',
7568
7804
  type: 'string',
7569
7805
  },
@@ -7577,7 +7813,7 @@ export default {
7577
7813
  type: 'string',
7578
7814
  },
7579
7815
  occurred_at: {
7580
- description: 'Time when the event occurred.',
7816
+ description: 'Date and time at which the event occurred.',
7581
7817
  format: 'date-time',
7582
7818
  type: 'string',
7583
7819
  },
@@ -7598,7 +7834,7 @@ export default {
7598
7834
  type: 'object',
7599
7835
  },
7600
7836
  {
7601
- description: 'A new device was connected to Seam.',
7837
+ 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.',
7602
7838
  properties: {
7603
7839
  connected_account_id: {
7604
7840
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -7606,7 +7842,7 @@ export default {
7606
7842
  type: 'string',
7607
7843
  },
7608
7844
  created_at: {
7609
- description: 'Time at which the event was created.',
7845
+ description: 'Date and time at which the event was created.',
7610
7846
  format: 'date-time',
7611
7847
  type: 'string',
7612
7848
  },
@@ -7622,7 +7858,7 @@ export default {
7622
7858
  },
7623
7859
  event_type: { enum: ['device.connected'], type: 'string' },
7624
7860
  occurred_at: {
7625
- description: 'Time when the event occurred.',
7861
+ description: 'Date and time at which the event occurred.',
7626
7862
  format: 'date-time',
7627
7863
  type: 'string',
7628
7864
  },
@@ -7644,7 +7880,7 @@ export default {
7644
7880
  type: 'object',
7645
7881
  },
7646
7882
  {
7647
- description: 'A device was added or reconnected to Seam.',
7883
+ 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.',
7648
7884
  properties: {
7649
7885
  connected_account_id: {
7650
7886
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -7652,7 +7888,7 @@ export default {
7652
7888
  type: 'string',
7653
7889
  },
7654
7890
  created_at: {
7655
- description: 'Time at which the event was created.',
7891
+ description: 'Date and time at which the event was created.',
7656
7892
  format: 'date-time',
7657
7893
  type: 'string',
7658
7894
  },
@@ -7668,7 +7904,7 @@ export default {
7668
7904
  },
7669
7905
  event_type: { enum: ['device.added'], type: 'string' },
7670
7906
  occurred_at: {
7671
- description: 'Time when the event occurred.',
7907
+ description: 'Date and time at which the event occurred.',
7672
7908
  format: 'date-time',
7673
7909
  type: 'string',
7674
7910
  },
@@ -7698,7 +7934,7 @@ export default {
7698
7934
  type: 'string',
7699
7935
  },
7700
7936
  created_at: {
7701
- description: 'Time at which the event was created.',
7937
+ description: 'Date and time at which the event was created.',
7702
7938
  format: 'date-time',
7703
7939
  type: 'string',
7704
7940
  },
@@ -7717,7 +7953,7 @@ export default {
7717
7953
  type: 'string',
7718
7954
  },
7719
7955
  occurred_at: {
7720
- description: 'Time when the event occurred.',
7956
+ description: 'Date and time at which the event occurred.',
7721
7957
  format: 'date-time',
7722
7958
  type: 'string',
7723
7959
  },
@@ -7747,7 +7983,7 @@ export default {
7747
7983
  type: 'string',
7748
7984
  },
7749
7985
  created_at: {
7750
- description: 'Time at which the event was created.',
7986
+ description: 'Date and time at which the event was created.',
7751
7987
  format: 'date-time',
7752
7988
  type: 'string',
7753
7989
  },
@@ -7766,7 +8002,7 @@ export default {
7766
8002
  type: 'string',
7767
8003
  },
7768
8004
  occurred_at: {
7769
- description: 'Time when the event occurred.',
8005
+ description: 'Date and time at which the event occurred.',
7770
8006
  format: 'date-time',
7771
8007
  type: 'string',
7772
8008
  },
@@ -7788,7 +8024,7 @@ export default {
7788
8024
  type: 'object',
7789
8025
  },
7790
8026
  {
7791
- description: 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.',
8027
+ 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`.',
7792
8028
  properties: {
7793
8029
  connected_account_id: {
7794
8030
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -7796,7 +8032,7 @@ export default {
7796
8032
  type: 'string',
7797
8033
  },
7798
8034
  created_at: {
7799
- description: 'Time at which the event was created.',
8035
+ description: 'Date and time at which the event was created.',
7800
8036
  format: 'date-time',
7801
8037
  type: 'string',
7802
8038
  },
@@ -7815,7 +8051,7 @@ export default {
7815
8051
  type: 'string',
7816
8052
  },
7817
8053
  occurred_at: {
7818
- description: 'Time when the event occurred.',
8054
+ description: 'Date and time at which the event occurred.',
7819
8055
  format: 'date-time',
7820
8056
  type: 'string',
7821
8057
  },
@@ -7837,7 +8073,7 @@ export default {
7837
8073
  type: 'object',
7838
8074
  },
7839
8075
  {
7840
- description: 'A device was disconnected from Seam.',
8076
+ 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`.',
7841
8077
  properties: {
7842
8078
  connected_account_id: {
7843
8079
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -7845,7 +8081,7 @@ export default {
7845
8081
  type: 'string',
7846
8082
  },
7847
8083
  created_at: {
7848
- description: 'Time at which the event was created.',
8084
+ description: 'Date and time at which the event was created.',
7849
8085
  format: 'date-time',
7850
8086
  type: 'string',
7851
8087
  },
@@ -7870,7 +8106,7 @@ export default {
7870
8106
  },
7871
8107
  event_type: { enum: ['device.disconnected'], type: 'string' },
7872
8108
  occurred_at: {
7873
- description: 'Time when the event occurred.',
8109
+ description: 'Date and time at which the event occurred.',
7874
8110
  format: 'date-time',
7875
8111
  type: 'string',
7876
8112
  },
@@ -7893,7 +8129,7 @@ export default {
7893
8129
  type: 'object',
7894
8130
  },
7895
8131
  {
7896
- description: 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.',
8132
+ 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`.',
7897
8133
  properties: {
7898
8134
  connected_account_id: {
7899
8135
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -7901,7 +8137,7 @@ export default {
7901
8137
  type: 'string',
7902
8138
  },
7903
8139
  created_at: {
7904
- description: 'Time at which the event was created.',
8140
+ description: 'Date and time at which the event was created.',
7905
8141
  format: 'date-time',
7906
8142
  type: 'string',
7907
8143
  },
@@ -7929,7 +8165,7 @@ export default {
7929
8165
  type: 'string',
7930
8166
  },
7931
8167
  occurred_at: {
7932
- description: 'Time when the event occurred.',
8168
+ description: 'Date and time at which the event occurred.',
7933
8169
  format: 'date-time',
7934
8170
  type: 'string',
7935
8171
  },
@@ -7952,7 +8188,7 @@ export default {
7952
8188
  type: 'object',
7953
8189
  },
7954
8190
  {
7955
- description: 'A device detected that it was tampered with, for example, opened or moved.',
8191
+ description: 'A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.',
7956
8192
  properties: {
7957
8193
  connected_account_id: {
7958
8194
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -7960,7 +8196,7 @@ export default {
7960
8196
  type: 'string',
7961
8197
  },
7962
8198
  created_at: {
7963
- description: 'Time at which the event was created.',
8199
+ description: 'Date and time at which the event was created.',
7964
8200
  format: 'date-time',
7965
8201
  type: 'string',
7966
8202
  },
@@ -7976,7 +8212,7 @@ export default {
7976
8212
  },
7977
8213
  event_type: { enum: ['device.tampered'], type: 'string' },
7978
8214
  occurred_at: {
7979
- description: 'Time when the event occurred.',
8215
+ description: 'Date and time at which the event occurred.',
7980
8216
  format: 'date-time',
7981
8217
  type: 'string',
7982
8218
  },
@@ -7998,7 +8234,7 @@ export default {
7998
8234
  type: 'object',
7999
8235
  },
8000
8236
  {
8001
- description: 'A device battery level dropped below the low threshold.',
8237
+ description: 'A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.',
8002
8238
  properties: {
8003
8239
  battery_level: {
8004
8240
  description: 'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.',
@@ -8013,7 +8249,7 @@ export default {
8013
8249
  type: 'string',
8014
8250
  },
8015
8251
  created_at: {
8016
- description: 'Time at which the event was created.',
8252
+ description: 'Date and time at which the event was created.',
8017
8253
  format: 'date-time',
8018
8254
  type: 'string',
8019
8255
  },
@@ -8029,7 +8265,7 @@ export default {
8029
8265
  },
8030
8266
  event_type: { enum: ['device.low_battery'], type: 'string' },
8031
8267
  occurred_at: {
8032
- description: 'Time when the event occurred.',
8268
+ description: 'Date and time at which the event occurred.',
8033
8269
  format: 'date-time',
8034
8270
  type: 'string',
8035
8271
  },
@@ -8052,7 +8288,7 @@ export default {
8052
8288
  type: 'object',
8053
8289
  },
8054
8290
  {
8055
- description: 'A device battery status changed since the last `battery_status_changed` event.',
8291
+ description: 'A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.',
8056
8292
  properties: {
8057
8293
  battery_level: {
8058
8294
  description: 'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.',
@@ -8072,7 +8308,7 @@ export default {
8072
8308
  type: 'string',
8073
8309
  },
8074
8310
  created_at: {
8075
- description: 'Time at which the event was created.',
8311
+ description: 'Date and time at which the event was created.',
8076
8312
  format: 'date-time',
8077
8313
  type: 'string',
8078
8314
  },
@@ -8091,7 +8327,7 @@ export default {
8091
8327
  type: 'string',
8092
8328
  },
8093
8329
  occurred_at: {
8094
- description: 'Time when the event occurred.',
8330
+ description: 'Date and time at which the event occurred.',
8095
8331
  format: 'date-time',
8096
8332
  type: 'string',
8097
8333
  },
@@ -8115,7 +8351,7 @@ export default {
8115
8351
  type: 'object',
8116
8352
  },
8117
8353
  {
8118
- description: 'A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8354
+ 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).',
8119
8355
  properties: {
8120
8356
  connected_account_id: {
8121
8357
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8123,7 +8359,7 @@ export default {
8123
8359
  type: 'string',
8124
8360
  },
8125
8361
  created_at: {
8126
- description: 'Time at which the event was created.',
8362
+ description: 'Date and time at which the event was created.',
8127
8363
  format: 'date-time',
8128
8364
  type: 'string',
8129
8365
  },
@@ -8139,7 +8375,7 @@ export default {
8139
8375
  },
8140
8376
  event_type: { enum: ['device.removed'], type: 'string' },
8141
8377
  occurred_at: {
8142
- description: 'Time when the event occurred.',
8378
+ description: 'Date and time at which the event occurred.',
8143
8379
  format: 'date-time',
8144
8380
  type: 'string',
8145
8381
  },
@@ -8161,7 +8397,7 @@ export default {
8161
8397
  type: 'object',
8162
8398
  },
8163
8399
  {
8164
- description: 'A device was [deleted](https://docs.seam.co/latest/api/devices/delete).',
8400
+ description: 'A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.',
8165
8401
  properties: {
8166
8402
  connected_account_id: {
8167
8403
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8169,7 +8405,7 @@ export default {
8169
8405
  type: 'string',
8170
8406
  },
8171
8407
  created_at: {
8172
- description: 'Time at which the event was created.',
8408
+ description: 'Date and time at which the event was created.',
8173
8409
  format: 'date-time',
8174
8410
  type: 'string',
8175
8411
  },
@@ -8185,7 +8421,7 @@ export default {
8185
8421
  },
8186
8422
  event_type: { enum: ['device.deleted'], type: 'string' },
8187
8423
  occurred_at: {
8188
- description: 'Time when the event occurred.',
8424
+ description: 'Date and time at which the event occurred.',
8189
8425
  format: 'date-time',
8190
8426
  type: 'string',
8191
8427
  },
@@ -8207,7 +8443,7 @@ export default {
8207
8443
  type: 'object',
8208
8444
  },
8209
8445
  {
8210
- description: 'Seam detected that a device is using a third-party integration that will interfere with Seam device management.',
8446
+ 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.',
8211
8447
  properties: {
8212
8448
  connected_account_id: {
8213
8449
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8215,7 +8451,7 @@ export default {
8215
8451
  type: 'string',
8216
8452
  },
8217
8453
  created_at: {
8218
- description: 'Time at which the event was created.',
8454
+ description: 'Date and time at which the event was created.',
8219
8455
  format: 'date-time',
8220
8456
  type: 'string',
8221
8457
  },
@@ -8234,7 +8470,7 @@ export default {
8234
8470
  type: 'string',
8235
8471
  },
8236
8472
  occurred_at: {
8237
- description: 'Time when the event occurred.',
8473
+ description: 'Date and time at which the event occurred.',
8238
8474
  format: 'date-time',
8239
8475
  type: 'string',
8240
8476
  },
@@ -8256,7 +8492,7 @@ export default {
8256
8492
  type: 'object',
8257
8493
  },
8258
8494
  {
8259
- description: 'Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.',
8495
+ 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.',
8260
8496
  properties: {
8261
8497
  connected_account_id: {
8262
8498
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8264,7 +8500,7 @@ export default {
8264
8500
  type: 'string',
8265
8501
  },
8266
8502
  created_at: {
8267
- description: 'Time at which the event was created.',
8503
+ description: 'Date and time at which the event was created.',
8268
8504
  format: 'date-time',
8269
8505
  type: 'string',
8270
8506
  },
@@ -8283,7 +8519,7 @@ export default {
8283
8519
  type: 'string',
8284
8520
  },
8285
8521
  occurred_at: {
8286
- description: 'Time when the event occurred.',
8522
+ description: 'Date and time at which the event occurred.',
8287
8523
  format: 'date-time',
8288
8524
  type: 'string',
8289
8525
  },
@@ -8305,7 +8541,7 @@ export default {
8305
8541
  type: 'object',
8306
8542
  },
8307
8543
  {
8308
- description: 'A Salto device activated privacy mode.',
8544
+ description: 'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.',
8309
8545
  properties: {
8310
8546
  connected_account_id: {
8311
8547
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8313,7 +8549,7 @@ export default {
8313
8549
  type: 'string',
8314
8550
  },
8315
8551
  created_at: {
8316
- description: 'Time at which the event was created.',
8552
+ description: 'Date and time at which the event was created.',
8317
8553
  format: 'date-time',
8318
8554
  type: 'string',
8319
8555
  },
@@ -8332,7 +8568,7 @@ export default {
8332
8568
  type: 'string',
8333
8569
  },
8334
8570
  occurred_at: {
8335
- description: 'Time when the event occurred.',
8571
+ description: 'Date and time at which the event occurred.',
8336
8572
  format: 'date-time',
8337
8573
  type: 'string',
8338
8574
  },
@@ -8354,7 +8590,7 @@ export default {
8354
8590
  type: 'object',
8355
8591
  },
8356
8592
  {
8357
- description: 'A Salto device deactivated privacy mode.',
8593
+ description: 'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.',
8358
8594
  properties: {
8359
8595
  connected_account_id: {
8360
8596
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8362,7 +8598,7 @@ export default {
8362
8598
  type: 'string',
8363
8599
  },
8364
8600
  created_at: {
8365
- description: 'Time at which the event was created.',
8601
+ description: 'Date and time at which the event was created.',
8366
8602
  format: 'date-time',
8367
8603
  type: 'string',
8368
8604
  },
@@ -8381,7 +8617,7 @@ export default {
8381
8617
  type: 'string',
8382
8618
  },
8383
8619
  occurred_at: {
8384
- description: 'Time when the event occurred.',
8620
+ description: 'Date and time at which the event occurred.',
8385
8621
  format: 'date-time',
8386
8622
  type: 'string',
8387
8623
  },
@@ -8403,7 +8639,7 @@ export default {
8403
8639
  type: 'object',
8404
8640
  },
8405
8641
  {
8406
- description: 'Seam detected a flaky device connection.',
8642
+ description: 'Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.',
8407
8643
  properties: {
8408
8644
  connected_account_id: {
8409
8645
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8411,7 +8647,7 @@ export default {
8411
8647
  type: 'string',
8412
8648
  },
8413
8649
  created_at: {
8414
- description: 'Time at which the event was created.',
8650
+ description: 'Date and time at which the event was created.',
8415
8651
  format: 'date-time',
8416
8652
  type: 'string',
8417
8653
  },
@@ -8430,7 +8666,7 @@ export default {
8430
8666
  type: 'string',
8431
8667
  },
8432
8668
  occurred_at: {
8433
- description: 'Time when the event occurred.',
8669
+ description: 'Date and time at which the event occurred.',
8434
8670
  format: 'date-time',
8435
8671
  type: 'string',
8436
8672
  },
@@ -8452,7 +8688,7 @@ export default {
8452
8688
  type: 'object',
8453
8689
  },
8454
8690
  {
8455
- description: 'Seam detected that a previously-flaky device connection stabilized.',
8691
+ description: 'Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.',
8456
8692
  properties: {
8457
8693
  connected_account_id: {
8458
8694
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8460,7 +8696,7 @@ export default {
8460
8696
  type: 'string',
8461
8697
  },
8462
8698
  created_at: {
8463
- description: 'Time at which the event was created.',
8699
+ description: 'Date and time at which the event was created.',
8464
8700
  format: 'date-time',
8465
8701
  type: 'string',
8466
8702
  },
@@ -8479,7 +8715,7 @@ export default {
8479
8715
  type: 'string',
8480
8716
  },
8481
8717
  occurred_at: {
8482
- description: 'Time when the event occurred.',
8718
+ description: 'Date and time at which the event occurred.',
8483
8719
  format: 'date-time',
8484
8720
  type: 'string',
8485
8721
  },
@@ -8501,7 +8737,7 @@ export default {
8501
8737
  type: 'object',
8502
8738
  },
8503
8739
  {
8504
- description: 'A third-party subscription is required to use all device features.',
8740
+ description: 'A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.',
8505
8741
  properties: {
8506
8742
  connected_account_id: {
8507
8743
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8509,7 +8745,7 @@ export default {
8509
8745
  type: 'string',
8510
8746
  },
8511
8747
  created_at: {
8512
- description: 'Time at which the event was created.',
8748
+ description: 'Date and time at which the event was created.',
8513
8749
  format: 'date-time',
8514
8750
  type: 'string',
8515
8751
  },
@@ -8528,7 +8764,7 @@ export default {
8528
8764
  type: 'string',
8529
8765
  },
8530
8766
  occurred_at: {
8531
- description: 'Time when the event occurred.',
8767
+ description: 'Date and time at which the event occurred.',
8532
8768
  format: 'date-time',
8533
8769
  type: 'string',
8534
8770
  },
@@ -8550,7 +8786,7 @@ export default {
8550
8786
  type: 'object',
8551
8787
  },
8552
8788
  {
8553
- description: 'A third-party subscription is active or no longer required to use all device features.',
8789
+ description: 'A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.',
8554
8790
  properties: {
8555
8791
  connected_account_id: {
8556
8792
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8558,7 +8794,7 @@ export default {
8558
8794
  type: 'string',
8559
8795
  },
8560
8796
  created_at: {
8561
- description: 'Time at which the event was created.',
8797
+ description: 'Date and time at which the event was created.',
8562
8798
  format: 'date-time',
8563
8799
  type: 'string',
8564
8800
  },
@@ -8577,7 +8813,7 @@ export default {
8577
8813
  type: 'string',
8578
8814
  },
8579
8815
  occurred_at: {
8580
- description: 'Time when the event occurred.',
8816
+ description: 'Date and time at which the event occurred.',
8581
8817
  format: 'date-time',
8582
8818
  type: 'string',
8583
8819
  },
@@ -8599,7 +8835,7 @@ export default {
8599
8835
  type: 'object',
8600
8836
  },
8601
8837
  {
8602
- description: 'An accessory keypad was connected to a device.',
8838
+ description: 'An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).',
8603
8839
  properties: {
8604
8840
  connected_account_id: {
8605
8841
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8607,7 +8843,7 @@ export default {
8607
8843
  type: 'string',
8608
8844
  },
8609
8845
  created_at: {
8610
- description: 'Time at which the event was created.',
8846
+ description: 'Date and time at which the event was created.',
8611
8847
  format: 'date-time',
8612
8848
  type: 'string',
8613
8849
  },
@@ -8626,7 +8862,7 @@ export default {
8626
8862
  type: 'string',
8627
8863
  },
8628
8864
  occurred_at: {
8629
- description: 'Time when the event occurred.',
8865
+ description: 'Date and time at which the event occurred.',
8630
8866
  format: 'date-time',
8631
8867
  type: 'string',
8632
8868
  },
@@ -8648,7 +8884,7 @@ export default {
8648
8884
  type: 'object',
8649
8885
  },
8650
8886
  {
8651
- description: 'An accessory keypad was disconnected from a device.',
8887
+ description: 'An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).',
8652
8888
  properties: {
8653
8889
  connected_account_id: {
8654
8890
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -8656,7 +8892,7 @@ export default {
8656
8892
  type: 'string',
8657
8893
  },
8658
8894
  created_at: {
8659
- description: 'Time at which the event was created.',
8895
+ description: 'Date and time at which the event was created.',
8660
8896
  format: 'date-time',
8661
8897
  type: 'string',
8662
8898
  },
@@ -8675,7 +8911,7 @@ export default {
8675
8911
  type: 'string',
8676
8912
  },
8677
8913
  occurred_at: {
8678
- description: 'Time when the event occurred.',
8914
+ description: 'Date and time at which the event occurred.',
8679
8915
  format: 'date-time',
8680
8916
  type: 'string',
8681
8917
  },
@@ -8705,7 +8941,7 @@ export default {
8705
8941
  type: 'string',
8706
8942
  },
8707
8943
  created_at: {
8708
- description: 'Time at which the event was created.',
8944
+ description: 'Date and time at which the event was created.',
8709
8945
  format: 'date-time',
8710
8946
  type: 'string',
8711
8947
  },
@@ -8727,7 +8963,6 @@ export default {
8727
8963
  additionalProperties: {},
8728
8964
  description: 'Metadata from Minut.',
8729
8965
  type: 'object',
8730
- 'x-title': 'Minut Metadata',
8731
8966
  },
8732
8967
  noise_level_decibels: {
8733
8968
  description: 'Detected noise level in decibels.',
@@ -8752,10 +8987,9 @@ export default {
8752
8987
  additionalProperties: {},
8753
8988
  description: 'Metadata from Noiseaware.',
8754
8989
  type: 'object',
8755
- 'x-title': 'Noiseaware Metadata',
8756
8990
  },
8757
8991
  occurred_at: {
8758
- description: 'Time when the event occurred.',
8992
+ description: 'Date and time at which the event occurred.',
8759
8993
  format: 'date-time',
8760
8994
  type: 'string',
8761
8995
  },
@@ -8777,7 +9011,7 @@ export default {
8777
9011
  type: 'object',
8778
9012
  },
8779
9013
  {
8780
- description: 'A lock was locked.',
9014
+ description: 'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.',
8781
9015
  properties: {
8782
9016
  access_code_id: {
8783
9017
  description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.',
@@ -8795,7 +9029,7 @@ export default {
8795
9029
  type: 'string',
8796
9030
  },
8797
9031
  created_at: {
8798
- description: 'Time at which the event was created.',
9032
+ description: 'Date and time at which the event was created.',
8799
9033
  format: 'date-time',
8800
9034
  type: 'string',
8801
9035
  },
@@ -8811,12 +9045,12 @@ export default {
8811
9045
  },
8812
9046
  event_type: { enum: ['lock.locked'], type: 'string' },
8813
9047
  method: {
8814
- 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.',
9048
+ 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.',
8815
9049
  enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
8816
9050
  type: 'string',
8817
9051
  },
8818
9052
  occurred_at: {
8819
- description: 'Time when the event occurred.',
9053
+ description: 'Date and time at which the event occurred.',
8820
9054
  format: 'date-time',
8821
9055
  type: 'string',
8822
9056
  },
@@ -8839,7 +9073,7 @@ export default {
8839
9073
  type: 'object',
8840
9074
  },
8841
9075
  {
8842
- description: 'A lock was unlocked.',
9076
+ description: 'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.',
8843
9077
  properties: {
8844
9078
  access_code_id: {
8845
9079
  description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.',
@@ -8857,7 +9091,7 @@ export default {
8857
9091
  type: 'string',
8858
9092
  },
8859
9093
  created_at: {
8860
- description: 'Time at which the event was created.',
9094
+ description: 'Date and time at which the event was created.',
8861
9095
  format: 'date-time',
8862
9096
  type: 'string',
8863
9097
  },
@@ -8873,12 +9107,12 @@ export default {
8873
9107
  },
8874
9108
  event_type: { enum: ['lock.unlocked'], type: 'string' },
8875
9109
  method: {
8876
- 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.',
9110
+ 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.',
8877
9111
  enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
8878
9112
  type: 'string',
8879
9113
  },
8880
9114
  occurred_at: {
8881
- description: 'Time when the event occurred.',
9115
+ description: 'Date and time at which the event occurred.',
8882
9116
  format: 'date-time',
8883
9117
  type: 'string',
8884
9118
  },
@@ -8901,7 +9135,7 @@ export default {
8901
9135
  type: 'object',
8902
9136
  },
8903
9137
  {
8904
- description: 'The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.',
9138
+ 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.',
8905
9139
  properties: {
8906
9140
  access_code_id: {
8907
9141
  description: 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.',
@@ -8914,7 +9148,7 @@ export default {
8914
9148
  type: 'string',
8915
9149
  },
8916
9150
  created_at: {
8917
- description: 'Time at which the event was created.',
9151
+ description: 'Date and time at which the event was created.',
8918
9152
  format: 'date-time',
8919
9153
  type: 'string',
8920
9154
  },
@@ -8930,7 +9164,7 @@ export default {
8930
9164
  },
8931
9165
  event_type: { enum: ['lock.access_denied'], type: 'string' },
8932
9166
  occurred_at: {
8933
- description: 'Time when the event occurred.',
9167
+ description: 'Date and time at which the event occurred.',
8934
9168
  format: 'date-time',
8935
9169
  type: 'string',
8936
9170
  },
@@ -8964,7 +9198,7 @@ export default {
8964
9198
  type: 'string',
8965
9199
  },
8966
9200
  created_at: {
8967
- description: 'Time at which the event was created.',
9201
+ description: 'Date and time at which the event was created.',
8968
9202
  format: 'date-time',
8969
9203
  type: 'string',
8970
9204
  },
@@ -8983,11 +9217,11 @@ export default {
8983
9217
  type: 'string',
8984
9218
  },
8985
9219
  is_fallback_climate_preset: {
8986
- 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.',
9220
+ 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).',
8987
9221
  type: 'boolean',
8988
9222
  },
8989
9223
  occurred_at: {
8990
- description: 'Time when the event occurred.',
9224
+ description: 'Date and time at which the event occurred.',
8991
9225
  format: 'date-time',
8992
9226
  type: 'string',
8993
9227
  },
@@ -9018,7 +9252,7 @@ export default {
9018
9252
  type: 'object',
9019
9253
  },
9020
9254
  {
9021
- description: 'A thermostat was adjusted manually.',
9255
+ description: 'A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.',
9022
9256
  properties: {
9023
9257
  connected_account_id: {
9024
9258
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -9036,7 +9270,7 @@ export default {
9036
9270
  type: 'number',
9037
9271
  },
9038
9272
  created_at: {
9039
- description: 'Time at which the event was created.',
9273
+ description: 'Date and time at which the event was created.',
9040
9274
  format: 'date-time',
9041
9275
  type: 'string',
9042
9276
  },
@@ -9075,12 +9309,12 @@ export default {
9075
9309
  type: 'string',
9076
9310
  },
9077
9311
  method: {
9078
- 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.',
9312
+ 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).',
9079
9313
  enum: ['seam', 'external'],
9080
9314
  type: 'string',
9081
9315
  },
9082
9316
  occurred_at: {
9083
- description: 'Time when the event occurred.',
9317
+ description: 'Date and time at which the event occurred.',
9084
9318
  format: 'date-time',
9085
9319
  type: 'string',
9086
9320
  },
@@ -9103,7 +9337,7 @@ export default {
9103
9337
  type: 'object',
9104
9338
  },
9105
9339
  {
9106
- description: "A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
9340
+ 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).",
9107
9341
  properties: {
9108
9342
  connected_account_id: {
9109
9343
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -9111,7 +9345,7 @@ export default {
9111
9345
  type: 'string',
9112
9346
  },
9113
9347
  created_at: {
9114
- description: 'Time at which the event was created.',
9348
+ description: 'Date and time at which the event was created.',
9115
9349
  format: 'date-time',
9116
9350
  type: 'string',
9117
9351
  },
@@ -9142,17 +9376,17 @@ export default {
9142
9376
  type: 'number',
9143
9377
  },
9144
9378
  occurred_at: {
9145
- description: 'Time when the event occurred.',
9379
+ description: 'Date and time at which the event occurred.',
9146
9380
  format: 'date-time',
9147
9381
  type: 'string',
9148
9382
  },
9149
9383
  temperature_celsius: {
9150
- description: 'Temperature, in °C, reported by the thermostat.',
9384
+ description: 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9151
9385
  format: 'float',
9152
9386
  type: 'number',
9153
9387
  },
9154
9388
  temperature_fahrenheit: {
9155
- description: 'Temperature, in °F, reported by the thermostat.',
9389
+ description: 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9156
9390
  format: 'float',
9157
9391
  type: 'number',
9158
9392
  },
@@ -9192,7 +9426,7 @@ export default {
9192
9426
  type: 'object',
9193
9427
  },
9194
9428
  {
9195
- 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).",
9429
+ 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).",
9196
9430
  properties: {
9197
9431
  connected_account_id: {
9198
9432
  description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
@@ -9200,7 +9434,7 @@ export default {
9200
9434
  type: 'string',
9201
9435
  },
9202
9436
  created_at: {
9203
- description: 'Time at which the event was created.',
9437
+ description: 'Date and time at which the event was created.',
9204
9438
  format: 'date-time',
9205
9439
  type: 'string',
9206
9440
  },
@@ -9231,17 +9465,17 @@ export default {
9231
9465
  type: 'number',
9232
9466
  },
9233
9467
  occurred_at: {
9234
- description: 'Time when the event occurred.',
9468
+ description: 'Date and time at which the event occurred.',
9235
9469
  format: 'date-time',
9236
9470
  type: 'string',
9237
9471
  },
9238
9472
  temperature_celsius: {
9239
- description: 'Temperature, in °C, reported by the thermostat.',
9473
+ description: 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9240
9474
  format: 'float',
9241
9475
  type: 'number',
9242
9476
  },
9243
9477
  temperature_fahrenheit: {
9244
- description: 'Temperature, in °F, reported by the thermostat.',
9478
+ description: 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9245
9479
  format: 'float',
9246
9480
  type: 'number',
9247
9481
  },
@@ -9281,18 +9515,17 @@ export default {
9281
9515
  type: 'object',
9282
9516
  },
9283
9517
  {
9284
- description: 'An enrollment automation was deleted.',
9518
+ 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.',
9285
9519
  properties: {
9286
9520
  created_at: {
9287
- description: 'Time at which the event was created.',
9521
+ description: 'Date and time at which the event was created.',
9288
9522
  format: 'date-time',
9289
9523
  type: 'string',
9290
9524
  },
9291
9525
  enrollment_automation_id: {
9292
- description: 'ID of the enrollment automation.',
9526
+ 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).',
9293
9527
  format: 'uuid',
9294
9528
  type: 'string',
9295
- 'x-title': 'Enrollment Automation ID',
9296
9529
  },
9297
9530
  event_id: {
9298
9531
  description: 'ID of the event.',
@@ -9304,7 +9537,7 @@ export default {
9304
9537
  type: 'string',
9305
9538
  },
9306
9539
  occurred_at: {
9307
- description: 'Time when the event occurred.',
9540
+ description: 'Date and time at which the event occurred.',
9308
9541
  format: 'date-time',
9309
9542
  type: 'string',
9310
9543
  },
@@ -9328,15 +9561,14 @@ export default {
9328
9561
  description: 'A phone device was deactivated.',
9329
9562
  properties: {
9330
9563
  created_at: {
9331
- description: 'Time at which the event was created.',
9564
+ description: 'Date and time at which the event was created.',
9332
9565
  format: 'date-time',
9333
9566
  type: 'string',
9334
9567
  },
9335
9568
  device_id: {
9336
- description: 'ID of the device.',
9569
+ description: 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
9337
9570
  format: 'uuid',
9338
9571
  type: 'string',
9339
- 'x-title': 'Device ID',
9340
9572
  },
9341
9573
  event_id: {
9342
9574
  description: 'ID of the event.',
@@ -9345,7 +9577,7 @@ export default {
9345
9577
  },
9346
9578
  event_type: { enum: ['phone.deactivated'], type: 'string' },
9347
9579
  occurred_at: {
9348
- description: 'Time when the event occurred.',
9580
+ description: 'Date and time at which the event occurred.',
9349
9581
  format: 'date-time',
9350
9582
  type: 'string',
9351
9583
  },
@@ -9451,13 +9683,191 @@ export default {
9451
9683
  items: {
9452
9684
  oneOf: [
9453
9685
  {
9454
- properties: {
9455
- error_code: { type: 'string' },
9456
- is_device_error: { enum: [true], type: 'boolean' },
9457
- message: { type: 'string' },
9458
- },
9459
- required: ['message', 'is_device_error', 'error_code'],
9460
- type: 'object',
9686
+ description: 'Error associated with the `device`.',
9687
+ oneOf: [
9688
+ {
9689
+ description: 'Device is offline',
9690
+ properties: {
9691
+ error_code: {
9692
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9693
+ enum: ['device_offline'],
9694
+ type: 'string',
9695
+ },
9696
+ is_device_error: { enum: [true], type: 'boolean' },
9697
+ message: { type: 'string' },
9698
+ },
9699
+ required: ['message', 'is_device_error', 'error_code'],
9700
+ type: 'object',
9701
+ },
9702
+ {
9703
+ description: 'Device has been removed',
9704
+ properties: {
9705
+ error_code: {
9706
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9707
+ enum: ['device_removed'],
9708
+ type: 'string',
9709
+ },
9710
+ is_device_error: { enum: [true], type: 'boolean' },
9711
+ message: { type: 'string' },
9712
+ },
9713
+ required: ['message', 'is_device_error', 'error_code'],
9714
+ type: 'object',
9715
+ },
9716
+ {
9717
+ description: 'Account is disconnected',
9718
+ properties: {
9719
+ error_code: {
9720
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9721
+ enum: ['account_disconnected'],
9722
+ type: 'string',
9723
+ },
9724
+ is_device_error: { enum: [true], type: 'boolean' },
9725
+ message: { type: 'string' },
9726
+ },
9727
+ required: ['message', 'is_device_error', 'error_code'],
9728
+ type: 'object',
9729
+ },
9730
+ {
9731
+ description: 'Hub is disconnected',
9732
+ properties: {
9733
+ error_code: {
9734
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9735
+ enum: ['hub_disconnected'],
9736
+ type: 'string',
9737
+ },
9738
+ is_device_error: { enum: [true], type: 'boolean' },
9739
+ message: { type: 'string' },
9740
+ },
9741
+ required: ['message', 'is_device_error', 'error_code'],
9742
+ type: 'object',
9743
+ },
9744
+ {
9745
+ description: 'Device is disconnected',
9746
+ properties: {
9747
+ error_code: {
9748
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9749
+ enum: ['device_disconnected'],
9750
+ type: 'string',
9751
+ },
9752
+ is_device_error: { enum: [true], type: 'boolean' },
9753
+ message: { type: 'string' },
9754
+ },
9755
+ required: ['message', 'is_device_error', 'error_code'],
9756
+ type: 'object',
9757
+ },
9758
+ {
9759
+ description: 'The backup access code pool is empty.',
9760
+ properties: {
9761
+ error_code: {
9762
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9763
+ enum: ['empty_backup_access_code_pool'],
9764
+ type: 'string',
9765
+ },
9766
+ is_device_error: { enum: [true], type: 'boolean' },
9767
+ message: { type: 'string' },
9768
+ },
9769
+ required: ['message', 'is_device_error', 'error_code'],
9770
+ type: 'object',
9771
+ },
9772
+ {
9773
+ description: 'User is not authorized to use the August Lock.',
9774
+ properties: {
9775
+ error_code: {
9776
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9777
+ enum: ['august_lock_not_authorized'],
9778
+ type: 'string',
9779
+ },
9780
+ is_device_error: { enum: [true], type: 'boolean' },
9781
+ message: { type: 'string' },
9782
+ },
9783
+ required: ['message', 'is_device_error', 'error_code'],
9784
+ type: 'object',
9785
+ },
9786
+ {
9787
+ description: 'Lock is not connected to the Seam Bridge.',
9788
+ properties: {
9789
+ error_code: {
9790
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9791
+ enum: ['august_lock_missing_bridge'],
9792
+ type: 'string',
9793
+ },
9794
+ is_device_error: { enum: [true], type: 'boolean' },
9795
+ message: { type: 'string' },
9796
+ },
9797
+ required: ['message', 'is_device_error', 'error_code'],
9798
+ type: 'object',
9799
+ },
9800
+ {
9801
+ description: 'Salto site user limit reached.',
9802
+ properties: {
9803
+ error_code: {
9804
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9805
+ enum: ['salto_site_user_limit_reached'],
9806
+ type: 'string',
9807
+ },
9808
+ is_device_error: { enum: [true], type: 'boolean' },
9809
+ message: { type: 'string' },
9810
+ },
9811
+ required: ['message', 'is_device_error', 'error_code'],
9812
+ type: 'object',
9813
+ },
9814
+ {
9815
+ description: 'Lock is not paired with a Gateway.',
9816
+ properties: {
9817
+ error_code: {
9818
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9819
+ enum: ['ttlock_lock_not_paired_to_gateway'],
9820
+ type: 'string',
9821
+ },
9822
+ is_device_error: { enum: [true], type: 'boolean' },
9823
+ message: { type: 'string' },
9824
+ },
9825
+ required: ['message', 'is_device_error', 'error_code'],
9826
+ type: 'object',
9827
+ },
9828
+ {
9829
+ description: 'Missing device credentials.',
9830
+ properties: {
9831
+ error_code: {
9832
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9833
+ enum: ['missing_device_credentials'],
9834
+ type: 'string',
9835
+ },
9836
+ is_device_error: { enum: [true], type: 'boolean' },
9837
+ message: { type: 'string' },
9838
+ },
9839
+ required: ['message', 'is_device_error', 'error_code'],
9840
+ type: 'object',
9841
+ },
9842
+ {
9843
+ description: 'The auxiliary heat is running.',
9844
+ properties: {
9845
+ error_code: {
9846
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9847
+ enum: ['auxiliary_heat_running'],
9848
+ type: 'string',
9849
+ },
9850
+ is_device_error: { enum: [true], type: 'boolean' },
9851
+ message: { type: 'string' },
9852
+ },
9853
+ required: ['message', 'is_device_error', 'error_code'],
9854
+ type: 'object',
9855
+ },
9856
+ {
9857
+ description: 'Subscription required to connect.',
9858
+ properties: {
9859
+ error_code: {
9860
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9861
+ enum: ['subscription_required'],
9862
+ type: 'string',
9863
+ },
9864
+ is_device_error: { enum: [true], type: 'boolean' },
9865
+ message: { type: 'string' },
9866
+ },
9867
+ required: ['message', 'is_device_error', 'error_code'],
9868
+ type: 'object',
9869
+ },
9870
+ ],
9461
9871
  },
9462
9872
  {
9463
9873
  properties: {
@@ -9682,13 +10092,191 @@ export default {
9682
10092
  type: 'object',
9683
10093
  },
9684
10094
  {
9685
- properties: {
9686
- error_code: { type: 'string' },
9687
- is_device_error: { enum: [true], type: 'boolean' },
9688
- message: { type: 'string' },
9689
- },
9690
- required: ['message', 'is_device_error', 'error_code'],
9691
- type: 'object',
10095
+ description: 'Error associated with the `device`.',
10096
+ oneOf: [
10097
+ {
10098
+ description: 'Device is offline',
10099
+ properties: {
10100
+ error_code: {
10101
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10102
+ enum: ['device_offline'],
10103
+ type: 'string',
10104
+ },
10105
+ is_device_error: { enum: [true], type: 'boolean' },
10106
+ message: { type: 'string' },
10107
+ },
10108
+ required: ['message', 'is_device_error', 'error_code'],
10109
+ type: 'object',
10110
+ },
10111
+ {
10112
+ description: 'Device has been removed',
10113
+ properties: {
10114
+ error_code: {
10115
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10116
+ enum: ['device_removed'],
10117
+ type: 'string',
10118
+ },
10119
+ is_device_error: { enum: [true], type: 'boolean' },
10120
+ message: { type: 'string' },
10121
+ },
10122
+ required: ['message', 'is_device_error', 'error_code'],
10123
+ type: 'object',
10124
+ },
10125
+ {
10126
+ description: 'Account is disconnected',
10127
+ properties: {
10128
+ error_code: {
10129
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10130
+ enum: ['account_disconnected'],
10131
+ type: 'string',
10132
+ },
10133
+ is_device_error: { enum: [true], type: 'boolean' },
10134
+ message: { type: 'string' },
10135
+ },
10136
+ required: ['message', 'is_device_error', 'error_code'],
10137
+ type: 'object',
10138
+ },
10139
+ {
10140
+ description: 'Hub is disconnected',
10141
+ properties: {
10142
+ error_code: {
10143
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10144
+ enum: ['hub_disconnected'],
10145
+ type: 'string',
10146
+ },
10147
+ is_device_error: { enum: [true], type: 'boolean' },
10148
+ message: { type: 'string' },
10149
+ },
10150
+ required: ['message', 'is_device_error', 'error_code'],
10151
+ type: 'object',
10152
+ },
10153
+ {
10154
+ description: 'Device is disconnected',
10155
+ properties: {
10156
+ error_code: {
10157
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10158
+ enum: ['device_disconnected'],
10159
+ type: 'string',
10160
+ },
10161
+ is_device_error: { enum: [true], type: 'boolean' },
10162
+ message: { type: 'string' },
10163
+ },
10164
+ required: ['message', 'is_device_error', 'error_code'],
10165
+ type: 'object',
10166
+ },
10167
+ {
10168
+ description: 'The backup access code pool is empty.',
10169
+ properties: {
10170
+ error_code: {
10171
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10172
+ enum: ['empty_backup_access_code_pool'],
10173
+ type: 'string',
10174
+ },
10175
+ is_device_error: { enum: [true], type: 'boolean' },
10176
+ message: { type: 'string' },
10177
+ },
10178
+ required: ['message', 'is_device_error', 'error_code'],
10179
+ type: 'object',
10180
+ },
10181
+ {
10182
+ description: 'User is not authorized to use the August Lock.',
10183
+ properties: {
10184
+ error_code: {
10185
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10186
+ enum: ['august_lock_not_authorized'],
10187
+ type: 'string',
10188
+ },
10189
+ is_device_error: { enum: [true], type: 'boolean' },
10190
+ message: { type: 'string' },
10191
+ },
10192
+ required: ['message', 'is_device_error', 'error_code'],
10193
+ type: 'object',
10194
+ },
10195
+ {
10196
+ description: 'Lock is not connected to the Seam Bridge.',
10197
+ properties: {
10198
+ error_code: {
10199
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10200
+ enum: ['august_lock_missing_bridge'],
10201
+ type: 'string',
10202
+ },
10203
+ is_device_error: { enum: [true], type: 'boolean' },
10204
+ message: { type: 'string' },
10205
+ },
10206
+ required: ['message', 'is_device_error', 'error_code'],
10207
+ type: 'object',
10208
+ },
10209
+ {
10210
+ description: 'Salto site user limit reached.',
10211
+ properties: {
10212
+ error_code: {
10213
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10214
+ enum: ['salto_site_user_limit_reached'],
10215
+ type: 'string',
10216
+ },
10217
+ is_device_error: { enum: [true], type: 'boolean' },
10218
+ message: { type: 'string' },
10219
+ },
10220
+ required: ['message', 'is_device_error', 'error_code'],
10221
+ type: 'object',
10222
+ },
10223
+ {
10224
+ description: 'Lock is not paired with a Gateway.',
10225
+ properties: {
10226
+ error_code: {
10227
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10228
+ enum: ['ttlock_lock_not_paired_to_gateway'],
10229
+ type: 'string',
10230
+ },
10231
+ is_device_error: { enum: [true], type: 'boolean' },
10232
+ message: { type: 'string' },
10233
+ },
10234
+ required: ['message', 'is_device_error', 'error_code'],
10235
+ type: 'object',
10236
+ },
10237
+ {
10238
+ description: 'Missing device credentials.',
10239
+ properties: {
10240
+ error_code: {
10241
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10242
+ enum: ['missing_device_credentials'],
10243
+ type: 'string',
10244
+ },
10245
+ is_device_error: { enum: [true], type: 'boolean' },
10246
+ message: { type: 'string' },
10247
+ },
10248
+ required: ['message', 'is_device_error', 'error_code'],
10249
+ type: 'object',
10250
+ },
10251
+ {
10252
+ description: 'The auxiliary heat is running.',
10253
+ properties: {
10254
+ error_code: {
10255
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10256
+ enum: ['auxiliary_heat_running'],
10257
+ type: 'string',
10258
+ },
10259
+ is_device_error: { enum: [true], type: 'boolean' },
10260
+ message: { type: 'string' },
10261
+ },
10262
+ required: ['message', 'is_device_error', 'error_code'],
10263
+ type: 'object',
10264
+ },
10265
+ {
10266
+ description: 'Subscription required to connect.',
10267
+ properties: {
10268
+ error_code: {
10269
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10270
+ enum: ['subscription_required'],
10271
+ type: 'string',
10272
+ },
10273
+ is_device_error: { enum: [true], type: 'boolean' },
10274
+ message: { type: 'string' },
10275
+ },
10276
+ required: ['message', 'is_device_error', 'error_code'],
10277
+ type: 'object',
10278
+ },
10279
+ ],
9692
10280
  },
9693
10281
  {
9694
10282
  properties: {
@@ -9854,13 +10442,191 @@ export default {
9854
10442
  items: {
9855
10443
  oneOf: [
9856
10444
  {
9857
- properties: {
9858
- error_code: { type: 'string' },
9859
- is_device_error: { enum: [true], type: 'boolean' },
9860
- message: { type: 'string' },
9861
- },
9862
- required: ['message', 'is_device_error', 'error_code'],
9863
- type: 'object',
10445
+ description: 'Error associated with the `device`.',
10446
+ oneOf: [
10447
+ {
10448
+ description: 'Device is offline',
10449
+ properties: {
10450
+ error_code: {
10451
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10452
+ enum: ['device_offline'],
10453
+ type: 'string',
10454
+ },
10455
+ is_device_error: { enum: [true], type: 'boolean' },
10456
+ message: { type: 'string' },
10457
+ },
10458
+ required: ['message', 'is_device_error', 'error_code'],
10459
+ type: 'object',
10460
+ },
10461
+ {
10462
+ description: 'Device has been removed',
10463
+ properties: {
10464
+ error_code: {
10465
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10466
+ enum: ['device_removed'],
10467
+ type: 'string',
10468
+ },
10469
+ is_device_error: { enum: [true], type: 'boolean' },
10470
+ message: { type: 'string' },
10471
+ },
10472
+ required: ['message', 'is_device_error', 'error_code'],
10473
+ type: 'object',
10474
+ },
10475
+ {
10476
+ description: 'Account is disconnected',
10477
+ properties: {
10478
+ error_code: {
10479
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10480
+ enum: ['account_disconnected'],
10481
+ type: 'string',
10482
+ },
10483
+ is_device_error: { enum: [true], type: 'boolean' },
10484
+ message: { type: 'string' },
10485
+ },
10486
+ required: ['message', 'is_device_error', 'error_code'],
10487
+ type: 'object',
10488
+ },
10489
+ {
10490
+ description: 'Hub is disconnected',
10491
+ properties: {
10492
+ error_code: {
10493
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10494
+ enum: ['hub_disconnected'],
10495
+ type: 'string',
10496
+ },
10497
+ is_device_error: { enum: [true], type: 'boolean' },
10498
+ message: { type: 'string' },
10499
+ },
10500
+ required: ['message', 'is_device_error', 'error_code'],
10501
+ type: 'object',
10502
+ },
10503
+ {
10504
+ description: 'Device is disconnected',
10505
+ properties: {
10506
+ error_code: {
10507
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10508
+ enum: ['device_disconnected'],
10509
+ type: 'string',
10510
+ },
10511
+ is_device_error: { enum: [true], type: 'boolean' },
10512
+ message: { type: 'string' },
10513
+ },
10514
+ required: ['message', 'is_device_error', 'error_code'],
10515
+ type: 'object',
10516
+ },
10517
+ {
10518
+ description: 'The backup access code pool is empty.',
10519
+ properties: {
10520
+ error_code: {
10521
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10522
+ enum: ['empty_backup_access_code_pool'],
10523
+ type: 'string',
10524
+ },
10525
+ is_device_error: { enum: [true], type: 'boolean' },
10526
+ message: { type: 'string' },
10527
+ },
10528
+ required: ['message', 'is_device_error', 'error_code'],
10529
+ type: 'object',
10530
+ },
10531
+ {
10532
+ description: 'User is not authorized to use the August Lock.',
10533
+ properties: {
10534
+ error_code: {
10535
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10536
+ enum: ['august_lock_not_authorized'],
10537
+ type: 'string',
10538
+ },
10539
+ is_device_error: { enum: [true], type: 'boolean' },
10540
+ message: { type: 'string' },
10541
+ },
10542
+ required: ['message', 'is_device_error', 'error_code'],
10543
+ type: 'object',
10544
+ },
10545
+ {
10546
+ description: 'Lock is not connected to the Seam Bridge.',
10547
+ properties: {
10548
+ error_code: {
10549
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10550
+ enum: ['august_lock_missing_bridge'],
10551
+ type: 'string',
10552
+ },
10553
+ is_device_error: { enum: [true], type: 'boolean' },
10554
+ message: { type: 'string' },
10555
+ },
10556
+ required: ['message', 'is_device_error', 'error_code'],
10557
+ type: 'object',
10558
+ },
10559
+ {
10560
+ description: 'Salto site user limit reached.',
10561
+ properties: {
10562
+ error_code: {
10563
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10564
+ enum: ['salto_site_user_limit_reached'],
10565
+ type: 'string',
10566
+ },
10567
+ is_device_error: { enum: [true], type: 'boolean' },
10568
+ message: { type: 'string' },
10569
+ },
10570
+ required: ['message', 'is_device_error', 'error_code'],
10571
+ type: 'object',
10572
+ },
10573
+ {
10574
+ description: 'Lock is not paired with a Gateway.',
10575
+ properties: {
10576
+ error_code: {
10577
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10578
+ enum: ['ttlock_lock_not_paired_to_gateway'],
10579
+ type: 'string',
10580
+ },
10581
+ is_device_error: { enum: [true], type: 'boolean' },
10582
+ message: { type: 'string' },
10583
+ },
10584
+ required: ['message', 'is_device_error', 'error_code'],
10585
+ type: 'object',
10586
+ },
10587
+ {
10588
+ description: 'Missing device credentials.',
10589
+ properties: {
10590
+ error_code: {
10591
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10592
+ enum: ['missing_device_credentials'],
10593
+ type: 'string',
10594
+ },
10595
+ is_device_error: { enum: [true], type: 'boolean' },
10596
+ message: { type: 'string' },
10597
+ },
10598
+ required: ['message', 'is_device_error', 'error_code'],
10599
+ type: 'object',
10600
+ },
10601
+ {
10602
+ description: 'The auxiliary heat is running.',
10603
+ properties: {
10604
+ error_code: {
10605
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10606
+ enum: ['auxiliary_heat_running'],
10607
+ type: 'string',
10608
+ },
10609
+ is_device_error: { enum: [true], type: 'boolean' },
10610
+ message: { type: 'string' },
10611
+ },
10612
+ required: ['message', 'is_device_error', 'error_code'],
10613
+ type: 'object',
10614
+ },
10615
+ {
10616
+ description: 'Subscription required to connect.',
10617
+ properties: {
10618
+ error_code: {
10619
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10620
+ enum: ['subscription_required'],
10621
+ type: 'string',
10622
+ },
10623
+ is_device_error: { enum: [true], type: 'boolean' },
10624
+ message: { type: 'string' },
10625
+ },
10626
+ required: ['message', 'is_device_error', 'error_code'],
10627
+ type: 'object',
10628
+ },
10629
+ ],
9864
10630
  },
9865
10631
  {
9866
10632
  properties: {