@seamapi/types 1.322.3 → 1.324.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/dist/connect.cjs +743 -742
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +559 -653
  4. package/lib/seam/connect/models/acs/acs-user.d.ts +53 -0
  5. package/lib/seam/connect/models/acs/acs-user.js +23 -0
  6. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  7. package/lib/seam/connect/models/events/access-codes.js +32 -41
  8. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  9. package/lib/seam/connect/models/events/acs/common.js +9 -12
  10. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  11. package/lib/seam/connect/models/events/acs/credentials.js +2 -2
  12. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  13. package/lib/seam/connect/models/events/acs/encoders.js +6 -3
  14. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -1
  15. package/lib/seam/connect/models/events/acs/systems.js +3 -3
  16. package/lib/seam/connect/models/events/acs/systems.js.map +1 -1
  17. package/lib/seam/connect/models/events/acs/users.js +5 -3
  18. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  19. package/lib/seam/connect/models/events/action-attempts.js +10 -22
  20. package/lib/seam/connect/models/events/action-attempts.js.map +1 -1
  21. package/lib/seam/connect/models/events/client-sessions.js +5 -7
  22. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  23. package/lib/seam/connect/models/events/common.js +5 -2
  24. package/lib/seam/connect/models/events/common.js.map +1 -1
  25. package/lib/seam/connect/models/events/connect-webviews.js +10 -14
  26. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  27. package/lib/seam/connect/models/events/connected-accounts.js +15 -19
  28. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  29. package/lib/seam/connect/models/events/devices.js +43 -47
  30. package/lib/seam/connect/models/events/devices.js.map +1 -1
  31. package/lib/seam/connect/models/events/enrollment-automations.js +5 -7
  32. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  33. package/lib/seam/connect/models/events/phones.js +4 -6
  34. package/lib/seam/connect/models/events/phones.js.map +1 -1
  35. package/lib/seam/connect/openapi.d.ts +34 -150
  36. package/lib/seam/connect/openapi.js +410 -463
  37. package/lib/seam/connect/openapi.js.map +1 -1
  38. package/lib/seam/connect/route-types.d.ts +525 -503
  39. package/package.json +1 -1
  40. package/src/lib/seam/connect/models/acs/acs-user.ts +35 -0
  41. package/src/lib/seam/connect/models/events/access-codes.ts +64 -41
  42. package/src/lib/seam/connect/models/events/acs/common.ts +13 -12
  43. package/src/lib/seam/connect/models/events/acs/credentials.ts +6 -2
  44. package/src/lib/seam/connect/models/events/acs/encoders.ts +12 -3
  45. package/src/lib/seam/connect/models/events/acs/systems.ts +9 -3
  46. package/src/lib/seam/connect/models/events/acs/users.ts +10 -4
  47. package/src/lib/seam/connect/models/events/action-attempts.ts +20 -22
  48. package/src/lib/seam/connect/models/events/client-sessions.ts +9 -7
  49. package/src/lib/seam/connect/models/events/common.ts +5 -2
  50. package/src/lib/seam/connect/models/events/connect-webviews.ts +18 -14
  51. package/src/lib/seam/connect/models/events/connected-accounts.ts +25 -19
  52. package/src/lib/seam/connect/models/events/devices.ts +75 -47
  53. package/src/lib/seam/connect/models/events/enrollment-automations.ts +9 -7
  54. package/src/lib/seam/connect/models/events/phones.ts +6 -6
  55. package/src/lib/seam/connect/openapi.ts +568 -463
  56. package/src/lib/seam/connect/route-types.ts +525 -503
@@ -5901,30 +5901,31 @@ export default {
5901
5901
  discriminator: { propertyName: 'event_type' },
5902
5902
  oneOf: [
5903
5903
  {
5904
- description: 'An access code was created.',
5904
+ description:
5905
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.',
5905
5906
  properties: {
5906
5907
  access_code_id: {
5907
- description: 'The ID of the access code.',
5908
+ description:
5909
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5908
5910
  format: 'uuid',
5909
5911
  type: 'string',
5910
- 'x-title': 'Access Code ID',
5911
5912
  },
5912
5913
  connected_account_id: {
5913
- description: 'The ID of the connected account.',
5914
+ description:
5915
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5914
5916
  format: 'uuid',
5915
5917
  type: 'string',
5916
- 'x-title': 'Connected Account ID',
5917
5918
  },
5918
5919
  created_at: {
5919
- description: 'Time at which the event was created.',
5920
+ description: 'Date and time at which the event was created.',
5920
5921
  format: 'date-time',
5921
5922
  type: 'string',
5922
5923
  },
5923
5924
  device_id: {
5924
- description: 'The ID of the device.',
5925
+ description:
5926
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5925
5927
  format: 'uuid',
5926
5928
  type: 'string',
5927
- 'x-title': 'Device ID',
5928
5929
  },
5929
5930
  event_id: {
5930
5931
  description: 'ID of the event.',
@@ -5933,7 +5934,7 @@ export default {
5933
5934
  },
5934
5935
  event_type: { enum: ['access_code.created'], type: 'string' },
5935
5936
  occurred_at: {
5936
- description: 'Time when the event occurred.',
5937
+ description: 'Date and time at which the event occurred.',
5937
5938
  format: 'date-time',
5938
5939
  type: 'string',
5939
5940
  },
@@ -5957,30 +5958,31 @@ export default {
5957
5958
  type: 'object',
5958
5959
  },
5959
5960
  {
5960
- description: 'An access code was changed.',
5961
+ description:
5962
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.',
5961
5963
  properties: {
5962
5964
  access_code_id: {
5963
- description: 'The ID of the access code.',
5965
+ description:
5966
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
5964
5967
  format: 'uuid',
5965
5968
  type: 'string',
5966
- 'x-title': 'Access Code ID',
5967
5969
  },
5968
5970
  connected_account_id: {
5969
- description: 'The ID of the connected account.',
5971
+ description:
5972
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
5970
5973
  format: 'uuid',
5971
5974
  type: 'string',
5972
- 'x-title': 'Connected Account ID',
5973
5975
  },
5974
5976
  created_at: {
5975
- description: 'Time at which the event was created.',
5977
+ description: 'Date and time at which the event was created.',
5976
5978
  format: 'date-time',
5977
5979
  type: 'string',
5978
5980
  },
5979
5981
  device_id: {
5980
- description: 'The ID of the device.',
5982
+ description:
5983
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
5981
5984
  format: 'uuid',
5982
5985
  type: 'string',
5983
- 'x-title': 'Device ID',
5984
5986
  },
5985
5987
  event_id: {
5986
5988
  description: 'ID of the event.',
@@ -5989,7 +5991,7 @@ export default {
5989
5991
  },
5990
5992
  event_type: { enum: ['access_code.changed'], type: 'string' },
5991
5993
  occurred_at: {
5992
- description: 'Time when the event occurred.',
5994
+ description: 'Date and time at which the event occurred.',
5993
5995
  format: 'date-time',
5994
5996
  type: 'string',
5995
5997
  },
@@ -6013,35 +6015,36 @@ export default {
6013
6015
  type: 'object',
6014
6016
  },
6015
6017
  {
6016
- description: 'An access code was natively scheduled on a device.',
6018
+ description:
6019
+ '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.',
6017
6020
  properties: {
6018
6021
  access_code_id: {
6019
- description: 'The ID of the access code.',
6022
+ description:
6023
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6020
6024
  format: 'uuid',
6021
6025
  type: 'string',
6022
- 'x-title': 'Access Code ID',
6023
6026
  },
6024
6027
  code: {
6025
- description: 'The code of the access code.',
6028
+ description:
6029
+ 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6026
6030
  type: 'string',
6027
- 'x-title': 'Access Code',
6028
6031
  },
6029
6032
  connected_account_id: {
6030
- description: 'The ID of the connected account.',
6033
+ description:
6034
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6031
6035
  format: 'uuid',
6032
6036
  type: 'string',
6033
- 'x-title': 'Connected Account ID',
6034
6037
  },
6035
6038
  created_at: {
6036
- description: 'Time at which the event was created.',
6039
+ description: 'Date and time at which the event was created.',
6037
6040
  format: 'date-time',
6038
6041
  type: 'string',
6039
6042
  },
6040
6043
  device_id: {
6041
- description: 'The ID of the device.',
6044
+ description:
6045
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6042
6046
  format: 'uuid',
6043
6047
  type: 'string',
6044
- 'x-title': 'Device ID',
6045
6048
  },
6046
6049
  event_id: {
6047
6050
  description: 'ID of the event.',
@@ -6053,7 +6056,7 @@ export default {
6053
6056
  type: 'string',
6054
6057
  },
6055
6058
  occurred_at: {
6056
- description: 'Time when the event occurred.',
6059
+ description: 'Date and time at which the event occurred.',
6057
6060
  format: 'date-time',
6058
6061
  type: 'string',
6059
6062
  },
@@ -6078,35 +6081,36 @@ export default {
6078
6081
  type: 'object',
6079
6082
  },
6080
6083
  {
6081
- description: 'An access code was set on a device.',
6084
+ description:
6085
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.',
6082
6086
  properties: {
6083
6087
  access_code_id: {
6084
- description: 'The ID of the access code.',
6088
+ description:
6089
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6085
6090
  format: 'uuid',
6086
6091
  type: 'string',
6087
- 'x-title': 'Access Code ID',
6088
6092
  },
6089
6093
  code: {
6090
- description: 'The code of the access code.',
6094
+ description:
6095
+ 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6091
6096
  type: 'string',
6092
- 'x-title': 'Access Code',
6093
6097
  },
6094
6098
  connected_account_id: {
6095
- description: 'The ID of the connected account.',
6099
+ description:
6100
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6096
6101
  format: 'uuid',
6097
6102
  type: 'string',
6098
- 'x-title': 'Connected Account ID',
6099
6103
  },
6100
6104
  created_at: {
6101
- description: 'Time at which the event was created.',
6105
+ description: 'Date and time at which the event was created.',
6102
6106
  format: 'date-time',
6103
6107
  type: 'string',
6104
6108
  },
6105
6109
  device_id: {
6106
- description: 'The ID of the device.',
6110
+ description:
6111
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6107
6112
  format: 'uuid',
6108
6113
  type: 'string',
6109
- 'x-title': 'Device ID',
6110
6114
  },
6111
6115
  event_id: {
6112
6116
  description: 'ID of the event.',
@@ -6118,7 +6122,7 @@ export default {
6118
6122
  type: 'string',
6119
6123
  },
6120
6124
  occurred_at: {
6121
- description: 'Time when the event occurred.',
6125
+ description: 'Date and time at which the event occurred.',
6122
6126
  format: 'date-time',
6123
6127
  type: 'string',
6124
6128
  },
@@ -6143,30 +6147,31 @@ export default {
6143
6147
  type: 'object',
6144
6148
  },
6145
6149
  {
6146
- description: 'An access code was removed from a device.',
6150
+ description:
6151
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.',
6147
6152
  properties: {
6148
6153
  access_code_id: {
6149
- description: 'The ID of the access code.',
6154
+ description:
6155
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6150
6156
  format: 'uuid',
6151
6157
  type: 'string',
6152
- 'x-title': 'Access Code ID',
6153
6158
  },
6154
6159
  connected_account_id: {
6155
- description: 'The ID of the connected account.',
6160
+ description:
6161
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6156
6162
  format: 'uuid',
6157
6163
  type: 'string',
6158
- 'x-title': 'Connected Account ID',
6159
6164
  },
6160
6165
  created_at: {
6161
- description: 'Time at which the event was created.',
6166
+ description: 'Date and time at which the event was created.',
6162
6167
  format: 'date-time',
6163
6168
  type: 'string',
6164
6169
  },
6165
6170
  device_id: {
6166
- description: 'The ID of the device.',
6171
+ description:
6172
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6167
6173
  format: 'uuid',
6168
6174
  type: 'string',
6169
- 'x-title': 'Device ID',
6170
6175
  },
6171
6176
  event_id: {
6172
6177
  description: 'ID of the event.',
@@ -6178,7 +6183,7 @@ export default {
6178
6183
  type: 'string',
6179
6184
  },
6180
6185
  occurred_at: {
6181
- description: 'Time when the event occurred.',
6186
+ description: 'Date and time at which the event occurred.',
6182
6187
  format: 'date-time',
6183
6188
  type: 'string',
6184
6189
  },
@@ -6203,30 +6208,30 @@ export default {
6203
6208
  },
6204
6209
  {
6205
6210
  description:
6206
- 'There was an unusually long delay in setting an access code on a device.',
6211
+ '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.',
6207
6212
  properties: {
6208
6213
  access_code_id: {
6209
- description: 'The ID of the access code.',
6214
+ description:
6215
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6210
6216
  format: 'uuid',
6211
6217
  type: 'string',
6212
- 'x-title': 'Access Code ID',
6213
6218
  },
6214
6219
  connected_account_id: {
6215
- description: 'The ID of the connected account.',
6220
+ description:
6221
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6216
6222
  format: 'uuid',
6217
6223
  type: 'string',
6218
- 'x-title': 'Connected Account ID',
6219
6224
  },
6220
6225
  created_at: {
6221
- description: 'Time at which the event was created.',
6226
+ description: 'Date and time at which the event was created.',
6222
6227
  format: 'date-time',
6223
6228
  type: 'string',
6224
6229
  },
6225
6230
  device_id: {
6226
- description: 'The ID of the device.',
6231
+ description:
6232
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6227
6233
  format: 'uuid',
6228
6234
  type: 'string',
6229
- 'x-title': 'Device ID',
6230
6235
  },
6231
6236
  event_id: {
6232
6237
  description: 'ID of the event.',
@@ -6238,7 +6243,7 @@ export default {
6238
6243
  type: 'string',
6239
6244
  },
6240
6245
  occurred_at: {
6241
- description: 'Time when the event occurred.',
6246
+ description: 'Date and time at which the event occurred.',
6242
6247
  format: 'date-time',
6243
6248
  type: 'string',
6244
6249
  },
@@ -6262,30 +6267,31 @@ export default {
6262
6267
  type: 'object',
6263
6268
  },
6264
6269
  {
6265
- description: 'An access code failed to be set on a device.',
6270
+ description:
6271
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.',
6266
6272
  properties: {
6267
6273
  access_code_id: {
6268
- description: 'The ID of the access code.',
6274
+ description:
6275
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6269
6276
  format: 'uuid',
6270
6277
  type: 'string',
6271
- 'x-title': 'Access Code ID',
6272
6278
  },
6273
6279
  connected_account_id: {
6274
- description: 'The ID of the connected account.',
6280
+ description:
6281
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6275
6282
  format: 'uuid',
6276
6283
  type: 'string',
6277
- 'x-title': 'Connected Account ID',
6278
6284
  },
6279
6285
  created_at: {
6280
- description: 'Time at which the event was created.',
6286
+ description: 'Date and time at which the event was created.',
6281
6287
  format: 'date-time',
6282
6288
  type: 'string',
6283
6289
  },
6284
6290
  device_id: {
6285
- description: 'The ID of the device.',
6291
+ description:
6292
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6286
6293
  format: 'uuid',
6287
6294
  type: 'string',
6288
- 'x-title': 'Device ID',
6289
6295
  },
6290
6296
  event_id: {
6291
6297
  description: 'ID of the event.',
@@ -6297,7 +6303,7 @@ export default {
6297
6303
  type: 'string',
6298
6304
  },
6299
6305
  occurred_at: {
6300
- description: 'Time when the event occurred.',
6306
+ description: 'Date and time at which the event occurred.',
6301
6307
  format: 'date-time',
6302
6308
  type: 'string',
6303
6309
  },
@@ -6321,36 +6327,37 @@ export default {
6321
6327
  type: 'object',
6322
6328
  },
6323
6329
  {
6324
- description: 'An access code was deleted.',
6330
+ description:
6331
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.',
6325
6332
  properties: {
6326
6333
  access_code_id: {
6327
- description: 'The ID of the access code.',
6334
+ description:
6335
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6328
6336
  format: 'uuid',
6329
6337
  type: 'string',
6330
- 'x-title': 'Access Code ID',
6331
6338
  },
6332
6339
  code: {
6333
- description: 'The code of the access code.',
6340
+ description:
6341
+ 'Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6334
6342
  nullable: true,
6335
6343
  type: 'string',
6336
- 'x-title': 'Access Code',
6337
6344
  },
6338
6345
  connected_account_id: {
6339
- description: 'The ID of the connected account.',
6346
+ description:
6347
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6340
6348
  format: 'uuid',
6341
6349
  type: 'string',
6342
- 'x-title': 'Connected Account ID',
6343
6350
  },
6344
6351
  created_at: {
6345
- description: 'Time at which the event was created.',
6352
+ description: 'Date and time at which the event was created.',
6346
6353
  format: 'date-time',
6347
6354
  type: 'string',
6348
6355
  },
6349
6356
  device_id: {
6350
- description: 'The ID of the device.',
6357
+ description:
6358
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6351
6359
  format: 'uuid',
6352
6360
  type: 'string',
6353
- 'x-title': 'Device ID',
6354
6361
  },
6355
6362
  event_id: {
6356
6363
  description: 'ID of the event.',
@@ -6359,7 +6366,7 @@ export default {
6359
6366
  },
6360
6367
  event_type: { enum: ['access_code.deleted'], type: 'string' },
6361
6368
  occurred_at: {
6362
- description: 'Time when the event occurred.',
6369
+ description: 'Date and time at which the event occurred.',
6363
6370
  format: 'date-time',
6364
6371
  type: 'string',
6365
6372
  },
@@ -6385,30 +6392,30 @@ export default {
6385
6392
  },
6386
6393
  {
6387
6394
  description:
6388
- 'There was an unusually long delay in removing an access code from a device.',
6395
+ '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.',
6389
6396
  properties: {
6390
6397
  access_code_id: {
6391
- description: 'The ID of the access code.',
6398
+ description:
6399
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6392
6400
  format: 'uuid',
6393
6401
  type: 'string',
6394
- 'x-title': 'Access Code ID',
6395
6402
  },
6396
6403
  connected_account_id: {
6397
- description: 'The ID of the connected account.',
6404
+ description:
6405
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6398
6406
  format: 'uuid',
6399
6407
  type: 'string',
6400
- 'x-title': 'Connected Account ID',
6401
6408
  },
6402
6409
  created_at: {
6403
- description: 'Time at which the event was created.',
6410
+ description: 'Date and time at which the event was created.',
6404
6411
  format: 'date-time',
6405
6412
  type: 'string',
6406
6413
  },
6407
6414
  device_id: {
6408
- description: 'The ID of the device.',
6415
+ description:
6416
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6409
6417
  format: 'uuid',
6410
6418
  type: 'string',
6411
- 'x-title': 'Device ID',
6412
6419
  },
6413
6420
  event_id: {
6414
6421
  description: 'ID of the event.',
@@ -6420,7 +6427,7 @@ export default {
6420
6427
  type: 'string',
6421
6428
  },
6422
6429
  occurred_at: {
6423
- description: 'Time when the event occurred.',
6430
+ description: 'Date and time at which the event occurred.',
6424
6431
  format: 'date-time',
6425
6432
  type: 'string',
6426
6433
  },
@@ -6444,30 +6451,31 @@ export default {
6444
6451
  type: 'object',
6445
6452
  },
6446
6453
  {
6447
- description: 'An access code failed to be removed from a device.',
6454
+ description:
6455
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.',
6448
6456
  properties: {
6449
6457
  access_code_id: {
6450
- description: 'The ID of the access code.',
6458
+ description:
6459
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6451
6460
  format: 'uuid',
6452
6461
  type: 'string',
6453
- 'x-title': 'Access Code ID',
6454
6462
  },
6455
6463
  connected_account_id: {
6456
- description: 'The ID of the connected account.',
6464
+ description:
6465
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6457
6466
  format: 'uuid',
6458
6467
  type: 'string',
6459
- 'x-title': 'Connected Account ID',
6460
6468
  },
6461
6469
  created_at: {
6462
- description: 'Time at which the event was created.',
6470
+ description: 'Date and time at which the event was created.',
6463
6471
  format: 'date-time',
6464
6472
  type: 'string',
6465
6473
  },
6466
6474
  device_id: {
6467
- description: 'The ID of the device.',
6475
+ description:
6476
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6468
6477
  format: 'uuid',
6469
6478
  type: 'string',
6470
- 'x-title': 'Device ID',
6471
6479
  },
6472
6480
  event_id: {
6473
6481
  description: 'ID of the event.',
@@ -6479,7 +6487,7 @@ export default {
6479
6487
  type: 'string',
6480
6488
  },
6481
6489
  occurred_at: {
6482
- description: 'Time when the event occurred.',
6490
+ description: 'Date and time at which the event occurred.',
6483
6491
  format: 'date-time',
6484
6492
  type: 'string',
6485
6493
  },
@@ -6503,30 +6511,31 @@ export default {
6503
6511
  type: 'object',
6504
6512
  },
6505
6513
  {
6506
- description: 'An access code was modified external to Seam.',
6514
+ description:
6515
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.',
6507
6516
  properties: {
6508
6517
  access_code_id: {
6509
- description: 'The ID of the access code.',
6518
+ description:
6519
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6510
6520
  format: 'uuid',
6511
6521
  type: 'string',
6512
- 'x-title': 'Access Code ID',
6513
6522
  },
6514
6523
  connected_account_id: {
6515
- description: 'The ID of the connected account.',
6524
+ description:
6525
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6516
6526
  format: 'uuid',
6517
6527
  type: 'string',
6518
- 'x-title': 'Connected Account ID',
6519
6528
  },
6520
6529
  created_at: {
6521
- description: 'Time at which the event was created.',
6530
+ description: 'Date and time at which the event was created.',
6522
6531
  format: 'date-time',
6523
6532
  type: 'string',
6524
6533
  },
6525
6534
  device_id: {
6526
- description: 'The ID of the device.',
6535
+ description:
6536
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6527
6537
  format: 'uuid',
6528
6538
  type: 'string',
6529
- 'x-title': 'Device ID',
6530
6539
  },
6531
6540
  event_id: {
6532
6541
  description: 'ID of the event.',
@@ -6538,7 +6547,7 @@ export default {
6538
6547
  type: 'string',
6539
6548
  },
6540
6549
  occurred_at: {
6541
- description: 'Time when the event occurred.',
6550
+ description: 'Date and time at which the event occurred.',
6542
6551
  format: 'date-time',
6543
6552
  type: 'string',
6544
6553
  },
@@ -6562,30 +6571,31 @@ export default {
6562
6571
  type: 'object',
6563
6572
  },
6564
6573
  {
6565
- description: 'An access code was deleted external to Seam.',
6574
+ description:
6575
+ 'An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.',
6566
6576
  properties: {
6567
6577
  access_code_id: {
6568
- description: 'The ID of the access code.',
6578
+ description:
6579
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6569
6580
  format: 'uuid',
6570
6581
  type: 'string',
6571
- 'x-title': 'Access Code ID',
6572
6582
  },
6573
6583
  connected_account_id: {
6574
- description: 'The ID of the connected account.',
6584
+ description:
6585
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6575
6586
  format: 'uuid',
6576
6587
  type: 'string',
6577
- 'x-title': 'Connected Account ID',
6578
6588
  },
6579
6589
  created_at: {
6580
- description: 'Time at which the event was created.',
6590
+ description: 'Date and time at which the event was created.',
6581
6591
  format: 'date-time',
6582
6592
  type: 'string',
6583
6593
  },
6584
6594
  device_id: {
6585
- description: 'The ID of the device.',
6595
+ description:
6596
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6586
6597
  format: 'uuid',
6587
6598
  type: 'string',
6588
- 'x-title': 'Device ID',
6589
6599
  },
6590
6600
  event_id: {
6591
6601
  description: 'ID of the event.',
@@ -6597,7 +6607,7 @@ export default {
6597
6607
  type: 'string',
6598
6608
  },
6599
6609
  occurred_at: {
6600
- description: 'Time when the event occurred.',
6610
+ description: 'Date and time at which the event occurred.',
6601
6611
  format: 'date-time',
6602
6612
  type: 'string',
6603
6613
  },
@@ -6622,31 +6632,31 @@ export default {
6622
6632
  },
6623
6633
  {
6624
6634
  description:
6625
- 'A backup access code was pulled from the backup access code pool and set on a device.',
6635
+ '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.',
6626
6636
  properties: {
6627
6637
  access_code_id: {
6628
- description: 'The ID of the access code.',
6638
+ description:
6639
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6629
6640
  format: 'uuid',
6630
6641
  type: 'string',
6631
- 'x-title': 'Access Code ID',
6632
6642
  },
6633
6643
  backup_access_code_id: { type: 'string' },
6634
6644
  connected_account_id: {
6635
- description: 'The ID of the connected account.',
6645
+ description:
6646
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6636
6647
  format: 'uuid',
6637
6648
  type: 'string',
6638
- 'x-title': 'Connected Account ID',
6639
6649
  },
6640
6650
  created_at: {
6641
- description: 'Time at which the event was created.',
6651
+ description: 'Date and time at which the event was created.',
6642
6652
  format: 'date-time',
6643
6653
  type: 'string',
6644
6654
  },
6645
6655
  device_id: {
6646
- description: 'The ID of the device.',
6656
+ description:
6657
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6647
6658
  format: 'uuid',
6648
6659
  type: 'string',
6649
- 'x-title': 'Device ID',
6650
6660
  },
6651
6661
  event_id: {
6652
6662
  description: 'ID of the event.',
@@ -6658,7 +6668,7 @@ export default {
6658
6668
  type: 'string',
6659
6669
  },
6660
6670
  occurred_at: {
6661
- description: 'Time when the event occurred.',
6671
+ description: 'Date and time at which the event occurred.',
6662
6672
  format: 'date-time',
6663
6673
  type: 'string',
6664
6674
  },
@@ -6684,30 +6694,30 @@ export default {
6684
6694
  },
6685
6695
  {
6686
6696
  description:
6687
- 'An unmanaged access code was successfully converted to a managed access code.',
6697
+ '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.',
6688
6698
  properties: {
6689
6699
  access_code_id: {
6690
- description: 'The ID of the access code.',
6700
+ description:
6701
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6691
6702
  format: 'uuid',
6692
6703
  type: 'string',
6693
- 'x-title': 'Access Code ID',
6694
6704
  },
6695
6705
  connected_account_id: {
6696
- description: 'The ID of the connected account.',
6706
+ description:
6707
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6697
6708
  format: 'uuid',
6698
6709
  type: 'string',
6699
- 'x-title': 'Connected Account ID',
6700
6710
  },
6701
6711
  created_at: {
6702
- description: 'Time at which the event was created.',
6712
+ description: 'Date and time at which the event was created.',
6703
6713
  format: 'date-time',
6704
6714
  type: 'string',
6705
6715
  },
6706
6716
  device_id: {
6707
- description: 'The ID of the device.',
6717
+ description:
6718
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6708
6719
  format: 'uuid',
6709
6720
  type: 'string',
6710
- 'x-title': 'Device ID',
6711
6721
  },
6712
6722
  event_id: {
6713
6723
  description: 'ID of the event.',
@@ -6719,7 +6729,7 @@ export default {
6719
6729
  type: 'string',
6720
6730
  },
6721
6731
  occurred_at: {
6722
- description: 'Time when the event occurred.',
6732
+ description: 'Date and time at which the event occurred.',
6723
6733
  format: 'date-time',
6724
6734
  type: 'string',
6725
6735
  },
@@ -6744,30 +6754,30 @@ export default {
6744
6754
  },
6745
6755
  {
6746
6756
  description:
6747
- 'An unmanaged access code failed to be converted to a managed access code.',
6757
+ '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.',
6748
6758
  properties: {
6749
6759
  access_code_id: {
6750
- description: 'The ID of the access code.',
6760
+ description:
6761
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6751
6762
  format: 'uuid',
6752
6763
  type: 'string',
6753
- 'x-title': 'Access Code ID',
6754
6764
  },
6755
6765
  connected_account_id: {
6756
- description: 'The ID of the connected account.',
6766
+ description:
6767
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6757
6768
  format: 'uuid',
6758
6769
  type: 'string',
6759
- 'x-title': 'Connected Account ID',
6760
6770
  },
6761
6771
  created_at: {
6762
- description: 'Time at which the event was created.',
6772
+ description: 'Date and time at which the event was created.',
6763
6773
  format: 'date-time',
6764
6774
  type: 'string',
6765
6775
  },
6766
6776
  device_id: {
6767
- description: 'The ID of the device.',
6777
+ description:
6778
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6768
6779
  format: 'uuid',
6769
6780
  type: 'string',
6770
- 'x-title': 'Device ID',
6771
6781
  },
6772
6782
  event_id: {
6773
6783
  description: 'ID of the event.',
@@ -6779,7 +6789,7 @@ export default {
6779
6789
  type: 'string',
6780
6790
  },
6781
6791
  occurred_at: {
6782
- description: 'Time when the event occurred.',
6792
+ description: 'Date and time at which the event occurred.',
6783
6793
  format: 'date-time',
6784
6794
  type: 'string',
6785
6795
  },
@@ -6803,30 +6813,31 @@ export default {
6803
6813
  type: 'object',
6804
6814
  },
6805
6815
  {
6806
- description: 'An unmanaged access code was created on a device.',
6816
+ description:
6817
+ 'An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.',
6807
6818
  properties: {
6808
6819
  access_code_id: {
6809
- description: 'The ID of the access code.',
6820
+ description:
6821
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6810
6822
  format: 'uuid',
6811
6823
  type: 'string',
6812
- 'x-title': 'Access Code ID',
6813
6824
  },
6814
6825
  connected_account_id: {
6815
- description: 'The ID of the connected account.',
6826
+ description:
6827
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6816
6828
  format: 'uuid',
6817
6829
  type: 'string',
6818
- 'x-title': 'Connected Account ID',
6819
6830
  },
6820
6831
  created_at: {
6821
- description: 'Time at which the event was created.',
6832
+ description: 'Date and time at which the event was created.',
6822
6833
  format: 'date-time',
6823
6834
  type: 'string',
6824
6835
  },
6825
6836
  device_id: {
6826
- description: 'The ID of the device.',
6837
+ description:
6838
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6827
6839
  format: 'uuid',
6828
6840
  type: 'string',
6829
- 'x-title': 'Device ID',
6830
6841
  },
6831
6842
  event_id: {
6832
6843
  description: 'ID of the event.',
@@ -6838,7 +6849,7 @@ export default {
6838
6849
  type: 'string',
6839
6850
  },
6840
6851
  occurred_at: {
6841
- description: 'Time when the event occurred.',
6852
+ description: 'Date and time at which the event occurred.',
6842
6853
  format: 'date-time',
6843
6854
  type: 'string',
6844
6855
  },
@@ -6862,30 +6873,31 @@ export default {
6862
6873
  type: 'object',
6863
6874
  },
6864
6875
  {
6865
- description: 'An unmanaged access code was removed from a device.',
6876
+ description:
6877
+ 'An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.',
6866
6878
  properties: {
6867
6879
  access_code_id: {
6868
- description: 'The ID of the access code.',
6880
+ description:
6881
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
6869
6882
  format: 'uuid',
6870
6883
  type: 'string',
6871
- 'x-title': 'Access Code ID',
6872
6884
  },
6873
6885
  connected_account_id: {
6874
- description: 'The ID of the connected account.',
6886
+ description:
6887
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6875
6888
  format: 'uuid',
6876
6889
  type: 'string',
6877
- 'x-title': 'Connected Account ID',
6878
6890
  },
6879
6891
  created_at: {
6880
- description: 'Time at which the event was created.',
6892
+ description: 'Date and time at which the event was created.',
6881
6893
  format: 'date-time',
6882
6894
  type: 'string',
6883
6895
  },
6884
6896
  device_id: {
6885
- description: 'The ID of the device.',
6897
+ description:
6898
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
6886
6899
  format: 'uuid',
6887
6900
  type: 'string',
6888
- 'x-title': 'Device ID',
6889
6901
  },
6890
6902
  event_id: {
6891
6903
  description: 'ID of the event.',
@@ -6897,7 +6909,7 @@ export default {
6897
6909
  type: 'string',
6898
6910
  },
6899
6911
  occurred_at: {
6900
- description: 'Time when the event occurred.',
6912
+ description: 'Date and time at which the event occurred.',
6901
6913
  format: 'date-time',
6902
6914
  type: 'string',
6903
6915
  },
@@ -6921,22 +6933,23 @@ export default {
6921
6933
  type: 'object',
6922
6934
  },
6923
6935
  {
6924
- description: 'An ACS system was connected.',
6936
+ description:
6937
+ 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.',
6925
6938
  properties: {
6926
6939
  acs_system_id: {
6927
- description: 'ID of the ACS system.',
6940
+ description:
6941
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6928
6942
  format: 'uuid',
6929
6943
  type: 'string',
6930
- 'x-title': 'ACS System ID',
6931
6944
  },
6932
6945
  connected_account_id: {
6933
- description: 'ID of the connected account.',
6946
+ description:
6947
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6934
6948
  format: 'uuid',
6935
6949
  type: 'string',
6936
- 'x-title': 'Connected Account ID',
6937
6950
  },
6938
6951
  created_at: {
6939
- description: 'Time at which the event was created.',
6952
+ description: 'Date and time at which the event was created.',
6940
6953
  format: 'date-time',
6941
6954
  type: 'string',
6942
6955
  },
@@ -6947,7 +6960,7 @@ export default {
6947
6960
  },
6948
6961
  event_type: { enum: ['acs_system.connected'], type: 'string' },
6949
6962
  occurred_at: {
6950
- description: 'Time when the event occurred.',
6963
+ description: 'Date and time at which the event occurred.',
6951
6964
  format: 'date-time',
6952
6965
  type: 'string',
6953
6966
  },
@@ -6969,22 +6982,23 @@ export default {
6969
6982
  type: 'object',
6970
6983
  },
6971
6984
  {
6972
- description: 'An ACS system was added.',
6985
+ description:
6986
+ 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.',
6973
6987
  properties: {
6974
6988
  acs_system_id: {
6975
- description: 'ID of the ACS system.',
6989
+ description:
6990
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
6976
6991
  format: 'uuid',
6977
6992
  type: 'string',
6978
- 'x-title': 'ACS System ID',
6979
6993
  },
6980
6994
  connected_account_id: {
6981
- description: 'ID of the connected account.',
6995
+ description:
6996
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
6982
6997
  format: 'uuid',
6983
6998
  type: 'string',
6984
- 'x-title': 'Connected Account ID',
6985
6999
  },
6986
7000
  created_at: {
6987
- description: 'Time at which the event was created.',
7001
+ description: 'Date and time at which the event was created.',
6988
7002
  format: 'date-time',
6989
7003
  type: 'string',
6990
7004
  },
@@ -6995,7 +7009,7 @@ export default {
6995
7009
  },
6996
7010
  event_type: { enum: ['acs_system.added'], type: 'string' },
6997
7011
  occurred_at: {
6998
- description: 'Time when the event occurred.',
7012
+ description: 'Date and time at which the event occurred.',
6999
7013
  format: 'date-time',
7000
7014
  type: 'string',
7001
7015
  },
@@ -7017,22 +7031,23 @@ export default {
7017
7031
  type: 'object',
7018
7032
  },
7019
7033
  {
7020
- description: 'An ACS system was disconnected.',
7034
+ description:
7035
+ 'An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.',
7021
7036
  properties: {
7022
7037
  acs_system_id: {
7023
- description: 'ID of the ACS system.',
7038
+ description:
7039
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
7024
7040
  format: 'uuid',
7025
7041
  type: 'string',
7026
- 'x-title': 'ACS System ID',
7027
7042
  },
7028
7043
  connected_account_id: {
7029
- description: 'ID of the connected account.',
7044
+ description:
7045
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7030
7046
  format: 'uuid',
7031
7047
  type: 'string',
7032
- 'x-title': 'Connected Account ID',
7033
7048
  },
7034
7049
  created_at: {
7035
- description: 'Time at which the event was created.',
7050
+ description: 'Date and time at which the event was created.',
7036
7051
  format: 'date-time',
7037
7052
  type: 'string',
7038
7053
  },
@@ -7043,7 +7058,7 @@ export default {
7043
7058
  },
7044
7059
  event_type: { enum: ['acs_system.disconnected'], type: 'string' },
7045
7060
  occurred_at: {
7046
- description: 'Time when the event occurred.',
7061
+ description: 'Date and time at which the event occurred.',
7047
7062
  format: 'date-time',
7048
7063
  type: 'string',
7049
7064
  },
@@ -7065,23 +7080,24 @@ export default {
7065
7080
  type: 'object',
7066
7081
  },
7067
7082
  {
7068
- description: 'An ACS credential was deleted.',
7083
+ description:
7084
+ 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was deleted.',
7069
7085
  properties: {
7070
7086
  acs_credential_id: { format: 'uuid', type: 'string' },
7071
7087
  acs_system_id: {
7072
- description: 'ID of the ACS system.',
7088
+ description:
7089
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
7073
7090
  format: 'uuid',
7074
7091
  type: 'string',
7075
- 'x-title': 'ACS System ID',
7076
7092
  },
7077
7093
  connected_account_id: {
7078
- description: 'ID of the connected account.',
7094
+ description:
7095
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7079
7096
  format: 'uuid',
7080
7097
  type: 'string',
7081
- 'x-title': 'Connected Account ID',
7082
7098
  },
7083
7099
  created_at: {
7084
- description: 'Time at which the event was created.',
7100
+ description: 'Date and time at which the event was created.',
7085
7101
  format: 'date-time',
7086
7102
  type: 'string',
7087
7103
  },
@@ -7092,7 +7108,7 @@ export default {
7092
7108
  },
7093
7109
  event_type: { enum: ['acs_credential.deleted'], type: 'string' },
7094
7110
  occurred_at: {
7095
- description: 'Time when the event occurred.',
7111
+ description: 'Date and time at which the event occurred.',
7096
7112
  format: 'date-time',
7097
7113
  type: 'string',
7098
7114
  },
@@ -7115,23 +7131,24 @@ export default {
7115
7131
  type: 'object',
7116
7132
  },
7117
7133
  {
7118
- description: 'An ACS credential was issued.',
7134
+ description:
7135
+ 'An [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was issued.',
7119
7136
  properties: {
7120
7137
  acs_credential_id: { format: 'uuid', type: 'string' },
7121
7138
  acs_system_id: {
7122
- description: 'ID of the ACS system.',
7139
+ description:
7140
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
7123
7141
  format: 'uuid',
7124
7142
  type: 'string',
7125
- 'x-title': 'ACS System ID',
7126
7143
  },
7127
7144
  connected_account_id: {
7128
- description: 'ID of the connected account.',
7145
+ description:
7146
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7129
7147
  format: 'uuid',
7130
7148
  type: 'string',
7131
- 'x-title': 'Connected Account ID',
7132
7149
  },
7133
7150
  created_at: {
7134
- description: 'Time at which the event was created.',
7151
+ description: 'Date and time at which the event was created.',
7135
7152
  format: 'date-time',
7136
7153
  type: 'string',
7137
7154
  },
@@ -7142,7 +7159,7 @@ export default {
7142
7159
  },
7143
7160
  event_type: { enum: ['acs_credential.issued'], type: 'string' },
7144
7161
  occurred_at: {
7145
- description: 'Time when the event occurred.',
7162
+ description: 'Date and time at which the event occurred.',
7146
7163
  format: 'date-time',
7147
7164
  type: 'string',
7148
7165
  },
@@ -7165,23 +7182,24 @@ export default {
7165
7182
  type: 'object',
7166
7183
  },
7167
7184
  {
7168
- description: 'An ACS user was deleted.',
7185
+ description:
7186
+ 'An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.',
7169
7187
  properties: {
7170
7188
  acs_system_id: {
7171
- description: 'ID of the ACS system.',
7189
+ description:
7190
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
7172
7191
  format: 'uuid',
7173
7192
  type: 'string',
7174
- 'x-title': 'ACS System ID',
7175
7193
  },
7176
7194
  acs_user_id: { format: 'uuid', type: 'string' },
7177
7195
  connected_account_id: {
7178
- description: 'ID of the connected account.',
7196
+ description:
7197
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7179
7198
  format: 'uuid',
7180
7199
  type: 'string',
7181
- 'x-title': 'Connected Account ID',
7182
7200
  },
7183
7201
  created_at: {
7184
- description: 'Time at which the event was created.',
7202
+ description: 'Date and time at which the event was created.',
7185
7203
  format: 'date-time',
7186
7204
  type: 'string',
7187
7205
  },
@@ -7192,7 +7210,7 @@ export default {
7192
7210
  },
7193
7211
  event_type: { enum: ['acs_user.deleted'], type: 'string' },
7194
7212
  occurred_at: {
7195
- description: 'Time when the event occurred.',
7213
+ description: 'Date and time at which the event occurred.',
7196
7214
  format: 'date-time',
7197
7215
  type: 'string',
7198
7216
  },
@@ -7215,27 +7233,29 @@ export default {
7215
7233
  type: 'object',
7216
7234
  },
7217
7235
  {
7218
- description: 'An ACS encoder was added.',
7236
+ description:
7237
+ 'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was added.',
7219
7238
  properties: {
7220
7239
  acs_encoder_id: {
7221
- description: 'ID of the ACS encoder.',
7240
+ description:
7241
+ 'ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
7222
7242
  format: 'uuid',
7223
7243
  type: 'string',
7224
7244
  },
7225
7245
  acs_system_id: {
7226
- description: 'ID of the ACS system.',
7246
+ description:
7247
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
7227
7248
  format: 'uuid',
7228
7249
  type: 'string',
7229
- 'x-title': 'ACS System ID',
7230
7250
  },
7231
7251
  connected_account_id: {
7232
- description: 'ID of the connected account.',
7252
+ description:
7253
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7233
7254
  format: 'uuid',
7234
7255
  type: 'string',
7235
- 'x-title': 'Connected Account ID',
7236
7256
  },
7237
7257
  created_at: {
7238
- description: 'Time at which the event was created.',
7258
+ description: 'Date and time at which the event was created.',
7239
7259
  format: 'date-time',
7240
7260
  type: 'string',
7241
7261
  },
@@ -7246,7 +7266,7 @@ export default {
7246
7266
  },
7247
7267
  event_type: { enum: ['acs_encoder.added'], type: 'string' },
7248
7268
  occurred_at: {
7249
- description: 'Time when the event occurred.',
7269
+ description: 'Date and time at which the event occurred.',
7250
7270
  format: 'date-time',
7251
7271
  type: 'string',
7252
7272
  },
@@ -7269,27 +7289,29 @@ export default {
7269
7289
  type: 'object',
7270
7290
  },
7271
7291
  {
7272
- description: 'An ACS encoder was removed.',
7292
+ description:
7293
+ 'An [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was removed.',
7273
7294
  properties: {
7274
7295
  acs_encoder_id: {
7275
- description: 'ID of the ACS encoder.',
7296
+ description:
7297
+ 'ID of the [ACS encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
7276
7298
  format: 'uuid',
7277
7299
  type: 'string',
7278
7300
  },
7279
7301
  acs_system_id: {
7280
- description: 'ID of the ACS system.',
7302
+ description:
7303
+ 'ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).',
7281
7304
  format: 'uuid',
7282
7305
  type: 'string',
7283
- 'x-title': 'ACS System ID',
7284
7306
  },
7285
7307
  connected_account_id: {
7286
- description: 'ID of the connected account.',
7308
+ description:
7309
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7287
7310
  format: 'uuid',
7288
7311
  type: 'string',
7289
- 'x-title': 'Connected Account ID',
7290
7312
  },
7291
7313
  created_at: {
7292
- description: 'Time at which the event was created.',
7314
+ description: 'Date and time at which the event was created.',
7293
7315
  format: 'date-time',
7294
7316
  type: 'string',
7295
7317
  },
@@ -7300,7 +7322,7 @@ export default {
7300
7322
  },
7301
7323
  event_type: { enum: ['acs_encoder.removed'], type: 'string' },
7302
7324
  occurred_at: {
7303
- description: 'Time when the event occurred.',
7325
+ description: 'Date and time at which the event occurred.',
7304
7326
  format: 'date-time',
7305
7327
  type: 'string',
7306
7328
  },
@@ -7323,16 +7345,17 @@ export default {
7323
7345
  type: 'object',
7324
7346
  },
7325
7347
  {
7326
- description: 'A client session was deleted.',
7348
+ description:
7349
+ 'A [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was deleted.',
7327
7350
  properties: {
7328
7351
  client_session_id: {
7329
- description: 'ID of the client session.',
7352
+ description:
7353
+ 'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
7330
7354
  format: 'uuid',
7331
7355
  type: 'string',
7332
- 'x-title': 'Client Session ID',
7333
7356
  },
7334
7357
  created_at: {
7335
- description: 'Time at which the event was created.',
7358
+ description: 'Date and time at which the event was created.',
7336
7359
  format: 'date-time',
7337
7360
  type: 'string',
7338
7361
  },
@@ -7343,7 +7366,7 @@ export default {
7343
7366
  },
7344
7367
  event_type: { enum: ['client_session.deleted'], type: 'string' },
7345
7368
  occurred_at: {
7346
- description: 'Time when the event occurred.',
7369
+ description: 'Date and time at which the event occurred.',
7347
7370
  format: 'date-time',
7348
7371
  type: 'string',
7349
7372
  },
@@ -7366,22 +7389,22 @@ export default {
7366
7389
  },
7367
7390
  {
7368
7391
  description:
7369
- 'A connected account was connected for the first time, was reconnected after being disconnected.',
7392
+ 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was connected for the first time or was reconnected after being disconnected.',
7370
7393
  properties: {
7371
7394
  connect_webview_id: {
7372
- description: 'ID of the connect webview.',
7395
+ description:
7396
+ 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7373
7397
  format: 'uuid',
7374
7398
  type: 'string',
7375
- 'x-title': 'Connect Webview ID',
7376
7399
  },
7377
7400
  connected_account_id: {
7378
- description: 'ID of the connected account.',
7401
+ description:
7402
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7379
7403
  format: 'uuid',
7380
7404
  type: 'string',
7381
- 'x-title': 'Connected Account ID',
7382
7405
  },
7383
7406
  created_at: {
7384
- description: 'Time at which the event was created.',
7407
+ description: 'Date and time at which the event was created.',
7385
7408
  format: 'date-time',
7386
7409
  type: 'string',
7387
7410
  },
@@ -7395,7 +7418,7 @@ export default {
7395
7418
  type: 'string',
7396
7419
  },
7397
7420
  occurred_at: {
7398
- description: 'Time when the event occurred.',
7421
+ description: 'Date and time at which the event occurred.',
7399
7422
  format: 'date-time',
7400
7423
  type: 'string',
7401
7424
  },
@@ -7418,22 +7441,23 @@ export default {
7418
7441
  type: 'object',
7419
7442
  },
7420
7443
  {
7421
- description: 'A connected account was created.',
7444
+ description:
7445
+ 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was created.',
7422
7446
  properties: {
7423
7447
  connect_webview_id: {
7424
- description: 'ID of the connect webview.',
7448
+ description:
7449
+ 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7425
7450
  format: 'uuid',
7426
7451
  type: 'string',
7427
- 'x-title': 'Connect Webview ID',
7428
7452
  },
7429
7453
  connected_account_id: {
7430
- description: 'ID of the connected account.',
7454
+ description:
7455
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7431
7456
  format: 'uuid',
7432
7457
  type: 'string',
7433
- 'x-title': 'Connected Account ID',
7434
7458
  },
7435
7459
  created_at: {
7436
- description: 'Time at which the event was created.',
7460
+ description: 'Date and time at which the event was created.',
7437
7461
  format: 'date-time',
7438
7462
  type: 'string',
7439
7463
  },
@@ -7447,7 +7471,7 @@ export default {
7447
7471
  type: 'string',
7448
7472
  },
7449
7473
  occurred_at: {
7450
- description: 'Time when the event occurred.',
7474
+ description: 'Date and time at which the event occurred.',
7451
7475
  format: 'date-time',
7452
7476
  type: 'string',
7453
7477
  },
@@ -7472,22 +7496,22 @@ export default {
7472
7496
  {
7473
7497
  deprecated: true,
7474
7498
  description:
7475
- 'A connected account had a successful connect webview login.',
7499
+ '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).',
7476
7500
  properties: {
7477
7501
  connect_webview_id: {
7478
- description: 'ID of the connect webview.',
7502
+ description:
7503
+ 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7479
7504
  format: 'uuid',
7480
7505
  type: 'string',
7481
- 'x-title': 'Connect Webview ID',
7482
7506
  },
7483
7507
  connected_account_id: {
7484
- description: 'ID of the connected account.',
7508
+ description:
7509
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7485
7510
  format: 'uuid',
7486
7511
  type: 'string',
7487
- 'x-title': 'Connected Account ID',
7488
7512
  },
7489
7513
  created_at: {
7490
- description: 'Time at which the event was created.',
7514
+ description: 'Date and time at which the event was created.',
7491
7515
  format: 'date-time',
7492
7516
  type: 'string',
7493
7517
  },
@@ -7501,7 +7525,7 @@ export default {
7501
7525
  type: 'string',
7502
7526
  },
7503
7527
  occurred_at: {
7504
- description: 'Time when the event occurred.',
7528
+ description: 'Date and time at which the event occurred.',
7505
7529
  format: 'date-time',
7506
7530
  type: 'string',
7507
7531
  },
@@ -7525,16 +7549,17 @@ export default {
7525
7549
  'x-deprecated': 'Use `connect_webview.login_succeeded`.',
7526
7550
  },
7527
7551
  {
7528
- description: 'A connected account was disconnected.',
7552
+ description:
7553
+ 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was disconnected.',
7529
7554
  properties: {
7530
7555
  connected_account_id: {
7531
- description: 'ID of the connected account.',
7556
+ description:
7557
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7532
7558
  format: 'uuid',
7533
7559
  type: 'string',
7534
- 'x-title': 'Connected Account ID',
7535
7560
  },
7536
7561
  created_at: {
7537
- description: 'Time at which the event was created.',
7562
+ description: 'Date and time at which the event was created.',
7538
7563
  format: 'date-time',
7539
7564
  type: 'string',
7540
7565
  },
@@ -7548,7 +7573,7 @@ export default {
7548
7573
  type: 'string',
7549
7574
  },
7550
7575
  occurred_at: {
7551
- description: 'Time when the event occurred.',
7576
+ description: 'Date and time at which the event occurred.',
7552
7577
  format: 'date-time',
7553
7578
  type: 'string',
7554
7579
  },
@@ -7571,16 +7596,16 @@ export default {
7571
7596
  },
7572
7597
  {
7573
7598
  description:
7574
- 'A connected account completed the first sync with Seam and devices are now available.',
7599
+ '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.',
7575
7600
  properties: {
7576
7601
  connected_account_id: {
7577
- description: 'ID of the connected account.',
7602
+ description:
7603
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7578
7604
  format: 'uuid',
7579
7605
  type: 'string',
7580
- 'x-title': 'Connected Account ID',
7581
7606
  },
7582
7607
  created_at: {
7583
- description: 'Time at which the event was created.',
7608
+ description: 'Date and time at which the event was created.',
7584
7609
  format: 'date-time',
7585
7610
  type: 'string',
7586
7611
  },
@@ -7594,7 +7619,7 @@ export default {
7594
7619
  type: 'string',
7595
7620
  },
7596
7621
  occurred_at: {
7597
- description: 'Time when the event occurred.',
7622
+ description: 'Date and time at which the event occurred.',
7598
7623
  format: 'date-time',
7599
7624
  type: 'string',
7600
7625
  },
@@ -7616,16 +7641,17 @@ export default {
7616
7641
  type: 'object',
7617
7642
  },
7618
7643
  {
7619
- description: 'A connected account was deleted.',
7644
+ description:
7645
+ 'A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) was deleted.',
7620
7646
  properties: {
7621
7647
  connected_account_id: {
7622
- description: 'ID of the connected account.',
7648
+ description:
7649
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7623
7650
  format: 'uuid',
7624
7651
  type: 'string',
7625
- 'x-title': 'Connected Account ID',
7626
7652
  },
7627
7653
  created_at: {
7628
- description: 'Time at which the event was created.',
7654
+ description: 'Date and time at which the event was created.',
7629
7655
  format: 'date-time',
7630
7656
  type: 'string',
7631
7657
  },
@@ -7639,7 +7665,7 @@ export default {
7639
7665
  type: 'string',
7640
7666
  },
7641
7667
  occurred_at: {
7642
- description: 'Time when the event occurred.',
7668
+ description: 'Date and time at which the event occurred.',
7643
7669
  format: 'date-time',
7644
7670
  type: 'string',
7645
7671
  },
@@ -7662,16 +7688,16 @@ export default {
7662
7688
  },
7663
7689
  {
7664
7690
  description:
7665
- 'A connected account completed the first sync after reconnection with Seam and devices are now available.',
7691
+ '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.',
7666
7692
  properties: {
7667
7693
  connected_account_id: {
7668
- description: 'ID of the connected account.',
7694
+ description:
7695
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7669
7696
  format: 'uuid',
7670
7697
  type: 'string',
7671
- 'x-title': 'Connected Account ID',
7672
7698
  },
7673
7699
  created_at: {
7674
- description: 'Time at which the event was created.',
7700
+ description: 'Date and time at which the event was created.',
7675
7701
  format: 'date-time',
7676
7702
  type: 'string',
7677
7703
  },
@@ -7687,7 +7713,7 @@ export default {
7687
7713
  type: 'string',
7688
7714
  },
7689
7715
  occurred_at: {
7690
- description: 'Time when the event occurred.',
7716
+ description: 'Date and time at which the event occurred.',
7691
7717
  format: 'date-time',
7692
7718
  type: 'string',
7693
7719
  },
@@ -7709,21 +7735,18 @@ export default {
7709
7735
  type: 'object',
7710
7736
  },
7711
7737
  {
7712
- description: 'A lock door action attempt succeeded.',
7738
+ description:
7739
+ 'A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.',
7713
7740
  properties: {
7714
7741
  action_attempt_id: {
7715
- description: 'The ID of the action attempt.',
7742
+ description:
7743
+ 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7716
7744
  format: 'uuid',
7717
7745
  type: 'string',
7718
- 'x-title': 'Action Attempt ID',
7719
- },
7720
- action_type: {
7721
- description: 'The type of action.',
7722
- type: 'string',
7723
- 'x-title': 'Action Type',
7724
7746
  },
7747
+ action_type: { description: 'Type of action.', type: 'string' },
7725
7748
  created_at: {
7726
- description: 'Time at which the event was created.',
7749
+ description: 'Date and time at which the event was created.',
7727
7750
  format: 'date-time',
7728
7751
  type: 'string',
7729
7752
  },
@@ -7737,15 +7760,11 @@ export default {
7737
7760
  type: 'string',
7738
7761
  },
7739
7762
  occurred_at: {
7740
- description: 'Time when the event occurred.',
7763
+ description: 'Date and time at which the event occurred.',
7741
7764
  format: 'date-time',
7742
7765
  type: 'string',
7743
7766
  },
7744
- status: {
7745
- description: 'The status of the action.',
7746
- type: 'string',
7747
- 'x-title': 'Status',
7748
- },
7767
+ status: { description: 'Status of the action.', type: 'string' },
7749
7768
  workspace_id: {
7750
7769
  description:
7751
7770
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
@@ -7766,21 +7785,18 @@ export default {
7766
7785
  type: 'object',
7767
7786
  },
7768
7787
  {
7769
- description: 'A lock door action attempt failed.',
7788
+ description:
7789
+ 'A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.',
7770
7790
  properties: {
7771
7791
  action_attempt_id: {
7772
- description: 'The ID of the action attempt.',
7792
+ description:
7793
+ 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7773
7794
  format: 'uuid',
7774
7795
  type: 'string',
7775
- 'x-title': 'Action Attempt ID',
7776
- },
7777
- action_type: {
7778
- description: 'The type of action.',
7779
- type: 'string',
7780
- 'x-title': 'Action Type',
7781
7796
  },
7797
+ action_type: { description: 'Type of action.', type: 'string' },
7782
7798
  created_at: {
7783
- description: 'Time at which the event was created.',
7799
+ description: 'Date and time at which the event was created.',
7784
7800
  format: 'date-time',
7785
7801
  type: 'string',
7786
7802
  },
@@ -7794,15 +7810,11 @@ export default {
7794
7810
  type: 'string',
7795
7811
  },
7796
7812
  occurred_at: {
7797
- description: 'Time when the event occurred.',
7813
+ description: 'Date and time at which the event occurred.',
7798
7814
  format: 'date-time',
7799
7815
  type: 'string',
7800
7816
  },
7801
- status: {
7802
- description: 'The status of the action.',
7803
- type: 'string',
7804
- 'x-title': 'Status',
7805
- },
7817
+ status: { description: 'Status of the action.', type: 'string' },
7806
7818
  workspace_id: {
7807
7819
  description:
7808
7820
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
@@ -7823,21 +7835,18 @@ export default {
7823
7835
  type: 'object',
7824
7836
  },
7825
7837
  {
7826
- description: 'An unlock door action attempt succeeded.',
7838
+ description:
7839
+ 'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.',
7827
7840
  properties: {
7828
7841
  action_attempt_id: {
7829
- description: 'The ID of the action attempt.',
7842
+ description:
7843
+ 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7830
7844
  format: 'uuid',
7831
7845
  type: 'string',
7832
- 'x-title': 'Action Attempt ID',
7833
- },
7834
- action_type: {
7835
- description: 'The type of action.',
7836
- type: 'string',
7837
- 'x-title': 'Action Type',
7838
7846
  },
7847
+ action_type: { description: 'Type of action.', type: 'string' },
7839
7848
  created_at: {
7840
- description: 'Time at which the event was created.',
7849
+ description: 'Date and time at which the event was created.',
7841
7850
  format: 'date-time',
7842
7851
  type: 'string',
7843
7852
  },
@@ -7851,15 +7860,11 @@ export default {
7851
7860
  type: 'string',
7852
7861
  },
7853
7862
  occurred_at: {
7854
- description: 'Time when the event occurred.',
7863
+ description: 'Date and time at which the event occurred.',
7855
7864
  format: 'date-time',
7856
7865
  type: 'string',
7857
7866
  },
7858
- status: {
7859
- description: 'The status of the action.',
7860
- type: 'string',
7861
- 'x-title': 'Status',
7862
- },
7867
+ status: { description: 'Status of the action.', type: 'string' },
7863
7868
  workspace_id: {
7864
7869
  description:
7865
7870
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
@@ -7880,21 +7885,18 @@ export default {
7880
7885
  type: 'object',
7881
7886
  },
7882
7887
  {
7883
- description: 'An unlock door action attempt failed.',
7888
+ description:
7889
+ 'An unlock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) failed.',
7884
7890
  properties: {
7885
7891
  action_attempt_id: {
7886
- description: 'The ID of the action attempt.',
7892
+ description:
7893
+ 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
7887
7894
  format: 'uuid',
7888
7895
  type: 'string',
7889
- 'x-title': 'Action Attempt ID',
7890
- },
7891
- action_type: {
7892
- description: 'The type of action.',
7893
- type: 'string',
7894
- 'x-title': 'Action Type',
7895
7896
  },
7897
+ action_type: { description: 'Type of action.', type: 'string' },
7896
7898
  created_at: {
7897
- description: 'Time at which the event was created.',
7899
+ description: 'Date and time at which the event was created.',
7898
7900
  format: 'date-time',
7899
7901
  type: 'string',
7900
7902
  },
@@ -7908,15 +7910,11 @@ export default {
7908
7910
  type: 'string',
7909
7911
  },
7910
7912
  occurred_at: {
7911
- description: 'Time when the event occurred.',
7913
+ description: 'Date and time at which the event occurred.',
7912
7914
  format: 'date-time',
7913
7915
  type: 'string',
7914
7916
  },
7915
- status: {
7916
- description: 'The status of the action.',
7917
- type: 'string',
7918
- 'x-title': 'Status',
7919
- },
7917
+ status: { description: 'Status of the action.', type: 'string' },
7920
7918
  workspace_id: {
7921
7919
  description:
7922
7920
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
@@ -7937,22 +7935,23 @@ export default {
7937
7935
  type: 'object',
7938
7936
  },
7939
7937
  {
7940
- description: 'A connect webview had a successful login.',
7938
+ description:
7939
+ 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.',
7941
7940
  properties: {
7942
7941
  connect_webview_id: {
7943
- description: 'ID of the connect webview.',
7942
+ description:
7943
+ 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7944
7944
  format: 'uuid',
7945
7945
  type: 'string',
7946
- 'x-title': 'Connect Webview ID',
7947
7946
  },
7948
7947
  connected_account_id: {
7949
- description: 'ID of the connected account.',
7948
+ description:
7949
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7950
7950
  format: 'uuid',
7951
7951
  type: 'string',
7952
- 'x-title': 'Connected Account ID',
7953
7952
  },
7954
7953
  created_at: {
7955
- description: 'Time at which the event was created.',
7954
+ description: 'Date and time at which the event was created.',
7956
7955
  format: 'date-time',
7957
7956
  type: 'string',
7958
7957
  },
@@ -7966,7 +7965,7 @@ export default {
7966
7965
  type: 'string',
7967
7966
  },
7968
7967
  occurred_at: {
7969
- description: 'Time when the event occurred.',
7968
+ description: 'Date and time at which the event occurred.',
7970
7969
  format: 'date-time',
7971
7970
  type: 'string',
7972
7971
  },
@@ -7989,16 +7988,17 @@ export default {
7989
7988
  type: 'object',
7990
7989
  },
7991
7990
  {
7992
- description: 'A connect webview had a failed login.',
7991
+ description:
7992
+ 'A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.',
7993
7993
  properties: {
7994
7994
  connect_webview_id: {
7995
- description: 'ID of the connect webview.',
7995
+ description:
7996
+ 'ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
7996
7997
  format: 'uuid',
7997
7998
  type: 'string',
7998
- 'x-title': 'Connect Webview ID',
7999
7999
  },
8000
8000
  created_at: {
8001
- description: 'Time at which the event was created.',
8001
+ description: 'Date and time at which the event was created.',
8002
8002
  format: 'date-time',
8003
8003
  type: 'string',
8004
8004
  },
@@ -8012,7 +8012,7 @@ export default {
8012
8012
  type: 'string',
8013
8013
  },
8014
8014
  occurred_at: {
8015
- description: 'Time when the event occurred.',
8015
+ description: 'Date and time at which the event occurred.',
8016
8016
  format: 'date-time',
8017
8017
  type: 'string',
8018
8018
  },
@@ -8034,7 +8034,8 @@ export default {
8034
8034
  type: 'object',
8035
8035
  },
8036
8036
  {
8037
- description: 'A new device was connected to Seam.',
8037
+ description:
8038
+ '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.',
8038
8039
  properties: {
8039
8040
  connected_account_id: {
8040
8041
  description:
@@ -8043,7 +8044,7 @@ export default {
8043
8044
  type: 'string',
8044
8045
  },
8045
8046
  created_at: {
8046
- description: 'Time at which the event was created.',
8047
+ description: 'Date and time at which the event was created.',
8047
8048
  format: 'date-time',
8048
8049
  type: 'string',
8049
8050
  },
@@ -8059,7 +8060,7 @@ export default {
8059
8060
  },
8060
8061
  event_type: { enum: ['device.connected'], type: 'string' },
8061
8062
  occurred_at: {
8062
- description: 'Time when the event occurred.',
8063
+ description: 'Date and time at which the event occurred.',
8063
8064
  format: 'date-time',
8064
8065
  type: 'string',
8065
8066
  },
@@ -8082,7 +8083,8 @@ export default {
8082
8083
  type: 'object',
8083
8084
  },
8084
8085
  {
8085
- description: 'A device was added or reconnected to Seam.',
8086
+ description:
8087
+ 'A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.',
8086
8088
  properties: {
8087
8089
  connected_account_id: {
8088
8090
  description:
@@ -8091,7 +8093,7 @@ export default {
8091
8093
  type: 'string',
8092
8094
  },
8093
8095
  created_at: {
8094
- description: 'Time at which the event was created.',
8096
+ description: 'Date and time at which the event was created.',
8095
8097
  format: 'date-time',
8096
8098
  type: 'string',
8097
8099
  },
@@ -8107,7 +8109,7 @@ export default {
8107
8109
  },
8108
8110
  event_type: { enum: ['device.added'], type: 'string' },
8109
8111
  occurred_at: {
8110
- description: 'Time when the event occurred.',
8112
+ description: 'Date and time at which the event occurred.',
8111
8113
  format: 'date-time',
8112
8114
  type: 'string',
8113
8115
  },
@@ -8140,7 +8142,7 @@ export default {
8140
8142
  type: 'string',
8141
8143
  },
8142
8144
  created_at: {
8143
- description: 'Time at which the event was created.',
8145
+ description: 'Date and time at which the event was created.',
8144
8146
  format: 'date-time',
8145
8147
  type: 'string',
8146
8148
  },
@@ -8159,7 +8161,7 @@ export default {
8159
8161
  type: 'string',
8160
8162
  },
8161
8163
  occurred_at: {
8162
- description: 'Time when the event occurred.',
8164
+ description: 'Date and time at which the event occurred.',
8163
8165
  format: 'date-time',
8164
8166
  type: 'string',
8165
8167
  },
@@ -8192,7 +8194,7 @@ export default {
8192
8194
  type: 'string',
8193
8195
  },
8194
8196
  created_at: {
8195
- description: 'Time at which the event was created.',
8197
+ description: 'Date and time at which the event was created.',
8196
8198
  format: 'date-time',
8197
8199
  type: 'string',
8198
8200
  },
@@ -8211,7 +8213,7 @@ export default {
8211
8213
  type: 'string',
8212
8214
  },
8213
8215
  occurred_at: {
8214
- description: 'Time when the event occurred.',
8216
+ description: 'Date and time at which the event occurred.',
8215
8217
  format: 'date-time',
8216
8218
  type: 'string',
8217
8219
  },
@@ -8235,7 +8237,7 @@ export default {
8235
8237
  },
8236
8238
  {
8237
8239
  description:
8238
- 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.',
8240
+ '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`.',
8239
8241
  properties: {
8240
8242
  connected_account_id: {
8241
8243
  description:
@@ -8244,7 +8246,7 @@ export default {
8244
8246
  type: 'string',
8245
8247
  },
8246
8248
  created_at: {
8247
- description: 'Time at which the event was created.',
8249
+ description: 'Date and time at which the event was created.',
8248
8250
  format: 'date-time',
8249
8251
  type: 'string',
8250
8252
  },
@@ -8263,7 +8265,7 @@ export default {
8263
8265
  type: 'string',
8264
8266
  },
8265
8267
  occurred_at: {
8266
- description: 'Time when the event occurred.',
8268
+ description: 'Date and time at which the event occurred.',
8267
8269
  format: 'date-time',
8268
8270
  type: 'string',
8269
8271
  },
@@ -8286,7 +8288,8 @@ export default {
8286
8288
  type: 'object',
8287
8289
  },
8288
8290
  {
8289
- description: 'A device was disconnected from Seam.',
8291
+ description:
8292
+ '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`.',
8290
8293
  properties: {
8291
8294
  connected_account_id: {
8292
8295
  description:
@@ -8295,7 +8298,7 @@ export default {
8295
8298
  type: 'string',
8296
8299
  },
8297
8300
  created_at: {
8298
- description: 'Time at which the event was created.',
8301
+ description: 'Date and time at which the event was created.',
8299
8302
  format: 'date-time',
8300
8303
  type: 'string',
8301
8304
  },
@@ -8321,7 +8324,7 @@ export default {
8321
8324
  },
8322
8325
  event_type: { enum: ['device.disconnected'], type: 'string' },
8323
8326
  occurred_at: {
8324
- description: 'Time when the event occurred.',
8327
+ description: 'Date and time at which the event occurred.',
8325
8328
  format: 'date-time',
8326
8329
  type: 'string',
8327
8330
  },
@@ -8346,7 +8349,7 @@ export default {
8346
8349
  },
8347
8350
  {
8348
8351
  description:
8349
- 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.',
8352
+ '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`.',
8350
8353
  properties: {
8351
8354
  connected_account_id: {
8352
8355
  description:
@@ -8355,7 +8358,7 @@ export default {
8355
8358
  type: 'string',
8356
8359
  },
8357
8360
  created_at: {
8358
- description: 'Time at which the event was created.',
8361
+ description: 'Date and time at which the event was created.',
8359
8362
  format: 'date-time',
8360
8363
  type: 'string',
8361
8364
  },
@@ -8384,7 +8387,7 @@ export default {
8384
8387
  type: 'string',
8385
8388
  },
8386
8389
  occurred_at: {
8387
- description: 'Time when the event occurred.',
8390
+ description: 'Date and time at which the event occurred.',
8388
8391
  format: 'date-time',
8389
8392
  type: 'string',
8390
8393
  },
@@ -8409,7 +8412,7 @@ export default {
8409
8412
  },
8410
8413
  {
8411
8414
  description:
8412
- 'A device detected that it was tampered with, for example, opened or moved.',
8415
+ 'A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.',
8413
8416
  properties: {
8414
8417
  connected_account_id: {
8415
8418
  description:
@@ -8418,7 +8421,7 @@ export default {
8418
8421
  type: 'string',
8419
8422
  },
8420
8423
  created_at: {
8421
- description: 'Time at which the event was created.',
8424
+ description: 'Date and time at which the event was created.',
8422
8425
  format: 'date-time',
8423
8426
  type: 'string',
8424
8427
  },
@@ -8434,7 +8437,7 @@ export default {
8434
8437
  },
8435
8438
  event_type: { enum: ['device.tampered'], type: 'string' },
8436
8439
  occurred_at: {
8437
- description: 'Time when the event occurred.',
8440
+ description: 'Date and time at which the event occurred.',
8438
8441
  format: 'date-time',
8439
8442
  type: 'string',
8440
8443
  },
@@ -8458,7 +8461,7 @@ export default {
8458
8461
  },
8459
8462
  {
8460
8463
  description:
8461
- 'A device battery level dropped below the low threshold.',
8464
+ 'A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.',
8462
8465
  properties: {
8463
8466
  battery_level: {
8464
8467
  description:
@@ -8475,7 +8478,7 @@ export default {
8475
8478
  type: 'string',
8476
8479
  },
8477
8480
  created_at: {
8478
- description: 'Time at which the event was created.',
8481
+ description: 'Date and time at which the event was created.',
8479
8482
  format: 'date-time',
8480
8483
  type: 'string',
8481
8484
  },
@@ -8491,7 +8494,7 @@ export default {
8491
8494
  },
8492
8495
  event_type: { enum: ['device.low_battery'], type: 'string' },
8493
8496
  occurred_at: {
8494
- description: 'Time when the event occurred.',
8497
+ description: 'Date and time at which the event occurred.',
8495
8498
  format: 'date-time',
8496
8499
  type: 'string',
8497
8500
  },
@@ -8516,7 +8519,7 @@ export default {
8516
8519
  },
8517
8520
  {
8518
8521
  description:
8519
- 'A device battery status changed since the last `battery_status_changed` event.',
8522
+ 'A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.',
8520
8523
  properties: {
8521
8524
  battery_level: {
8522
8525
  description:
@@ -8539,7 +8542,7 @@ export default {
8539
8542
  type: 'string',
8540
8543
  },
8541
8544
  created_at: {
8542
- description: 'Time at which the event was created.',
8545
+ description: 'Date and time at which the event was created.',
8543
8546
  format: 'date-time',
8544
8547
  type: 'string',
8545
8548
  },
@@ -8558,7 +8561,7 @@ export default {
8558
8561
  type: 'string',
8559
8562
  },
8560
8563
  occurred_at: {
8561
- description: 'Time when the event occurred.',
8564
+ description: 'Date and time at which the event occurred.',
8562
8565
  format: 'date-time',
8563
8566
  type: 'string',
8564
8567
  },
@@ -8584,7 +8587,7 @@ export default {
8584
8587
  },
8585
8588
  {
8586
8589
  description:
8587
- 'A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8590
+ '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).',
8588
8591
  properties: {
8589
8592
  connected_account_id: {
8590
8593
  description:
@@ -8593,7 +8596,7 @@ export default {
8593
8596
  type: 'string',
8594
8597
  },
8595
8598
  created_at: {
8596
- description: 'Time at which the event was created.',
8599
+ description: 'Date and time at which the event was created.',
8597
8600
  format: 'date-time',
8598
8601
  type: 'string',
8599
8602
  },
@@ -8609,7 +8612,7 @@ export default {
8609
8612
  },
8610
8613
  event_type: { enum: ['device.removed'], type: 'string' },
8611
8614
  occurred_at: {
8612
- description: 'Time when the event occurred.',
8615
+ description: 'Date and time at which the event occurred.',
8613
8616
  format: 'date-time',
8614
8617
  type: 'string',
8615
8618
  },
@@ -8633,7 +8636,7 @@ export default {
8633
8636
  },
8634
8637
  {
8635
8638
  description:
8636
- 'A device was [deleted](https://docs.seam.co/latest/api/devices/delete).',
8639
+ 'A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.',
8637
8640
  properties: {
8638
8641
  connected_account_id: {
8639
8642
  description:
@@ -8642,7 +8645,7 @@ export default {
8642
8645
  type: 'string',
8643
8646
  },
8644
8647
  created_at: {
8645
- description: 'Time at which the event was created.',
8648
+ description: 'Date and time at which the event was created.',
8646
8649
  format: 'date-time',
8647
8650
  type: 'string',
8648
8651
  },
@@ -8658,7 +8661,7 @@ export default {
8658
8661
  },
8659
8662
  event_type: { enum: ['device.deleted'], type: 'string' },
8660
8663
  occurred_at: {
8661
- description: 'Time when the event occurred.',
8664
+ description: 'Date and time at which the event occurred.',
8662
8665
  format: 'date-time',
8663
8666
  type: 'string',
8664
8667
  },
@@ -8682,7 +8685,7 @@ export default {
8682
8685
  },
8683
8686
  {
8684
8687
  description:
8685
- 'Seam detected that a device is using a third-party integration that will interfere with Seam device management.',
8688
+ '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.',
8686
8689
  properties: {
8687
8690
  connected_account_id: {
8688
8691
  description:
@@ -8691,7 +8694,7 @@ export default {
8691
8694
  type: 'string',
8692
8695
  },
8693
8696
  created_at: {
8694
- description: 'Time at which the event was created.',
8697
+ description: 'Date and time at which the event was created.',
8695
8698
  format: 'date-time',
8696
8699
  type: 'string',
8697
8700
  },
@@ -8710,7 +8713,7 @@ export default {
8710
8713
  type: 'string',
8711
8714
  },
8712
8715
  occurred_at: {
8713
- description: 'Time when the event occurred.',
8716
+ description: 'Date and time at which the event occurred.',
8714
8717
  format: 'date-time',
8715
8718
  type: 'string',
8716
8719
  },
@@ -8734,7 +8737,7 @@ export default {
8734
8737
  },
8735
8738
  {
8736
8739
  description:
8737
- 'Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.',
8740
+ '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.',
8738
8741
  properties: {
8739
8742
  connected_account_id: {
8740
8743
  description:
@@ -8743,7 +8746,7 @@ export default {
8743
8746
  type: 'string',
8744
8747
  },
8745
8748
  created_at: {
8746
- description: 'Time at which the event was created.',
8749
+ description: 'Date and time at which the event was created.',
8747
8750
  format: 'date-time',
8748
8751
  type: 'string',
8749
8752
  },
@@ -8762,7 +8765,7 @@ export default {
8762
8765
  type: 'string',
8763
8766
  },
8764
8767
  occurred_at: {
8765
- description: 'Time when the event occurred.',
8768
+ description: 'Date and time at which the event occurred.',
8766
8769
  format: 'date-time',
8767
8770
  type: 'string',
8768
8771
  },
@@ -8785,7 +8788,8 @@ export default {
8785
8788
  type: 'object',
8786
8789
  },
8787
8790
  {
8788
- description: 'A Salto device activated privacy mode.',
8791
+ description:
8792
+ 'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.',
8789
8793
  properties: {
8790
8794
  connected_account_id: {
8791
8795
  description:
@@ -8794,7 +8798,7 @@ export default {
8794
8798
  type: 'string',
8795
8799
  },
8796
8800
  created_at: {
8797
- description: 'Time at which the event was created.',
8801
+ description: 'Date and time at which the event was created.',
8798
8802
  format: 'date-time',
8799
8803
  type: 'string',
8800
8804
  },
@@ -8813,7 +8817,7 @@ export default {
8813
8817
  type: 'string',
8814
8818
  },
8815
8819
  occurred_at: {
8816
- description: 'Time when the event occurred.',
8820
+ description: 'Date and time at which the event occurred.',
8817
8821
  format: 'date-time',
8818
8822
  type: 'string',
8819
8823
  },
@@ -8836,7 +8840,8 @@ export default {
8836
8840
  type: 'object',
8837
8841
  },
8838
8842
  {
8839
- description: 'A Salto device deactivated privacy mode.',
8843
+ description:
8844
+ 'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.',
8840
8845
  properties: {
8841
8846
  connected_account_id: {
8842
8847
  description:
@@ -8845,7 +8850,7 @@ export default {
8845
8850
  type: 'string',
8846
8851
  },
8847
8852
  created_at: {
8848
- description: 'Time at which the event was created.',
8853
+ description: 'Date and time at which the event was created.',
8849
8854
  format: 'date-time',
8850
8855
  type: 'string',
8851
8856
  },
@@ -8864,7 +8869,7 @@ export default {
8864
8869
  type: 'string',
8865
8870
  },
8866
8871
  occurred_at: {
8867
- description: 'Time when the event occurred.',
8872
+ description: 'Date and time at which the event occurred.',
8868
8873
  format: 'date-time',
8869
8874
  type: 'string',
8870
8875
  },
@@ -8887,7 +8892,8 @@ export default {
8887
8892
  type: 'object',
8888
8893
  },
8889
8894
  {
8890
- description: 'Seam detected a flaky device connection.',
8895
+ description:
8896
+ 'Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.',
8891
8897
  properties: {
8892
8898
  connected_account_id: {
8893
8899
  description:
@@ -8896,7 +8902,7 @@ export default {
8896
8902
  type: 'string',
8897
8903
  },
8898
8904
  created_at: {
8899
- description: 'Time at which the event was created.',
8905
+ description: 'Date and time at which the event was created.',
8900
8906
  format: 'date-time',
8901
8907
  type: 'string',
8902
8908
  },
@@ -8915,7 +8921,7 @@ export default {
8915
8921
  type: 'string',
8916
8922
  },
8917
8923
  occurred_at: {
8918
- description: 'Time when the event occurred.',
8924
+ description: 'Date and time at which the event occurred.',
8919
8925
  format: 'date-time',
8920
8926
  type: 'string',
8921
8927
  },
@@ -8939,7 +8945,7 @@ export default {
8939
8945
  },
8940
8946
  {
8941
8947
  description:
8942
- 'Seam detected that a previously-flaky device connection stabilized.',
8948
+ 'Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.',
8943
8949
  properties: {
8944
8950
  connected_account_id: {
8945
8951
  description:
@@ -8948,7 +8954,7 @@ export default {
8948
8954
  type: 'string',
8949
8955
  },
8950
8956
  created_at: {
8951
- description: 'Time at which the event was created.',
8957
+ description: 'Date and time at which the event was created.',
8952
8958
  format: 'date-time',
8953
8959
  type: 'string',
8954
8960
  },
@@ -8967,7 +8973,7 @@ export default {
8967
8973
  type: 'string',
8968
8974
  },
8969
8975
  occurred_at: {
8970
- description: 'Time when the event occurred.',
8976
+ description: 'Date and time at which the event occurred.',
8971
8977
  format: 'date-time',
8972
8978
  type: 'string',
8973
8979
  },
@@ -8991,7 +8997,7 @@ export default {
8991
8997
  },
8992
8998
  {
8993
8999
  description:
8994
- 'A third-party subscription is required to use all device features.',
9000
+ 'A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.',
8995
9001
  properties: {
8996
9002
  connected_account_id: {
8997
9003
  description:
@@ -9000,7 +9006,7 @@ export default {
9000
9006
  type: 'string',
9001
9007
  },
9002
9008
  created_at: {
9003
- description: 'Time at which the event was created.',
9009
+ description: 'Date and time at which the event was created.',
9004
9010
  format: 'date-time',
9005
9011
  type: 'string',
9006
9012
  },
@@ -9019,7 +9025,7 @@ export default {
9019
9025
  type: 'string',
9020
9026
  },
9021
9027
  occurred_at: {
9022
- description: 'Time when the event occurred.',
9028
+ description: 'Date and time at which the event occurred.',
9023
9029
  format: 'date-time',
9024
9030
  type: 'string',
9025
9031
  },
@@ -9043,7 +9049,7 @@ export default {
9043
9049
  },
9044
9050
  {
9045
9051
  description:
9046
- 'A third-party subscription is active or no longer required to use all device features.',
9052
+ 'A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.',
9047
9053
  properties: {
9048
9054
  connected_account_id: {
9049
9055
  description:
@@ -9052,7 +9058,7 @@ export default {
9052
9058
  type: 'string',
9053
9059
  },
9054
9060
  created_at: {
9055
- description: 'Time at which the event was created.',
9061
+ description: 'Date and time at which the event was created.',
9056
9062
  format: 'date-time',
9057
9063
  type: 'string',
9058
9064
  },
@@ -9071,7 +9077,7 @@ export default {
9071
9077
  type: 'string',
9072
9078
  },
9073
9079
  occurred_at: {
9074
- description: 'Time when the event occurred.',
9080
+ description: 'Date and time at which the event occurred.',
9075
9081
  format: 'date-time',
9076
9082
  type: 'string',
9077
9083
  },
@@ -9094,7 +9100,8 @@ export default {
9094
9100
  type: 'object',
9095
9101
  },
9096
9102
  {
9097
- description: 'An accessory keypad was connected to a device.',
9103
+ description:
9104
+ 'An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).',
9098
9105
  properties: {
9099
9106
  connected_account_id: {
9100
9107
  description:
@@ -9103,7 +9110,7 @@ export default {
9103
9110
  type: 'string',
9104
9111
  },
9105
9112
  created_at: {
9106
- description: 'Time at which the event was created.',
9113
+ description: 'Date and time at which the event was created.',
9107
9114
  format: 'date-time',
9108
9115
  type: 'string',
9109
9116
  },
@@ -9122,7 +9129,7 @@ export default {
9122
9129
  type: 'string',
9123
9130
  },
9124
9131
  occurred_at: {
9125
- description: 'Time when the event occurred.',
9132
+ description: 'Date and time at which the event occurred.',
9126
9133
  format: 'date-time',
9127
9134
  type: 'string',
9128
9135
  },
@@ -9145,7 +9152,8 @@ export default {
9145
9152
  type: 'object',
9146
9153
  },
9147
9154
  {
9148
- description: 'An accessory keypad was disconnected from a device.',
9155
+ description:
9156
+ 'An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).',
9149
9157
  properties: {
9150
9158
  connected_account_id: {
9151
9159
  description:
@@ -9154,7 +9162,7 @@ export default {
9154
9162
  type: 'string',
9155
9163
  },
9156
9164
  created_at: {
9157
- description: 'Time at which the event was created.',
9165
+ description: 'Date and time at which the event was created.',
9158
9166
  format: 'date-time',
9159
9167
  type: 'string',
9160
9168
  },
@@ -9173,7 +9181,7 @@ export default {
9173
9181
  type: 'string',
9174
9182
  },
9175
9183
  occurred_at: {
9176
- description: 'Time when the event occurred.',
9184
+ description: 'Date and time at which the event occurred.',
9177
9185
  format: 'date-time',
9178
9186
  type: 'string',
9179
9187
  },
@@ -9206,7 +9214,7 @@ export default {
9206
9214
  type: 'string',
9207
9215
  },
9208
9216
  created_at: {
9209
- description: 'Time at which the event was created.',
9217
+ description: 'Date and time at which the event was created.',
9210
9218
  format: 'date-time',
9211
9219
  type: 'string',
9212
9220
  },
@@ -9228,7 +9236,6 @@ export default {
9228
9236
  additionalProperties: {},
9229
9237
  description: 'Metadata from Minut.',
9230
9238
  type: 'object',
9231
- 'x-title': 'Minut Metadata',
9232
9239
  },
9233
9240
  noise_level_decibels: {
9234
9241
  description: 'Detected noise level in decibels.',
@@ -9256,10 +9263,9 @@ export default {
9256
9263
  additionalProperties: {},
9257
9264
  description: 'Metadata from Noiseaware.',
9258
9265
  type: 'object',
9259
- 'x-title': 'Noiseaware Metadata',
9260
9266
  },
9261
9267
  occurred_at: {
9262
- description: 'Time when the event occurred.',
9268
+ description: 'Date and time at which the event occurred.',
9263
9269
  format: 'date-time',
9264
9270
  type: 'string',
9265
9271
  },
@@ -9282,7 +9288,8 @@ export default {
9282
9288
  type: 'object',
9283
9289
  },
9284
9290
  {
9285
- description: 'A lock was locked.',
9291
+ description:
9292
+ 'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.',
9286
9293
  properties: {
9287
9294
  access_code_id: {
9288
9295
  description:
@@ -9303,7 +9310,7 @@ export default {
9303
9310
  type: 'string',
9304
9311
  },
9305
9312
  created_at: {
9306
- description: 'Time at which the event was created.',
9313
+ description: 'Date and time at which the event was created.',
9307
9314
  format: 'date-time',
9308
9315
  type: 'string',
9309
9316
  },
@@ -9320,12 +9327,12 @@ export default {
9320
9327
  event_type: { enum: ['lock.locked'], type: 'string' },
9321
9328
  method: {
9322
9329
  description:
9323
- '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.',
9330
+ '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.',
9324
9331
  enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
9325
9332
  type: 'string',
9326
9333
  },
9327
9334
  occurred_at: {
9328
- description: 'Time when the event occurred.',
9335
+ description: 'Date and time at which the event occurred.',
9329
9336
  format: 'date-time',
9330
9337
  type: 'string',
9331
9338
  },
@@ -9349,7 +9356,8 @@ export default {
9349
9356
  type: 'object',
9350
9357
  },
9351
9358
  {
9352
- description: 'A lock was unlocked.',
9359
+ description:
9360
+ 'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.',
9353
9361
  properties: {
9354
9362
  access_code_id: {
9355
9363
  description:
@@ -9370,7 +9378,7 @@ export default {
9370
9378
  type: 'string',
9371
9379
  },
9372
9380
  created_at: {
9373
- description: 'Time at which the event was created.',
9381
+ description: 'Date and time at which the event was created.',
9374
9382
  format: 'date-time',
9375
9383
  type: 'string',
9376
9384
  },
@@ -9387,12 +9395,12 @@ export default {
9387
9395
  event_type: { enum: ['lock.unlocked'], type: 'string' },
9388
9396
  method: {
9389
9397
  description:
9390
- '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.',
9398
+ '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.',
9391
9399
  enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
9392
9400
  type: 'string',
9393
9401
  },
9394
9402
  occurred_at: {
9395
- description: 'Time when the event occurred.',
9403
+ description: 'Date and time at which the event occurred.',
9396
9404
  format: 'date-time',
9397
9405
  type: 'string',
9398
9406
  },
@@ -9417,7 +9425,7 @@ export default {
9417
9425
  },
9418
9426
  {
9419
9427
  description:
9420
- 'The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.',
9428
+ '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.',
9421
9429
  properties: {
9422
9430
  access_code_id: {
9423
9431
  description:
@@ -9432,7 +9440,7 @@ export default {
9432
9440
  type: 'string',
9433
9441
  },
9434
9442
  created_at: {
9435
- description: 'Time at which the event was created.',
9443
+ description: 'Date and time at which the event was created.',
9436
9444
  format: 'date-time',
9437
9445
  type: 'string',
9438
9446
  },
@@ -9448,7 +9456,7 @@ export default {
9448
9456
  },
9449
9457
  event_type: { enum: ['lock.access_denied'], type: 'string' },
9450
9458
  occurred_at: {
9451
- description: 'Time when the event occurred.',
9459
+ description: 'Date and time at which the event occurred.',
9452
9460
  format: 'date-time',
9453
9461
  type: 'string',
9454
9462
  },
@@ -9486,7 +9494,7 @@ export default {
9486
9494
  type: 'string',
9487
9495
  },
9488
9496
  created_at: {
9489
- description: 'Time at which the event was created.',
9497
+ description: 'Date and time at which the event was created.',
9490
9498
  format: 'date-time',
9491
9499
  type: 'string',
9492
9500
  },
@@ -9506,11 +9514,11 @@ export default {
9506
9514
  },
9507
9515
  is_fallback_climate_preset: {
9508
9516
  description:
9509
- '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.',
9517
+ '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).',
9510
9518
  type: 'boolean',
9511
9519
  },
9512
9520
  occurred_at: {
9513
- description: 'Time when the event occurred.',
9521
+ description: 'Date and time at which the event occurred.',
9514
9522
  format: 'date-time',
9515
9523
  type: 'string',
9516
9524
  },
@@ -9543,7 +9551,8 @@ export default {
9543
9551
  type: 'object',
9544
9552
  },
9545
9553
  {
9546
- description: 'A thermostat was adjusted manually.',
9554
+ description:
9555
+ 'A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.',
9547
9556
  properties: {
9548
9557
  connected_account_id: {
9549
9558
  description:
@@ -9564,7 +9573,7 @@ export default {
9564
9573
  type: 'number',
9565
9574
  },
9566
9575
  created_at: {
9567
- description: 'Time at which the event was created.',
9576
+ description: 'Date and time at which the event was created.',
9568
9577
  format: 'date-time',
9569
9578
  type: 'string',
9570
9579
  },
@@ -9608,12 +9617,12 @@ export default {
9608
9617
  },
9609
9618
  method: {
9610
9619
  description:
9611
- 'Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.',
9620
+ '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).',
9612
9621
  enum: ['seam', 'external'],
9613
9622
  type: 'string',
9614
9623
  },
9615
9624
  occurred_at: {
9616
- description: 'Time when the event occurred.',
9625
+ description: 'Date and time at which the event occurred.',
9617
9626
  format: 'date-time',
9618
9627
  type: 'string',
9619
9628
  },
@@ -9638,7 +9647,7 @@ export default {
9638
9647
  },
9639
9648
  {
9640
9649
  description:
9641
- "A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
9650
+ "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).",
9642
9651
  properties: {
9643
9652
  connected_account_id: {
9644
9653
  description:
@@ -9647,7 +9656,7 @@ export default {
9647
9656
  type: 'string',
9648
9657
  },
9649
9658
  created_at: {
9650
- description: 'Time at which the event was created.',
9659
+ description: 'Date and time at which the event was created.',
9651
9660
  format: 'date-time',
9652
9661
  type: 'string',
9653
9662
  },
@@ -9680,17 +9689,19 @@ export default {
9680
9689
  type: 'number',
9681
9690
  },
9682
9691
  occurred_at: {
9683
- description: 'Time when the event occurred.',
9692
+ description: 'Date and time at which the event occurred.',
9684
9693
  format: 'date-time',
9685
9694
  type: 'string',
9686
9695
  },
9687
9696
  temperature_celsius: {
9688
- description: 'Temperature, in °C, reported by the thermostat.',
9697
+ description:
9698
+ 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9689
9699
  format: 'float',
9690
9700
  type: 'number',
9691
9701
  },
9692
9702
  temperature_fahrenheit: {
9693
- description: 'Temperature, in °F, reported by the thermostat.',
9703
+ description:
9704
+ 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9694
9705
  format: 'float',
9695
9706
  type: 'number',
9696
9707
  },
@@ -9734,7 +9745,7 @@ export default {
9734
9745
  },
9735
9746
  {
9736
9747
  description:
9737
- "A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
9748
+ "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).",
9738
9749
  properties: {
9739
9750
  connected_account_id: {
9740
9751
  description:
@@ -9743,7 +9754,7 @@ export default {
9743
9754
  type: 'string',
9744
9755
  },
9745
9756
  created_at: {
9746
- description: 'Time at which the event was created.',
9757
+ description: 'Date and time at which the event was created.',
9747
9758
  format: 'date-time',
9748
9759
  type: 'string',
9749
9760
  },
@@ -9776,17 +9787,19 @@ export default {
9776
9787
  type: 'number',
9777
9788
  },
9778
9789
  occurred_at: {
9779
- description: 'Time when the event occurred.',
9790
+ description: 'Date and time at which the event occurred.',
9780
9791
  format: 'date-time',
9781
9792
  type: 'string',
9782
9793
  },
9783
9794
  temperature_celsius: {
9784
- description: 'Temperature, in °C, reported by the thermostat.',
9795
+ description:
9796
+ 'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9785
9797
  format: 'float',
9786
9798
  type: 'number',
9787
9799
  },
9788
9800
  temperature_fahrenheit: {
9789
- description: 'Temperature, in °F, reported by the thermostat.',
9801
+ description:
9802
+ 'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
9790
9803
  format: 'float',
9791
9804
  type: 'number',
9792
9805
  },
@@ -9829,18 +9842,19 @@ export default {
9829
9842
  type: 'object',
9830
9843
  },
9831
9844
  {
9832
- description: 'An enrollment automation was deleted.',
9845
+ description:
9846
+ '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.',
9833
9847
  properties: {
9834
9848
  created_at: {
9835
- description: 'Time at which the event was created.',
9849
+ description: 'Date and time at which the event was created.',
9836
9850
  format: 'date-time',
9837
9851
  type: 'string',
9838
9852
  },
9839
9853
  enrollment_automation_id: {
9840
- description: 'ID of the enrollment automation.',
9854
+ description:
9855
+ '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).',
9841
9856
  format: 'uuid',
9842
9857
  type: 'string',
9843
- 'x-title': 'Enrollment Automation ID',
9844
9858
  },
9845
9859
  event_id: {
9846
9860
  description: 'ID of the event.',
@@ -9852,7 +9866,7 @@ export default {
9852
9866
  type: 'string',
9853
9867
  },
9854
9868
  occurred_at: {
9855
- description: 'Time when the event occurred.',
9869
+ description: 'Date and time at which the event occurred.',
9856
9870
  format: 'date-time',
9857
9871
  type: 'string',
9858
9872
  },
@@ -9877,15 +9891,15 @@ export default {
9877
9891
  description: 'A phone device was deactivated.',
9878
9892
  properties: {
9879
9893
  created_at: {
9880
- description: 'Time at which the event was created.',
9894
+ description: 'Date and time at which the event was created.',
9881
9895
  format: 'date-time',
9882
9896
  type: 'string',
9883
9897
  },
9884
9898
  device_id: {
9885
- description: 'ID of the device.',
9899
+ description:
9900
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
9886
9901
  format: 'uuid',
9887
9902
  type: 'string',
9888
- 'x-title': 'Device ID',
9889
9903
  },
9890
9904
  event_id: {
9891
9905
  description: 'ID of the event.',
@@ -9894,7 +9908,7 @@ export default {
9894
9908
  },
9895
9909
  event_type: { enum: ['phone.deactivated'], type: 'string' },
9896
9910
  occurred_at: {
9897
- description: 'Time when the event occurred.',
9911
+ description: 'Date and time at which the event occurred.',
9898
9912
  format: 'date-time',
9899
9913
  type: 'string',
9900
9914
  },
@@ -14633,6 +14647,8 @@ export default {
14633
14647
  },
14634
14648
  '/acs/encoders/encode_credential': {
14635
14649
  post: {
14650
+ description:
14651
+ 'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
14636
14652
  operationId: 'acsEncodersEncodeCredentialPost',
14637
14653
  requestBody: {
14638
14654
  content: {
@@ -14641,13 +14657,13 @@ export default {
14641
14657
  properties: {
14642
14658
  acs_credential_id: {
14643
14659
  description:
14644
- 'ID of the acs_credential to encode on a physical card.',
14660
+ 'ID of the `acs_credential` to encode onto a card.',
14645
14661
  format: 'uuid',
14646
14662
  type: 'string',
14647
14663
  },
14648
14664
  acs_encoder_id: {
14649
14665
  description:
14650
- 'ID of the acs_encoder to use for the encoding.',
14666
+ 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
14651
14667
  format: 'uuid',
14652
14668
  type: 'string',
14653
14669
  },
@@ -14690,11 +14706,13 @@ export default {
14690
14706
  'x-fern-sdk-method-name': 'encode_credential',
14691
14707
  'x-fern-sdk-return-value': 'action_attempt',
14692
14708
  'x-response-key': 'action_attempt',
14693
- 'x-undocumented': 'Encoders are in alpha.',
14709
+ 'x-title': 'Encode a Credential',
14694
14710
  },
14695
14711
  },
14696
14712
  '/acs/encoders/list': {
14697
14713
  post: {
14714
+ description:
14715
+ 'Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
14698
14716
  operationId: 'acsEncodersListPost',
14699
14717
  requestBody: {
14700
14718
  content: {
@@ -14703,8 +14721,18 @@ export default {
14703
14721
  oneOf: [
14704
14722
  {
14705
14723
  properties: {
14706
- acs_system_id: { format: 'uuid', type: 'string' },
14707
- limit: { default: 500, format: 'float', type: 'number' },
14724
+ acs_system_id: {
14725
+ description:
14726
+ 'ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.',
14727
+ format: 'uuid',
14728
+ type: 'string',
14729
+ },
14730
+ limit: {
14731
+ default: 500,
14732
+ description: 'Number of `acs_encoders` to return.',
14733
+ format: 'float',
14734
+ type: 'number',
14735
+ },
14708
14736
  },
14709
14737
  required: ['acs_system_id'],
14710
14738
  type: 'object',
@@ -14712,10 +14740,17 @@ export default {
14712
14740
  {
14713
14741
  properties: {
14714
14742
  acs_system_ids: {
14743
+ description:
14744
+ 'IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.',
14715
14745
  items: { format: 'uuid', type: 'string' },
14716
14746
  type: 'array',
14717
14747
  },
14718
- limit: { default: 500, format: 'float', type: 'number' },
14748
+ limit: {
14749
+ default: 500,
14750
+ description: 'Number of `acs_encoders` to return.',
14751
+ format: 'float',
14752
+ type: 'number',
14753
+ },
14719
14754
  },
14720
14755
  required: ['acs_system_ids'],
14721
14756
  type: 'object',
@@ -14723,10 +14758,17 @@ export default {
14723
14758
  {
14724
14759
  properties: {
14725
14760
  acs_encoder_ids: {
14761
+ description:
14762
+ 'IDs of the `acs_encoder`s that you want to retrieve.',
14726
14763
  items: { format: 'uuid', type: 'string' },
14727
14764
  type: 'array',
14728
14765
  },
14729
- limit: { default: 500, format: 'float', type: 'number' },
14766
+ limit: {
14767
+ default: 500,
14768
+ description: 'Number of `acs_encoders` to return.',
14769
+ format: 'float',
14770
+ type: 'number',
14771
+ },
14730
14772
  },
14731
14773
  required: ['acs_encoder_ids'],
14732
14774
  type: 'object',
@@ -14838,11 +14880,13 @@ export default {
14838
14880
  'x-fern-sdk-method-name': 'list',
14839
14881
  'x-fern-sdk-return-value': 'acs_encoders',
14840
14882
  'x-response-key': 'acs_encoders',
14841
- 'x-undocumented': 'Encoders are in alpha.',
14883
+ 'x-title': 'List Encoders',
14842
14884
  },
14843
14885
  },
14844
14886
  '/acs/encoders/scan_credential': {
14845
14887
  post: {
14888
+ description:
14889
+ 'Scans an encoded [acs_credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
14846
14890
  operationId: 'acsEncodersScanCredentialPost',
14847
14891
  requestBody: {
14848
14892
  content: {
@@ -14850,7 +14894,7 @@ export default {
14850
14894
  schema: {
14851
14895
  properties: {
14852
14896
  acs_encoder_id: {
14853
- description: 'ID of the acs_encoder to use for the scan.',
14897
+ description: 'ID of the `acs_encoder` to use for the scan.',
14854
14898
  format: 'uuid',
14855
14899
  type: 'string',
14856
14900
  },
@@ -14893,11 +14937,13 @@ export default {
14893
14937
  'x-fern-sdk-method-name': 'scan_credential',
14894
14938
  'x-fern-sdk-return-value': 'action_attempt',
14895
14939
  'x-response-key': 'action_attempt',
14896
- 'x-undocumented': 'Encoders are in alpha.',
14940
+ 'x-title': 'Scan a Credential',
14897
14941
  },
14898
14942
  },
14899
14943
  '/acs/encoders/simulate/next_credential_encode_will_fail': {
14900
14944
  post: {
14945
+ description:
14946
+ 'Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
14901
14947
  operationId: 'acsEncodersSimulateNextCredentialEncodeWillFailPost',
14902
14948
  requestBody: {
14903
14949
  content: {
@@ -14907,9 +14953,15 @@ export default {
14907
14953
  {
14908
14954
  additionalProperties: false,
14909
14955
  properties: {
14910
- acs_encoder_id: { format: 'uuid', type: 'string' },
14956
+ acs_encoder_id: {
14957
+ description:
14958
+ 'ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.',
14959
+ format: 'uuid',
14960
+ type: 'string',
14961
+ },
14911
14962
  error_code: {
14912
14963
  default: 'no_credential_on_encoder',
14964
+ description: 'Code of the error to simulate.',
14913
14965
  enum: ['no_credential_on_encoder'],
14914
14966
  type: 'string',
14915
14967
  },
@@ -14920,9 +14972,20 @@ export default {
14920
14972
  {
14921
14973
  additionalProperties: false,
14922
14974
  properties: {
14923
- acs_credential_id: { format: 'uuid', type: 'string' },
14924
- acs_encoder_id: { format: 'uuid', type: 'string' },
14975
+ acs_credential_id: {
14976
+ description:
14977
+ 'ID of the `acs_credential` that will fail to be encoded onto a card in the next request.',
14978
+ format: 'uuid',
14979
+ type: 'string',
14980
+ },
14981
+ acs_encoder_id: {
14982
+ description:
14983
+ 'ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.',
14984
+ format: 'uuid',
14985
+ type: 'string',
14986
+ },
14925
14987
  error_code: {
14988
+ description: 'Code of the error to simulate.',
14926
14989
  enum: ['uncategorized_error', 'action_attempt_expired'],
14927
14990
  type: 'string',
14928
14991
  },
@@ -14961,11 +15024,13 @@ export default {
14961
15024
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14962
15025
  'x-fern-sdk-method-name': 'next_credential_encode_will_fail',
14963
15026
  'x-response-key': null,
14964
- 'x-undocumented': 'Encoder simulations are in alpha.',
15027
+ 'x-title': 'Simulate that the Next Credential Encoding Will Fail',
14965
15028
  },
14966
15029
  },
14967
15030
  '/acs/encoders/simulate/next_credential_encode_will_succeed': {
14968
15031
  post: {
15032
+ description:
15033
+ 'Simulates that the next attempt to encode a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
14969
15034
  operationId: 'acsEncodersSimulateNextCredentialEncodeWillSucceedPost',
14970
15035
  requestBody: {
14971
15036
  content: {
@@ -14973,9 +15038,15 @@ export default {
14973
15038
  schema: {
14974
15039
  additionalProperties: false,
14975
15040
  properties: {
14976
- acs_encoder_id: { format: 'uuid', type: 'string' },
15041
+ acs_encoder_id: {
15042
+ description:
15043
+ 'ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.',
15044
+ format: 'uuid',
15045
+ type: 'string',
15046
+ },
14977
15047
  scenario: {
14978
15048
  default: 'credential_is_issued',
15049
+ description: 'Scenario to simulate.',
14979
15050
  enum: ['credential_is_issued'],
14980
15051
  type: 'string',
14981
15052
  },
@@ -15012,11 +15083,13 @@ export default {
15012
15083
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
15013
15084
  'x-fern-sdk-method-name': 'next_credential_encode_will_succeed',
15014
15085
  'x-response-key': null,
15015
- 'x-undocumented': 'Encoder simulations are in alpha.',
15086
+ 'x-title': 'Simulate that the Next Credential Encoding Will Succeed',
15016
15087
  },
15017
15088
  },
15018
15089
  '/acs/encoders/simulate/next_credential_scan_will_fail': {
15019
15090
  post: {
15091
+ description:
15092
+ 'Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
15020
15093
  operationId: 'acsEncodersSimulateNextCredentialScanWillFailPost',
15021
15094
  requestBody: {
15022
15095
  content: {
@@ -15026,7 +15099,12 @@ export default {
15026
15099
  {
15027
15100
  additionalProperties: false,
15028
15101
  properties: {
15029
- acs_encoder_id: { format: 'uuid', type: 'string' },
15102
+ acs_encoder_id: {
15103
+ description:
15104
+ 'ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.',
15105
+ format: 'uuid',
15106
+ type: 'string',
15107
+ },
15030
15108
  error_code: {
15031
15109
  default: 'no_credential_on_encoder',
15032
15110
  enum: ['no_credential_on_encoder'],
@@ -15043,7 +15121,12 @@ export default {
15043
15121
  format: 'uuid',
15044
15122
  type: 'string',
15045
15123
  },
15046
- acs_encoder_id: { format: 'uuid', type: 'string' },
15124
+ acs_encoder_id: {
15125
+ description:
15126
+ 'ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.',
15127
+ format: 'uuid',
15128
+ type: 'string',
15129
+ },
15047
15130
  error_code: {
15048
15131
  enum: ['uncategorized_error', 'action_attempt_expired'],
15049
15132
  type: 'string',
@@ -15083,11 +15166,13 @@ export default {
15083
15166
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
15084
15167
  'x-fern-sdk-method-name': 'next_credential_scan_will_fail',
15085
15168
  'x-response-key': null,
15086
- 'x-undocumented': 'Encoder simulations are in alpha.',
15169
+ 'x-title': 'Simulate that the Next Credential Scan Will Fail',
15087
15170
  },
15088
15171
  },
15089
15172
  '/acs/encoders/simulate/next_credential_scan_will_succeed': {
15090
15173
  post: {
15174
+ description:
15175
+ 'Simulates that the next attempt to scan a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
15091
15176
  operationId: 'acsEncodersSimulateNextCredentialScanWillSucceedPost',
15092
15177
  requestBody: {
15093
15178
  content: {
@@ -15098,12 +15183,20 @@ export default {
15098
15183
  additionalProperties: false,
15099
15184
  properties: {
15100
15185
  acs_credential_id_on_seam: {
15186
+ description:
15187
+ 'ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.',
15188
+ format: 'uuid',
15189
+ type: 'string',
15190
+ },
15191
+ acs_encoder_id: {
15192
+ description:
15193
+ 'ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.',
15101
15194
  format: 'uuid',
15102
15195
  type: 'string',
15103
15196
  },
15104
- acs_encoder_id: { format: 'uuid', type: 'string' },
15105
15197
  scenario: {
15106
15198
  default: 'credential_exists_on_seam',
15199
+ description: 'Scenario to simulate.',
15107
15200
  enum: [
15108
15201
  'credential_exists_on_seam',
15109
15202
  'credential_on_encoder_needs_update',
@@ -15117,8 +15210,14 @@ export default {
15117
15210
  {
15118
15211
  additionalProperties: false,
15119
15212
  properties: {
15120
- acs_encoder_id: { format: 'uuid', type: 'string' },
15213
+ acs_encoder_id: {
15214
+ description:
15215
+ 'ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.',
15216
+ format: 'uuid',
15217
+ type: 'string',
15218
+ },
15121
15219
  scenario: {
15220
+ description: 'Scenario to simulate.',
15122
15221
  enum: ['credential_does_not_exist_on_seam'],
15123
15222
  type: 'string',
15124
15223
  },
@@ -15129,8 +15228,14 @@ export default {
15129
15228
  {
15130
15229
  additionalProperties: false,
15131
15230
  properties: {
15132
- acs_encoder_id: { format: 'uuid', type: 'string' },
15231
+ acs_encoder_id: {
15232
+ description:
15233
+ 'ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.',
15234
+ format: 'uuid',
15235
+ type: 'string',
15236
+ },
15133
15237
  scenario: {
15238
+ description: 'Scenario to simulate.',
15134
15239
  enum: ['credential_on_encoder_is_empty'],
15135
15240
  type: 'string',
15136
15241
  },
@@ -15169,7 +15274,7 @@ export default {
15169
15274
  'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
15170
15275
  'x-fern-sdk-method-name': 'next_credential_scan_will_succeed',
15171
15276
  'x-response-key': null,
15172
- 'x-undocumented': 'Encoder simulations are in alpha.',
15277
+ 'x-title': 'Simulate that the Next Credential Scan Will Succeed',
15173
15278
  },
15174
15279
  },
15175
15280
  '/acs/entrances/get': {