@seamapi/types 1.312.2 → 1.313.1

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 (25) hide show
  1. package/dist/connect.cjs +1201 -1194
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1296 -934
  4. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +10 -10
  5. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +5 -5
  6. package/lib/seam/connect/models/action-attempts/encode-credential.js +3 -3
  7. package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -1
  8. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +5 -5
  9. package/lib/seam/connect/models/action-attempts/scan-credential.js +3 -3
  10. package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -1
  11. package/lib/seam/connect/models/events/common.js +10 -24
  12. package/lib/seam/connect/models/events/common.js.map +1 -1
  13. package/lib/seam/connect/models/events/devices.js +145 -98
  14. package/lib/seam/connect/models/events/devices.js.map +1 -1
  15. package/lib/seam/connect/openapi.d.ts +383 -134
  16. package/lib/seam/connect/openapi.js +717 -716
  17. package/lib/seam/connect/openapi.js.map +1 -1
  18. package/lib/seam/connect/route-types.d.ts +801 -688
  19. package/package.json +1 -1
  20. package/src/lib/seam/connect/models/action-attempts/encode-credential.ts +3 -3
  21. package/src/lib/seam/connect/models/action-attempts/scan-credential.ts +3 -3
  22. package/src/lib/seam/connect/models/events/common.ts +12 -24
  23. package/src/lib/seam/connect/models/events/devices.ts +212 -101
  24. package/src/lib/seam/connect/openapi.ts +842 -716
  25. package/src/lib/seam/connect/route-types.ts +810 -688
@@ -2342,7 +2342,10 @@ export default {
2342
2342
  {
2343
2343
  properties: {
2344
2344
  message: { type: 'string' },
2345
- type: { enum: ['no_card_on_encoder'], type: 'string' },
2345
+ type: {
2346
+ enum: ['no_credential_on_encoder'],
2347
+ type: 'string',
2348
+ },
2346
2349
  },
2347
2350
  required: ['type', 'message'],
2348
2351
  type: 'object',
@@ -3042,7 +3045,10 @@ export default {
3042
3045
  {
3043
3046
  properties: {
3044
3047
  message: { type: 'string' },
3045
- type: { enum: ['no_card_on_encoder'], type: 'string' },
3048
+ type: {
3049
+ enum: ['no_credential_on_encoder'],
3050
+ type: 'string',
3051
+ },
3046
3052
  },
3047
3053
  required: ['type', 'message'],
3048
3054
  type: 'object',
@@ -5682,10 +5688,9 @@ export default {
5682
5688
  'x-title': 'Connected Account ID',
5683
5689
  },
5684
5690
  created_at: {
5685
- description: 'The time when the event was created.',
5691
+ description: 'Time at which the event was created.',
5686
5692
  format: 'date-time',
5687
5693
  type: 'string',
5688
- 'x-title': 'Created At',
5689
5694
  },
5690
5695
  device_id: {
5691
5696
  description: 'The ID of the device.',
@@ -5694,23 +5699,21 @@ export default {
5694
5699
  'x-title': 'Device ID',
5695
5700
  },
5696
5701
  event_id: {
5697
- description: 'The ID of the event.',
5702
+ description: 'ID of the event.',
5698
5703
  format: 'uuid',
5699
5704
  type: 'string',
5700
- 'x-title': 'Event ID',
5701
5705
  },
5702
5706
  event_type: { enum: ['access_code.created'], type: 'string' },
5703
5707
  occurred_at: {
5704
- description: 'The time when the event occurred.',
5708
+ description: 'Time when the event occurred.',
5705
5709
  format: 'date-time',
5706
5710
  type: 'string',
5707
- 'x-title': 'Occurred At',
5708
5711
  },
5709
5712
  workspace_id: {
5710
- description: 'The ID of the workspace.',
5713
+ description:
5714
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
5711
5715
  format: 'uuid',
5712
5716
  type: 'string',
5713
- 'x-title': 'Workspace ID',
5714
5717
  },
5715
5718
  },
5716
5719
  required: [
@@ -5741,10 +5744,9 @@ export default {
5741
5744
  'x-title': 'Connected Account ID',
5742
5745
  },
5743
5746
  created_at: {
5744
- description: 'The time when the event was created.',
5747
+ description: 'Time at which the event was created.',
5745
5748
  format: 'date-time',
5746
5749
  type: 'string',
5747
- 'x-title': 'Created At',
5748
5750
  },
5749
5751
  device_id: {
5750
5752
  description: 'The ID of the device.',
@@ -5753,23 +5755,21 @@ export default {
5753
5755
  'x-title': 'Device ID',
5754
5756
  },
5755
5757
  event_id: {
5756
- description: 'The ID of the event.',
5758
+ description: 'ID of the event.',
5757
5759
  format: 'uuid',
5758
5760
  type: 'string',
5759
- 'x-title': 'Event ID',
5760
5761
  },
5761
5762
  event_type: { enum: ['access_code.changed'], type: 'string' },
5762
5763
  occurred_at: {
5763
- description: 'The time when the event occurred.',
5764
+ description: 'Time when the event occurred.',
5764
5765
  format: 'date-time',
5765
5766
  type: 'string',
5766
- 'x-title': 'Occurred At',
5767
5767
  },
5768
5768
  workspace_id: {
5769
- description: 'The ID of the workspace.',
5769
+ description:
5770
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
5770
5771
  format: 'uuid',
5771
5772
  type: 'string',
5772
- 'x-title': 'Workspace ID',
5773
5773
  },
5774
5774
  },
5775
5775
  required: [
@@ -5805,10 +5805,9 @@ export default {
5805
5805
  'x-title': 'Connected Account ID',
5806
5806
  },
5807
5807
  created_at: {
5808
- description: 'The time when the event was created.',
5808
+ description: 'Time at which the event was created.',
5809
5809
  format: 'date-time',
5810
5810
  type: 'string',
5811
- 'x-title': 'Created At',
5812
5811
  },
5813
5812
  device_id: {
5814
5813
  description: 'The ID of the device.',
@@ -5817,26 +5816,24 @@ export default {
5817
5816
  'x-title': 'Device ID',
5818
5817
  },
5819
5818
  event_id: {
5820
- description: 'The ID of the event.',
5819
+ description: 'ID of the event.',
5821
5820
  format: 'uuid',
5822
5821
  type: 'string',
5823
- 'x-title': 'Event ID',
5824
5822
  },
5825
5823
  event_type: {
5826
5824
  enum: ['access_code.scheduled_on_device'],
5827
5825
  type: 'string',
5828
5826
  },
5829
5827
  occurred_at: {
5830
- description: 'The time when the event occurred.',
5828
+ description: 'Time when the event occurred.',
5831
5829
  format: 'date-time',
5832
5830
  type: 'string',
5833
- 'x-title': 'Occurred At',
5834
5831
  },
5835
5832
  workspace_id: {
5836
- description: 'The ID of the workspace.',
5833
+ description:
5834
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
5837
5835
  format: 'uuid',
5838
5836
  type: 'string',
5839
- 'x-title': 'Workspace ID',
5840
5837
  },
5841
5838
  },
5842
5839
  required: [
@@ -5873,10 +5870,9 @@ export default {
5873
5870
  'x-title': 'Connected Account ID',
5874
5871
  },
5875
5872
  created_at: {
5876
- description: 'The time when the event was created.',
5873
+ description: 'Time at which the event was created.',
5877
5874
  format: 'date-time',
5878
5875
  type: 'string',
5879
- 'x-title': 'Created At',
5880
5876
  },
5881
5877
  device_id: {
5882
5878
  description: 'The ID of the device.',
@@ -5885,26 +5881,24 @@ export default {
5885
5881
  'x-title': 'Device ID',
5886
5882
  },
5887
5883
  event_id: {
5888
- description: 'The ID of the event.',
5884
+ description: 'ID of the event.',
5889
5885
  format: 'uuid',
5890
5886
  type: 'string',
5891
- 'x-title': 'Event ID',
5892
5887
  },
5893
5888
  event_type: {
5894
5889
  enum: ['access_code.set_on_device'],
5895
5890
  type: 'string',
5896
5891
  },
5897
5892
  occurred_at: {
5898
- description: 'The time when the event occurred.',
5893
+ description: 'Time when the event occurred.',
5899
5894
  format: 'date-time',
5900
5895
  type: 'string',
5901
- 'x-title': 'Occurred At',
5902
5896
  },
5903
5897
  workspace_id: {
5904
- description: 'The ID of the workspace.',
5898
+ description:
5899
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
5905
5900
  format: 'uuid',
5906
5901
  type: 'string',
5907
- 'x-title': 'Workspace ID',
5908
5902
  },
5909
5903
  },
5910
5904
  required: [
@@ -5936,10 +5930,9 @@ export default {
5936
5930
  'x-title': 'Connected Account ID',
5937
5931
  },
5938
5932
  created_at: {
5939
- description: 'The time when the event was created.',
5933
+ description: 'Time at which the event was created.',
5940
5934
  format: 'date-time',
5941
5935
  type: 'string',
5942
- 'x-title': 'Created At',
5943
5936
  },
5944
5937
  device_id: {
5945
5938
  description: 'The ID of the device.',
@@ -5948,26 +5941,24 @@ export default {
5948
5941
  'x-title': 'Device ID',
5949
5942
  },
5950
5943
  event_id: {
5951
- description: 'The ID of the event.',
5944
+ description: 'ID of the event.',
5952
5945
  format: 'uuid',
5953
5946
  type: 'string',
5954
- 'x-title': 'Event ID',
5955
5947
  },
5956
5948
  event_type: {
5957
5949
  enum: ['access_code.removed_from_device'],
5958
5950
  type: 'string',
5959
5951
  },
5960
5952
  occurred_at: {
5961
- description: 'The time when the event occurred.',
5953
+ description: 'Time when the event occurred.',
5962
5954
  format: 'date-time',
5963
5955
  type: 'string',
5964
- 'x-title': 'Occurred At',
5965
5956
  },
5966
5957
  workspace_id: {
5967
- description: 'The ID of the workspace.',
5958
+ description:
5959
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
5968
5960
  format: 'uuid',
5969
5961
  type: 'string',
5970
- 'x-title': 'Workspace ID',
5971
5962
  },
5972
5963
  },
5973
5964
  required: [
@@ -5999,10 +5990,9 @@ export default {
5999
5990
  'x-title': 'Connected Account ID',
6000
5991
  },
6001
5992
  created_at: {
6002
- description: 'The time when the event was created.',
5993
+ description: 'Time at which the event was created.',
6003
5994
  format: 'date-time',
6004
5995
  type: 'string',
6005
- 'x-title': 'Created At',
6006
5996
  },
6007
5997
  device_id: {
6008
5998
  description: 'The ID of the device.',
@@ -6011,26 +6001,24 @@ export default {
6011
6001
  'x-title': 'Device ID',
6012
6002
  },
6013
6003
  event_id: {
6014
- description: 'The ID of the event.',
6004
+ description: 'ID of the event.',
6015
6005
  format: 'uuid',
6016
6006
  type: 'string',
6017
- 'x-title': 'Event ID',
6018
6007
  },
6019
6008
  event_type: {
6020
6009
  enum: ['access_code.delay_in_setting_on_device'],
6021
6010
  type: 'string',
6022
6011
  },
6023
6012
  occurred_at: {
6024
- description: 'The time when the event occurred.',
6013
+ description: 'Time when the event occurred.',
6025
6014
  format: 'date-time',
6026
6015
  type: 'string',
6027
- 'x-title': 'Occurred At',
6028
6016
  },
6029
6017
  workspace_id: {
6030
- description: 'The ID of the workspace.',
6018
+ description:
6019
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6031
6020
  format: 'uuid',
6032
6021
  type: 'string',
6033
- 'x-title': 'Workspace ID',
6034
6022
  },
6035
6023
  },
6036
6024
  required: [
@@ -6061,10 +6049,9 @@ export default {
6061
6049
  'x-title': 'Connected Account ID',
6062
6050
  },
6063
6051
  created_at: {
6064
- description: 'The time when the event was created.',
6052
+ description: 'Time at which the event was created.',
6065
6053
  format: 'date-time',
6066
6054
  type: 'string',
6067
- 'x-title': 'Created At',
6068
6055
  },
6069
6056
  device_id: {
6070
6057
  description: 'The ID of the device.',
@@ -6073,26 +6060,24 @@ export default {
6073
6060
  'x-title': 'Device ID',
6074
6061
  },
6075
6062
  event_id: {
6076
- description: 'The ID of the event.',
6063
+ description: 'ID of the event.',
6077
6064
  format: 'uuid',
6078
6065
  type: 'string',
6079
- 'x-title': 'Event ID',
6080
6066
  },
6081
6067
  event_type: {
6082
6068
  enum: ['access_code.failed_to_set_on_device'],
6083
6069
  type: 'string',
6084
6070
  },
6085
6071
  occurred_at: {
6086
- description: 'The time when the event occurred.',
6072
+ description: 'Time when the event occurred.',
6087
6073
  format: 'date-time',
6088
6074
  type: 'string',
6089
- 'x-title': 'Occurred At',
6090
6075
  },
6091
6076
  workspace_id: {
6092
- description: 'The ID of the workspace.',
6077
+ description:
6078
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6093
6079
  format: 'uuid',
6094
6080
  type: 'string',
6095
- 'x-title': 'Workspace ID',
6096
6081
  },
6097
6082
  },
6098
6083
  required: [
@@ -6129,10 +6114,9 @@ export default {
6129
6114
  'x-title': 'Connected Account ID',
6130
6115
  },
6131
6116
  created_at: {
6132
- description: 'The time when the event was created.',
6117
+ description: 'Time at which the event was created.',
6133
6118
  format: 'date-time',
6134
6119
  type: 'string',
6135
- 'x-title': 'Created At',
6136
6120
  },
6137
6121
  device_id: {
6138
6122
  description: 'The ID of the device.',
@@ -6141,23 +6125,21 @@ export default {
6141
6125
  'x-title': 'Device ID',
6142
6126
  },
6143
6127
  event_id: {
6144
- description: 'The ID of the event.',
6128
+ description: 'ID of the event.',
6145
6129
  format: 'uuid',
6146
6130
  type: 'string',
6147
- 'x-title': 'Event ID',
6148
6131
  },
6149
6132
  event_type: { enum: ['access_code.deleted'], type: 'string' },
6150
6133
  occurred_at: {
6151
- description: 'The time when the event occurred.',
6134
+ description: 'Time when the event occurred.',
6152
6135
  format: 'date-time',
6153
6136
  type: 'string',
6154
- 'x-title': 'Occurred At',
6155
6137
  },
6156
6138
  workspace_id: {
6157
- description: 'The ID of the workspace.',
6139
+ description:
6140
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6158
6141
  format: 'uuid',
6159
6142
  type: 'string',
6160
- 'x-title': 'Workspace ID',
6161
6143
  },
6162
6144
  },
6163
6145
  required: [
@@ -6190,10 +6172,9 @@ export default {
6190
6172
  'x-title': 'Connected Account ID',
6191
6173
  },
6192
6174
  created_at: {
6193
- description: 'The time when the event was created.',
6175
+ description: 'Time at which the event was created.',
6194
6176
  format: 'date-time',
6195
6177
  type: 'string',
6196
- 'x-title': 'Created At',
6197
6178
  },
6198
6179
  device_id: {
6199
6180
  description: 'The ID of the device.',
@@ -6202,26 +6183,24 @@ export default {
6202
6183
  'x-title': 'Device ID',
6203
6184
  },
6204
6185
  event_id: {
6205
- description: 'The ID of the event.',
6186
+ description: 'ID of the event.',
6206
6187
  format: 'uuid',
6207
6188
  type: 'string',
6208
- 'x-title': 'Event ID',
6209
6189
  },
6210
6190
  event_type: {
6211
6191
  enum: ['access_code.delay_in_removing_from_device'],
6212
6192
  type: 'string',
6213
6193
  },
6214
6194
  occurred_at: {
6215
- description: 'The time when the event occurred.',
6195
+ description: 'Time when the event occurred.',
6216
6196
  format: 'date-time',
6217
6197
  type: 'string',
6218
- 'x-title': 'Occurred At',
6219
6198
  },
6220
6199
  workspace_id: {
6221
- description: 'The ID of the workspace.',
6200
+ description:
6201
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6222
6202
  format: 'uuid',
6223
6203
  type: 'string',
6224
- 'x-title': 'Workspace ID',
6225
6204
  },
6226
6205
  },
6227
6206
  required: [
@@ -6252,10 +6231,9 @@ export default {
6252
6231
  'x-title': 'Connected Account ID',
6253
6232
  },
6254
6233
  created_at: {
6255
- description: 'The time when the event was created.',
6234
+ description: 'Time at which the event was created.',
6256
6235
  format: 'date-time',
6257
6236
  type: 'string',
6258
- 'x-title': 'Created At',
6259
6237
  },
6260
6238
  device_id: {
6261
6239
  description: 'The ID of the device.',
@@ -6264,26 +6242,24 @@ export default {
6264
6242
  'x-title': 'Device ID',
6265
6243
  },
6266
6244
  event_id: {
6267
- description: 'The ID of the event.',
6245
+ description: 'ID of the event.',
6268
6246
  format: 'uuid',
6269
6247
  type: 'string',
6270
- 'x-title': 'Event ID',
6271
6248
  },
6272
6249
  event_type: {
6273
6250
  enum: ['access_code.failed_to_remove_from_device'],
6274
6251
  type: 'string',
6275
6252
  },
6276
6253
  occurred_at: {
6277
- description: 'The time when the event occurred.',
6254
+ description: 'Time when the event occurred.',
6278
6255
  format: 'date-time',
6279
6256
  type: 'string',
6280
- 'x-title': 'Occurred At',
6281
6257
  },
6282
6258
  workspace_id: {
6283
- description: 'The ID of the workspace.',
6259
+ description:
6260
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6284
6261
  format: 'uuid',
6285
6262
  type: 'string',
6286
- 'x-title': 'Workspace ID',
6287
6263
  },
6288
6264
  },
6289
6265
  required: [
@@ -6314,10 +6290,9 @@ export default {
6314
6290
  'x-title': 'Connected Account ID',
6315
6291
  },
6316
6292
  created_at: {
6317
- description: 'The time when the event was created.',
6293
+ description: 'Time at which the event was created.',
6318
6294
  format: 'date-time',
6319
6295
  type: 'string',
6320
- 'x-title': 'Created At',
6321
6296
  },
6322
6297
  device_id: {
6323
6298
  description: 'The ID of the device.',
@@ -6326,26 +6301,24 @@ export default {
6326
6301
  'x-title': 'Device ID',
6327
6302
  },
6328
6303
  event_id: {
6329
- description: 'The ID of the event.',
6304
+ description: 'ID of the event.',
6330
6305
  format: 'uuid',
6331
6306
  type: 'string',
6332
- 'x-title': 'Event ID',
6333
6307
  },
6334
6308
  event_type: {
6335
6309
  enum: ['access_code.modified_external_to_seam'],
6336
6310
  type: 'string',
6337
6311
  },
6338
6312
  occurred_at: {
6339
- description: 'The time when the event occurred.',
6313
+ description: 'Time when the event occurred.',
6340
6314
  format: 'date-time',
6341
6315
  type: 'string',
6342
- 'x-title': 'Occurred At',
6343
6316
  },
6344
6317
  workspace_id: {
6345
- description: 'The ID of the workspace.',
6318
+ description:
6319
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6346
6320
  format: 'uuid',
6347
6321
  type: 'string',
6348
- 'x-title': 'Workspace ID',
6349
6322
  },
6350
6323
  },
6351
6324
  required: [
@@ -6376,10 +6349,9 @@ export default {
6376
6349
  'x-title': 'Connected Account ID',
6377
6350
  },
6378
6351
  created_at: {
6379
- description: 'The time when the event was created.',
6352
+ description: 'Time at which the event was created.',
6380
6353
  format: 'date-time',
6381
6354
  type: 'string',
6382
- 'x-title': 'Created At',
6383
6355
  },
6384
6356
  device_id: {
6385
6357
  description: 'The ID of the device.',
@@ -6388,26 +6360,24 @@ export default {
6388
6360
  'x-title': 'Device ID',
6389
6361
  },
6390
6362
  event_id: {
6391
- description: 'The ID of the event.',
6363
+ description: 'ID of the event.',
6392
6364
  format: 'uuid',
6393
6365
  type: 'string',
6394
- 'x-title': 'Event ID',
6395
6366
  },
6396
6367
  event_type: {
6397
6368
  enum: ['access_code.deleted_external_to_seam'],
6398
6369
  type: 'string',
6399
6370
  },
6400
6371
  occurred_at: {
6401
- description: 'The time when the event occurred.',
6372
+ description: 'Time when the event occurred.',
6402
6373
  format: 'date-time',
6403
6374
  type: 'string',
6404
- 'x-title': 'Occurred At',
6405
6375
  },
6406
6376
  workspace_id: {
6407
- description: 'The ID of the workspace.',
6377
+ description:
6378
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6408
6379
  format: 'uuid',
6409
6380
  type: 'string',
6410
- 'x-title': 'Workspace ID',
6411
6381
  },
6412
6382
  },
6413
6383
  required: [
@@ -6440,10 +6410,9 @@ export default {
6440
6410
  'x-title': 'Connected Account ID',
6441
6411
  },
6442
6412
  created_at: {
6443
- description: 'The time when the event was created.',
6413
+ description: 'Time at which the event was created.',
6444
6414
  format: 'date-time',
6445
6415
  type: 'string',
6446
- 'x-title': 'Created At',
6447
6416
  },
6448
6417
  device_id: {
6449
6418
  description: 'The ID of the device.',
@@ -6452,26 +6421,24 @@ export default {
6452
6421
  'x-title': 'Device ID',
6453
6422
  },
6454
6423
  event_id: {
6455
- description: 'The ID of the event.',
6424
+ description: 'ID of the event.',
6456
6425
  format: 'uuid',
6457
6426
  type: 'string',
6458
- 'x-title': 'Event ID',
6459
6427
  },
6460
6428
  event_type: {
6461
6429
  enum: ['access_code.backup_access_code_pulled'],
6462
6430
  type: 'string',
6463
6431
  },
6464
6432
  occurred_at: {
6465
- description: 'The time when the event occurred.',
6433
+ description: 'Time when the event occurred.',
6466
6434
  format: 'date-time',
6467
6435
  type: 'string',
6468
- 'x-title': 'Occurred At',
6469
6436
  },
6470
6437
  workspace_id: {
6471
- description: 'The ID of the workspace.',
6438
+ description:
6439
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6472
6440
  format: 'uuid',
6473
6441
  type: 'string',
6474
- 'x-title': 'Workspace ID',
6475
6442
  },
6476
6443
  },
6477
6444
  required: [
@@ -6504,10 +6471,9 @@ export default {
6504
6471
  'x-title': 'Connected Account ID',
6505
6472
  },
6506
6473
  created_at: {
6507
- description: 'The time when the event was created.',
6474
+ description: 'Time at which the event was created.',
6508
6475
  format: 'date-time',
6509
6476
  type: 'string',
6510
- 'x-title': 'Created At',
6511
6477
  },
6512
6478
  device_id: {
6513
6479
  description: 'The ID of the device.',
@@ -6516,26 +6482,24 @@ export default {
6516
6482
  'x-title': 'Device ID',
6517
6483
  },
6518
6484
  event_id: {
6519
- description: 'The ID of the event.',
6485
+ description: 'ID of the event.',
6520
6486
  format: 'uuid',
6521
6487
  type: 'string',
6522
- 'x-title': 'Event ID',
6523
6488
  },
6524
6489
  event_type: {
6525
6490
  enum: ['access_code.unmanaged.converted_to_managed'],
6526
6491
  type: 'string',
6527
6492
  },
6528
6493
  occurred_at: {
6529
- description: 'The time when the event occurred.',
6494
+ description: 'Time when the event occurred.',
6530
6495
  format: 'date-time',
6531
6496
  type: 'string',
6532
- 'x-title': 'Occurred At',
6533
6497
  },
6534
6498
  workspace_id: {
6535
- description: 'The ID of the workspace.',
6499
+ description:
6500
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6536
6501
  format: 'uuid',
6537
6502
  type: 'string',
6538
- 'x-title': 'Workspace ID',
6539
6503
  },
6540
6504
  },
6541
6505
  required: [
@@ -6567,10 +6531,9 @@ export default {
6567
6531
  'x-title': 'Connected Account ID',
6568
6532
  },
6569
6533
  created_at: {
6570
- description: 'The time when the event was created.',
6534
+ description: 'Time at which the event was created.',
6571
6535
  format: 'date-time',
6572
6536
  type: 'string',
6573
- 'x-title': 'Created At',
6574
6537
  },
6575
6538
  device_id: {
6576
6539
  description: 'The ID of the device.',
@@ -6579,26 +6542,24 @@ export default {
6579
6542
  'x-title': 'Device ID',
6580
6543
  },
6581
6544
  event_id: {
6582
- description: 'The ID of the event.',
6545
+ description: 'ID of the event.',
6583
6546
  format: 'uuid',
6584
6547
  type: 'string',
6585
- 'x-title': 'Event ID',
6586
6548
  },
6587
6549
  event_type: {
6588
6550
  enum: ['access_code.unmanaged.failed_to_convert_to_managed'],
6589
6551
  type: 'string',
6590
6552
  },
6591
6553
  occurred_at: {
6592
- description: 'The time when the event occurred.',
6554
+ description: 'Time when the event occurred.',
6593
6555
  format: 'date-time',
6594
6556
  type: 'string',
6595
- 'x-title': 'Occurred At',
6596
6557
  },
6597
6558
  workspace_id: {
6598
- description: 'The ID of the workspace.',
6559
+ description:
6560
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6599
6561
  format: 'uuid',
6600
6562
  type: 'string',
6601
- 'x-title': 'Workspace ID',
6602
6563
  },
6603
6564
  },
6604
6565
  required: [
@@ -6629,10 +6590,9 @@ export default {
6629
6590
  'x-title': 'Connected Account ID',
6630
6591
  },
6631
6592
  created_at: {
6632
- description: 'The time when the event was created.',
6593
+ description: 'Time at which the event was created.',
6633
6594
  format: 'date-time',
6634
6595
  type: 'string',
6635
- 'x-title': 'Created At',
6636
6596
  },
6637
6597
  device_id: {
6638
6598
  description: 'The ID of the device.',
@@ -6641,26 +6601,24 @@ export default {
6641
6601
  'x-title': 'Device ID',
6642
6602
  },
6643
6603
  event_id: {
6644
- description: 'The ID of the event.',
6604
+ description: 'ID of the event.',
6645
6605
  format: 'uuid',
6646
6606
  type: 'string',
6647
- 'x-title': 'Event ID',
6648
6607
  },
6649
6608
  event_type: {
6650
6609
  enum: ['access_code.unmanaged.created'],
6651
6610
  type: 'string',
6652
6611
  },
6653
6612
  occurred_at: {
6654
- description: 'The time when the event occurred.',
6613
+ description: 'Time when the event occurred.',
6655
6614
  format: 'date-time',
6656
6615
  type: 'string',
6657
- 'x-title': 'Occurred At',
6658
6616
  },
6659
6617
  workspace_id: {
6660
- description: 'The ID of the workspace.',
6618
+ description:
6619
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6661
6620
  format: 'uuid',
6662
6621
  type: 'string',
6663
- 'x-title': 'Workspace ID',
6664
6622
  },
6665
6623
  },
6666
6624
  required: [
@@ -6691,10 +6649,9 @@ export default {
6691
6649
  'x-title': 'Connected Account ID',
6692
6650
  },
6693
6651
  created_at: {
6694
- description: 'The time when the event was created.',
6652
+ description: 'Time at which the event was created.',
6695
6653
  format: 'date-time',
6696
6654
  type: 'string',
6697
- 'x-title': 'Created At',
6698
6655
  },
6699
6656
  device_id: {
6700
6657
  description: 'The ID of the device.',
@@ -6703,26 +6660,24 @@ export default {
6703
6660
  'x-title': 'Device ID',
6704
6661
  },
6705
6662
  event_id: {
6706
- description: 'The ID of the event.',
6663
+ description: 'ID of the event.',
6707
6664
  format: 'uuid',
6708
6665
  type: 'string',
6709
- 'x-title': 'Event ID',
6710
6666
  },
6711
6667
  event_type: {
6712
6668
  enum: ['access_code.unmanaged.removed'],
6713
6669
  type: 'string',
6714
6670
  },
6715
6671
  occurred_at: {
6716
- description: 'The time when the event occurred.',
6672
+ description: 'Time when the event occurred.',
6717
6673
  format: 'date-time',
6718
6674
  type: 'string',
6719
- 'x-title': 'Occurred At',
6720
6675
  },
6721
6676
  workspace_id: {
6722
- description: 'The ID of the workspace.',
6677
+ description:
6678
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6723
6679
  format: 'uuid',
6724
6680
  type: 'string',
6725
- 'x-title': 'Workspace ID',
6726
6681
  },
6727
6682
  },
6728
6683
  required: [
@@ -6755,29 +6710,26 @@ export default {
6755
6710
  'x-title': 'Connected Account ID',
6756
6711
  },
6757
6712
  created_at: {
6758
- description: 'The time when the event was created.',
6713
+ description: 'Time at which the event was created.',
6759
6714
  format: 'date-time',
6760
6715
  type: 'string',
6761
- 'x-title': 'Created At',
6762
6716
  },
6763
6717
  event_id: {
6764
- description: 'The ID of the event.',
6718
+ description: 'ID of the event.',
6765
6719
  format: 'uuid',
6766
6720
  type: 'string',
6767
- 'x-title': 'Event ID',
6768
6721
  },
6769
6722
  event_type: { enum: ['acs_system.connected'], type: 'string' },
6770
6723
  occurred_at: {
6771
- description: 'The time when the event occurred.',
6724
+ description: 'Time when the event occurred.',
6772
6725
  format: 'date-time',
6773
6726
  type: 'string',
6774
- 'x-title': 'Occurred At',
6775
6727
  },
6776
6728
  workspace_id: {
6777
- description: 'The ID of the workspace.',
6729
+ description:
6730
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6778
6731
  format: 'uuid',
6779
6732
  type: 'string',
6780
- 'x-title': 'Workspace ID',
6781
6733
  },
6782
6734
  },
6783
6735
  required: [
@@ -6808,29 +6760,26 @@ export default {
6808
6760
  'x-title': 'Connected Account ID',
6809
6761
  },
6810
6762
  created_at: {
6811
- description: 'The time when the event was created.',
6763
+ description: 'Time at which the event was created.',
6812
6764
  format: 'date-time',
6813
6765
  type: 'string',
6814
- 'x-title': 'Created At',
6815
6766
  },
6816
6767
  event_id: {
6817
- description: 'The ID of the event.',
6768
+ description: 'ID of the event.',
6818
6769
  format: 'uuid',
6819
6770
  type: 'string',
6820
- 'x-title': 'Event ID',
6821
6771
  },
6822
6772
  event_type: { enum: ['acs_system.added'], type: 'string' },
6823
6773
  occurred_at: {
6824
- description: 'The time when the event occurred.',
6774
+ description: 'Time when the event occurred.',
6825
6775
  format: 'date-time',
6826
6776
  type: 'string',
6827
- 'x-title': 'Occurred At',
6828
6777
  },
6829
6778
  workspace_id: {
6830
- description: 'The ID of the workspace.',
6779
+ description:
6780
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6831
6781
  format: 'uuid',
6832
6782
  type: 'string',
6833
- 'x-title': 'Workspace ID',
6834
6783
  },
6835
6784
  },
6836
6785
  required: [
@@ -6861,29 +6810,26 @@ export default {
6861
6810
  'x-title': 'Connected Account ID',
6862
6811
  },
6863
6812
  created_at: {
6864
- description: 'The time when the event was created.',
6813
+ description: 'Time at which the event was created.',
6865
6814
  format: 'date-time',
6866
6815
  type: 'string',
6867
- 'x-title': 'Created At',
6868
6816
  },
6869
6817
  event_id: {
6870
- description: 'The ID of the event.',
6818
+ description: 'ID of the event.',
6871
6819
  format: 'uuid',
6872
6820
  type: 'string',
6873
- 'x-title': 'Event ID',
6874
6821
  },
6875
6822
  event_type: { enum: ['acs_system.disconnected'], type: 'string' },
6876
6823
  occurred_at: {
6877
- description: 'The time when the event occurred.',
6824
+ description: 'Time when the event occurred.',
6878
6825
  format: 'date-time',
6879
6826
  type: 'string',
6880
- 'x-title': 'Occurred At',
6881
6827
  },
6882
6828
  workspace_id: {
6883
- description: 'The ID of the workspace.',
6829
+ description:
6830
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6884
6831
  format: 'uuid',
6885
6832
  type: 'string',
6886
- 'x-title': 'Workspace ID',
6887
6833
  },
6888
6834
  },
6889
6835
  required: [
@@ -6915,29 +6861,26 @@ export default {
6915
6861
  'x-title': 'Connected Account ID',
6916
6862
  },
6917
6863
  created_at: {
6918
- description: 'The time when the event was created.',
6864
+ description: 'Time at which the event was created.',
6919
6865
  format: 'date-time',
6920
6866
  type: 'string',
6921
- 'x-title': 'Created At',
6922
6867
  },
6923
6868
  event_id: {
6924
- description: 'The ID of the event.',
6869
+ description: 'ID of the event.',
6925
6870
  format: 'uuid',
6926
6871
  type: 'string',
6927
- 'x-title': 'Event ID',
6928
6872
  },
6929
6873
  event_type: { enum: ['acs_credential.deleted'], type: 'string' },
6930
6874
  occurred_at: {
6931
- description: 'The time when the event occurred.',
6875
+ description: 'Time when the event occurred.',
6932
6876
  format: 'date-time',
6933
6877
  type: 'string',
6934
- 'x-title': 'Occurred At',
6935
6878
  },
6936
6879
  workspace_id: {
6937
- description: 'The ID of the workspace.',
6880
+ description:
6881
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6938
6882
  format: 'uuid',
6939
6883
  type: 'string',
6940
- 'x-title': 'Workspace ID',
6941
6884
  },
6942
6885
  },
6943
6886
  required: [
@@ -6970,29 +6913,26 @@ export default {
6970
6913
  'x-title': 'Connected Account ID',
6971
6914
  },
6972
6915
  created_at: {
6973
- description: 'The time when the event was created.',
6916
+ description: 'Time at which the event was created.',
6974
6917
  format: 'date-time',
6975
6918
  type: 'string',
6976
- 'x-title': 'Created At',
6977
6919
  },
6978
6920
  event_id: {
6979
- description: 'The ID of the event.',
6921
+ description: 'ID of the event.',
6980
6922
  format: 'uuid',
6981
6923
  type: 'string',
6982
- 'x-title': 'Event ID',
6983
6924
  },
6984
6925
  event_type: { enum: ['acs_credential.issued'], type: 'string' },
6985
6926
  occurred_at: {
6986
- description: 'The time when the event occurred.',
6927
+ description: 'Time when the event occurred.',
6987
6928
  format: 'date-time',
6988
6929
  type: 'string',
6989
- 'x-title': 'Occurred At',
6990
6930
  },
6991
6931
  workspace_id: {
6992
- description: 'The ID of the workspace.',
6932
+ description:
6933
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
6993
6934
  format: 'uuid',
6994
6935
  type: 'string',
6995
- 'x-title': 'Workspace ID',
6996
6936
  },
6997
6937
  },
6998
6938
  required: [
@@ -7025,29 +6965,26 @@ export default {
7025
6965
  'x-title': 'Connected Account ID',
7026
6966
  },
7027
6967
  created_at: {
7028
- description: 'The time when the event was created.',
6968
+ description: 'Time at which the event was created.',
7029
6969
  format: 'date-time',
7030
6970
  type: 'string',
7031
- 'x-title': 'Created At',
7032
6971
  },
7033
6972
  event_id: {
7034
- description: 'The ID of the event.',
6973
+ description: 'ID of the event.',
7035
6974
  format: 'uuid',
7036
6975
  type: 'string',
7037
- 'x-title': 'Event ID',
7038
6976
  },
7039
6977
  event_type: { enum: ['acs_user.deleted'], type: 'string' },
7040
6978
  occurred_at: {
7041
- description: 'The time when the event occurred.',
6979
+ description: 'Time when the event occurred.',
7042
6980
  format: 'date-time',
7043
6981
  type: 'string',
7044
- 'x-title': 'Occurred At',
7045
6982
  },
7046
6983
  workspace_id: {
7047
- description: 'The ID of the workspace.',
6984
+ description:
6985
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7048
6986
  format: 'uuid',
7049
6987
  type: 'string',
7050
- 'x-title': 'Workspace ID',
7051
6988
  },
7052
6989
  },
7053
6990
  required: [
@@ -7084,29 +7021,26 @@ export default {
7084
7021
  'x-title': 'Connected Account ID',
7085
7022
  },
7086
7023
  created_at: {
7087
- description: 'The time when the event was created.',
7024
+ description: 'Time at which the event was created.',
7088
7025
  format: 'date-time',
7089
7026
  type: 'string',
7090
- 'x-title': 'Created At',
7091
7027
  },
7092
7028
  event_id: {
7093
- description: 'The ID of the event.',
7029
+ description: 'ID of the event.',
7094
7030
  format: 'uuid',
7095
7031
  type: 'string',
7096
- 'x-title': 'Event ID',
7097
7032
  },
7098
7033
  event_type: { enum: ['acs_encoder.added'], type: 'string' },
7099
7034
  occurred_at: {
7100
- description: 'The time when the event occurred.',
7035
+ description: 'Time when the event occurred.',
7101
7036
  format: 'date-time',
7102
7037
  type: 'string',
7103
- 'x-title': 'Occurred At',
7104
7038
  },
7105
7039
  workspace_id: {
7106
- description: 'The ID of the workspace.',
7040
+ description:
7041
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7107
7042
  format: 'uuid',
7108
7043
  type: 'string',
7109
- 'x-title': 'Workspace ID',
7110
7044
  },
7111
7045
  },
7112
7046
  required: [
@@ -7143,29 +7077,26 @@ export default {
7143
7077
  'x-title': 'Connected Account ID',
7144
7078
  },
7145
7079
  created_at: {
7146
- description: 'The time when the event was created.',
7080
+ description: 'Time at which the event was created.',
7147
7081
  format: 'date-time',
7148
7082
  type: 'string',
7149
- 'x-title': 'Created At',
7150
7083
  },
7151
7084
  event_id: {
7152
- description: 'The ID of the event.',
7085
+ description: 'ID of the event.',
7153
7086
  format: 'uuid',
7154
7087
  type: 'string',
7155
- 'x-title': 'Event ID',
7156
7088
  },
7157
7089
  event_type: { enum: ['acs_encoder.removed'], type: 'string' },
7158
7090
  occurred_at: {
7159
- description: 'The time when the event occurred.',
7091
+ description: 'Time when the event occurred.',
7160
7092
  format: 'date-time',
7161
7093
  type: 'string',
7162
- 'x-title': 'Occurred At',
7163
7094
  },
7164
7095
  workspace_id: {
7165
- description: 'The ID of the workspace.',
7096
+ description:
7097
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7166
7098
  format: 'uuid',
7167
7099
  type: 'string',
7168
- 'x-title': 'Workspace ID',
7169
7100
  },
7170
7101
  },
7171
7102
  required: [
@@ -7189,29 +7120,26 @@ export default {
7189
7120
  'x-title': 'Client Session ID',
7190
7121
  },
7191
7122
  created_at: {
7192
- description: 'The time when the event was created.',
7123
+ description: 'Time at which the event was created.',
7193
7124
  format: 'date-time',
7194
7125
  type: 'string',
7195
- 'x-title': 'Created At',
7196
7126
  },
7197
7127
  event_id: {
7198
- description: 'The ID of the event.',
7128
+ description: 'ID of the event.',
7199
7129
  format: 'uuid',
7200
7130
  type: 'string',
7201
- 'x-title': 'Event ID',
7202
7131
  },
7203
7132
  event_type: { enum: ['client_session.deleted'], type: 'string' },
7204
7133
  occurred_at: {
7205
- description: 'The time when the event occurred.',
7134
+ description: 'Time when the event occurred.',
7206
7135
  format: 'date-time',
7207
7136
  type: 'string',
7208
- 'x-title': 'Occurred At',
7209
7137
  },
7210
7138
  workspace_id: {
7211
- description: 'The ID of the workspace.',
7139
+ description:
7140
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7212
7141
  format: 'uuid',
7213
7142
  type: 'string',
7214
- 'x-title': 'Workspace ID',
7215
7143
  },
7216
7144
  },
7217
7145
  required: [
@@ -7241,32 +7169,29 @@ export default {
7241
7169
  'x-title': 'Connected Account ID',
7242
7170
  },
7243
7171
  created_at: {
7244
- description: 'The time when the event was created.',
7172
+ description: 'Time at which the event was created.',
7245
7173
  format: 'date-time',
7246
7174
  type: 'string',
7247
- 'x-title': 'Created At',
7248
7175
  },
7249
7176
  event_id: {
7250
- description: 'The ID of the event.',
7177
+ description: 'ID of the event.',
7251
7178
  format: 'uuid',
7252
7179
  type: 'string',
7253
- 'x-title': 'Event ID',
7254
7180
  },
7255
7181
  event_type: {
7256
7182
  enum: ['connected_account.connected'],
7257
7183
  type: 'string',
7258
7184
  },
7259
7185
  occurred_at: {
7260
- description: 'The time when the event occurred.',
7186
+ description: 'Time when the event occurred.',
7261
7187
  format: 'date-time',
7262
7188
  type: 'string',
7263
- 'x-title': 'Occurred At',
7264
7189
  },
7265
7190
  workspace_id: {
7266
- description: 'The ID of the workspace.',
7191
+ description:
7192
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7267
7193
  format: 'uuid',
7268
7194
  type: 'string',
7269
- 'x-title': 'Workspace ID',
7270
7195
  },
7271
7196
  },
7272
7197
  required: [
@@ -7296,32 +7221,29 @@ export default {
7296
7221
  'x-title': 'Connected Account ID',
7297
7222
  },
7298
7223
  created_at: {
7299
- description: 'The time when the event was created.',
7224
+ description: 'Time at which the event was created.',
7300
7225
  format: 'date-time',
7301
7226
  type: 'string',
7302
- 'x-title': 'Created At',
7303
7227
  },
7304
7228
  event_id: {
7305
- description: 'The ID of the event.',
7229
+ description: 'ID of the event.',
7306
7230
  format: 'uuid',
7307
7231
  type: 'string',
7308
- 'x-title': 'Event ID',
7309
7232
  },
7310
7233
  event_type: {
7311
7234
  enum: ['connected_account.created'],
7312
7235
  type: 'string',
7313
7236
  },
7314
7237
  occurred_at: {
7315
- description: 'The time when the event occurred.',
7238
+ description: 'Time when the event occurred.',
7316
7239
  format: 'date-time',
7317
7240
  type: 'string',
7318
- 'x-title': 'Occurred At',
7319
7241
  },
7320
7242
  workspace_id: {
7321
- description: 'The ID of the workspace.',
7243
+ description:
7244
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7322
7245
  format: 'uuid',
7323
7246
  type: 'string',
7324
- 'x-title': 'Workspace ID',
7325
7247
  },
7326
7248
  },
7327
7249
  required: [
@@ -7353,32 +7275,29 @@ export default {
7353
7275
  'x-title': 'Connected Account ID',
7354
7276
  },
7355
7277
  created_at: {
7356
- description: 'The time when the event was created.',
7278
+ description: 'Time at which the event was created.',
7357
7279
  format: 'date-time',
7358
7280
  type: 'string',
7359
- 'x-title': 'Created At',
7360
7281
  },
7361
7282
  event_id: {
7362
- description: 'The ID of the event.',
7283
+ description: 'ID of the event.',
7363
7284
  format: 'uuid',
7364
7285
  type: 'string',
7365
- 'x-title': 'Event ID',
7366
7286
  },
7367
7287
  event_type: {
7368
7288
  enum: ['connected_account.successful_login'],
7369
7289
  type: 'string',
7370
7290
  },
7371
7291
  occurred_at: {
7372
- description: 'The time when the event occurred.',
7292
+ description: 'Time when the event occurred.',
7373
7293
  format: 'date-time',
7374
7294
  type: 'string',
7375
- 'x-title': 'Occurred At',
7376
7295
  },
7377
7296
  workspace_id: {
7378
- description: 'The ID of the workspace.',
7297
+ description:
7298
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7379
7299
  format: 'uuid',
7380
7300
  type: 'string',
7381
- 'x-title': 'Workspace ID',
7382
7301
  },
7383
7302
  },
7384
7303
  required: [
@@ -7403,32 +7322,29 @@ export default {
7403
7322
  'x-title': 'Connected Account ID',
7404
7323
  },
7405
7324
  created_at: {
7406
- description: 'The time when the event was created.',
7325
+ description: 'Time at which the event was created.',
7407
7326
  format: 'date-time',
7408
7327
  type: 'string',
7409
- 'x-title': 'Created At',
7410
7328
  },
7411
7329
  event_id: {
7412
- description: 'The ID of the event.',
7330
+ description: 'ID of the event.',
7413
7331
  format: 'uuid',
7414
7332
  type: 'string',
7415
- 'x-title': 'Event ID',
7416
7333
  },
7417
7334
  event_type: {
7418
7335
  enum: ['connected_account.disconnected'],
7419
7336
  type: 'string',
7420
7337
  },
7421
7338
  occurred_at: {
7422
- description: 'The time when the event occurred.',
7339
+ description: 'Time when the event occurred.',
7423
7340
  format: 'date-time',
7424
7341
  type: 'string',
7425
- 'x-title': 'Occurred At',
7426
7342
  },
7427
7343
  workspace_id: {
7428
- description: 'The ID of the workspace.',
7344
+ description:
7345
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7429
7346
  format: 'uuid',
7430
7347
  type: 'string',
7431
- 'x-title': 'Workspace ID',
7432
7348
  },
7433
7349
  },
7434
7350
  required: [
@@ -7452,32 +7368,29 @@ export default {
7452
7368
  'x-title': 'Connected Account ID',
7453
7369
  },
7454
7370
  created_at: {
7455
- description: 'The time when the event was created.',
7371
+ description: 'Time at which the event was created.',
7456
7372
  format: 'date-time',
7457
7373
  type: 'string',
7458
- 'x-title': 'Created At',
7459
7374
  },
7460
7375
  event_id: {
7461
- description: 'The ID of the event.',
7376
+ description: 'ID of the event.',
7462
7377
  format: 'uuid',
7463
7378
  type: 'string',
7464
- 'x-title': 'Event ID',
7465
7379
  },
7466
7380
  event_type: {
7467
7381
  enum: ['connected_account.completed_first_sync'],
7468
7382
  type: 'string',
7469
7383
  },
7470
7384
  occurred_at: {
7471
- description: 'The time when the event occurred.',
7385
+ description: 'Time when the event occurred.',
7472
7386
  format: 'date-time',
7473
7387
  type: 'string',
7474
- 'x-title': 'Occurred At',
7475
7388
  },
7476
7389
  workspace_id: {
7477
- description: 'The ID of the workspace.',
7390
+ description:
7391
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7478
7392
  format: 'uuid',
7479
7393
  type: 'string',
7480
- 'x-title': 'Workspace ID',
7481
7394
  },
7482
7395
  },
7483
7396
  required: [
@@ -7500,32 +7413,29 @@ export default {
7500
7413
  'x-title': 'Connected Account ID',
7501
7414
  },
7502
7415
  created_at: {
7503
- description: 'The time when the event was created.',
7416
+ description: 'Time at which the event was created.',
7504
7417
  format: 'date-time',
7505
7418
  type: 'string',
7506
- 'x-title': 'Created At',
7507
7419
  },
7508
7420
  event_id: {
7509
- description: 'The ID of the event.',
7421
+ description: 'ID of the event.',
7510
7422
  format: 'uuid',
7511
7423
  type: 'string',
7512
- 'x-title': 'Event ID',
7513
7424
  },
7514
7425
  event_type: {
7515
7426
  enum: ['connected_account.deleted'],
7516
7427
  type: 'string',
7517
7428
  },
7518
7429
  occurred_at: {
7519
- description: 'The time when the event occurred.',
7430
+ description: 'Time when the event occurred.',
7520
7431
  format: 'date-time',
7521
7432
  type: 'string',
7522
- 'x-title': 'Occurred At',
7523
7433
  },
7524
7434
  workspace_id: {
7525
- description: 'The ID of the workspace.',
7435
+ description:
7436
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7526
7437
  format: 'uuid',
7527
7438
  type: 'string',
7528
- 'x-title': 'Workspace ID',
7529
7439
  },
7530
7440
  },
7531
7441
  required: [
@@ -7549,16 +7459,14 @@ export default {
7549
7459
  'x-title': 'Connected Account ID',
7550
7460
  },
7551
7461
  created_at: {
7552
- description: 'The time when the event was created.',
7462
+ description: 'Time at which the event was created.',
7553
7463
  format: 'date-time',
7554
7464
  type: 'string',
7555
- 'x-title': 'Created At',
7556
7465
  },
7557
7466
  event_id: {
7558
- description: 'The ID of the event.',
7467
+ description: 'ID of the event.',
7559
7468
  format: 'uuid',
7560
7469
  type: 'string',
7561
- 'x-title': 'Event ID',
7562
7470
  },
7563
7471
  event_type: {
7564
7472
  enum: [
@@ -7567,16 +7475,15 @@ export default {
7567
7475
  type: 'string',
7568
7476
  },
7569
7477
  occurred_at: {
7570
- description: 'The time when the event occurred.',
7478
+ description: 'Time when the event occurred.',
7571
7479
  format: 'date-time',
7572
7480
  type: 'string',
7573
- 'x-title': 'Occurred At',
7574
7481
  },
7575
7482
  workspace_id: {
7576
- description: 'The ID of the workspace.',
7483
+ description:
7484
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7577
7485
  format: 'uuid',
7578
7486
  type: 'string',
7579
- 'x-title': 'Workspace ID',
7580
7487
  },
7581
7488
  },
7582
7489
  required: [
@@ -7604,26 +7511,23 @@ export default {
7604
7511
  'x-title': 'Action Type',
7605
7512
  },
7606
7513
  created_at: {
7607
- description: 'The time when the event was created.',
7514
+ description: 'Time at which the event was created.',
7608
7515
  format: 'date-time',
7609
7516
  type: 'string',
7610
- 'x-title': 'Created At',
7611
7517
  },
7612
7518
  event_id: {
7613
- description: 'The ID of the event.',
7519
+ description: 'ID of the event.',
7614
7520
  format: 'uuid',
7615
7521
  type: 'string',
7616
- 'x-title': 'Event ID',
7617
7522
  },
7618
7523
  event_type: {
7619
7524
  enum: ['action_attempt.lock_door.succeeded'],
7620
7525
  type: 'string',
7621
7526
  },
7622
7527
  occurred_at: {
7623
- description: 'The time when the event occurred.',
7528
+ description: 'Time when the event occurred.',
7624
7529
  format: 'date-time',
7625
7530
  type: 'string',
7626
- 'x-title': 'Occurred At',
7627
7531
  },
7628
7532
  status: {
7629
7533
  description: 'The status of the action.',
@@ -7631,10 +7535,10 @@ export default {
7631
7535
  'x-title': 'Status',
7632
7536
  },
7633
7537
  workspace_id: {
7634
- description: 'The ID of the workspace.',
7538
+ description:
7539
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7635
7540
  format: 'uuid',
7636
7541
  type: 'string',
7637
- 'x-title': 'Workspace ID',
7638
7542
  },
7639
7543
  },
7640
7544
  required: [
@@ -7664,26 +7568,23 @@ export default {
7664
7568
  'x-title': 'Action Type',
7665
7569
  },
7666
7570
  created_at: {
7667
- description: 'The time when the event was created.',
7571
+ description: 'Time at which the event was created.',
7668
7572
  format: 'date-time',
7669
7573
  type: 'string',
7670
- 'x-title': 'Created At',
7671
7574
  },
7672
7575
  event_id: {
7673
- description: 'The ID of the event.',
7576
+ description: 'ID of the event.',
7674
7577
  format: 'uuid',
7675
7578
  type: 'string',
7676
- 'x-title': 'Event ID',
7677
7579
  },
7678
7580
  event_type: {
7679
7581
  enum: ['action_attempt.lock_door.failed'],
7680
7582
  type: 'string',
7681
7583
  },
7682
7584
  occurred_at: {
7683
- description: 'The time when the event occurred.',
7585
+ description: 'Time when the event occurred.',
7684
7586
  format: 'date-time',
7685
7587
  type: 'string',
7686
- 'x-title': 'Occurred At',
7687
7588
  },
7688
7589
  status: {
7689
7590
  description: 'The status of the action.',
@@ -7691,10 +7592,10 @@ export default {
7691
7592
  'x-title': 'Status',
7692
7593
  },
7693
7594
  workspace_id: {
7694
- description: 'The ID of the workspace.',
7595
+ description:
7596
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7695
7597
  format: 'uuid',
7696
7598
  type: 'string',
7697
- 'x-title': 'Workspace ID',
7698
7599
  },
7699
7600
  },
7700
7601
  required: [
@@ -7724,26 +7625,23 @@ export default {
7724
7625
  'x-title': 'Action Type',
7725
7626
  },
7726
7627
  created_at: {
7727
- description: 'The time when the event was created.',
7628
+ description: 'Time at which the event was created.',
7728
7629
  format: 'date-time',
7729
7630
  type: 'string',
7730
- 'x-title': 'Created At',
7731
7631
  },
7732
7632
  event_id: {
7733
- description: 'The ID of the event.',
7633
+ description: 'ID of the event.',
7734
7634
  format: 'uuid',
7735
7635
  type: 'string',
7736
- 'x-title': 'Event ID',
7737
7636
  },
7738
7637
  event_type: {
7739
7638
  enum: ['action_attempt.unlock_door.succeeded'],
7740
7639
  type: 'string',
7741
7640
  },
7742
7641
  occurred_at: {
7743
- description: 'The time when the event occurred.',
7642
+ description: 'Time when the event occurred.',
7744
7643
  format: 'date-time',
7745
7644
  type: 'string',
7746
- 'x-title': 'Occurred At',
7747
7645
  },
7748
7646
  status: {
7749
7647
  description: 'The status of the action.',
@@ -7751,10 +7649,10 @@ export default {
7751
7649
  'x-title': 'Status',
7752
7650
  },
7753
7651
  workspace_id: {
7754
- description: 'The ID of the workspace.',
7652
+ description:
7653
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7755
7654
  format: 'uuid',
7756
7655
  type: 'string',
7757
- 'x-title': 'Workspace ID',
7758
7656
  },
7759
7657
  },
7760
7658
  required: [
@@ -7784,26 +7682,23 @@ export default {
7784
7682
  'x-title': 'Action Type',
7785
7683
  },
7786
7684
  created_at: {
7787
- description: 'The time when the event was created.',
7685
+ description: 'Time at which the event was created.',
7788
7686
  format: 'date-time',
7789
7687
  type: 'string',
7790
- 'x-title': 'Created At',
7791
7688
  },
7792
7689
  event_id: {
7793
- description: 'The ID of the event.',
7690
+ description: 'ID of the event.',
7794
7691
  format: 'uuid',
7795
7692
  type: 'string',
7796
- 'x-title': 'Event ID',
7797
7693
  },
7798
7694
  event_type: {
7799
7695
  enum: ['action_attempt.unlock_door.failed'],
7800
7696
  type: 'string',
7801
7697
  },
7802
7698
  occurred_at: {
7803
- description: 'The time when the event occurred.',
7699
+ description: 'Time when the event occurred.',
7804
7700
  format: 'date-time',
7805
7701
  type: 'string',
7806
- 'x-title': 'Occurred At',
7807
7702
  },
7808
7703
  status: {
7809
7704
  description: 'The status of the action.',
@@ -7811,10 +7706,10 @@ export default {
7811
7706
  'x-title': 'Status',
7812
7707
  },
7813
7708
  workspace_id: {
7814
- description: 'The ID of the workspace.',
7709
+ description:
7710
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7815
7711
  format: 'uuid',
7816
7712
  type: 'string',
7817
- 'x-title': 'Workspace ID',
7818
7713
  },
7819
7714
  },
7820
7715
  required: [
@@ -7845,32 +7740,29 @@ export default {
7845
7740
  'x-title': 'Connected Account ID',
7846
7741
  },
7847
7742
  created_at: {
7848
- description: 'The time when the event was created.',
7743
+ description: 'Time at which the event was created.',
7849
7744
  format: 'date-time',
7850
7745
  type: 'string',
7851
- 'x-title': 'Created At',
7852
7746
  },
7853
7747
  event_id: {
7854
- description: 'The ID of the event.',
7748
+ description: 'ID of the event.',
7855
7749
  format: 'uuid',
7856
7750
  type: 'string',
7857
- 'x-title': 'Event ID',
7858
7751
  },
7859
7752
  event_type: {
7860
7753
  enum: ['connect_webview.login_succeeded'],
7861
7754
  type: 'string',
7862
7755
  },
7863
7756
  occurred_at: {
7864
- description: 'The time when the event occurred.',
7757
+ description: 'Time when the event occurred.',
7865
7758
  format: 'date-time',
7866
7759
  type: 'string',
7867
- 'x-title': 'Occurred At',
7868
7760
  },
7869
7761
  workspace_id: {
7870
- description: 'The ID of the workspace.',
7762
+ description:
7763
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7871
7764
  format: 'uuid',
7872
7765
  type: 'string',
7873
- 'x-title': 'Workspace ID',
7874
7766
  },
7875
7767
  },
7876
7768
  required: [
@@ -7894,32 +7786,29 @@ export default {
7894
7786
  'x-title': 'Connect Webview ID',
7895
7787
  },
7896
7788
  created_at: {
7897
- description: 'The time when the event was created.',
7789
+ description: 'Time at which the event was created.',
7898
7790
  format: 'date-time',
7899
7791
  type: 'string',
7900
- 'x-title': 'Created At',
7901
7792
  },
7902
7793
  event_id: {
7903
- description: 'The ID of the event.',
7794
+ description: 'ID of the event.',
7904
7795
  format: 'uuid',
7905
7796
  type: 'string',
7906
- 'x-title': 'Event ID',
7907
7797
  },
7908
7798
  event_type: {
7909
7799
  enum: ['connect_webview.login_failed'],
7910
7800
  type: 'string',
7911
7801
  },
7912
7802
  occurred_at: {
7913
- description: 'The time when the event occurred.',
7803
+ description: 'Time when the event occurred.',
7914
7804
  format: 'date-time',
7915
7805
  type: 'string',
7916
- 'x-title': 'Occurred At',
7917
7806
  },
7918
7807
  workspace_id: {
7919
- description: 'The ID of the workspace.',
7808
+ description:
7809
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7920
7810
  format: 'uuid',
7921
7811
  type: 'string',
7922
- 'x-title': 'Workspace ID',
7923
7812
  },
7924
7813
  },
7925
7814
  required: [
@@ -7936,41 +7825,37 @@ export default {
7936
7825
  description: 'A new device was connected to Seam.',
7937
7826
  properties: {
7938
7827
  connected_account_id: {
7939
- description: 'ID of the connected account.',
7828
+ description:
7829
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7940
7830
  format: 'uuid',
7941
7831
  type: 'string',
7942
- 'x-title': 'Connected Account ID',
7943
7832
  },
7944
7833
  created_at: {
7945
- description: 'The time when the event was created.',
7834
+ description: 'Time at which the event was created.',
7946
7835
  format: 'date-time',
7947
7836
  type: 'string',
7948
- 'x-title': 'Created At',
7949
7837
  },
7950
7838
  device_id: {
7951
7839
  description: 'ID of the device.',
7952
7840
  format: 'uuid',
7953
7841
  type: 'string',
7954
- 'x-title': 'Device ID',
7955
7842
  },
7956
7843
  event_id: {
7957
- description: 'The ID of the event.',
7844
+ description: 'ID of the event.',
7958
7845
  format: 'uuid',
7959
7846
  type: 'string',
7960
- 'x-title': 'Event ID',
7961
7847
  },
7962
7848
  event_type: { enum: ['device.connected'], type: 'string' },
7963
7849
  occurred_at: {
7964
- description: 'The time when the event occurred.',
7850
+ description: 'Time when the event occurred.',
7965
7851
  format: 'date-time',
7966
7852
  type: 'string',
7967
- 'x-title': 'Occurred At',
7968
7853
  },
7969
7854
  workspace_id: {
7970
- description: 'The ID of the workspace.',
7855
+ description:
7856
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
7971
7857
  format: 'uuid',
7972
7858
  type: 'string',
7973
- 'x-title': 'Workspace ID',
7974
7859
  },
7975
7860
  },
7976
7861
  required: [
@@ -7985,44 +7870,40 @@ export default {
7985
7870
  type: 'object',
7986
7871
  },
7987
7872
  {
7988
- description: 'A device has been added or reconnected to Seam.',
7873
+ description: 'A device was added or reconnected to Seam.',
7989
7874
  properties: {
7990
7875
  connected_account_id: {
7991
- description: 'ID of the connected account.',
7876
+ description:
7877
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
7992
7878
  format: 'uuid',
7993
7879
  type: 'string',
7994
- 'x-title': 'Connected Account ID',
7995
7880
  },
7996
7881
  created_at: {
7997
- description: 'The time when the event was created.',
7882
+ description: 'Time at which the event was created.',
7998
7883
  format: 'date-time',
7999
7884
  type: 'string',
8000
- 'x-title': 'Created At',
8001
7885
  },
8002
7886
  device_id: {
8003
7887
  description: 'ID of the device.',
8004
7888
  format: 'uuid',
8005
7889
  type: 'string',
8006
- 'x-title': 'Device ID',
8007
7890
  },
8008
7891
  event_id: {
8009
- description: 'The ID of the event.',
7892
+ description: 'ID of the event.',
8010
7893
  format: 'uuid',
8011
7894
  type: 'string',
8012
- 'x-title': 'Event ID',
8013
7895
  },
8014
7896
  event_type: { enum: ['device.added'], type: 'string' },
8015
7897
  occurred_at: {
8016
- description: 'The time when the event occurred.',
7898
+ description: 'Time when the event occurred.',
8017
7899
  format: 'date-time',
8018
7900
  type: 'string',
8019
- 'x-title': 'Occurred At',
8020
7901
  },
8021
7902
  workspace_id: {
8022
- description: 'The ID of the workspace.',
7903
+ description:
7904
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8023
7905
  format: 'uuid',
8024
7906
  type: 'string',
8025
- 'x-title': 'Workspace ID',
8026
7907
  },
8027
7908
  },
8028
7909
  required: [
@@ -8038,47 +7919,43 @@ export default {
8038
7919
  },
8039
7920
  {
8040
7921
  description:
8041
- 'An unmanaged device was successfully converted to a managed device.',
7922
+ 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.',
8042
7923
  properties: {
8043
7924
  connected_account_id: {
8044
- description: 'ID of the connected account.',
7925
+ description:
7926
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8045
7927
  format: 'uuid',
8046
7928
  type: 'string',
8047
- 'x-title': 'Connected Account ID',
8048
7929
  },
8049
7930
  created_at: {
8050
- description: 'The time when the event was created.',
7931
+ description: 'Time at which the event was created.',
8051
7932
  format: 'date-time',
8052
7933
  type: 'string',
8053
- 'x-title': 'Created At',
8054
7934
  },
8055
7935
  device_id: {
8056
7936
  description: 'ID of the device.',
8057
7937
  format: 'uuid',
8058
7938
  type: 'string',
8059
- 'x-title': 'Device ID',
8060
7939
  },
8061
7940
  event_id: {
8062
- description: 'The ID of the event.',
7941
+ description: 'ID of the event.',
8063
7942
  format: 'uuid',
8064
7943
  type: 'string',
8065
- 'x-title': 'Event ID',
8066
7944
  },
8067
7945
  event_type: {
8068
7946
  enum: ['device.converted_to_unmanaged'],
8069
7947
  type: 'string',
8070
7948
  },
8071
7949
  occurred_at: {
8072
- description: 'The time when the event occurred.',
7950
+ description: 'Time when the event occurred.',
8073
7951
  format: 'date-time',
8074
7952
  type: 'string',
8075
- 'x-title': 'Occurred At',
8076
7953
  },
8077
7954
  workspace_id: {
8078
- description: 'The ID of the workspace.',
7955
+ description:
7956
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8079
7957
  format: 'uuid',
8080
7958
  type: 'string',
8081
- 'x-title': 'Workspace ID',
8082
7959
  },
8083
7960
  },
8084
7961
  required: [
@@ -8094,47 +7971,43 @@ export default {
8094
7971
  },
8095
7972
  {
8096
7973
  description:
8097
- 'A managed device was successfully converted to an unmanaged device.',
7974
+ 'A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
8098
7975
  properties: {
8099
7976
  connected_account_id: {
8100
- description: 'ID of the connected account.',
7977
+ description:
7978
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8101
7979
  format: 'uuid',
8102
7980
  type: 'string',
8103
- 'x-title': 'Connected Account ID',
8104
7981
  },
8105
7982
  created_at: {
8106
- description: 'The time when the event was created.',
7983
+ description: 'Time at which the event was created.',
8107
7984
  format: 'date-time',
8108
7985
  type: 'string',
8109
- 'x-title': 'Created At',
8110
7986
  },
8111
7987
  device_id: {
8112
7988
  description: 'ID of the device.',
8113
7989
  format: 'uuid',
8114
7990
  type: 'string',
8115
- 'x-title': 'Device ID',
8116
7991
  },
8117
7992
  event_id: {
8118
- description: 'The ID of the event.',
7993
+ description: 'ID of the event.',
8119
7994
  format: 'uuid',
8120
7995
  type: 'string',
8121
- 'x-title': 'Event ID',
8122
7996
  },
8123
7997
  event_type: {
8124
7998
  enum: ['device.unmanaged.converted_to_managed'],
8125
7999
  type: 'string',
8126
8000
  },
8127
8001
  occurred_at: {
8128
- description: 'The time when the event occurred.',
8002
+ description: 'Time when the event occurred.',
8129
8003
  format: 'date-time',
8130
8004
  type: 'string',
8131
- 'x-title': 'Occurred At',
8132
8005
  },
8133
8006
  workspace_id: {
8134
- description: 'The ID of the workspace.',
8007
+ description:
8008
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8135
8009
  format: 'uuid',
8136
8010
  type: 'string',
8137
- 'x-title': 'Workspace ID',
8138
8011
  },
8139
8012
  },
8140
8013
  required: [
@@ -8149,47 +8022,44 @@ export default {
8149
8022
  type: 'object',
8150
8023
  },
8151
8024
  {
8152
- description: 'An unmanaged device was connected to Seam',
8025
+ description:
8026
+ 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.',
8153
8027
  properties: {
8154
8028
  connected_account_id: {
8155
- description: 'ID of the connected account.',
8029
+ description:
8030
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8156
8031
  format: 'uuid',
8157
8032
  type: 'string',
8158
- 'x-title': 'Connected Account ID',
8159
8033
  },
8160
8034
  created_at: {
8161
- description: 'The time when the event was created.',
8035
+ description: 'Time at which the event was created.',
8162
8036
  format: 'date-time',
8163
8037
  type: 'string',
8164
- 'x-title': 'Created At',
8165
8038
  },
8166
8039
  device_id: {
8167
8040
  description: 'ID of the device.',
8168
8041
  format: 'uuid',
8169
8042
  type: 'string',
8170
- 'x-title': 'Device ID',
8171
8043
  },
8172
8044
  event_id: {
8173
- description: 'The ID of the event.',
8045
+ description: 'ID of the event.',
8174
8046
  format: 'uuid',
8175
8047
  type: 'string',
8176
- 'x-title': 'Event ID',
8177
8048
  },
8178
8049
  event_type: {
8179
8050
  enum: ['device.unmanaged.connected'],
8180
8051
  type: 'string',
8181
8052
  },
8182
8053
  occurred_at: {
8183
- description: 'The time when the event occurred.',
8054
+ description: 'Time when the event occurred.',
8184
8055
  format: 'date-time',
8185
8056
  type: 'string',
8186
- 'x-title': 'Occurred At',
8187
8057
  },
8188
8058
  workspace_id: {
8189
- description: 'The ID of the workspace.',
8059
+ description:
8060
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8190
8061
  format: 'uuid',
8191
8062
  type: 'string',
8192
- 'x-title': 'Workspace ID',
8193
8063
  },
8194
8064
  },
8195
8065
  required: [
@@ -8204,55 +8074,50 @@ export default {
8204
8074
  type: 'object',
8205
8075
  },
8206
8076
  {
8207
- description: 'A device was disconnected',
8077
+ description: 'A device was disconnected from Seam.',
8208
8078
  properties: {
8209
8079
  connected_account_id: {
8210
- description: 'ID of the connected account.',
8080
+ description:
8081
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8211
8082
  format: 'uuid',
8212
8083
  type: 'string',
8213
- 'x-title': 'Connected Account ID',
8214
8084
  },
8215
8085
  created_at: {
8216
- description: 'The time when the event was created.',
8086
+ description: 'Time at which the event was created.',
8217
8087
  format: 'date-time',
8218
8088
  type: 'string',
8219
- 'x-title': 'Created At',
8220
8089
  },
8221
8090
  device_id: {
8222
8091
  description: 'ID of the device.',
8223
8092
  format: 'uuid',
8224
8093
  type: 'string',
8225
- 'x-title': 'Device ID',
8226
8094
  },
8227
8095
  error_code: {
8228
8096
  description:
8229
- 'The error code associated with the event, if any.',
8097
+ 'Error code associated with the disconnection event, if any.',
8230
8098
  enum: [
8231
8099
  'account_disconnected',
8232
8100
  'hub_disconnected',
8233
8101
  'device_disconnected',
8234
8102
  ],
8235
8103
  type: 'string',
8236
- 'x-title': 'Event Error Code',
8237
8104
  },
8238
8105
  event_id: {
8239
- description: 'The ID of the event.',
8106
+ description: 'ID of the event.',
8240
8107
  format: 'uuid',
8241
8108
  type: 'string',
8242
- 'x-title': 'Event ID',
8243
8109
  },
8244
8110
  event_type: { enum: ['device.disconnected'], type: 'string' },
8245
8111
  occurred_at: {
8246
- description: 'The time when the event occurred.',
8112
+ description: 'Time when the event occurred.',
8247
8113
  format: 'date-time',
8248
8114
  type: 'string',
8249
- 'x-title': 'Occurred At',
8250
8115
  },
8251
8116
  workspace_id: {
8252
- description: 'The ID of the workspace.',
8117
+ description:
8118
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8253
8119
  format: 'uuid',
8254
8120
  type: 'string',
8255
- 'x-title': 'Workspace ID',
8256
8121
  },
8257
8122
  },
8258
8123
  required: [
@@ -8268,58 +8133,54 @@ export default {
8268
8133
  type: 'object',
8269
8134
  },
8270
8135
  {
8271
- description: 'An unmanaged device was disconnected',
8136
+ description:
8137
+ 'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.',
8272
8138
  properties: {
8273
8139
  connected_account_id: {
8274
- description: 'ID of the connected account.',
8140
+ description:
8141
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8275
8142
  format: 'uuid',
8276
8143
  type: 'string',
8277
- 'x-title': 'Connected Account ID',
8278
8144
  },
8279
8145
  created_at: {
8280
- description: 'The time when the event was created.',
8146
+ description: 'Time at which the event was created.',
8281
8147
  format: 'date-time',
8282
8148
  type: 'string',
8283
- 'x-title': 'Created At',
8284
8149
  },
8285
8150
  device_id: {
8286
8151
  description: 'ID of the device.',
8287
8152
  format: 'uuid',
8288
8153
  type: 'string',
8289
- 'x-title': 'Device ID',
8290
8154
  },
8291
8155
  error_code: {
8292
8156
  description:
8293
- 'The error code associated with the event, if any.',
8157
+ 'Error code associated with the disconnection event, if any.',
8294
8158
  enum: [
8295
8159
  'account_disconnected',
8296
8160
  'hub_disconnected',
8297
8161
  'device_disconnected',
8298
8162
  ],
8299
8163
  type: 'string',
8300
- 'x-title': 'Event Error Code',
8301
8164
  },
8302
8165
  event_id: {
8303
- description: 'The ID of the event.',
8166
+ description: 'ID of the event.',
8304
8167
  format: 'uuid',
8305
8168
  type: 'string',
8306
- 'x-title': 'Event ID',
8307
8169
  },
8308
8170
  event_type: {
8309
8171
  enum: ['device.unmanaged.disconnected'],
8310
8172
  type: 'string',
8311
8173
  },
8312
8174
  occurred_at: {
8313
- description: 'The time when the event occurred.',
8175
+ description: 'Time when the event occurred.',
8314
8176
  format: 'date-time',
8315
8177
  type: 'string',
8316
- 'x-title': 'Occurred At',
8317
8178
  },
8318
8179
  workspace_id: {
8319
- description: 'The ID of the workspace.',
8180
+ description:
8181
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8320
8182
  format: 'uuid',
8321
8183
  type: 'string',
8322
- 'x-title': 'Workspace ID',
8323
8184
  },
8324
8185
  },
8325
8186
  required: [
@@ -8336,44 +8197,40 @@ export default {
8336
8197
  },
8337
8198
  {
8338
8199
  description:
8339
- 'A device detected that it was tampered with, e.g., opened or moved.',
8200
+ 'A device detected that it was tampered with, for example, opened or moved.',
8340
8201
  properties: {
8341
8202
  connected_account_id: {
8342
- description: 'ID of the connected account.',
8203
+ description:
8204
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8343
8205
  format: 'uuid',
8344
8206
  type: 'string',
8345
- 'x-title': 'Connected Account ID',
8346
8207
  },
8347
8208
  created_at: {
8348
- description: 'The time when the event was created.',
8209
+ description: 'Time at which the event was created.',
8349
8210
  format: 'date-time',
8350
8211
  type: 'string',
8351
- 'x-title': 'Created At',
8352
8212
  },
8353
8213
  device_id: {
8354
8214
  description: 'ID of the device.',
8355
8215
  format: 'uuid',
8356
8216
  type: 'string',
8357
- 'x-title': 'Device ID',
8358
8217
  },
8359
8218
  event_id: {
8360
- description: 'The ID of the event.',
8219
+ description: 'ID of the event.',
8361
8220
  format: 'uuid',
8362
8221
  type: 'string',
8363
- 'x-title': 'Event ID',
8364
8222
  },
8365
8223
  event_type: { enum: ['device.tampered'], type: 'string' },
8366
8224
  occurred_at: {
8367
- description: 'The time when the event occurred.',
8225
+ description: 'Time when the event occurred.',
8368
8226
  format: 'date-time',
8369
8227
  type: 'string',
8370
- 'x-title': 'Occurred At',
8371
8228
  },
8372
8229
  workspace_id: {
8373
- description: 'The ID of the workspace.',
8230
+ description:
8231
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8374
8232
  format: 'uuid',
8375
8233
  type: 'string',
8376
- 'x-title': 'Workspace ID',
8377
8234
  },
8378
8235
  },
8379
8236
  required: [
@@ -8393,49 +8250,44 @@ export default {
8393
8250
  properties: {
8394
8251
  battery_level: {
8395
8252
  description:
8396
- 'Fractional number 0 to 1.0 indicating amount of battery in device, as reported by device.',
8253
+ 'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.',
8397
8254
  format: 'float',
8398
8255
  maximum: 1,
8399
8256
  minimum: 0,
8400
8257
  type: 'number',
8401
- 'x-title': 'Battery Level',
8402
8258
  },
8403
8259
  connected_account_id: {
8404
- description: 'ID of the connected account.',
8260
+ description:
8261
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8405
8262
  format: 'uuid',
8406
8263
  type: 'string',
8407
- 'x-title': 'Connected Account ID',
8408
8264
  },
8409
8265
  created_at: {
8410
- description: 'The time when the event was created.',
8266
+ description: 'Time at which the event was created.',
8411
8267
  format: 'date-time',
8412
8268
  type: 'string',
8413
- 'x-title': 'Created At',
8414
8269
  },
8415
8270
  device_id: {
8416
8271
  description: 'ID of the device.',
8417
8272
  format: 'uuid',
8418
8273
  type: 'string',
8419
- 'x-title': 'Device ID',
8420
8274
  },
8421
8275
  event_id: {
8422
- description: 'The ID of the event.',
8276
+ description: 'ID of the event.',
8423
8277
  format: 'uuid',
8424
8278
  type: 'string',
8425
- 'x-title': 'Event ID',
8426
8279
  },
8427
8280
  event_type: { enum: ['device.low_battery'], type: 'string' },
8428
8281
  occurred_at: {
8429
- description: 'The time when the event occurred.',
8282
+ description: 'Time when the event occurred.',
8430
8283
  format: 'date-time',
8431
8284
  type: 'string',
8432
- 'x-title': 'Occurred At',
8433
8285
  },
8434
8286
  workspace_id: {
8435
- description: 'The ID of the workspace.',
8287
+ description:
8288
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8436
8289
  format: 'uuid',
8437
8290
  type: 'string',
8438
- 'x-title': 'Workspace ID',
8439
8291
  },
8440
8292
  },
8441
8293
  required: [
@@ -8452,63 +8304,57 @@ export default {
8452
8304
  },
8453
8305
  {
8454
8306
  description:
8455
- 'A device battery status changed since the last battery status changed event.',
8307
+ 'A device battery status changed since the last `battery_status_changed` event.',
8456
8308
  properties: {
8457
8309
  battery_level: {
8458
8310
  description:
8459
- 'Fractional number 0 to 1.0 indicating amount of battery in device, as reported by device.',
8311
+ 'Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.',
8460
8312
  format: 'float',
8461
8313
  maximum: 1,
8462
8314
  minimum: 0,
8463
8315
  type: 'number',
8464
- 'x-title': 'Battery Level',
8465
8316
  },
8466
8317
  battery_status: {
8467
8318
  description:
8468
- "Enum representing the battery status calculated from numeric battery_level value, one of 'critical' | 'low' | 'good' | 'full'",
8319
+ 'Battery status of the device, calculated from the numeric `battery_level` value.',
8469
8320
  enum: ['critical', 'low', 'good', 'full'],
8470
8321
  type: 'string',
8471
- 'x-title': 'Battery Status',
8472
8322
  },
8473
8323
  connected_account_id: {
8474
- description: 'ID of the connected account.',
8324
+ description:
8325
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8475
8326
  format: 'uuid',
8476
8327
  type: 'string',
8477
- 'x-title': 'Connected Account ID',
8478
8328
  },
8479
8329
  created_at: {
8480
- description: 'The time when the event was created.',
8330
+ description: 'Time at which the event was created.',
8481
8331
  format: 'date-time',
8482
8332
  type: 'string',
8483
- 'x-title': 'Created At',
8484
8333
  },
8485
8334
  device_id: {
8486
8335
  description: 'ID of the device.',
8487
8336
  format: 'uuid',
8488
8337
  type: 'string',
8489
- 'x-title': 'Device ID',
8490
8338
  },
8491
8339
  event_id: {
8492
- description: 'The ID of the event.',
8340
+ description: 'ID of the event.',
8493
8341
  format: 'uuid',
8494
8342
  type: 'string',
8495
- 'x-title': 'Event ID',
8496
8343
  },
8497
8344
  event_type: {
8498
8345
  enum: ['device.battery_status_changed'],
8499
8346
  type: 'string',
8500
8347
  },
8501
8348
  occurred_at: {
8502
- description: 'The time when the event occurred.',
8349
+ description: 'Time when the event occurred.',
8503
8350
  format: 'date-time',
8504
8351
  type: 'string',
8505
- 'x-title': 'Occurred At',
8506
8352
  },
8507
8353
  workspace_id: {
8508
- description: 'The ID of the workspace.',
8354
+ description:
8355
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8509
8356
  format: 'uuid',
8510
8357
  type: 'string',
8511
- 'x-title': 'Workspace ID',
8512
8358
  },
8513
8359
  },
8514
8360
  required: [
@@ -8526,44 +8372,40 @@ export default {
8526
8372
  },
8527
8373
  {
8528
8374
  description:
8529
- 'A device was removed externally from the connected account.',
8375
+ 'A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8530
8376
  properties: {
8531
8377
  connected_account_id: {
8532
- description: 'ID of the connected account.',
8378
+ description:
8379
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8533
8380
  format: 'uuid',
8534
8381
  type: 'string',
8535
- 'x-title': 'Connected Account ID',
8536
8382
  },
8537
8383
  created_at: {
8538
- description: 'The time when the event was created.',
8384
+ description: 'Time at which the event was created.',
8539
8385
  format: 'date-time',
8540
8386
  type: 'string',
8541
- 'x-title': 'Created At',
8542
8387
  },
8543
8388
  device_id: {
8544
8389
  description: 'ID of the device.',
8545
8390
  format: 'uuid',
8546
8391
  type: 'string',
8547
- 'x-title': 'Device ID',
8548
8392
  },
8549
8393
  event_id: {
8550
- description: 'The ID of the event.',
8394
+ description: 'ID of the event.',
8551
8395
  format: 'uuid',
8552
8396
  type: 'string',
8553
- 'x-title': 'Event ID',
8554
8397
  },
8555
8398
  event_type: { enum: ['device.removed'], type: 'string' },
8556
8399
  occurred_at: {
8557
- description: 'The time when the event occurred.',
8400
+ description: 'Time when the event occurred.',
8558
8401
  format: 'date-time',
8559
8402
  type: 'string',
8560
- 'x-title': 'Occurred At',
8561
8403
  },
8562
8404
  workspace_id: {
8563
- description: 'The ID of the workspace.',
8405
+ description:
8406
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8564
8407
  format: 'uuid',
8565
8408
  type: 'string',
8566
- 'x-title': 'Workspace ID',
8567
8409
  },
8568
8410
  },
8569
8411
  required: [
@@ -8578,44 +8420,41 @@ export default {
8578
8420
  type: 'object',
8579
8421
  },
8580
8422
  {
8581
- description: 'A device was deleted.',
8423
+ description:
8424
+ 'A device was [deleted](https://docs.seam.co/latest/api/devices/delete).',
8582
8425
  properties: {
8583
8426
  connected_account_id: {
8584
- description: 'ID of the connected account.',
8427
+ description:
8428
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8585
8429
  format: 'uuid',
8586
8430
  type: 'string',
8587
- 'x-title': 'Connected Account ID',
8588
8431
  },
8589
8432
  created_at: {
8590
- description: 'The time when the event was created.',
8433
+ description: 'Time at which the event was created.',
8591
8434
  format: 'date-time',
8592
8435
  type: 'string',
8593
- 'x-title': 'Created At',
8594
8436
  },
8595
8437
  device_id: {
8596
8438
  description: 'ID of the device.',
8597
8439
  format: 'uuid',
8598
8440
  type: 'string',
8599
- 'x-title': 'Device ID',
8600
8441
  },
8601
8442
  event_id: {
8602
- description: 'The ID of the event.',
8443
+ description: 'ID of the event.',
8603
8444
  format: 'uuid',
8604
8445
  type: 'string',
8605
- 'x-title': 'Event ID',
8606
8446
  },
8607
8447
  event_type: { enum: ['device.deleted'], type: 'string' },
8608
8448
  occurred_at: {
8609
- description: 'The time when the event occurred.',
8449
+ description: 'Time when the event occurred.',
8610
8450
  format: 'date-time',
8611
8451
  type: 'string',
8612
- 'x-title': 'Occurred At',
8613
8452
  },
8614
8453
  workspace_id: {
8615
- description: 'The ID of the workspace.',
8454
+ description:
8455
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8616
8456
  format: 'uuid',
8617
8457
  type: 'string',
8618
- 'x-title': 'Workspace ID',
8619
8458
  },
8620
8459
  },
8621
8460
  required: [
@@ -8631,47 +8470,43 @@ export default {
8631
8470
  },
8632
8471
  {
8633
8472
  description:
8634
- 'Seam detected a device is using a third party integration that will interfere with Seam device management.',
8473
+ 'Seam detected that a device is using a third-party integration that will interfere with Seam device management.',
8635
8474
  properties: {
8636
8475
  connected_account_id: {
8637
- description: 'ID of the connected account.',
8476
+ description:
8477
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8638
8478
  format: 'uuid',
8639
8479
  type: 'string',
8640
- 'x-title': 'Connected Account ID',
8641
8480
  },
8642
8481
  created_at: {
8643
- description: 'The time when the event was created.',
8482
+ description: 'Time at which the event was created.',
8644
8483
  format: 'date-time',
8645
8484
  type: 'string',
8646
- 'x-title': 'Created At',
8647
8485
  },
8648
8486
  device_id: {
8649
8487
  description: 'ID of the device.',
8650
8488
  format: 'uuid',
8651
8489
  type: 'string',
8652
- 'x-title': 'Device ID',
8653
8490
  },
8654
8491
  event_id: {
8655
- description: 'The ID of the event.',
8492
+ description: 'ID of the event.',
8656
8493
  format: 'uuid',
8657
8494
  type: 'string',
8658
- 'x-title': 'Event ID',
8659
8495
  },
8660
8496
  event_type: {
8661
8497
  enum: ['device.third_party_integration_detected'],
8662
8498
  type: 'string',
8663
8499
  },
8664
8500
  occurred_at: {
8665
- description: 'The time when the event occurred.',
8501
+ description: 'Time when the event occurred.',
8666
8502
  format: 'date-time',
8667
8503
  type: 'string',
8668
- 'x-title': 'Occurred At',
8669
8504
  },
8670
8505
  workspace_id: {
8671
- description: 'The ID of the workspace.',
8506
+ description:
8507
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8672
8508
  format: 'uuid',
8673
8509
  type: 'string',
8674
- 'x-title': 'Workspace ID',
8675
8510
  },
8676
8511
  },
8677
8512
  required: [
@@ -8687,47 +8522,43 @@ export default {
8687
8522
  },
8688
8523
  {
8689
8524
  description:
8690
- 'Seam detected a device is no longer using a third party integration that was interfering with Seam device management.',
8525
+ 'Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.',
8691
8526
  properties: {
8692
8527
  connected_account_id: {
8693
- description: 'ID of the connected account.',
8528
+ description:
8529
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8694
8530
  format: 'uuid',
8695
8531
  type: 'string',
8696
- 'x-title': 'Connected Account ID',
8697
8532
  },
8698
8533
  created_at: {
8699
- description: 'The time when the event was created.',
8534
+ description: 'Time at which the event was created.',
8700
8535
  format: 'date-time',
8701
8536
  type: 'string',
8702
- 'x-title': 'Created At',
8703
8537
  },
8704
8538
  device_id: {
8705
8539
  description: 'ID of the device.',
8706
8540
  format: 'uuid',
8707
8541
  type: 'string',
8708
- 'x-title': 'Device ID',
8709
8542
  },
8710
8543
  event_id: {
8711
- description: 'The ID of the event.',
8544
+ description: 'ID of the event.',
8712
8545
  format: 'uuid',
8713
8546
  type: 'string',
8714
- 'x-title': 'Event ID',
8715
8547
  },
8716
8548
  event_type: {
8717
8549
  enum: ['device.third_party_integration_no_longer_detected'],
8718
8550
  type: 'string',
8719
8551
  },
8720
8552
  occurred_at: {
8721
- description: 'The time when the event occurred.',
8553
+ description: 'Time when the event occurred.',
8722
8554
  format: 'date-time',
8723
8555
  type: 'string',
8724
- 'x-title': 'Occurred At',
8725
8556
  },
8726
8557
  workspace_id: {
8727
- description: 'The ID of the workspace.',
8558
+ description:
8559
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8728
8560
  format: 'uuid',
8729
8561
  type: 'string',
8730
- 'x-title': 'Workspace ID',
8731
8562
  },
8732
8563
  },
8733
8564
  required: [
@@ -8745,44 +8576,40 @@ export default {
8745
8576
  description: 'A Salto device activated privacy mode.',
8746
8577
  properties: {
8747
8578
  connected_account_id: {
8748
- description: 'ID of the connected account.',
8579
+ description:
8580
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8749
8581
  format: 'uuid',
8750
8582
  type: 'string',
8751
- 'x-title': 'Connected Account ID',
8752
8583
  },
8753
8584
  created_at: {
8754
- description: 'The time when the event was created.',
8585
+ description: 'Time at which the event was created.',
8755
8586
  format: 'date-time',
8756
8587
  type: 'string',
8757
- 'x-title': 'Created At',
8758
8588
  },
8759
8589
  device_id: {
8760
8590
  description: 'ID of the device.',
8761
8591
  format: 'uuid',
8762
8592
  type: 'string',
8763
- 'x-title': 'Device ID',
8764
8593
  },
8765
8594
  event_id: {
8766
- description: 'The ID of the event.',
8595
+ description: 'ID of the event.',
8767
8596
  format: 'uuid',
8768
8597
  type: 'string',
8769
- 'x-title': 'Event ID',
8770
8598
  },
8771
8599
  event_type: {
8772
8600
  enum: ['device.salto.privacy_mode_activated'],
8773
8601
  type: 'string',
8774
8602
  },
8775
8603
  occurred_at: {
8776
- description: 'The time when the event occurred.',
8604
+ description: 'Time when the event occurred.',
8777
8605
  format: 'date-time',
8778
8606
  type: 'string',
8779
- 'x-title': 'Occurred At',
8780
8607
  },
8781
8608
  workspace_id: {
8782
- description: 'The ID of the workspace.',
8609
+ description:
8610
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8783
8611
  format: 'uuid',
8784
8612
  type: 'string',
8785
- 'x-title': 'Workspace ID',
8786
8613
  },
8787
8614
  },
8788
8615
  required: [
@@ -8800,44 +8627,40 @@ export default {
8800
8627
  description: 'A Salto device deactivated privacy mode.',
8801
8628
  properties: {
8802
8629
  connected_account_id: {
8803
- description: 'ID of the connected account.',
8630
+ description:
8631
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8804
8632
  format: 'uuid',
8805
8633
  type: 'string',
8806
- 'x-title': 'Connected Account ID',
8807
8634
  },
8808
8635
  created_at: {
8809
- description: 'The time when the event was created.',
8636
+ description: 'Time at which the event was created.',
8810
8637
  format: 'date-time',
8811
8638
  type: 'string',
8812
- 'x-title': 'Created At',
8813
8639
  },
8814
8640
  device_id: {
8815
8641
  description: 'ID of the device.',
8816
8642
  format: 'uuid',
8817
8643
  type: 'string',
8818
- 'x-title': 'Device ID',
8819
8644
  },
8820
8645
  event_id: {
8821
- description: 'The ID of the event.',
8646
+ description: 'ID of the event.',
8822
8647
  format: 'uuid',
8823
8648
  type: 'string',
8824
- 'x-title': 'Event ID',
8825
8649
  },
8826
8650
  event_type: {
8827
8651
  enum: ['device.salto.privacy_mode_deactivated'],
8828
8652
  type: 'string',
8829
8653
  },
8830
8654
  occurred_at: {
8831
- description: 'The time when the event occurred.',
8655
+ description: 'Time when the event occurred.',
8832
8656
  format: 'date-time',
8833
8657
  type: 'string',
8834
- 'x-title': 'Occurred At',
8835
8658
  },
8836
8659
  workspace_id: {
8837
- description: 'The ID of the workspace.',
8660
+ description:
8661
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8838
8662
  format: 'uuid',
8839
8663
  type: 'string',
8840
- 'x-title': 'Workspace ID',
8841
8664
  },
8842
8665
  },
8843
8666
  required: [
@@ -8855,44 +8678,40 @@ export default {
8855
8678
  description: 'Seam detected a flaky device connection.',
8856
8679
  properties: {
8857
8680
  connected_account_id: {
8858
- description: 'ID of the connected account.',
8681
+ description:
8682
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8859
8683
  format: 'uuid',
8860
8684
  type: 'string',
8861
- 'x-title': 'Connected Account ID',
8862
8685
  },
8863
8686
  created_at: {
8864
- description: 'The time when the event was created.',
8687
+ description: 'Time at which the event was created.',
8865
8688
  format: 'date-time',
8866
8689
  type: 'string',
8867
- 'x-title': 'Created At',
8868
8690
  },
8869
8691
  device_id: {
8870
8692
  description: 'ID of the device.',
8871
8693
  format: 'uuid',
8872
8694
  type: 'string',
8873
- 'x-title': 'Device ID',
8874
8695
  },
8875
8696
  event_id: {
8876
- description: 'The ID of the event.',
8697
+ description: 'ID of the event.',
8877
8698
  format: 'uuid',
8878
8699
  type: 'string',
8879
- 'x-title': 'Event ID',
8880
8700
  },
8881
8701
  event_type: {
8882
8702
  enum: ['device.connection_became_flaky'],
8883
8703
  type: 'string',
8884
8704
  },
8885
8705
  occurred_at: {
8886
- description: 'The time when the event occurred.',
8706
+ description: 'Time when the event occurred.',
8887
8707
  format: 'date-time',
8888
8708
  type: 'string',
8889
- 'x-title': 'Occurred At',
8890
8709
  },
8891
8710
  workspace_id: {
8892
- description: 'The ID of the workspace.',
8711
+ description:
8712
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8893
8713
  format: 'uuid',
8894
8714
  type: 'string',
8895
- 'x-title': 'Workspace ID',
8896
8715
  },
8897
8716
  },
8898
8717
  required: [
@@ -8908,47 +8727,43 @@ export default {
8908
8727
  },
8909
8728
  {
8910
8729
  description:
8911
- 'Seam detected a previously flaky device connection stabilized.',
8730
+ 'Seam detected that a previously-flaky device connection stabilized.',
8912
8731
  properties: {
8913
8732
  connected_account_id: {
8914
- description: 'ID of the connected account.',
8733
+ description:
8734
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8915
8735
  format: 'uuid',
8916
8736
  type: 'string',
8917
- 'x-title': 'Connected Account ID',
8918
8737
  },
8919
8738
  created_at: {
8920
- description: 'The time when the event was created.',
8739
+ description: 'Time at which the event was created.',
8921
8740
  format: 'date-time',
8922
8741
  type: 'string',
8923
- 'x-title': 'Created At',
8924
8742
  },
8925
8743
  device_id: {
8926
8744
  description: 'ID of the device.',
8927
8745
  format: 'uuid',
8928
8746
  type: 'string',
8929
- 'x-title': 'Device ID',
8930
8747
  },
8931
8748
  event_id: {
8932
- description: 'The ID of the event.',
8749
+ description: 'ID of the event.',
8933
8750
  format: 'uuid',
8934
8751
  type: 'string',
8935
- 'x-title': 'Event ID',
8936
8752
  },
8937
8753
  event_type: {
8938
8754
  enum: ['device.connection_stabilized'],
8939
8755
  type: 'string',
8940
8756
  },
8941
8757
  occurred_at: {
8942
- description: 'The time when the event occurred.',
8758
+ description: 'Time when the event occurred.',
8943
8759
  format: 'date-time',
8944
8760
  type: 'string',
8945
- 'x-title': 'Occurred At',
8946
8761
  },
8947
8762
  workspace_id: {
8948
- description: 'The ID of the workspace.',
8763
+ description:
8764
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
8949
8765
  format: 'uuid',
8950
8766
  type: 'string',
8951
- 'x-title': 'Workspace ID',
8952
8767
  },
8953
8768
  },
8954
8769
  required: [
@@ -8964,47 +8779,43 @@ export default {
8964
8779
  },
8965
8780
  {
8966
8781
  description:
8967
- 'A third party subscription is required to use all device features.',
8782
+ 'A third-party subscription is required to use all device features.',
8968
8783
  properties: {
8969
8784
  connected_account_id: {
8970
- description: 'ID of the connected account.',
8785
+ description:
8786
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
8971
8787
  format: 'uuid',
8972
8788
  type: 'string',
8973
- 'x-title': 'Connected Account ID',
8974
8789
  },
8975
8790
  created_at: {
8976
- description: 'The time when the event was created.',
8791
+ description: 'Time at which the event was created.',
8977
8792
  format: 'date-time',
8978
8793
  type: 'string',
8979
- 'x-title': 'Created At',
8980
8794
  },
8981
8795
  device_id: {
8982
8796
  description: 'ID of the device.',
8983
8797
  format: 'uuid',
8984
8798
  type: 'string',
8985
- 'x-title': 'Device ID',
8986
8799
  },
8987
8800
  event_id: {
8988
- description: 'The ID of the event.',
8801
+ description: 'ID of the event.',
8989
8802
  format: 'uuid',
8990
8803
  type: 'string',
8991
- 'x-title': 'Event ID',
8992
8804
  },
8993
8805
  event_type: {
8994
8806
  enum: ['device.error.subscription_required'],
8995
8807
  type: 'string',
8996
8808
  },
8997
8809
  occurred_at: {
8998
- description: 'The time when the event occurred.',
8810
+ description: 'Time when the event occurred.',
8999
8811
  format: 'date-time',
9000
8812
  type: 'string',
9001
- 'x-title': 'Occurred At',
9002
8813
  },
9003
8814
  workspace_id: {
9004
- description: 'The ID of the workspace.',
8815
+ description:
8816
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9005
8817
  format: 'uuid',
9006
8818
  type: 'string',
9007
- 'x-title': 'Workspace ID',
9008
8819
  },
9009
8820
  },
9010
8821
  required: [
@@ -9020,47 +8831,43 @@ export default {
9020
8831
  },
9021
8832
  {
9022
8833
  description:
9023
- 'A third party subscription is active or no longer-required to use all device features.',
8834
+ 'A third-party subscription is active or no longer required to use all device features.',
9024
8835
  properties: {
9025
8836
  connected_account_id: {
9026
- description: 'ID of the connected account.',
8837
+ description:
8838
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9027
8839
  format: 'uuid',
9028
8840
  type: 'string',
9029
- 'x-title': 'Connected Account ID',
9030
8841
  },
9031
8842
  created_at: {
9032
- description: 'The time when the event was created.',
8843
+ description: 'Time at which the event was created.',
9033
8844
  format: 'date-time',
9034
8845
  type: 'string',
9035
- 'x-title': 'Created At',
9036
8846
  },
9037
8847
  device_id: {
9038
8848
  description: 'ID of the device.',
9039
8849
  format: 'uuid',
9040
8850
  type: 'string',
9041
- 'x-title': 'Device ID',
9042
8851
  },
9043
8852
  event_id: {
9044
- description: 'The ID of the event.',
8853
+ description: 'ID of the event.',
9045
8854
  format: 'uuid',
9046
8855
  type: 'string',
9047
- 'x-title': 'Event ID',
9048
8856
  },
9049
8857
  event_type: {
9050
8858
  enum: ['device.error.subscription_required.resolved'],
9051
8859
  type: 'string',
9052
8860
  },
9053
8861
  occurred_at: {
9054
- description: 'The time when the event occurred.',
8862
+ description: 'Time when the event occurred.',
9055
8863
  format: 'date-time',
9056
8864
  type: 'string',
9057
- 'x-title': 'Occurred At',
9058
8865
  },
9059
8866
  workspace_id: {
9060
- description: 'The ID of the workspace.',
8867
+ description:
8868
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9061
8869
  format: 'uuid',
9062
8870
  type: 'string',
9063
- 'x-title': 'Workspace ID',
9064
8871
  },
9065
8872
  },
9066
8873
  required: [
@@ -9075,47 +8882,43 @@ export default {
9075
8882
  type: 'object',
9076
8883
  },
9077
8884
  {
9078
- description: 'A accessory keypad was connected to a device.',
8885
+ description: 'An accessory keypad was connected to a device.',
9079
8886
  properties: {
9080
8887
  connected_account_id: {
9081
- description: 'ID of the connected account.',
8888
+ description:
8889
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9082
8890
  format: 'uuid',
9083
8891
  type: 'string',
9084
- 'x-title': 'Connected Account ID',
9085
8892
  },
9086
8893
  created_at: {
9087
- description: 'The time when the event was created.',
8894
+ description: 'Time at which the event was created.',
9088
8895
  format: 'date-time',
9089
8896
  type: 'string',
9090
- 'x-title': 'Created At',
9091
8897
  },
9092
8898
  device_id: {
9093
8899
  description: 'ID of the device.',
9094
8900
  format: 'uuid',
9095
8901
  type: 'string',
9096
- 'x-title': 'Device ID',
9097
8902
  },
9098
8903
  event_id: {
9099
- description: 'The ID of the event.',
8904
+ description: 'ID of the event.',
9100
8905
  format: 'uuid',
9101
8906
  type: 'string',
9102
- 'x-title': 'Event ID',
9103
8907
  },
9104
8908
  event_type: {
9105
8909
  enum: ['device.accessory_keypad_connected'],
9106
8910
  type: 'string',
9107
8911
  },
9108
8912
  occurred_at: {
9109
- description: 'The time when the event occurred.',
8913
+ description: 'Time when the event occurred.',
9110
8914
  format: 'date-time',
9111
8915
  type: 'string',
9112
- 'x-title': 'Occurred At',
9113
8916
  },
9114
8917
  workspace_id: {
9115
- description: 'The ID of the workspace.',
8918
+ description:
8919
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9116
8920
  format: 'uuid',
9117
8921
  type: 'string',
9118
- 'x-title': 'Workspace ID',
9119
8922
  },
9120
8923
  },
9121
8924
  required: [
@@ -9130,47 +8933,43 @@ export default {
9130
8933
  type: 'object',
9131
8934
  },
9132
8935
  {
9133
- description: 'A accessory keypad was disconnected to a device.',
8936
+ description: 'An accessory keypad was disconnected from a device.',
9134
8937
  properties: {
9135
8938
  connected_account_id: {
9136
- description: 'ID of the connected account.',
8939
+ description:
8940
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9137
8941
  format: 'uuid',
9138
8942
  type: 'string',
9139
- 'x-title': 'Connected Account ID',
9140
8943
  },
9141
8944
  created_at: {
9142
- description: 'The time when the event was created.',
8945
+ description: 'Time at which the event was created.',
9143
8946
  format: 'date-time',
9144
8947
  type: 'string',
9145
- 'x-title': 'Created At',
9146
8948
  },
9147
8949
  device_id: {
9148
8950
  description: 'ID of the device.',
9149
8951
  format: 'uuid',
9150
8952
  type: 'string',
9151
- 'x-title': 'Device ID',
9152
8953
  },
9153
8954
  event_id: {
9154
- description: 'The ID of the event.',
8955
+ description: 'ID of the event.',
9155
8956
  format: 'uuid',
9156
8957
  type: 'string',
9157
- 'x-title': 'Event ID',
9158
8958
  },
9159
8959
  event_type: {
9160
8960
  enum: ['device.accessory_keypad_disconnected'],
9161
8961
  type: 'string',
9162
8962
  },
9163
8963
  occurred_at: {
9164
- description: 'The time when the event occurred.',
8964
+ description: 'Time when the event occurred.',
9165
8965
  format: 'date-time',
9166
8966
  type: 'string',
9167
- 'x-title': 'Occurred At',
9168
8967
  },
9169
8968
  workspace_id: {
9170
- description: 'The ID of the workspace.',
8969
+ description:
8970
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9171
8971
  format: 'uuid',
9172
8972
  type: 'string',
9173
- 'x-title': 'Workspace ID',
9174
8973
  },
9175
8974
  },
9176
8975
  required: [
@@ -9186,31 +8985,28 @@ export default {
9186
8985
  },
9187
8986
  {
9188
8987
  description:
9189
- 'Extended periods of noise or noise exceeding a threshold was detected.',
8988
+ 'Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.',
9190
8989
  properties: {
9191
8990
  connected_account_id: {
9192
- description: 'ID of the connected account.',
8991
+ description:
8992
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9193
8993
  format: 'uuid',
9194
8994
  type: 'string',
9195
- 'x-title': 'Connected Account ID',
9196
8995
  },
9197
8996
  created_at: {
9198
- description: 'The time when the event was created.',
8997
+ description: 'Time at which the event was created.',
9199
8998
  format: 'date-time',
9200
8999
  type: 'string',
9201
- 'x-title': 'Created At',
9202
9000
  },
9203
9001
  device_id: {
9204
9002
  description: 'ID of the device.',
9205
9003
  format: 'uuid',
9206
9004
  type: 'string',
9207
- 'x-title': 'Device ID',
9208
9005
  },
9209
9006
  event_id: {
9210
- description: 'The ID of the event.',
9007
+ description: 'ID of the event.',
9211
9008
  format: 'uuid',
9212
9009
  type: 'string',
9213
- 'x-title': 'Event ID',
9214
9010
  },
9215
9011
  event_type: {
9216
9012
  enum: ['noise_sensor.noise_threshold_triggered'],
@@ -9218,31 +9014,48 @@ export default {
9218
9014
  },
9219
9015
  minut_metadata: {
9220
9016
  additionalProperties: {},
9221
- description: 'Metadata from the Minut API.',
9017
+ description: 'Metadata from Minut.',
9222
9018
  type: 'object',
9223
9019
  'x-title': 'Minut Metadata',
9224
9020
  },
9225
- noise_level_decibels: { format: 'float', type: 'number' },
9226
- noise_level_nrs: { format: 'float', type: 'number' },
9227
- noise_threshold_id: { format: 'uuid', type: 'string' },
9228
- noise_threshold_name: { type: 'string' },
9021
+ noise_level_decibels: {
9022
+ description: 'Detected noise level in decibels.',
9023
+ format: 'float',
9024
+ type: 'number',
9025
+ },
9026
+ noise_level_nrs: {
9027
+ description:
9028
+ 'Detected noise level in Noiseaware Noise Risk Score (NRS).',
9029
+ format: 'float',
9030
+ type: 'number',
9031
+ },
9032
+ noise_threshold_id: {
9033
+ description:
9034
+ 'ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.',
9035
+ format: 'uuid',
9036
+ type: 'string',
9037
+ },
9038
+ noise_threshold_name: {
9039
+ description:
9040
+ 'Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.',
9041
+ type: 'string',
9042
+ },
9229
9043
  noiseaware_metadata: {
9230
9044
  additionalProperties: {},
9231
- description: 'Metadata from the Noiseaware API.',
9045
+ description: 'Metadata from Noiseaware.',
9232
9046
  type: 'object',
9233
9047
  'x-title': 'Noiseaware Metadata',
9234
9048
  },
9235
9049
  occurred_at: {
9236
- description: 'The time when the event occurred.',
9050
+ description: 'Time when the event occurred.',
9237
9051
  format: 'date-time',
9238
9052
  type: 'string',
9239
- 'x-title': 'Occurred At',
9240
9053
  },
9241
9054
  workspace_id: {
9242
- description: 'The ID of the workspace.',
9055
+ description:
9056
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9243
9057
  format: 'uuid',
9244
9058
  type: 'string',
9245
- 'x-title': 'Workspace ID',
9246
9059
  },
9247
9060
  },
9248
9061
  required: [
@@ -9259,51 +9072,56 @@ export default {
9259
9072
  {
9260
9073
  description: 'A lock was locked.',
9261
9074
  properties: {
9262
- access_code_id: { format: 'uuid', type: 'string' },
9263
- action_attempt_id: { format: 'uuid', type: 'string' },
9075
+ access_code_id: {
9076
+ description:
9077
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.',
9078
+ format: 'uuid',
9079
+ type: 'string',
9080
+ },
9081
+ action_attempt_id: {
9082
+ description:
9083
+ 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.',
9084
+ format: 'uuid',
9085
+ type: 'string',
9086
+ },
9264
9087
  connected_account_id: {
9265
- description: 'ID of the connected account.',
9088
+ description:
9089
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9266
9090
  format: 'uuid',
9267
9091
  type: 'string',
9268
- 'x-title': 'Connected Account ID',
9269
9092
  },
9270
9093
  created_at: {
9271
- description: 'The time when the event was created.',
9094
+ description: 'Time at which the event was created.',
9272
9095
  format: 'date-time',
9273
9096
  type: 'string',
9274
- 'x-title': 'Created At',
9275
9097
  },
9276
9098
  device_id: {
9277
9099
  description: 'ID of the device.',
9278
9100
  format: 'uuid',
9279
9101
  type: 'string',
9280
- 'x-title': 'Device ID',
9281
9102
  },
9282
9103
  event_id: {
9283
- description: 'The ID of the event.',
9104
+ description: 'ID of the event.',
9284
9105
  format: 'uuid',
9285
9106
  type: 'string',
9286
- 'x-title': 'Event ID',
9287
9107
  },
9288
9108
  event_type: { enum: ['lock.locked'], type: 'string' },
9289
9109
  method: {
9290
9110
  description:
9291
- 'Method by which a lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` will reference the Seam access code which was used, if reported by the device.',
9111
+ '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.',
9292
9112
  enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
9293
9113
  type: 'string',
9294
- 'x-title': 'Lock Lock/Unlock Method',
9295
9114
  },
9296
9115
  occurred_at: {
9297
- description: 'The time when the event occurred.',
9116
+ description: 'Time when the event occurred.',
9298
9117
  format: 'date-time',
9299
9118
  type: 'string',
9300
- 'x-title': 'Occurred At',
9301
9119
  },
9302
9120
  workspace_id: {
9303
- description: 'The ID of the workspace.',
9121
+ description:
9122
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9304
9123
  format: 'uuid',
9305
9124
  type: 'string',
9306
- 'x-title': 'Workspace ID',
9307
9125
  },
9308
9126
  },
9309
9127
  required: [
@@ -9321,51 +9139,56 @@ export default {
9321
9139
  {
9322
9140
  description: 'A lock was unlocked.',
9323
9141
  properties: {
9324
- access_code_id: { format: 'uuid', type: 'string' },
9325
- action_attempt_id: { format: 'uuid', type: 'string' },
9142
+ access_code_id: {
9143
+ description:
9144
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.',
9145
+ format: 'uuid',
9146
+ type: 'string',
9147
+ },
9148
+ action_attempt_id: {
9149
+ description:
9150
+ 'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.',
9151
+ format: 'uuid',
9152
+ type: 'string',
9153
+ },
9326
9154
  connected_account_id: {
9327
- description: 'ID of the connected account.',
9155
+ description:
9156
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9328
9157
  format: 'uuid',
9329
9158
  type: 'string',
9330
- 'x-title': 'Connected Account ID',
9331
9159
  },
9332
9160
  created_at: {
9333
- description: 'The time when the event was created.',
9161
+ description: 'Time at which the event was created.',
9334
9162
  format: 'date-time',
9335
9163
  type: 'string',
9336
- 'x-title': 'Created At',
9337
9164
  },
9338
9165
  device_id: {
9339
9166
  description: 'ID of the device.',
9340
9167
  format: 'uuid',
9341
9168
  type: 'string',
9342
- 'x-title': 'Device ID',
9343
9169
  },
9344
9170
  event_id: {
9345
- description: 'The ID of the event.',
9171
+ description: 'ID of the event.',
9346
9172
  format: 'uuid',
9347
9173
  type: 'string',
9348
- 'x-title': 'Event ID',
9349
9174
  },
9350
9175
  event_type: { enum: ['lock.unlocked'], type: 'string' },
9351
9176
  method: {
9352
9177
  description:
9353
- 'Method by which a lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` will reference the Seam access code which was used, if reported by the device.',
9178
+ '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.',
9354
9179
  enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
9355
9180
  type: 'string',
9356
- 'x-title': 'Lock Lock/Unlock Method',
9357
9181
  },
9358
9182
  occurred_at: {
9359
- description: 'The time when the event occurred.',
9183
+ description: 'Time when the event occurred.',
9360
9184
  format: 'date-time',
9361
9185
  type: 'string',
9362
- 'x-title': 'Occurred At',
9363
9186
  },
9364
9187
  workspace_id: {
9365
- description: 'The ID of the workspace.',
9188
+ description:
9189
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9366
9190
  format: 'uuid',
9367
9191
  type: 'string',
9368
- 'x-title': 'Workspace ID',
9369
9192
  },
9370
9193
  },
9371
9194
  required: [
@@ -9384,43 +9207,44 @@ export default {
9384
9207
  description:
9385
9208
  'The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.',
9386
9209
  properties: {
9387
- access_code_id: { format: 'uuid', type: 'string' },
9210
+ access_code_id: {
9211
+ description:
9212
+ 'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.',
9213
+ format: 'uuid',
9214
+ type: 'string',
9215
+ },
9388
9216
  connected_account_id: {
9389
- description: 'ID of the connected account.',
9217
+ description:
9218
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9390
9219
  format: 'uuid',
9391
9220
  type: 'string',
9392
- 'x-title': 'Connected Account ID',
9393
9221
  },
9394
9222
  created_at: {
9395
- description: 'The time when the event was created.',
9223
+ description: 'Time at which the event was created.',
9396
9224
  format: 'date-time',
9397
9225
  type: 'string',
9398
- 'x-title': 'Created At',
9399
9226
  },
9400
9227
  device_id: {
9401
9228
  description: 'ID of the device.',
9402
9229
  format: 'uuid',
9403
9230
  type: 'string',
9404
- 'x-title': 'Device ID',
9405
9231
  },
9406
9232
  event_id: {
9407
- description: 'The ID of the event.',
9233
+ description: 'ID of the event.',
9408
9234
  format: 'uuid',
9409
9235
  type: 'string',
9410
- 'x-title': 'Event ID',
9411
9236
  },
9412
9237
  event_type: { enum: ['lock.access_denied'], type: 'string' },
9413
9238
  occurred_at: {
9414
- description: 'The time when the event occurred.',
9239
+ description: 'Time when the event occurred.',
9415
9240
  format: 'date-time',
9416
9241
  type: 'string',
9417
- 'x-title': 'Occurred At',
9418
9242
  },
9419
9243
  workspace_id: {
9420
- description: 'The ID of the workspace.',
9244
+ description:
9245
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9421
9246
  format: 'uuid',
9422
9247
  type: 'string',
9423
- 'x-title': 'Workspace ID',
9424
9248
  },
9425
9249
  },
9426
9250
  required: [
@@ -9435,54 +9259,61 @@ export default {
9435
9259
  type: 'object',
9436
9260
  },
9437
9261
  {
9438
- description: 'A thermostat climate preset was activated.',
9262
+ description:
9263
+ 'A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.',
9439
9264
  properties: {
9440
- climate_preset_key: { type: 'string' },
9265
+ climate_preset_key: {
9266
+ description:
9267
+ 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.',
9268
+ type: 'string',
9269
+ },
9441
9270
  connected_account_id: {
9442
- description: 'ID of the connected account.',
9271
+ description:
9272
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9443
9273
  format: 'uuid',
9444
9274
  type: 'string',
9445
- 'x-title': 'Connected Account ID',
9446
9275
  },
9447
9276
  created_at: {
9448
- description: 'The time when the event was created.',
9277
+ description: 'Time at which the event was created.',
9449
9278
  format: 'date-time',
9450
9279
  type: 'string',
9451
- 'x-title': 'Created At',
9452
9280
  },
9453
9281
  device_id: {
9454
9282
  description: 'ID of the device.',
9455
9283
  format: 'uuid',
9456
9284
  type: 'string',
9457
- 'x-title': 'Device ID',
9458
9285
  },
9459
9286
  event_id: {
9460
- description: 'The ID of the event.',
9287
+ description: 'ID of the event.',
9461
9288
  format: 'uuid',
9462
9289
  type: 'string',
9463
- 'x-title': 'Event ID',
9464
9290
  },
9465
9291
  event_type: {
9466
9292
  enum: ['thermostat.climate_preset_activated'],
9467
9293
  type: 'string',
9468
9294
  },
9469
- is_fallback_climate_preset: { type: 'boolean' },
9295
+ is_fallback_climate_preset: {
9296
+ description:
9297
+ '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.',
9298
+ type: 'boolean',
9299
+ },
9470
9300
  occurred_at: {
9471
- description: 'The time when the event occurred.',
9301
+ description: 'Time when the event occurred.',
9472
9302
  format: 'date-time',
9473
9303
  type: 'string',
9474
- 'x-title': 'Occurred At',
9475
9304
  },
9476
9305
  thermostat_schedule_id: {
9306
+ description:
9307
+ 'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.',
9477
9308
  format: 'uuid',
9478
9309
  nullable: true,
9479
9310
  type: 'string',
9480
9311
  },
9481
9312
  workspace_id: {
9482
- description: 'The ID of the workspace.',
9313
+ description:
9314
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9483
9315
  format: 'uuid',
9484
9316
  type: 'string',
9485
- 'x-title': 'Workspace ID',
9486
9317
  },
9487
9318
  },
9488
9319
  required: [
@@ -9500,13 +9331,13 @@ export default {
9500
9331
  type: 'object',
9501
9332
  },
9502
9333
  {
9503
- description: 'A thermostat was manually adjusted.',
9334
+ description: 'A thermostat was adjusted manually.',
9504
9335
  properties: {
9505
9336
  connected_account_id: {
9506
- description: 'ID of the connected account.',
9337
+ description:
9338
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9507
9339
  format: 'uuid',
9508
9340
  type: 'string',
9509
- 'x-title': 'Connected Account ID',
9510
9341
  },
9511
9342
  cooling_set_point_celsius: {
9512
9343
  description:
@@ -9521,22 +9352,19 @@ export default {
9521
9352
  type: 'number',
9522
9353
  },
9523
9354
  created_at: {
9524
- description: 'The time when the event was created.',
9355
+ description: 'Time at which the event was created.',
9525
9356
  format: 'date-time',
9526
9357
  type: 'string',
9527
- 'x-title': 'Created At',
9528
9358
  },
9529
9359
  device_id: {
9530
9360
  description: 'ID of the device.',
9531
9361
  format: 'uuid',
9532
9362
  type: 'string',
9533
- 'x-title': 'Device ID',
9534
9363
  },
9535
9364
  event_id: {
9536
- description: 'The ID of the event.',
9365
+ description: 'ID of the event.',
9537
9366
  format: 'uuid',
9538
9367
  type: 'string',
9539
- 'x-title': 'Event ID',
9540
9368
  },
9541
9369
  event_type: {
9542
9370
  enum: ['thermostat.manually_adjusted'],
@@ -9566,18 +9394,22 @@ export default {
9566
9394
  enum: ['off', 'heat', 'cool', 'heat_cool'],
9567
9395
  type: 'string',
9568
9396
  },
9569
- method: { enum: ['seam', 'external'], type: 'string' },
9397
+ method: {
9398
+ description:
9399
+ 'Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.',
9400
+ enum: ['seam', 'external'],
9401
+ type: 'string',
9402
+ },
9570
9403
  occurred_at: {
9571
- description: 'The time when the event occurred.',
9404
+ description: 'Time when the event occurred.',
9572
9405
  format: 'date-time',
9573
9406
  type: 'string',
9574
- 'x-title': 'Occurred At',
9575
9407
  },
9576
9408
  workspace_id: {
9577
- description: 'The ID of the workspace.',
9409
+ description:
9410
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9578
9411
  format: 'uuid',
9579
9412
  type: 'string',
9580
- 'x-title': 'Workspace ID',
9581
9413
  },
9582
9414
  },
9583
9415
  required: [
@@ -9594,69 +9426,81 @@ export default {
9594
9426
  },
9595
9427
  {
9596
9428
  description:
9597
- "A thermostat's temperature reading exceeded the set threshold.",
9429
+ "A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
9598
9430
  properties: {
9599
9431
  connected_account_id: {
9600
- description: 'ID of the connected account.',
9432
+ description:
9433
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9601
9434
  format: 'uuid',
9602
9435
  type: 'string',
9603
- 'x-title': 'Connected Account ID',
9604
9436
  },
9605
9437
  created_at: {
9606
- description: 'The time when the event was created.',
9438
+ description: 'Time at which the event was created.',
9607
9439
  format: 'date-time',
9608
9440
  type: 'string',
9609
- 'x-title': 'Created At',
9610
9441
  },
9611
9442
  device_id: {
9612
9443
  description: 'ID of the device.',
9613
9444
  format: 'uuid',
9614
9445
  type: 'string',
9615
- 'x-title': 'Device ID',
9616
9446
  },
9617
9447
  event_id: {
9618
- description: 'The ID of the event.',
9448
+ description: 'ID of the event.',
9619
9449
  format: 'uuid',
9620
9450
  type: 'string',
9621
- 'x-title': 'Event ID',
9622
9451
  },
9623
9452
  event_type: {
9624
9453
  enum: ['thermostat.temperature_threshold_exceeded'],
9625
9454
  type: 'string',
9626
9455
  },
9627
9456
  lower_limit_celsius: {
9457
+ description:
9458
+ 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9628
9459
  format: 'float',
9629
9460
  nullable: true,
9630
9461
  type: 'number',
9631
9462
  },
9632
9463
  lower_limit_fahrenheit: {
9464
+ description:
9465
+ 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9633
9466
  format: 'float',
9634
9467
  nullable: true,
9635
9468
  type: 'number',
9636
9469
  },
9637
9470
  occurred_at: {
9638
- description: 'The time when the event occurred.',
9471
+ description: 'Time when the event occurred.',
9639
9472
  format: 'date-time',
9640
9473
  type: 'string',
9641
- 'x-title': 'Occurred At',
9642
9474
  },
9643
- temperature_celsius: { format: 'float', type: 'number' },
9644
- temperature_fahrenheit: { format: 'float', type: 'number' },
9475
+ temperature_celsius: {
9476
+ description: 'Temperature, in °C, reported by the thermostat.',
9477
+ format: 'float',
9478
+ type: 'number',
9479
+ },
9480
+ temperature_fahrenheit: {
9481
+ description: 'Temperature, in °F, reported by the thermostat.',
9482
+ format: 'float',
9483
+ type: 'number',
9484
+ },
9645
9485
  upper_limit_celsius: {
9486
+ description:
9487
+ 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9646
9488
  format: 'float',
9647
9489
  nullable: true,
9648
9490
  type: 'number',
9649
9491
  },
9650
9492
  upper_limit_fahrenheit: {
9493
+ description:
9494
+ 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9651
9495
  format: 'float',
9652
9496
  nullable: true,
9653
9497
  type: 'number',
9654
9498
  },
9655
9499
  workspace_id: {
9656
- description: 'The ID of the workspace.',
9500
+ description:
9501
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9657
9502
  format: 'uuid',
9658
9503
  type: 'string',
9659
- 'x-title': 'Workspace ID',
9660
9504
  },
9661
9505
  },
9662
9506
  required: [
@@ -9678,69 +9522,81 @@ export default {
9678
9522
  },
9679
9523
  {
9680
9524
  description:
9681
- "A thermostat's temperature reading is no longer exceeding the set threshold.",
9525
+ "A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
9682
9526
  properties: {
9683
9527
  connected_account_id: {
9684
- description: 'ID of the connected account.',
9528
+ description:
9529
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9685
9530
  format: 'uuid',
9686
9531
  type: 'string',
9687
- 'x-title': 'Connected Account ID',
9688
9532
  },
9689
9533
  created_at: {
9690
- description: 'The time when the event was created.',
9534
+ description: 'Time at which the event was created.',
9691
9535
  format: 'date-time',
9692
9536
  type: 'string',
9693
- 'x-title': 'Created At',
9694
9537
  },
9695
9538
  device_id: {
9696
9539
  description: 'ID of the device.',
9697
9540
  format: 'uuid',
9698
9541
  type: 'string',
9699
- 'x-title': 'Device ID',
9700
9542
  },
9701
9543
  event_id: {
9702
- description: 'The ID of the event.',
9544
+ description: 'ID of the event.',
9703
9545
  format: 'uuid',
9704
9546
  type: 'string',
9705
- 'x-title': 'Event ID',
9706
9547
  },
9707
9548
  event_type: {
9708
9549
  enum: ['thermostat.temperature_threshold_no_longer_exceeded'],
9709
9550
  type: 'string',
9710
9551
  },
9711
9552
  lower_limit_celsius: {
9553
+ description:
9554
+ 'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9712
9555
  format: 'float',
9713
9556
  nullable: true,
9714
9557
  type: 'number',
9715
9558
  },
9716
9559
  lower_limit_fahrenheit: {
9560
+ description:
9561
+ 'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9717
9562
  format: 'float',
9718
9563
  nullable: true,
9719
9564
  type: 'number',
9720
9565
  },
9721
9566
  occurred_at: {
9722
- description: 'The time when the event occurred.',
9567
+ description: 'Time when the event occurred.',
9723
9568
  format: 'date-time',
9724
9569
  type: 'string',
9725
- 'x-title': 'Occurred At',
9726
9570
  },
9727
- temperature_celsius: { format: 'float', type: 'number' },
9728
- temperature_fahrenheit: { format: 'float', type: 'number' },
9571
+ temperature_celsius: {
9572
+ description: 'Temperature, in °C, reported by the thermostat.',
9573
+ format: 'float',
9574
+ type: 'number',
9575
+ },
9576
+ temperature_fahrenheit: {
9577
+ description: 'Temperature, in °F, reported by the thermostat.',
9578
+ format: 'float',
9579
+ type: 'number',
9580
+ },
9729
9581
  upper_limit_celsius: {
9582
+ description:
9583
+ 'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9730
9584
  format: 'float',
9731
9585
  nullable: true,
9732
9586
  type: 'number',
9733
9587
  },
9734
9588
  upper_limit_fahrenheit: {
9589
+ description:
9590
+ 'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
9735
9591
  format: 'float',
9736
9592
  nullable: true,
9737
9593
  type: 'number',
9738
9594
  },
9739
9595
  workspace_id: {
9740
- description: 'The ID of the workspace.',
9596
+ description:
9597
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9741
9598
  format: 'uuid',
9742
9599
  type: 'string',
9743
- 'x-title': 'Workspace ID',
9744
9600
  },
9745
9601
  },
9746
9602
  required: [
@@ -9764,10 +9620,9 @@ export default {
9764
9620
  description: 'An enrollment automation was deleted.',
9765
9621
  properties: {
9766
9622
  created_at: {
9767
- description: 'The time when the event was created.',
9623
+ description: 'Time at which the event was created.',
9768
9624
  format: 'date-time',
9769
9625
  type: 'string',
9770
- 'x-title': 'Created At',
9771
9626
  },
9772
9627
  enrollment_automation_id: {
9773
9628
  description: 'ID of the enrollment automation.',
@@ -9776,26 +9631,24 @@ export default {
9776
9631
  'x-title': 'Enrollment Automation ID',
9777
9632
  },
9778
9633
  event_id: {
9779
- description: 'The ID of the event.',
9634
+ description: 'ID of the event.',
9780
9635
  format: 'uuid',
9781
9636
  type: 'string',
9782
- 'x-title': 'Event ID',
9783
9637
  },
9784
9638
  event_type: {
9785
9639
  enum: ['enrollment_automation.deleted'],
9786
9640
  type: 'string',
9787
9641
  },
9788
9642
  occurred_at: {
9789
- description: 'The time when the event occurred.',
9643
+ description: 'Time when the event occurred.',
9790
9644
  format: 'date-time',
9791
9645
  type: 'string',
9792
- 'x-title': 'Occurred At',
9793
9646
  },
9794
9647
  workspace_id: {
9795
- description: 'The ID of the workspace.',
9648
+ description:
9649
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9796
9650
  format: 'uuid',
9797
9651
  type: 'string',
9798
- 'x-title': 'Workspace ID',
9799
9652
  },
9800
9653
  },
9801
9654
  required: [
@@ -9812,10 +9665,9 @@ export default {
9812
9665
  description: 'A phone device was deactivated.',
9813
9666
  properties: {
9814
9667
  created_at: {
9815
- description: 'The time when the event was created.',
9668
+ description: 'Time at which the event was created.',
9816
9669
  format: 'date-time',
9817
9670
  type: 'string',
9818
- 'x-title': 'Created At',
9819
9671
  },
9820
9672
  device_id: {
9821
9673
  description: 'ID of the device.',
@@ -9824,23 +9676,21 @@ export default {
9824
9676
  'x-title': 'Device ID',
9825
9677
  },
9826
9678
  event_id: {
9827
- description: 'The ID of the event.',
9679
+ description: 'ID of the event.',
9828
9680
  format: 'uuid',
9829
9681
  type: 'string',
9830
- 'x-title': 'Event ID',
9831
9682
  },
9832
9683
  event_type: { enum: ['phone.deactivated'], type: 'string' },
9833
9684
  occurred_at: {
9834
- description: 'The time when the event occurred.',
9685
+ description: 'Time when the event occurred.',
9835
9686
  format: 'date-time',
9836
9687
  type: 'string',
9837
- 'x-title': 'Occurred At',
9838
9688
  },
9839
9689
  workspace_id: {
9840
- description: 'The ID of the workspace.',
9690
+ description:
9691
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9841
9692
  format: 'uuid',
9842
9693
  type: 'string',
9843
- 'x-title': 'Workspace ID',
9844
9694
  },
9845
9695
  },
9846
9696
  required: [
@@ -14476,7 +14326,7 @@ export default {
14476
14326
  'x-fern-sdk-method-name': 'encode_credential',
14477
14327
  'x-fern-sdk-return-value': 'action_attempt',
14478
14328
  'x-response-key': 'action_attempt',
14479
- 'x-undocumented': 'Encoding a card is currently unimplemented.',
14329
+ 'x-undocumented': 'Encoders are in alpha.',
14480
14330
  },
14481
14331
  },
14482
14332
  '/acs/encoders/list': {
@@ -14690,7 +14540,283 @@ export default {
14690
14540
  'x-fern-sdk-method-name': 'scan_credential',
14691
14541
  'x-fern-sdk-return-value': 'action_attempt',
14692
14542
  'x-response-key': 'action_attempt',
14693
- 'x-undocumented': 'Reading a card is currently unimplemented.',
14543
+ 'x-undocumented': 'Encoders are in alpha.',
14544
+ },
14545
+ },
14546
+ '/acs/encoders/simulate/next_credential_encode_will_fail': {
14547
+ post: {
14548
+ operationId: 'acsEncodersSimulateNextCredentialEncodeWillFailPost',
14549
+ requestBody: {
14550
+ content: {
14551
+ 'application/json': {
14552
+ schema: {
14553
+ oneOf: [
14554
+ {
14555
+ additionalProperties: false,
14556
+ properties: {
14557
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14558
+ error_code: {
14559
+ default: 'no_credential_on_encoder',
14560
+ enum: ['no_credential_on_encoder'],
14561
+ type: 'string',
14562
+ },
14563
+ },
14564
+ required: ['acs_encoder_id'],
14565
+ type: 'object',
14566
+ },
14567
+ {
14568
+ additionalProperties: false,
14569
+ properties: {
14570
+ acs_credential_id: { format: 'uuid', type: 'string' },
14571
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14572
+ error_code: {
14573
+ enum: ['uncategorized_error', 'action_attempt_expired'],
14574
+ type: 'string',
14575
+ },
14576
+ },
14577
+ required: ['acs_encoder_id', 'error_code'],
14578
+ type: 'object',
14579
+ },
14580
+ ],
14581
+ },
14582
+ },
14583
+ },
14584
+ },
14585
+ responses: {
14586
+ 200: {
14587
+ content: {
14588
+ 'application/json': {
14589
+ schema: {
14590
+ properties: { ok: { type: 'boolean' } },
14591
+ required: ['ok'],
14592
+ type: 'object',
14593
+ },
14594
+ },
14595
+ },
14596
+ description: 'OK',
14597
+ },
14598
+ 400: { description: 'Bad Request' },
14599
+ 401: { description: 'Unauthorized' },
14600
+ },
14601
+ security: [
14602
+ { api_key: [] },
14603
+ { pat_with_workspace: [] },
14604
+ { console_session_with_workspace: [] },
14605
+ ],
14606
+ summary: '/acs/encoders/simulate/next_credential_encode_will_fail',
14607
+ tags: ['/acs'],
14608
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14609
+ 'x-fern-sdk-method-name': 'next_credential_encode_will_fail',
14610
+ 'x-response-key': null,
14611
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14612
+ },
14613
+ },
14614
+ '/acs/encoders/simulate/next_credential_encode_will_succeed': {
14615
+ post: {
14616
+ operationId: 'acsEncodersSimulateNextCredentialEncodeWillSucceedPost',
14617
+ requestBody: {
14618
+ content: {
14619
+ 'application/json': {
14620
+ schema: {
14621
+ additionalProperties: false,
14622
+ properties: {
14623
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14624
+ scenario: {
14625
+ default: 'credential_is_issued',
14626
+ enum: ['credential_is_issued'],
14627
+ type: 'string',
14628
+ },
14629
+ },
14630
+ required: ['acs_encoder_id'],
14631
+ type: 'object',
14632
+ },
14633
+ },
14634
+ },
14635
+ },
14636
+ responses: {
14637
+ 200: {
14638
+ content: {
14639
+ 'application/json': {
14640
+ schema: {
14641
+ properties: { ok: { type: 'boolean' } },
14642
+ required: ['ok'],
14643
+ type: 'object',
14644
+ },
14645
+ },
14646
+ },
14647
+ description: 'OK',
14648
+ },
14649
+ 400: { description: 'Bad Request' },
14650
+ 401: { description: 'Unauthorized' },
14651
+ },
14652
+ security: [
14653
+ { api_key: [] },
14654
+ { pat_with_workspace: [] },
14655
+ { console_session_with_workspace: [] },
14656
+ ],
14657
+ summary: '/acs/encoders/simulate/next_credential_encode_will_succeed',
14658
+ tags: ['/acs'],
14659
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14660
+ 'x-fern-sdk-method-name': 'next_credential_encode_will_succeed',
14661
+ 'x-response-key': null,
14662
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14663
+ },
14664
+ },
14665
+ '/acs/encoders/simulate/next_credential_scan_will_fail': {
14666
+ post: {
14667
+ operationId: 'acsEncodersSimulateNextCredentialScanWillFailPost',
14668
+ requestBody: {
14669
+ content: {
14670
+ 'application/json': {
14671
+ schema: {
14672
+ oneOf: [
14673
+ {
14674
+ additionalProperties: false,
14675
+ properties: {
14676
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14677
+ error_code: {
14678
+ default: 'no_credential_on_encoder',
14679
+ enum: ['no_credential_on_encoder'],
14680
+ type: 'string',
14681
+ },
14682
+ },
14683
+ required: ['acs_encoder_id'],
14684
+ type: 'object',
14685
+ },
14686
+ {
14687
+ additionalProperties: false,
14688
+ properties: {
14689
+ acs_credential_id_on_seam: {
14690
+ format: 'uuid',
14691
+ type: 'string',
14692
+ },
14693
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14694
+ error_code: {
14695
+ enum: ['uncategorized_error', 'action_attempt_expired'],
14696
+ type: 'string',
14697
+ },
14698
+ },
14699
+ required: ['acs_encoder_id', 'error_code'],
14700
+ type: 'object',
14701
+ },
14702
+ ],
14703
+ },
14704
+ },
14705
+ },
14706
+ },
14707
+ responses: {
14708
+ 200: {
14709
+ content: {
14710
+ 'application/json': {
14711
+ schema: {
14712
+ properties: { ok: { type: 'boolean' } },
14713
+ required: ['ok'],
14714
+ type: 'object',
14715
+ },
14716
+ },
14717
+ },
14718
+ description: 'OK',
14719
+ },
14720
+ 400: { description: 'Bad Request' },
14721
+ 401: { description: 'Unauthorized' },
14722
+ },
14723
+ security: [
14724
+ { api_key: [] },
14725
+ { pat_with_workspace: [] },
14726
+ { console_session_with_workspace: [] },
14727
+ ],
14728
+ summary: '/acs/encoders/simulate/next_credential_scan_will_fail',
14729
+ tags: ['/acs'],
14730
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14731
+ 'x-fern-sdk-method-name': 'next_credential_scan_will_fail',
14732
+ 'x-response-key': null,
14733
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14734
+ },
14735
+ },
14736
+ '/acs/encoders/simulate/next_credential_scan_will_succeed': {
14737
+ post: {
14738
+ operationId: 'acsEncodersSimulateNextCredentialScanWillSucceedPost',
14739
+ requestBody: {
14740
+ content: {
14741
+ 'application/json': {
14742
+ schema: {
14743
+ oneOf: [
14744
+ {
14745
+ additionalProperties: false,
14746
+ properties: {
14747
+ acs_credential_id_on_seam: {
14748
+ format: 'uuid',
14749
+ type: 'string',
14750
+ },
14751
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14752
+ scenario: {
14753
+ default: 'credential_exists_on_seam',
14754
+ enum: [
14755
+ 'credential_exists_on_seam',
14756
+ 'credential_on_encoder_needs_update',
14757
+ ],
14758
+ type: 'string',
14759
+ },
14760
+ },
14761
+ required: ['acs_encoder_id'],
14762
+ type: 'object',
14763
+ },
14764
+ {
14765
+ additionalProperties: false,
14766
+ properties: {
14767
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14768
+ scenario: {
14769
+ enum: ['credential_does_not_exist_on_seam'],
14770
+ type: 'string',
14771
+ },
14772
+ },
14773
+ required: ['acs_encoder_id', 'scenario'],
14774
+ type: 'object',
14775
+ },
14776
+ {
14777
+ additionalProperties: false,
14778
+ properties: {
14779
+ acs_encoder_id: { format: 'uuid', type: 'string' },
14780
+ scenario: {
14781
+ enum: ['credential_on_encoder_is_empty'],
14782
+ type: 'string',
14783
+ },
14784
+ },
14785
+ required: ['acs_encoder_id', 'scenario'],
14786
+ type: 'object',
14787
+ },
14788
+ ],
14789
+ },
14790
+ },
14791
+ },
14792
+ },
14793
+ responses: {
14794
+ 200: {
14795
+ content: {
14796
+ 'application/json': {
14797
+ schema: {
14798
+ properties: { ok: { type: 'boolean' } },
14799
+ required: ['ok'],
14800
+ type: 'object',
14801
+ },
14802
+ },
14803
+ },
14804
+ description: 'OK',
14805
+ },
14806
+ 400: { description: 'Bad Request' },
14807
+ 401: { description: 'Unauthorized' },
14808
+ },
14809
+ security: [
14810
+ { api_key: [] },
14811
+ { pat_with_workspace: [] },
14812
+ { console_session_with_workspace: [] },
14813
+ ],
14814
+ summary: '/acs/encoders/simulate/next_credential_scan_will_succeed',
14815
+ tags: ['/acs'],
14816
+ 'x-fern-sdk-group-name': ['acs', 'encoders', 'simulate'],
14817
+ 'x-fern-sdk-method-name': 'next_credential_scan_will_succeed',
14818
+ 'x-response-key': null,
14819
+ 'x-undocumented': 'Encoder simulations are in alpha.',
14694
14820
  },
14695
14821
  },
14696
14822
  '/acs/entrances/get': {