@seamapi/types 1.360.0 → 1.360.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 (31) hide show
  1. package/dist/connect.cjs +899 -569
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3626 -2951
  4. package/lib/seam/connect/models/acs/acs-credential.js +94 -51
  5. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-encoder.js +12 -7
  7. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js +37 -14
  9. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-system.js +48 -41
  11. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-user.js +45 -32
  13. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/thermostats/climate-preset.js +12 -10
  15. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  16. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +19 -12
  17. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  18. package/lib/seam/connect/openapi.d.ts +45 -23
  19. package/lib/seam/connect/openapi.js +557 -401
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +3581 -2928
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/acs/acs-credential.ts +162 -51
  24. package/src/lib/seam/connect/models/acs/acs-encoder.ts +22 -7
  25. package/src/lib/seam/connect/models/acs/acs-entrance.ts +65 -18
  26. package/src/lib/seam/connect/models/acs/acs-system.ts +81 -52
  27. package/src/lib/seam/connect/models/acs/acs-user.ts +69 -32
  28. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +28 -10
  29. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +31 -12
  30. package/src/lib/seam/connect/openapi.ts +698 -401
  31. package/src/lib/seam/connect/route-types.ts +3581 -2928
@@ -943,31 +943,31 @@ export default {
943
943
  'x-route-path': '/acs/access_groups',
944
944
  },
945
945
  acs_credential: {
946
- description: 'Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
946
+ description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
947
947
  properties: {
948
948
  access_method: {
949
- description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
949
+ description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
950
950
  enum: ['code', 'card', 'mobile_key'],
951
951
  type: 'string',
952
952
  },
953
953
  acs_credential_id: {
954
- description: 'ID of the credential.',
954
+ description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
955
955
  format: 'uuid',
956
956
  type: 'string',
957
957
  },
958
958
  acs_credential_pool_id: { format: 'uuid', type: 'string' },
959
959
  acs_system_id: {
960
- description: 'ID of the access control system that contains the credential.',
960
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
961
961
  format: 'uuid',
962
962
  type: 'string',
963
963
  },
964
964
  acs_user_id: {
965
- description: 'ID of the ACS user to whom the credential belongs.',
965
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
966
966
  format: 'uuid',
967
967
  type: 'string',
968
968
  },
969
969
  assa_abloy_vostio_metadata: {
970
- description: 'Vostio-specific metadata for the credential.',
970
+ description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
971
971
  properties: {
972
972
  door_names: { items: { type: 'string' }, type: 'array' },
973
973
  endpoint_id: { type: 'string' },
@@ -980,28 +980,32 @@ export default {
980
980
  },
981
981
  type: 'object',
982
982
  },
983
- card_number: { nullable: true, type: 'string' },
983
+ card_number: {
984
+ description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
985
+ nullable: true,
986
+ type: 'string',
987
+ },
984
988
  code: {
985
- description: 'Access (PIN) code for the credential.',
989
+ description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
986
990
  nullable: true,
987
991
  type: 'string',
988
992
  },
989
993
  created_at: {
990
- description: 'Date and time at which the credential was created.',
994
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
991
995
  format: 'date-time',
992
996
  type: 'string',
993
997
  },
994
998
  display_name: {
995
- description: 'Display name that corresponds to the credential type.',
999
+ description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
996
1000
  minLength: 1,
997
1001
  type: 'string',
998
1002
  },
999
1003
  ends_at: {
1000
- description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
1004
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
1001
1005
  type: 'string',
1002
1006
  },
1003
1007
  errors: {
1004
- description: 'Errors associated with the `acs_credential`.',
1008
+ description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
1005
1009
  items: {
1006
1010
  properties: {
1007
1011
  error_code: { type: 'string' },
@@ -1013,7 +1017,7 @@ export default {
1013
1017
  type: 'array',
1014
1018
  },
1015
1019
  external_type: {
1016
- description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
1020
+ description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
1017
1021
  enum: [
1018
1022
  'pti_card',
1019
1023
  'brivo_credential',
@@ -1026,42 +1030,50 @@ export default {
1026
1030
  type: 'string',
1027
1031
  },
1028
1032
  external_type_display_name: {
1029
- description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
1033
+ description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
1030
1034
  type: 'string',
1031
1035
  },
1032
- is_issued: { type: 'boolean' },
1036
+ is_issued: {
1037
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
1038
+ type: 'boolean',
1039
+ },
1033
1040
  is_latest_desired_state_synced_with_provider: {
1034
- description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
1041
+ description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
1035
1042
  nullable: true,
1036
1043
  type: 'boolean',
1037
1044
  },
1038
1045
  is_managed: { enum: [true], type: 'boolean' },
1039
1046
  is_multi_phone_sync_credential: {
1040
- description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
1047
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
1041
1048
  type: 'boolean',
1042
1049
  },
1043
1050
  is_one_time_use: {
1044
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
1051
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
1045
1052
  type: 'boolean',
1046
1053
  },
1047
- issued_at: { format: 'date-time', nullable: true, type: 'string' },
1054
+ issued_at: {
1055
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
1056
+ format: 'date-time',
1057
+ nullable: true,
1058
+ type: 'string',
1059
+ },
1048
1060
  latest_desired_state_synced_with_provider_at: {
1049
- description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
1061
+ description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
1050
1062
  format: 'date-time',
1051
1063
  nullable: true,
1052
1064
  type: 'string',
1053
1065
  },
1054
1066
  parent_acs_credential_id: {
1055
- description: 'ID of the parent credential.',
1067
+ description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
1056
1068
  format: 'uuid',
1057
1069
  type: 'string',
1058
1070
  },
1059
1071
  starts_at: {
1060
- description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
1072
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
1061
1073
  type: 'string',
1062
1074
  },
1063
1075
  visionline_metadata: {
1064
- description: 'Visionline-specific metadata for the credential.',
1076
+ description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
1065
1077
  properties: {
1066
1078
  auto_join: { type: 'boolean' },
1067
1079
  card_function_type: { enum: ['guest', 'staff'], type: 'string' },
@@ -1085,13 +1097,13 @@ export default {
1085
1097
  type: 'object',
1086
1098
  },
1087
1099
  warnings: {
1088
- description: 'Warnings associated with the `acs_credential`.',
1100
+ description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
1089
1101
  items: {
1090
- description: 'Warning associated with the `acs_credential`.',
1102
+ description: 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
1091
1103
  discriminator: { propertyName: 'warning_code' },
1092
1104
  oneOf: [
1093
1105
  {
1094
- description: 'Indicates that the credential is waiting to be issued.',
1106
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
1095
1107
  properties: {
1096
1108
  created_at: {
1097
1109
  description: 'Date and time at which Seam created the warning.',
@@ -1112,7 +1124,7 @@ export default {
1112
1124
  type: 'object',
1113
1125
  },
1114
1126
  {
1115
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
1127
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
1116
1128
  properties: {
1117
1129
  created_at: {
1118
1130
  description: 'Date and time at which Seam created the warning.',
@@ -1133,7 +1145,7 @@ export default {
1133
1145
  type: 'object',
1134
1146
  },
1135
1147
  {
1136
- description: 'Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.',
1148
+ description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
1137
1149
  properties: {
1138
1150
  created_at: {
1139
1151
  description: 'Date and time at which Seam created the warning.',
@@ -1154,7 +1166,7 @@ export default {
1154
1166
  type: 'object',
1155
1167
  },
1156
1168
  {
1157
- description: 'Indicates that this credential is being deleted.',
1169
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
1158
1170
  properties: {
1159
1171
  created_at: {
1160
1172
  description: 'Date and time at which Seam created the warning.',
@@ -1175,7 +1187,7 @@ export default {
1175
1187
  type: 'object',
1176
1188
  },
1177
1189
  {
1178
- description: 'An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.',
1190
+ description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
1179
1191
  properties: {
1180
1192
  created_at: {
1181
1193
  description: 'Date and time at which Seam created the warning.',
@@ -1196,7 +1208,7 @@ export default {
1196
1208
  type: 'object',
1197
1209
  },
1198
1210
  {
1199
- description: 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
1211
+ description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
1200
1212
  properties: {
1201
1213
  created_at: {
1202
1214
  description: 'Date and time at which Seam created the warning.',
@@ -1221,7 +1233,7 @@ export default {
1221
1233
  type: 'array',
1222
1234
  },
1223
1235
  workspace_id: {
1224
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
1236
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
1225
1237
  format: 'uuid',
1226
1238
  type: 'string',
1227
1239
  },
@@ -1287,28 +1299,28 @@ export default {
1287
1299
  description: 'Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
1288
1300
  properties: {
1289
1301
  acs_encoder_id: {
1290
- description: 'ID of the `acs_encoder`.',
1302
+ description: 'ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.',
1291
1303
  format: 'uuid',
1292
1304
  type: 'string',
1293
1305
  },
1294
1306
  acs_system_id: {
1295
- description: 'ID of the access control system that contains the `acs_encoder`.',
1307
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
1296
1308
  format: 'uuid',
1297
1309
  type: 'string',
1298
1310
  },
1299
1311
  created_at: {
1300
- description: 'Date and time at which the `acs_encoder` was created.',
1312
+ description: 'Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.',
1301
1313
  format: 'date-time',
1302
1314
  type: 'string',
1303
1315
  },
1304
1316
  display_name: {
1305
- description: 'Display name for the `acs_encoder`.',
1317
+ description: 'Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
1306
1318
  type: 'string',
1307
1319
  },
1308
1320
  errors: {
1309
- description: 'Errors associated with the `acs_encoder`.',
1321
+ description: 'Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
1310
1322
  items: {
1311
- description: 'Error associated with the `acs_encoder`.',
1323
+ description: 'Error associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
1312
1324
  properties: {
1313
1325
  created_at: {
1314
1326
  description: 'Date and time at which Seam created the error.',
@@ -1331,7 +1343,7 @@ export default {
1331
1343
  type: 'array',
1332
1344
  },
1333
1345
  workspace_id: {
1334
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
1346
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
1335
1347
  format: 'uuid',
1336
1348
  type: 'string',
1337
1349
  },
@@ -1351,16 +1363,17 @@ export default {
1351
1363
  description: 'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1352
1364
  properties: {
1353
1365
  acs_entrance_id: {
1354
- description: 'ID of the entrance.',
1366
+ description: 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1355
1367
  format: 'uuid',
1356
1368
  type: 'string',
1357
1369
  },
1358
1370
  acs_system_id: {
1359
- description: 'ID of the access control system that contains the entrance.',
1371
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1360
1372
  format: 'uuid',
1361
1373
  type: 'string',
1362
1374
  },
1363
1375
  assa_abloy_vostio_metadata: {
1376
+ description: 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1364
1377
  properties: {
1365
1378
  door_name: { type: 'string' },
1366
1379
  door_number: { format: 'float', type: 'number' },
@@ -1375,24 +1388,32 @@ export default {
1375
1388
  type: 'object',
1376
1389
  },
1377
1390
  created_at: {
1378
- description: 'Date and time at which the entrance was created.',
1391
+ description: 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
1379
1392
  format: 'date-time',
1380
1393
  type: 'string',
1381
1394
  },
1382
1395
  display_name: {
1383
- description: 'Display name for the entrance.',
1396
+ description: 'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1384
1397
  type: 'string',
1385
1398
  },
1386
1399
  dormakaba_community_metadata: {
1400
+ description: 'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1387
1401
  properties: { access_point_name: { type: 'string' } },
1388
1402
  required: ['access_point_name'],
1389
1403
  type: 'object',
1390
1404
  },
1391
1405
  errors: {
1406
+ description: 'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1392
1407
  items: {
1393
1408
  properties: {
1394
- error_code: { type: 'string' },
1395
- message: { type: 'string' },
1409
+ error_code: {
1410
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
1411
+ type: 'string',
1412
+ },
1413
+ message: {
1414
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
1415
+ type: 'string',
1416
+ },
1396
1417
  },
1397
1418
  required: ['error_code', 'message'],
1398
1419
  type: 'object',
@@ -1400,6 +1421,7 @@ export default {
1400
1421
  type: 'array',
1401
1422
  },
1402
1423
  latch_metadata: {
1424
+ description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1403
1425
  properties: {
1404
1426
  accessibility_type: { type: 'string' },
1405
1427
  door_name: { type: 'string' },
@@ -1415,6 +1437,7 @@ export default {
1415
1437
  type: 'object',
1416
1438
  },
1417
1439
  salto_ks_metadata: {
1440
+ description: 'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1418
1441
  properties: {
1419
1442
  battery_level: { type: 'string' },
1420
1443
  door_name: { type: 'string' },
@@ -1434,6 +1457,7 @@ export default {
1434
1457
  type: 'object',
1435
1458
  },
1436
1459
  salto_space_metadata: {
1460
+ description: 'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1437
1461
  properties: {
1438
1462
  door_description: { type: 'string' },
1439
1463
  door_name: { type: 'string' },
@@ -1443,6 +1467,7 @@ export default {
1443
1467
  type: 'object',
1444
1468
  },
1445
1469
  visionline_metadata: {
1470
+ description: 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1446
1471
  properties: {
1447
1472
  door_category: {
1448
1473
  enum: [
@@ -1491,58 +1516,57 @@ export default {
1491
1516
  description: 'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1492
1517
  properties: {
1493
1518
  acs_system_id: {
1494
- description: 'ID of the `acs_system`.',
1519
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1495
1520
  format: 'uuid',
1496
1521
  type: 'string',
1497
1522
  },
1498
1523
  can_add_acs_users_to_acs_access_groups: {
1499
- description: 'Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
1524
+ description: 'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
1500
1525
  type: 'boolean',
1501
1526
  },
1502
1527
  can_automate_enrollment: {
1503
- description: 'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.',
1528
+ description: 'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1504
1529
  type: 'boolean',
1505
1530
  },
1506
1531
  can_create_acs_access_groups: {
1507
- description: 'Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
1532
+ description: 'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
1508
1533
  type: 'boolean',
1509
1534
  },
1510
1535
  can_remove_acs_users_from_acs_access_groups: {
1511
- description: 'Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
1536
+ description: 'Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).',
1512
1537
  type: 'boolean',
1513
1538
  },
1514
1539
  connected_account_id: {
1515
- description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.',
1540
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1516
1541
  format: 'uuid',
1517
1542
  type: 'string',
1518
1543
  },
1519
1544
  connected_account_ids: {
1520
1545
  deprecated: true,
1521
- description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.',
1546
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1522
1547
  items: { format: 'uuid', type: 'string' },
1523
1548
  type: 'array',
1524
1549
  'x-deprecated': 'Use `connected_account_id`.',
1525
1550
  },
1526
1551
  created_at: {
1527
- description: 'Date and time at which the `acs_system` was created.',
1552
+ description: 'Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.',
1528
1553
  format: 'date-time',
1529
1554
  type: 'string',
1530
1555
  },
1531
1556
  default_credential_manager_acs_system_id: {
1532
- description: 'ID of the default credential manager acs_system for this access control system.',
1557
+ description: 'ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1533
1558
  format: 'uuid',
1534
1559
  nullable: true,
1535
1560
  type: 'string',
1536
- 'x-draft': 'Needs review',
1537
1561
  },
1538
1562
  errors: {
1539
- description: 'Errors associated with the `acs_system`.',
1563
+ description: 'Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1540
1564
  items: {
1541
- description: 'Error associated with the `acs_system`.',
1565
+ description: 'Error associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1542
1566
  discriminator: { propertyName: 'error_code' },
1543
1567
  oneOf: [
1544
1568
  {
1545
- description: 'Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
1569
+ description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).',
1546
1570
  properties: {
1547
1571
  created_at: {
1548
1572
  description: 'Date and time at which Seam created the error.',
@@ -1563,7 +1587,7 @@ export default {
1563
1587
  type: 'object',
1564
1588
  },
1565
1589
  {
1566
- description: 'Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
1590
+ description: 'Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).',
1567
1591
  properties: {
1568
1592
  created_at: {
1569
1593
  description: 'Date and time at which Seam created the error.',
@@ -1605,7 +1629,7 @@ export default {
1605
1629
  type: 'object',
1606
1630
  },
1607
1631
  {
1608
- description: 'Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
1632
+ description: 'Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue.',
1609
1633
  properties: {
1610
1634
  created_at: {
1611
1635
  description: 'Date and time at which Seam created the error.',
@@ -1626,7 +1650,7 @@ export default {
1626
1650
  type: 'object',
1627
1651
  },
1628
1652
  {
1629
- description: 'Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access.',
1653
+ description: 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.',
1630
1654
  properties: {
1631
1655
  created_at: {
1632
1656
  description: 'Date and time at which Seam created the error.',
@@ -1647,6 +1671,7 @@ export default {
1647
1671
  type: 'object',
1648
1672
  },
1649
1673
  {
1674
+ description: 'Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.',
1650
1675
  properties: {
1651
1676
  created_at: {
1652
1677
  description: 'Date and time at which Seam created the error.',
@@ -1654,7 +1679,7 @@ export default {
1654
1679
  type: 'string',
1655
1680
  },
1656
1681
  error_code: {
1657
- description: 'Indicates that the access system has lost its Salto KS certification. Please contact support to regain access.',
1682
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
1658
1683
  enum: ['salto_ks_certification_expired'],
1659
1684
  type: 'string',
1660
1685
  },
@@ -1671,7 +1696,7 @@ export default {
1671
1696
  type: 'array',
1672
1697
  },
1673
1698
  external_type: {
1674
- description: 'Brand-specific terminology for the `acs_system` type.',
1699
+ description: 'Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.',
1675
1700
  enum: [
1676
1701
  'pti_site',
1677
1702
  'alta_org',
@@ -1690,25 +1715,25 @@ export default {
1690
1715
  type: 'string',
1691
1716
  },
1692
1717
  external_type_display_name: {
1693
- description: 'Display name that corresponds to the brand-specific terminology for the `acs_system` type.',
1718
+ description: 'Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.',
1694
1719
  type: 'string',
1695
1720
  },
1696
1721
  image_alt_text: {
1697
- description: 'Alternative text for the `acs_system` image.',
1722
+ description: 'Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.',
1698
1723
  type: 'string',
1699
1724
  },
1700
1725
  image_url: {
1701
- description: 'URL for the image that represents the `acs_system`.',
1726
+ description: 'URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1702
1727
  type: 'string',
1703
1728
  },
1704
1729
  is_credential_manager: {
1705
- description: 'Indicates if the `acs_system` is a credential manager.',
1730
+ description: 'Indicates whether the `acs_system` is a credential manager.',
1706
1731
  type: 'boolean',
1707
1732
  },
1708
1733
  location: {
1709
1734
  properties: {
1710
1735
  time_zone: {
1711
- description: 'Time zone in which the `acs_system` is located.',
1736
+ description: 'Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.',
1712
1737
  nullable: true,
1713
1738
  type: 'string',
1714
1739
  },
@@ -1716,7 +1741,10 @@ export default {
1716
1741
  required: ['time_zone'],
1717
1742
  type: 'object',
1718
1743
  },
1719
- name: { description: 'Name of the `acs_system`.', type: 'string' },
1744
+ name: {
1745
+ description: 'Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1746
+ type: 'string',
1747
+ },
1720
1748
  system_type: {
1721
1749
  deprecated: true,
1722
1750
  enum: [
@@ -1745,7 +1773,7 @@ export default {
1745
1773
  visionline_metadata: {
1746
1774
  properties: {
1747
1775
  lan_address: {
1748
- description: 'IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.',
1776
+ description: 'IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network.',
1749
1777
  type: 'string',
1750
1778
  },
1751
1779
  mobile_access_uuid: {
@@ -1761,12 +1789,13 @@ export default {
1761
1789
  type: 'object',
1762
1790
  },
1763
1791
  warnings: {
1764
- description: 'Warnings associated with the `acs_system`.',
1792
+ description: 'Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1765
1793
  items: {
1766
- description: 'Warning associated with the `acs_system`.',
1794
+ description: 'Warning associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1767
1795
  discriminator: { propertyName: 'warning_code' },
1768
1796
  oneOf: [
1769
1797
  {
1798
+ description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.',
1770
1799
  properties: {
1771
1800
  created_at: {
1772
1801
  description: 'Date and time at which Seam created the warning.',
@@ -1778,7 +1807,7 @@ export default {
1778
1807
  type: 'string',
1779
1808
  },
1780
1809
  warning_code: {
1781
- description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
1810
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1782
1811
  enum: ['salto_ks_subscription_limit_almost_reached'],
1783
1812
  type: 'string',
1784
1813
  },
@@ -1787,6 +1816,7 @@ export default {
1787
1816
  type: 'object',
1788
1817
  },
1789
1818
  {
1819
+ description: 'Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
1790
1820
  properties: {
1791
1821
  created_at: {
1792
1822
  description: 'Date and time at which Seam created the warning.',
@@ -1802,7 +1832,7 @@ export default {
1802
1832
  type: 'array',
1803
1833
  },
1804
1834
  warning_code: {
1805
- description: 'Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.',
1835
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1806
1836
  enum: ['time_zone_does_not_match_location'],
1807
1837
  type: 'string',
1808
1838
  },
@@ -1815,7 +1845,7 @@ export default {
1815
1845
  type: 'array',
1816
1846
  },
1817
1847
  workspace_id: {
1818
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
1848
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1819
1849
  format: 'uuid',
1820
1850
  type: 'string',
1821
1851
  },
@@ -1841,7 +1871,7 @@ export default {
1841
1871
  description: 'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
1842
1872
  properties: {
1843
1873
  access_schedule: {
1844
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
1874
+ description: "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
1845
1875
  properties: {
1846
1876
  ends_at: {
1847
1877
  description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
@@ -1859,22 +1889,22 @@ export default {
1859
1889
  type: 'object',
1860
1890
  },
1861
1891
  acs_system_id: {
1862
- description: 'ID of the access control system that contains the `acs_user`.',
1892
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
1863
1893
  format: 'uuid',
1864
1894
  type: 'string',
1865
1895
  },
1866
1896
  acs_user_id: {
1867
- description: 'ID of the `acs_user`.',
1897
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
1868
1898
  format: 'uuid',
1869
1899
  type: 'string',
1870
1900
  },
1871
1901
  created_at: {
1872
- description: 'Date and time at which the `acs_user` was created.',
1902
+ description: 'Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
1873
1903
  format: 'date-time',
1874
1904
  type: 'string',
1875
1905
  },
1876
1906
  display_name: {
1877
- description: 'Display name for the `acs_user`.',
1907
+ description: 'Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
1878
1908
  type: 'string',
1879
1909
  },
1880
1910
  email: {
@@ -1884,18 +1914,18 @@ export default {
1884
1914
  'x-deprecated': 'use email_address.',
1885
1915
  },
1886
1916
  email_address: {
1887
- description: 'Email address of the `acs_user`.',
1917
+ description: 'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
1888
1918
  format: 'email',
1889
1919
  type: 'string',
1890
1920
  },
1891
1921
  errors: {
1892
- description: 'Errors associated with the `acs_user`.',
1922
+ description: 'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
1893
1923
  items: {
1894
- description: 'Error associated with the `acs_user`.',
1924
+ description: 'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
1895
1925
  discriminator: { propertyName: 'error_code' },
1896
1926
  oneOf: [
1897
1927
  {
1898
- description: 'Indicates that the ACS user was deleted from the ACS system outside of Seam.',
1928
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.',
1899
1929
  properties: {
1900
1930
  created_at: {
1901
1931
  description: 'Date and time at which Seam created the error.',
@@ -1915,7 +1945,7 @@ export default {
1915
1945
  type: 'object',
1916
1946
  },
1917
1947
  {
1918
- description: 'Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.',
1948
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.',
1919
1949
  properties: {
1920
1950
  created_at: {
1921
1951
  description: 'Date and time at which Seam created the error.',
@@ -1935,7 +1965,7 @@ export default {
1935
1965
  type: 'object',
1936
1966
  },
1937
1967
  {
1938
- description: "Indicates that the user was not created on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
1968
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
1939
1969
  properties: {
1940
1970
  created_at: {
1941
1971
  description: 'Date and time at which Seam created the error.',
@@ -1955,7 +1985,7 @@ export default {
1955
1985
  type: 'object',
1956
1986
  },
1957
1987
  {
1958
- description: "Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
1988
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
1959
1989
  properties: {
1960
1990
  created_at: {
1961
1991
  description: 'Date and time at which Seam created the error.',
@@ -1975,7 +2005,7 @@ export default {
1975
2005
  type: 'object',
1976
2006
  },
1977
2007
  {
1978
- description: "Indicates that the user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
2008
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
1979
2009
  properties: {
1980
2010
  created_at: {
1981
2011
  description: 'Date and time at which Seam created the error.',
@@ -1999,7 +2029,7 @@ export default {
1999
2029
  type: 'array',
2000
2030
  },
2001
2031
  external_type: {
2002
- description: 'Brand-specific terminology for the `acs_user` type.',
2032
+ description: 'Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
2003
2033
  enum: [
2004
2034
  'pti_user',
2005
2035
  'brivo_user',
@@ -2012,11 +2042,11 @@ export default {
2012
2042
  type: 'string',
2013
2043
  },
2014
2044
  external_type_display_name: {
2015
- description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
2045
+ description: 'Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
2016
2046
  type: 'string',
2017
2047
  },
2018
2048
  full_name: {
2019
- description: 'Full name of the `acs_user`.',
2049
+ description: 'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2020
2050
  type: 'string',
2021
2051
  },
2022
2052
  hid_acs_system_id: { format: 'uuid', type: 'string' },
@@ -2027,7 +2057,7 @@ export default {
2027
2057
  },
2028
2058
  is_managed: { enum: [true], type: 'boolean' },
2029
2059
  is_suspended: {
2030
- description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
2060
+ description: 'Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
2031
2061
  type: 'boolean',
2032
2062
  },
2033
2063
  latest_desired_state_synced_with_provider_at: {
@@ -2037,49 +2067,63 @@ export default {
2037
2067
  'x-undocumented': 'Only used internally.',
2038
2068
  },
2039
2069
  phone_number: {
2040
- description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
2070
+ description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
2041
2071
  type: 'string',
2042
2072
  },
2043
2073
  user_identity_email_address: {
2044
- description: 'Email address of the user identity associated with the `acs_user`.',
2074
+ description: 'Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2045
2075
  nullable: true,
2046
2076
  type: 'string',
2047
2077
  },
2048
2078
  user_identity_full_name: {
2049
- description: 'Full name of the user identity associated with the `acs_user`.',
2079
+ description: 'Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2050
2080
  nullable: true,
2051
2081
  type: 'string',
2052
2082
  },
2053
2083
  user_identity_id: {
2054
- description: 'ID of the user identity associated with the `acs_user`.',
2084
+ description: 'ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2055
2085
  type: 'string',
2056
2086
  },
2057
2087
  user_identity_phone_number: {
2058
- description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
2088
+ description: 'Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
2059
2089
  nullable: true,
2060
2090
  type: 'string',
2061
2091
  },
2062
2092
  warnings: {
2063
- description: 'Warnings associated with the `acs_user`.',
2093
+ description: 'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2064
2094
  items: {
2065
- description: 'Warning associated with the `acs_user`.',
2095
+ description: 'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2066
2096
  discriminator: { propertyName: 'warning_code' },
2067
2097
  oneOf: [
2068
2098
  {
2069
- description: 'Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.',
2099
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.',
2070
2100
  properties: {
2071
- created_at: { format: 'date-time', type: 'string' },
2072
- message: { type: 'string' },
2101
+ created_at: {
2102
+ description: 'Date and time at which Seam created the warning.',
2103
+ format: 'date-time',
2104
+ type: 'string',
2105
+ },
2106
+ message: {
2107
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2108
+ type: 'string',
2109
+ },
2073
2110
  warning_code: { enum: ['being_deleted'], type: 'string' },
2074
2111
  },
2075
2112
  required: ['created_at', 'message', 'warning_code'],
2076
2113
  type: 'object',
2077
2114
  },
2078
2115
  {
2079
- description: 'Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn’t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.',
2116
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.',
2080
2117
  properties: {
2081
- created_at: { format: 'date-time', type: 'string' },
2082
- message: { type: 'string' },
2118
+ created_at: {
2119
+ description: 'Date and time at which Seam created the warning.',
2120
+ format: 'date-time',
2121
+ type: 'string',
2122
+ },
2123
+ message: {
2124
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2125
+ type: 'string',
2126
+ },
2083
2127
  warning_code: {
2084
2128
  enum: ['salto_ks_user_not_subscribed'],
2085
2129
  type: 'string',
@@ -2089,10 +2133,17 @@ export default {
2089
2133
  type: 'object',
2090
2134
  },
2091
2135
  {
2092
- description: 'An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.',
2136
+ description: 'An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.',
2093
2137
  properties: {
2094
- created_at: { format: 'date-time', type: 'string' },
2095
- message: { type: 'string' },
2138
+ created_at: {
2139
+ description: 'Date and time at which Seam created the warning.',
2140
+ format: 'date-time',
2141
+ type: 'string',
2142
+ },
2143
+ message: {
2144
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
2145
+ type: 'string',
2146
+ },
2096
2147
  warning_code: {
2097
2148
  enum: ['unknown_issue_with_acs_user'],
2098
2149
  type: 'string',
@@ -2106,7 +2157,7 @@ export default {
2106
2157
  type: 'array',
2107
2158
  },
2108
2159
  workspace_id: {
2109
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
2160
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
2110
2161
  format: 'uuid',
2111
2162
  type: 'string',
2112
2163
  },
@@ -2319,56 +2370,84 @@ export default {
2319
2370
  nullable: true,
2320
2371
  properties: {
2321
2372
  card_number: {
2322
- description: 'A number or string that physically identifies this card.',
2373
+ description: 'A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2323
2374
  nullable: true,
2324
2375
  type: 'string',
2325
2376
  },
2326
2377
  created_at: {
2327
- description: 'Date and time the credential was created.',
2378
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
2328
2379
  format: 'date-time',
2329
2380
  nullable: true,
2330
2381
  type: 'string',
2331
2382
  },
2332
2383
  ends_at: {
2333
- description: 'Date and time the credential will stop being useable.',
2384
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable.',
2334
2385
  format: 'date-time',
2335
2386
  nullable: true,
2336
2387
  type: 'string',
2337
2388
  },
2338
2389
  is_issued: { nullable: true, type: 'boolean' },
2339
2390
  starts_at: {
2340
- description: 'Date and time the credential will become useable.',
2391
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable.',
2341
2392
  format: 'date-time',
2342
2393
  nullable: true,
2343
2394
  type: 'string',
2344
2395
  },
2345
2396
  visionline_metadata: {
2346
- description: 'Visionline-specific metadata for the credential.',
2397
+ description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2347
2398
  properties: {
2348
- cancelled: { type: 'boolean' },
2399
+ cancelled: {
2400
+ description: 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled.',
2401
+ type: 'boolean',
2402
+ },
2349
2403
  card_format: {
2404
+ description: 'Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2350
2405
  enum: ['TLCode', 'rfid48'],
2351
2406
  type: 'string',
2352
2407
  },
2353
- card_holder: { type: 'string' },
2354
- card_id: { type: 'string' },
2408
+ card_holder: {
2409
+ description: 'Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2410
+ type: 'string',
2411
+ },
2412
+ card_id: {
2413
+ description: 'Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2414
+ type: 'string',
2415
+ },
2355
2416
  common_acs_entrance_ids: {
2417
+ description: 'IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2356
2418
  items: { format: 'uuid', type: 'string' },
2357
2419
  type: 'array',
2358
2420
  },
2359
- discarded: { type: 'boolean' },
2360
- expired: { type: 'boolean' },
2421
+ discarded: {
2422
+ description: 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded.',
2423
+ type: 'boolean',
2424
+ },
2425
+ expired: {
2426
+ description: 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired.',
2427
+ type: 'boolean',
2428
+ },
2361
2429
  guest_acs_entrance_ids: {
2430
+ description: 'IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2362
2431
  items: { format: 'uuid', type: 'string' },
2363
2432
  type: 'array',
2364
2433
  },
2365
2434
  number_of_issued_cards: {
2435
+ description: 'Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2366
2436
  format: 'float',
2367
2437
  type: 'number',
2368
2438
  },
2369
- overridden: { type: 'boolean' },
2370
- overwritten: { type: 'boolean' },
2371
- pending_auto_update: { type: 'boolean' },
2439
+ overridden: {
2440
+ description: 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden.',
2441
+ type: 'boolean',
2442
+ },
2443
+ overwritten: {
2444
+ description: 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten.',
2445
+ type: 'boolean',
2446
+ },
2447
+ pending_auto_update: {
2448
+ description: 'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update.',
2449
+ type: 'boolean',
2450
+ },
2372
2451
  },
2373
2452
  required: [
2374
2453
  'card_id',
@@ -2397,15 +2476,15 @@ export default {
2397
2476
  nullable: true,
2398
2477
  oneOf: [
2399
2478
  {
2400
- description: 'Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
2479
+ description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
2401
2480
  properties: {
2402
2481
  access_method: {
2403
- description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
2482
+ description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
2404
2483
  enum: ['code', 'card', 'mobile_key'],
2405
2484
  type: 'string',
2406
2485
  },
2407
2486
  acs_credential_id: {
2408
- description: 'ID of the credential.',
2487
+ description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2409
2488
  format: 'uuid',
2410
2489
  type: 'string',
2411
2490
  },
@@ -2414,17 +2493,17 @@ export default {
2414
2493
  type: 'string',
2415
2494
  },
2416
2495
  acs_system_id: {
2417
- description: 'ID of the access control system that contains the credential.',
2496
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2418
2497
  format: 'uuid',
2419
2498
  type: 'string',
2420
2499
  },
2421
2500
  acs_user_id: {
2422
- description: 'ID of the ACS user to whom the credential belongs.',
2501
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
2423
2502
  format: 'uuid',
2424
2503
  type: 'string',
2425
2504
  },
2426
2505
  assa_abloy_vostio_metadata: {
2427
- description: 'Vostio-specific metadata for the credential.',
2506
+ description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2428
2507
  properties: {
2429
2508
  door_names: {
2430
2509
  items: { type: 'string' },
@@ -2440,28 +2519,32 @@ export default {
2440
2519
  },
2441
2520
  type: 'object',
2442
2521
  },
2443
- card_number: { nullable: true, type: 'string' },
2522
+ card_number: {
2523
+ description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2524
+ nullable: true,
2525
+ type: 'string',
2526
+ },
2444
2527
  code: {
2445
- description: 'Access (PIN) code for the credential.',
2528
+ description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2446
2529
  nullable: true,
2447
2530
  type: 'string',
2448
2531
  },
2449
2532
  created_at: {
2450
- description: 'Date and time at which the credential was created.',
2533
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
2451
2534
  format: 'date-time',
2452
2535
  type: 'string',
2453
2536
  },
2454
2537
  display_name: {
2455
- description: 'Display name that corresponds to the credential type.',
2538
+ description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
2456
2539
  minLength: 1,
2457
2540
  type: 'string',
2458
2541
  },
2459
2542
  ends_at: {
2460
- description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
2543
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
2461
2544
  type: 'string',
2462
2545
  },
2463
2546
  errors: {
2464
- description: 'Errors associated with the `acs_credential`.',
2547
+ description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2465
2548
  items: {
2466
2549
  properties: {
2467
2550
  error_code: { type: 'string' },
@@ -2473,7 +2556,7 @@ export default {
2473
2556
  type: 'array',
2474
2557
  },
2475
2558
  external_type: {
2476
- description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
2559
+ description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
2477
2560
  enum: [
2478
2561
  'pti_card',
2479
2562
  'brivo_credential',
@@ -2486,46 +2569,50 @@ export default {
2486
2569
  type: 'string',
2487
2570
  },
2488
2571
  external_type_display_name: {
2489
- description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
2572
+ description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
2490
2573
  type: 'string',
2491
2574
  },
2492
- is_issued: { type: 'boolean' },
2575
+ is_issued: {
2576
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
2577
+ type: 'boolean',
2578
+ },
2493
2579
  is_latest_desired_state_synced_with_provider: {
2494
- description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
2580
+ description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
2495
2581
  nullable: true,
2496
2582
  type: 'boolean',
2497
2583
  },
2498
2584
  is_managed: { enum: [true], type: 'boolean' },
2499
2585
  is_multi_phone_sync_credential: {
2500
- description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
2586
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
2501
2587
  type: 'boolean',
2502
2588
  },
2503
2589
  is_one_time_use: {
2504
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
2590
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
2505
2591
  type: 'boolean',
2506
2592
  },
2507
2593
  issued_at: {
2594
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
2508
2595
  format: 'date-time',
2509
2596
  nullable: true,
2510
2597
  type: 'string',
2511
2598
  },
2512
2599
  latest_desired_state_synced_with_provider_at: {
2513
- description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
2600
+ description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
2514
2601
  format: 'date-time',
2515
2602
  nullable: true,
2516
2603
  type: 'string',
2517
2604
  },
2518
2605
  parent_acs_credential_id: {
2519
- description: 'ID of the parent credential.',
2606
+ description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2520
2607
  format: 'uuid',
2521
2608
  type: 'string',
2522
2609
  },
2523
2610
  starts_at: {
2524
- description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
2611
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
2525
2612
  type: 'string',
2526
2613
  },
2527
2614
  visionline_metadata: {
2528
- description: 'Visionline-specific metadata for the credential.',
2615
+ description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2529
2616
  properties: {
2530
2617
  auto_join: { type: 'boolean' },
2531
2618
  card_function_type: {
@@ -2552,13 +2639,13 @@ export default {
2552
2639
  type: 'object',
2553
2640
  },
2554
2641
  warnings: {
2555
- description: 'Warnings associated with the `acs_credential`.',
2642
+ description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2556
2643
  items: {
2557
- description: 'Warning associated with the `acs_credential`.',
2644
+ description: 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2558
2645
  discriminator: { propertyName: 'warning_code' },
2559
2646
  oneOf: [
2560
2647
  {
2561
- description: 'Indicates that the credential is waiting to be issued.',
2648
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
2562
2649
  properties: {
2563
2650
  created_at: {
2564
2651
  description: 'Date and time at which Seam created the warning.',
@@ -2583,7 +2670,7 @@ export default {
2583
2670
  type: 'object',
2584
2671
  },
2585
2672
  {
2586
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
2673
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
2587
2674
  properties: {
2588
2675
  created_at: {
2589
2676
  description: 'Date and time at which Seam created the warning.',
@@ -2608,7 +2695,7 @@ export default {
2608
2695
  type: 'object',
2609
2696
  },
2610
2697
  {
2611
- description: 'Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.',
2698
+ description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
2612
2699
  properties: {
2613
2700
  created_at: {
2614
2701
  description: 'Date and time at which Seam created the warning.',
@@ -2633,7 +2720,7 @@ export default {
2633
2720
  type: 'object',
2634
2721
  },
2635
2722
  {
2636
- description: 'Indicates that this credential is being deleted.',
2723
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
2637
2724
  properties: {
2638
2725
  created_at: {
2639
2726
  description: 'Date and time at which Seam created the warning.',
@@ -2658,7 +2745,7 @@ export default {
2658
2745
  type: 'object',
2659
2746
  },
2660
2747
  {
2661
- description: 'An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.',
2748
+ description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
2662
2749
  properties: {
2663
2750
  created_at: {
2664
2751
  description: 'Date and time at which Seam created the warning.',
@@ -2685,7 +2772,7 @@ export default {
2685
2772
  type: 'object',
2686
2773
  },
2687
2774
  {
2688
- description: 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
2775
+ description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
2689
2776
  properties: {
2690
2777
  created_at: {
2691
2778
  description: 'Date and time at which Seam created the warning.',
@@ -2714,7 +2801,7 @@ export default {
2714
2801
  type: 'array',
2715
2802
  },
2716
2803
  workspace_id: {
2717
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
2804
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2718
2805
  format: 'uuid',
2719
2806
  type: 'string',
2720
2807
  },
@@ -2734,15 +2821,15 @@ export default {
2734
2821
  'x-route-path': '/acs/credentials',
2735
2822
  },
2736
2823
  {
2737
- description: 'Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
2824
+ description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
2738
2825
  properties: {
2739
2826
  access_method: {
2740
- description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
2827
+ description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
2741
2828
  enum: ['code', 'card', 'mobile_key'],
2742
2829
  type: 'string',
2743
2830
  },
2744
2831
  acs_credential_id: {
2745
- description: 'ID of the credential.',
2832
+ description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2746
2833
  format: 'uuid',
2747
2834
  type: 'string',
2748
2835
  },
@@ -2751,17 +2838,17 @@ export default {
2751
2838
  type: 'string',
2752
2839
  },
2753
2840
  acs_system_id: {
2754
- description: 'ID of the access control system that contains the credential.',
2841
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2755
2842
  format: 'uuid',
2756
2843
  type: 'string',
2757
2844
  },
2758
2845
  acs_user_id: {
2759
- description: 'ID of the ACS user to whom the credential belongs.',
2846
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
2760
2847
  format: 'uuid',
2761
2848
  type: 'string',
2762
2849
  },
2763
2850
  assa_abloy_vostio_metadata: {
2764
- description: 'Vostio-specific metadata for the credential.',
2851
+ description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2765
2852
  properties: {
2766
2853
  door_names: {
2767
2854
  items: { type: 'string' },
@@ -2777,28 +2864,32 @@ export default {
2777
2864
  },
2778
2865
  type: 'object',
2779
2866
  },
2780
- card_number: { nullable: true, type: 'string' },
2867
+ card_number: {
2868
+ description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2869
+ nullable: true,
2870
+ type: 'string',
2871
+ },
2781
2872
  code: {
2782
- description: 'Access (PIN) code for the credential.',
2873
+ description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2783
2874
  nullable: true,
2784
2875
  type: 'string',
2785
2876
  },
2786
2877
  created_at: {
2787
- description: 'Date and time at which the credential was created.',
2878
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
2788
2879
  format: 'date-time',
2789
2880
  type: 'string',
2790
2881
  },
2791
2882
  display_name: {
2792
- description: 'Display name that corresponds to the credential type.',
2883
+ description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
2793
2884
  minLength: 1,
2794
2885
  type: 'string',
2795
2886
  },
2796
2887
  ends_at: {
2797
- description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
2888
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
2798
2889
  type: 'string',
2799
2890
  },
2800
2891
  errors: {
2801
- description: 'Errors associated with the `acs_credential`.',
2892
+ description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2802
2893
  items: {
2803
2894
  properties: {
2804
2895
  error_code: { type: 'string' },
@@ -2810,7 +2901,7 @@ export default {
2810
2901
  type: 'array',
2811
2902
  },
2812
2903
  external_type: {
2813
- description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
2904
+ description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
2814
2905
  enum: [
2815
2906
  'pti_card',
2816
2907
  'brivo_credential',
@@ -2823,46 +2914,50 @@ export default {
2823
2914
  type: 'string',
2824
2915
  },
2825
2916
  external_type_display_name: {
2826
- description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
2917
+ description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
2827
2918
  type: 'string',
2828
2919
  },
2829
- is_issued: { type: 'boolean' },
2920
+ is_issued: {
2921
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
2922
+ type: 'boolean',
2923
+ },
2830
2924
  is_latest_desired_state_synced_with_provider: {
2831
- description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
2925
+ description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
2832
2926
  nullable: true,
2833
2927
  type: 'boolean',
2834
2928
  },
2835
2929
  is_managed: { enum: [false], type: 'boolean' },
2836
2930
  is_multi_phone_sync_credential: {
2837
- description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
2931
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
2838
2932
  type: 'boolean',
2839
2933
  },
2840
2934
  is_one_time_use: {
2841
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
2935
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
2842
2936
  type: 'boolean',
2843
2937
  },
2844
2938
  issued_at: {
2939
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
2845
2940
  format: 'date-time',
2846
2941
  nullable: true,
2847
2942
  type: 'string',
2848
2943
  },
2849
2944
  latest_desired_state_synced_with_provider_at: {
2850
- description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
2945
+ description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
2851
2946
  format: 'date-time',
2852
2947
  nullable: true,
2853
2948
  type: 'string',
2854
2949
  },
2855
2950
  parent_acs_credential_id: {
2856
- description: 'ID of the parent credential.',
2951
+ description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2857
2952
  format: 'uuid',
2858
2953
  type: 'string',
2859
2954
  },
2860
2955
  starts_at: {
2861
- description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
2956
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
2862
2957
  type: 'string',
2863
2958
  },
2864
2959
  visionline_metadata: {
2865
- description: 'Visionline-specific metadata for the credential.',
2960
+ description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2866
2961
  properties: {
2867
2962
  auto_join: { type: 'boolean' },
2868
2963
  card_function_type: {
@@ -2889,13 +2984,13 @@ export default {
2889
2984
  type: 'object',
2890
2985
  },
2891
2986
  warnings: {
2892
- description: 'Warnings associated with the `acs_credential`.',
2987
+ description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2893
2988
  items: {
2894
- description: 'Warning associated with the `acs_credential`.',
2989
+ description: 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
2895
2990
  discriminator: { propertyName: 'warning_code' },
2896
2991
  oneOf: [
2897
2992
  {
2898
- description: 'Indicates that the credential is waiting to be issued.',
2993
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
2899
2994
  properties: {
2900
2995
  created_at: {
2901
2996
  description: 'Date and time at which Seam created the warning.',
@@ -2920,7 +3015,7 @@ export default {
2920
3015
  type: 'object',
2921
3016
  },
2922
3017
  {
2923
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
3018
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
2924
3019
  properties: {
2925
3020
  created_at: {
2926
3021
  description: 'Date and time at which Seam created the warning.',
@@ -2945,7 +3040,7 @@ export default {
2945
3040
  type: 'object',
2946
3041
  },
2947
3042
  {
2948
- description: 'Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.',
3043
+ description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
2949
3044
  properties: {
2950
3045
  created_at: {
2951
3046
  description: 'Date and time at which Seam created the warning.',
@@ -2970,7 +3065,7 @@ export default {
2970
3065
  type: 'object',
2971
3066
  },
2972
3067
  {
2973
- description: 'Indicates that this credential is being deleted.',
3068
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
2974
3069
  properties: {
2975
3070
  created_at: {
2976
3071
  description: 'Date and time at which Seam created the warning.',
@@ -2995,7 +3090,7 @@ export default {
2995
3090
  type: 'object',
2996
3091
  },
2997
3092
  {
2998
- description: 'An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.',
3093
+ description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
2999
3094
  properties: {
3000
3095
  created_at: {
3001
3096
  description: 'Date and time at which Seam created the warning.',
@@ -3022,7 +3117,7 @@ export default {
3022
3117
  type: 'object',
3023
3118
  },
3024
3119
  {
3025
- description: 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
3120
+ description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
3026
3121
  properties: {
3027
3122
  created_at: {
3028
3123
  description: 'Date and time at which Seam created the warning.',
@@ -3051,7 +3146,7 @@ export default {
3051
3146
  type: 'array',
3052
3147
  },
3053
3148
  workspace_id: {
3054
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
3149
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3055
3150
  format: 'uuid',
3056
3151
  type: 'string',
3057
3152
  },
@@ -3200,18 +3295,18 @@ export default {
3200
3295
  action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
3201
3296
  error: { nullable: true },
3202
3297
  result: {
3203
- description: 'Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
3298
+ description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
3204
3299
  oneOf: [
3205
3300
  {
3206
- description: 'Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
3301
+ description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
3207
3302
  properties: {
3208
3303
  access_method: {
3209
- description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
3304
+ description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
3210
3305
  enum: ['code', 'card', 'mobile_key'],
3211
3306
  type: 'string',
3212
3307
  },
3213
3308
  acs_credential_id: {
3214
- description: 'ID of the credential.',
3309
+ description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3215
3310
  format: 'uuid',
3216
3311
  type: 'string',
3217
3312
  },
@@ -3220,17 +3315,17 @@ export default {
3220
3315
  type: 'string',
3221
3316
  },
3222
3317
  acs_system_id: {
3223
- description: 'ID of the access control system that contains the credential.',
3318
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3224
3319
  format: 'uuid',
3225
3320
  type: 'string',
3226
3321
  },
3227
3322
  acs_user_id: {
3228
- description: 'ID of the ACS user to whom the credential belongs.',
3323
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
3229
3324
  format: 'uuid',
3230
3325
  type: 'string',
3231
3326
  },
3232
3327
  assa_abloy_vostio_metadata: {
3233
- description: 'Vostio-specific metadata for the credential.',
3328
+ description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3234
3329
  properties: {
3235
3330
  door_names: {
3236
3331
  items: { type: 'string' },
@@ -3246,28 +3341,32 @@ export default {
3246
3341
  },
3247
3342
  type: 'object',
3248
3343
  },
3249
- card_number: { nullable: true, type: 'string' },
3344
+ card_number: {
3345
+ description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3346
+ nullable: true,
3347
+ type: 'string',
3348
+ },
3250
3349
  code: {
3251
- description: 'Access (PIN) code for the credential.',
3350
+ description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3252
3351
  nullable: true,
3253
3352
  type: 'string',
3254
3353
  },
3255
3354
  created_at: {
3256
- description: 'Date and time at which the credential was created.',
3355
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
3257
3356
  format: 'date-time',
3258
3357
  type: 'string',
3259
3358
  },
3260
3359
  display_name: {
3261
- description: 'Display name that corresponds to the credential type.',
3360
+ description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
3262
3361
  minLength: 1,
3263
3362
  type: 'string',
3264
3363
  },
3265
3364
  ends_at: {
3266
- description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
3365
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
3267
3366
  type: 'string',
3268
3367
  },
3269
3368
  errors: {
3270
- description: 'Errors associated with the `acs_credential`.',
3369
+ description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3271
3370
  items: {
3272
3371
  properties: {
3273
3372
  error_code: { type: 'string' },
@@ -3279,7 +3378,7 @@ export default {
3279
3378
  type: 'array',
3280
3379
  },
3281
3380
  external_type: {
3282
- description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
3381
+ description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
3283
3382
  enum: [
3284
3383
  'pti_card',
3285
3384
  'brivo_credential',
@@ -3292,46 +3391,50 @@ export default {
3292
3391
  type: 'string',
3293
3392
  },
3294
3393
  external_type_display_name: {
3295
- description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
3394
+ description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
3296
3395
  type: 'string',
3297
3396
  },
3298
- is_issued: { type: 'boolean' },
3397
+ is_issued: {
3398
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
3399
+ type: 'boolean',
3400
+ },
3299
3401
  is_latest_desired_state_synced_with_provider: {
3300
- description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
3402
+ description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
3301
3403
  nullable: true,
3302
3404
  type: 'boolean',
3303
3405
  },
3304
3406
  is_managed: { enum: [true], type: 'boolean' },
3305
3407
  is_multi_phone_sync_credential: {
3306
- description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
3408
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
3307
3409
  type: 'boolean',
3308
3410
  },
3309
3411
  is_one_time_use: {
3310
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
3412
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
3311
3413
  type: 'boolean',
3312
3414
  },
3313
3415
  issued_at: {
3416
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
3314
3417
  format: 'date-time',
3315
3418
  nullable: true,
3316
3419
  type: 'string',
3317
3420
  },
3318
3421
  latest_desired_state_synced_with_provider_at: {
3319
- description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
3422
+ description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
3320
3423
  format: 'date-time',
3321
3424
  nullable: true,
3322
3425
  type: 'string',
3323
3426
  },
3324
3427
  parent_acs_credential_id: {
3325
- description: 'ID of the parent credential.',
3428
+ description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3326
3429
  format: 'uuid',
3327
3430
  type: 'string',
3328
3431
  },
3329
3432
  starts_at: {
3330
- description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
3433
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
3331
3434
  type: 'string',
3332
3435
  },
3333
3436
  visionline_metadata: {
3334
- description: 'Visionline-specific metadata for the credential.',
3437
+ description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3335
3438
  properties: {
3336
3439
  auto_join: { type: 'boolean' },
3337
3440
  card_function_type: {
@@ -3358,13 +3461,13 @@ export default {
3358
3461
  type: 'object',
3359
3462
  },
3360
3463
  warnings: {
3361
- description: 'Warnings associated with the `acs_credential`.',
3464
+ description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3362
3465
  items: {
3363
- description: 'Warning associated with the `acs_credential`.',
3466
+ description: 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3364
3467
  discriminator: { propertyName: 'warning_code' },
3365
3468
  oneOf: [
3366
3469
  {
3367
- description: 'Indicates that the credential is waiting to be issued.',
3470
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
3368
3471
  properties: {
3369
3472
  created_at: {
3370
3473
  description: 'Date and time at which Seam created the warning.',
@@ -3389,7 +3492,7 @@ export default {
3389
3492
  type: 'object',
3390
3493
  },
3391
3494
  {
3392
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
3495
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
3393
3496
  properties: {
3394
3497
  created_at: {
3395
3498
  description: 'Date and time at which Seam created the warning.',
@@ -3414,7 +3517,7 @@ export default {
3414
3517
  type: 'object',
3415
3518
  },
3416
3519
  {
3417
- description: 'Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.',
3520
+ description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
3418
3521
  properties: {
3419
3522
  created_at: {
3420
3523
  description: 'Date and time at which Seam created the warning.',
@@ -3439,7 +3542,7 @@ export default {
3439
3542
  type: 'object',
3440
3543
  },
3441
3544
  {
3442
- description: 'Indicates that this credential is being deleted.',
3545
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
3443
3546
  properties: {
3444
3547
  created_at: {
3445
3548
  description: 'Date and time at which Seam created the warning.',
@@ -3464,7 +3567,7 @@ export default {
3464
3567
  type: 'object',
3465
3568
  },
3466
3569
  {
3467
- description: 'An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.',
3570
+ description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
3468
3571
  properties: {
3469
3572
  created_at: {
3470
3573
  description: 'Date and time at which Seam created the warning.',
@@ -3489,7 +3592,7 @@ export default {
3489
3592
  type: 'object',
3490
3593
  },
3491
3594
  {
3492
- description: 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
3595
+ description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
3493
3596
  properties: {
3494
3597
  created_at: {
3495
3598
  description: 'Date and time at which Seam created the warning.',
@@ -3518,7 +3621,7 @@ export default {
3518
3621
  type: 'array',
3519
3622
  },
3520
3623
  workspace_id: {
3521
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
3624
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3522
3625
  format: 'uuid',
3523
3626
  type: 'string',
3524
3627
  },
@@ -3538,15 +3641,15 @@ export default {
3538
3641
  'x-route-path': '/acs/credentials',
3539
3642
  },
3540
3643
  {
3541
- description: 'Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
3644
+ description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
3542
3645
  properties: {
3543
3646
  access_method: {
3544
- description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
3647
+ description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
3545
3648
  enum: ['code', 'card', 'mobile_key'],
3546
3649
  type: 'string',
3547
3650
  },
3548
3651
  acs_credential_id: {
3549
- description: 'ID of the credential.',
3652
+ description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3550
3653
  format: 'uuid',
3551
3654
  type: 'string',
3552
3655
  },
@@ -3555,17 +3658,17 @@ export default {
3555
3658
  type: 'string',
3556
3659
  },
3557
3660
  acs_system_id: {
3558
- description: 'ID of the access control system that contains the credential.',
3661
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3559
3662
  format: 'uuid',
3560
3663
  type: 'string',
3561
3664
  },
3562
3665
  acs_user_id: {
3563
- description: 'ID of the ACS user to whom the credential belongs.',
3666
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
3564
3667
  format: 'uuid',
3565
3668
  type: 'string',
3566
3669
  },
3567
3670
  assa_abloy_vostio_metadata: {
3568
- description: 'Vostio-specific metadata for the credential.',
3671
+ description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3569
3672
  properties: {
3570
3673
  door_names: {
3571
3674
  items: { type: 'string' },
@@ -3581,28 +3684,32 @@ export default {
3581
3684
  },
3582
3685
  type: 'object',
3583
3686
  },
3584
- card_number: { nullable: true, type: 'string' },
3687
+ card_number: {
3688
+ description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3689
+ nullable: true,
3690
+ type: 'string',
3691
+ },
3585
3692
  code: {
3586
- description: 'Access (PIN) code for the credential.',
3693
+ description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3587
3694
  nullable: true,
3588
3695
  type: 'string',
3589
3696
  },
3590
3697
  created_at: {
3591
- description: 'Date and time at which the credential was created.',
3698
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
3592
3699
  format: 'date-time',
3593
3700
  type: 'string',
3594
3701
  },
3595
3702
  display_name: {
3596
- description: 'Display name that corresponds to the credential type.',
3703
+ description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
3597
3704
  minLength: 1,
3598
3705
  type: 'string',
3599
3706
  },
3600
3707
  ends_at: {
3601
- description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
3708
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
3602
3709
  type: 'string',
3603
3710
  },
3604
3711
  errors: {
3605
- description: 'Errors associated with the `acs_credential`.',
3712
+ description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3606
3713
  items: {
3607
3714
  properties: {
3608
3715
  error_code: { type: 'string' },
@@ -3614,7 +3721,7 @@ export default {
3614
3721
  type: 'array',
3615
3722
  },
3616
3723
  external_type: {
3617
- description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
3724
+ description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
3618
3725
  enum: [
3619
3726
  'pti_card',
3620
3727
  'brivo_credential',
@@ -3627,46 +3734,50 @@ export default {
3627
3734
  type: 'string',
3628
3735
  },
3629
3736
  external_type_display_name: {
3630
- description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
3737
+ description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
3631
3738
  type: 'string',
3632
3739
  },
3633
- is_issued: { type: 'boolean' },
3740
+ is_issued: {
3741
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
3742
+ type: 'boolean',
3743
+ },
3634
3744
  is_latest_desired_state_synced_with_provider: {
3635
- description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
3745
+ description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
3636
3746
  nullable: true,
3637
3747
  type: 'boolean',
3638
3748
  },
3639
3749
  is_managed: { enum: [false], type: 'boolean' },
3640
3750
  is_multi_phone_sync_credential: {
3641
- description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
3751
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
3642
3752
  type: 'boolean',
3643
3753
  },
3644
3754
  is_one_time_use: {
3645
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
3755
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
3646
3756
  type: 'boolean',
3647
3757
  },
3648
3758
  issued_at: {
3759
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
3649
3760
  format: 'date-time',
3650
3761
  nullable: true,
3651
3762
  type: 'string',
3652
3763
  },
3653
3764
  latest_desired_state_synced_with_provider_at: {
3654
- description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
3765
+ description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
3655
3766
  format: 'date-time',
3656
3767
  nullable: true,
3657
3768
  type: 'string',
3658
3769
  },
3659
3770
  parent_acs_credential_id: {
3660
- description: 'ID of the parent credential.',
3771
+ description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3661
3772
  format: 'uuid',
3662
3773
  type: 'string',
3663
3774
  },
3664
3775
  starts_at: {
3665
- description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
3776
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
3666
3777
  type: 'string',
3667
3778
  },
3668
3779
  visionline_metadata: {
3669
- description: 'Visionline-specific metadata for the credential.',
3780
+ description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3670
3781
  properties: {
3671
3782
  auto_join: { type: 'boolean' },
3672
3783
  card_function_type: {
@@ -3693,13 +3804,13 @@ export default {
3693
3804
  type: 'object',
3694
3805
  },
3695
3806
  warnings: {
3696
- description: 'Warnings associated with the `acs_credential`.',
3807
+ description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3697
3808
  items: {
3698
- description: 'Warning associated with the `acs_credential`.',
3809
+ description: 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3699
3810
  discriminator: { propertyName: 'warning_code' },
3700
3811
  oneOf: [
3701
3812
  {
3702
- description: 'Indicates that the credential is waiting to be issued.',
3813
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
3703
3814
  properties: {
3704
3815
  created_at: {
3705
3816
  description: 'Date and time at which Seam created the warning.',
@@ -3724,7 +3835,7 @@ export default {
3724
3835
  type: 'object',
3725
3836
  },
3726
3837
  {
3727
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
3838
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
3728
3839
  properties: {
3729
3840
  created_at: {
3730
3841
  description: 'Date and time at which Seam created the warning.',
@@ -3749,7 +3860,7 @@ export default {
3749
3860
  type: 'object',
3750
3861
  },
3751
3862
  {
3752
- description: 'Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.',
3863
+ description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
3753
3864
  properties: {
3754
3865
  created_at: {
3755
3866
  description: 'Date and time at which Seam created the warning.',
@@ -3774,7 +3885,7 @@ export default {
3774
3885
  type: 'object',
3775
3886
  },
3776
3887
  {
3777
- description: 'Indicates that this credential is being deleted.',
3888
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
3778
3889
  properties: {
3779
3890
  created_at: {
3780
3891
  description: 'Date and time at which Seam created the warning.',
@@ -3799,7 +3910,7 @@ export default {
3799
3910
  type: 'object',
3800
3911
  },
3801
3912
  {
3802
- description: 'An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.',
3913
+ description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
3803
3914
  properties: {
3804
3915
  created_at: {
3805
3916
  description: 'Date and time at which Seam created the warning.',
@@ -3824,7 +3935,7 @@ export default {
3824
3935
  type: 'object',
3825
3936
  },
3826
3937
  {
3827
- description: 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
3938
+ description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
3828
3939
  properties: {
3829
3940
  created_at: {
3830
3941
  description: 'Date and time at which Seam created the warning.',
@@ -3853,7 +3964,7 @@ export default {
3853
3964
  type: 'array',
3854
3965
  },
3855
3966
  workspace_id: {
3856
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
3967
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
3857
3968
  format: 'uuid',
3858
3969
  type: 'string',
3859
3970
  },
@@ -6417,30 +6528,36 @@ export default {
6417
6528
  nullable: true,
6418
6529
  properties: {
6419
6530
  climate_preset_key: {
6420
- description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
6531
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
6421
6532
  type: 'string',
6422
6533
  },
6423
6534
  created_at: {
6424
- description: 'Date and time at which the thermostat schedule was created.',
6535
+ description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.',
6425
6536
  format: 'date-time',
6426
6537
  type: 'string',
6427
6538
  },
6428
6539
  device_id: {
6429
- description: 'ID of the desired thermostat device.',
6540
+ description: 'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.',
6430
6541
  format: 'uuid',
6431
6542
  type: 'string',
6432
6543
  },
6433
6544
  ends_at: {
6434
- description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
6545
+ description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
6435
6546
  format: 'date-time',
6436
6547
  type: 'string',
6437
6548
  },
6438
6549
  errors: {
6439
- description: 'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
6550
+ description: 'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
6440
6551
  items: {
6441
6552
  properties: {
6442
- error_code: { type: 'string' },
6443
- message: { type: 'string' },
6553
+ error_code: {
6554
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
6555
+ type: 'string',
6556
+ },
6557
+ message: {
6558
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
6559
+ type: 'string',
6560
+ },
6444
6561
  },
6445
6562
  required: ['error_code', 'message'],
6446
6563
  type: 'object',
@@ -6448,26 +6565,26 @@ export default {
6448
6565
  type: 'array',
6449
6566
  },
6450
6567
  max_override_period_minutes: {
6451
- description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
6568
+ description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
6452
6569
  minimum: 0,
6453
6570
  type: 'integer',
6454
6571
  },
6455
6572
  name: {
6456
- description: 'User-friendly name to identify the thermostat schedule.',
6573
+ description: 'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
6457
6574
  type: 'string',
6458
6575
  },
6459
6576
  starts_at: {
6460
- description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
6577
+ description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
6461
6578
  format: 'date-time',
6462
6579
  type: 'string',
6463
6580
  },
6464
6581
  thermostat_schedule_id: {
6465
- description: 'ID of the thermostat schedule.',
6582
+ description: 'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
6466
6583
  format: 'uuid',
6467
6584
  type: 'string',
6468
6585
  },
6469
6586
  unstable_is_override_allowed: {
6470
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
6587
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.",
6471
6588
  type: 'boolean',
6472
6589
  'x-undocumented': 'Unstable',
6473
6590
  },
@@ -6489,15 +6606,15 @@ export default {
6489
6606
  items: {
6490
6607
  properties: {
6491
6608
  can_delete: {
6492
- description: 'Indicates whether this climate preset key can be deleted.',
6609
+ description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
6493
6610
  type: 'boolean',
6494
6611
  },
6495
6612
  can_edit: {
6496
- description: 'Indicates whether this climate preset key can be edited.',
6613
+ description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
6497
6614
  type: 'boolean',
6498
6615
  },
6499
6616
  climate_preset_key: {
6500
- description: 'Unique key to identify the climate preset.',
6617
+ description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6501
6618
  type: 'string',
6502
6619
  },
6503
6620
  cooling_set_point_celsius: {
@@ -6506,26 +6623,26 @@ export default {
6506
6623
  type: 'number',
6507
6624
  },
6508
6625
  cooling_set_point_fahrenheit: {
6509
- description: 'Temperature to which the thermostat should cool (in °F).',
6626
+ description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6510
6627
  format: 'float',
6511
6628
  type: 'number',
6512
6629
  },
6513
6630
  display_name: {
6514
- description: 'Display name for the climate preset.',
6631
+ description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6515
6632
  type: 'string',
6516
6633
  },
6517
6634
  fan_mode_setting: {
6518
- description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
6635
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
6519
6636
  enum: ['auto', 'on', 'circulate'],
6520
6637
  type: 'string',
6521
6638
  },
6522
6639
  heating_set_point_celsius: {
6523
- description: 'Temperature to which the thermostat should heat (in °C).',
6640
+ description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6524
6641
  format: 'float',
6525
6642
  type: 'number',
6526
6643
  },
6527
6644
  heating_set_point_fahrenheit: {
6528
- description: 'Temperature to which the thermostat should heat (in °F).',
6645
+ description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6529
6646
  format: 'float',
6530
6647
  type: 'number',
6531
6648
  },
@@ -6536,13 +6653,13 @@ export default {
6536
6653
  },
6537
6654
  manual_override_allowed: {
6538
6655
  deprecated: true,
6539
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
6656
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
6540
6657
  type: 'boolean',
6541
6658
  'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
6542
6659
  },
6543
6660
  name: {
6544
6661
  default: null,
6545
- description: 'User-friendly name to identify the climate preset.',
6662
+ description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6546
6663
  nullable: true,
6547
6664
  type: 'string',
6548
6665
  },
@@ -6575,15 +6692,15 @@ export default {
6575
6692
  current_climate_setting: {
6576
6693
  properties: {
6577
6694
  can_delete: {
6578
- description: 'Indicates whether this climate preset key can be deleted.',
6695
+ description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
6579
6696
  type: 'boolean',
6580
6697
  },
6581
6698
  can_edit: {
6582
- description: 'Indicates whether this climate preset key can be edited.',
6699
+ description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
6583
6700
  type: 'boolean',
6584
6701
  },
6585
6702
  climate_preset_key: {
6586
- description: 'Unique key to identify the climate preset.',
6703
+ description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6587
6704
  type: 'string',
6588
6705
  },
6589
6706
  cooling_set_point_celsius: {
@@ -6592,26 +6709,26 @@ export default {
6592
6709
  type: 'number',
6593
6710
  },
6594
6711
  cooling_set_point_fahrenheit: {
6595
- description: 'Temperature to which the thermostat should cool (in °F).',
6712
+ description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6596
6713
  format: 'float',
6597
6714
  type: 'number',
6598
6715
  },
6599
6716
  display_name: {
6600
- description: 'Display name for the climate preset.',
6717
+ description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6601
6718
  type: 'string',
6602
6719
  },
6603
6720
  fan_mode_setting: {
6604
- description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
6721
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
6605
6722
  enum: ['auto', 'on', 'circulate'],
6606
6723
  type: 'string',
6607
6724
  },
6608
6725
  heating_set_point_celsius: {
6609
- description: 'Temperature to which the thermostat should heat (in °C).',
6726
+ description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6610
6727
  format: 'float',
6611
6728
  type: 'number',
6612
6729
  },
6613
6730
  heating_set_point_fahrenheit: {
6614
- description: 'Temperature to which the thermostat should heat (in °F).',
6731
+ description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6615
6732
  format: 'float',
6616
6733
  type: 'number',
6617
6734
  },
@@ -6622,13 +6739,13 @@ export default {
6622
6739
  },
6623
6740
  manual_override_allowed: {
6624
6741
  deprecated: true,
6625
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
6742
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
6626
6743
  type: 'boolean',
6627
6744
  'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
6628
6745
  },
6629
6746
  name: {
6630
6747
  default: null,
6631
- description: 'User-friendly name to identify the climate preset.',
6748
+ description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6632
6749
  nullable: true,
6633
6750
  type: 'string',
6634
6751
  },
@@ -6639,15 +6756,15 @@ export default {
6639
6756
  deprecated: true,
6640
6757
  properties: {
6641
6758
  can_delete: {
6642
- description: 'Indicates whether this climate preset key can be deleted.',
6759
+ description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
6643
6760
  type: 'boolean',
6644
6761
  },
6645
6762
  can_edit: {
6646
- description: 'Indicates whether this climate preset key can be edited.',
6763
+ description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
6647
6764
  type: 'boolean',
6648
6765
  },
6649
6766
  climate_preset_key: {
6650
- description: 'Unique key to identify the climate preset.',
6767
+ description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6651
6768
  type: 'string',
6652
6769
  },
6653
6770
  cooling_set_point_celsius: {
@@ -6656,26 +6773,26 @@ export default {
6656
6773
  type: 'number',
6657
6774
  },
6658
6775
  cooling_set_point_fahrenheit: {
6659
- description: 'Temperature to which the thermostat should cool (in °F).',
6776
+ description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6660
6777
  format: 'float',
6661
6778
  type: 'number',
6662
6779
  },
6663
6780
  display_name: {
6664
- description: 'Display name for the climate preset.',
6781
+ description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6665
6782
  type: 'string',
6666
6783
  },
6667
6784
  fan_mode_setting: {
6668
- description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
6785
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
6669
6786
  enum: ['auto', 'on', 'circulate'],
6670
6787
  type: 'string',
6671
6788
  },
6672
6789
  heating_set_point_celsius: {
6673
- description: 'Temperature to which the thermostat should heat (in °C).',
6790
+ description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6674
6791
  format: 'float',
6675
6792
  type: 'number',
6676
6793
  },
6677
6794
  heating_set_point_fahrenheit: {
6678
- description: 'Temperature to which the thermostat should heat (in °F).',
6795
+ description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
6679
6796
  format: 'float',
6680
6797
  type: 'number',
6681
6798
  },
@@ -6686,13 +6803,13 @@ export default {
6686
6803
  },
6687
6804
  manual_override_allowed: {
6688
6805
  deprecated: true,
6689
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
6806
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
6690
6807
  type: 'boolean',
6691
6808
  'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
6692
6809
  },
6693
6810
  name: {
6694
6811
  default: null,
6695
- description: 'User-friendly name to identify the climate preset.',
6812
+ description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
6696
6813
  nullable: true,
6697
6814
  type: 'string',
6698
6815
  },
@@ -10739,7 +10856,7 @@ export default {
10739
10856
  type: 'number',
10740
10857
  },
10741
10858
  cooling_set_point_fahrenheit: {
10742
- description: 'Temperature to which the thermostat should cool (in °F).',
10859
+ description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
10743
10860
  format: 'float',
10744
10861
  type: 'number',
10745
10862
  },
@@ -10763,17 +10880,17 @@ export default {
10763
10880
  type: 'string',
10764
10881
  },
10765
10882
  fan_mode_setting: {
10766
- description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
10883
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
10767
10884
  enum: ['auto', 'on', 'circulate'],
10768
10885
  type: 'string',
10769
10886
  },
10770
10887
  heating_set_point_celsius: {
10771
- description: 'Temperature to which the thermostat should heat (in °C).',
10888
+ description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
10772
10889
  format: 'float',
10773
10890
  type: 'number',
10774
10891
  },
10775
10892
  heating_set_point_fahrenheit: {
10776
- description: 'Temperature to which the thermostat should heat (in °F).',
10893
+ description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
10777
10894
  format: 'float',
10778
10895
  type: 'number',
10779
10896
  },
@@ -11446,30 +11563,36 @@ export default {
11446
11563
  description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
11447
11564
  properties: {
11448
11565
  climate_preset_key: {
11449
- description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
11566
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
11450
11567
  type: 'string',
11451
11568
  },
11452
11569
  created_at: {
11453
- description: 'Date and time at which the thermostat schedule was created.',
11570
+ description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.',
11454
11571
  format: 'date-time',
11455
11572
  type: 'string',
11456
11573
  },
11457
11574
  device_id: {
11458
- description: 'ID of the desired thermostat device.',
11575
+ description: 'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.',
11459
11576
  format: 'uuid',
11460
11577
  type: 'string',
11461
11578
  },
11462
11579
  ends_at: {
11463
- description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
11580
+ description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
11464
11581
  format: 'date-time',
11465
11582
  type: 'string',
11466
11583
  },
11467
11584
  errors: {
11468
- description: 'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
11585
+ description: 'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
11469
11586
  items: {
11470
11587
  properties: {
11471
- error_code: { type: 'string' },
11472
- message: { type: 'string' },
11588
+ error_code: {
11589
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11590
+ type: 'string',
11591
+ },
11592
+ message: {
11593
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
11594
+ type: 'string',
11595
+ },
11473
11596
  },
11474
11597
  required: ['error_code', 'message'],
11475
11598
  type: 'object',
@@ -11477,26 +11600,26 @@ export default {
11477
11600
  type: 'array',
11478
11601
  },
11479
11602
  max_override_period_minutes: {
11480
- description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
11603
+ description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
11481
11604
  minimum: 0,
11482
11605
  type: 'integer',
11483
11606
  },
11484
11607
  name: {
11485
- description: 'User-friendly name to identify the thermostat schedule.',
11608
+ description: 'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
11486
11609
  type: 'string',
11487
11610
  },
11488
11611
  starts_at: {
11489
- description: 'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
11612
+ description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
11490
11613
  format: 'date-time',
11491
11614
  type: 'string',
11492
11615
  },
11493
11616
  thermostat_schedule_id: {
11494
- description: 'ID of the thermostat schedule.',
11617
+ description: 'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
11495
11618
  format: 'uuid',
11496
11619
  type: 'string',
11497
11620
  },
11498
11621
  unstable_is_override_allowed: {
11499
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
11622
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.",
11500
11623
  type: 'boolean',
11501
11624
  'x-undocumented': 'Unstable',
11502
11625
  },
@@ -12403,31 +12526,31 @@ export default {
12403
12526
  'x-route-path': '/acs/access_groups/unmanaged',
12404
12527
  },
12405
12528
  unmanaged_acs_credential: {
12406
- description: 'Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.',
12529
+ description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.',
12407
12530
  properties: {
12408
12531
  access_method: {
12409
- description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
12532
+ description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
12410
12533
  enum: ['code', 'card', 'mobile_key'],
12411
12534
  type: 'string',
12412
12535
  },
12413
12536
  acs_credential_id: {
12414
- description: 'ID of the credential.',
12537
+ description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12415
12538
  format: 'uuid',
12416
12539
  type: 'string',
12417
12540
  },
12418
12541
  acs_credential_pool_id: { format: 'uuid', type: 'string' },
12419
12542
  acs_system_id: {
12420
- description: 'ID of the access control system that contains the credential.',
12543
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12421
12544
  format: 'uuid',
12422
12545
  type: 'string',
12423
12546
  },
12424
12547
  acs_user_id: {
12425
- description: 'ID of the ACS user to whom the credential belongs.',
12548
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
12426
12549
  format: 'uuid',
12427
12550
  type: 'string',
12428
12551
  },
12429
12552
  assa_abloy_vostio_metadata: {
12430
- description: 'Vostio-specific metadata for the credential.',
12553
+ description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12431
12554
  properties: {
12432
12555
  door_names: { items: { type: 'string' }, type: 'array' },
12433
12556
  endpoint_id: { type: 'string' },
@@ -12440,28 +12563,32 @@ export default {
12440
12563
  },
12441
12564
  type: 'object',
12442
12565
  },
12443
- card_number: { nullable: true, type: 'string' },
12566
+ card_number: {
12567
+ description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12568
+ nullable: true,
12569
+ type: 'string',
12570
+ },
12444
12571
  code: {
12445
- description: 'Access (PIN) code for the credential.',
12572
+ description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12446
12573
  nullable: true,
12447
12574
  type: 'string',
12448
12575
  },
12449
12576
  created_at: {
12450
- description: 'Date and time at which the credential was created.',
12577
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
12451
12578
  format: 'date-time',
12452
12579
  type: 'string',
12453
12580
  },
12454
12581
  display_name: {
12455
- description: 'Display name that corresponds to the credential type.',
12582
+ description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
12456
12583
  minLength: 1,
12457
12584
  type: 'string',
12458
12585
  },
12459
12586
  ends_at: {
12460
- description: 'Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
12587
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
12461
12588
  type: 'string',
12462
12589
  },
12463
12590
  errors: {
12464
- description: 'Errors associated with the `acs_credential`.',
12591
+ description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12465
12592
  items: {
12466
12593
  properties: {
12467
12594
  error_code: { type: 'string' },
@@ -12473,7 +12600,7 @@ export default {
12473
12600
  type: 'array',
12474
12601
  },
12475
12602
  external_type: {
12476
- description: 'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
12603
+ description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
12477
12604
  enum: [
12478
12605
  'pti_card',
12479
12606
  'brivo_credential',
@@ -12486,42 +12613,50 @@ export default {
12486
12613
  type: 'string',
12487
12614
  },
12488
12615
  external_type_display_name: {
12489
- description: 'Display name that corresponds to the brand-specific terminology for the credential type.',
12616
+ description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
12490
12617
  type: 'string',
12491
12618
  },
12492
- is_issued: { type: 'boolean' },
12619
+ is_issued: {
12620
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
12621
+ type: 'boolean',
12622
+ },
12493
12623
  is_latest_desired_state_synced_with_provider: {
12494
- description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
12624
+ description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.',
12495
12625
  nullable: true,
12496
12626
  type: 'boolean',
12497
12627
  },
12498
12628
  is_managed: { enum: [false], type: 'boolean' },
12499
12629
  is_multi_phone_sync_credential: {
12500
- description: 'Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
12630
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
12501
12631
  type: 'boolean',
12502
12632
  },
12503
12633
  is_one_time_use: {
12504
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
12634
+ description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.',
12505
12635
  type: 'boolean',
12506
12636
  },
12507
- issued_at: { format: 'date-time', nullable: true, type: 'string' },
12637
+ issued_at: {
12638
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
12639
+ format: 'date-time',
12640
+ nullable: true,
12641
+ type: 'string',
12642
+ },
12508
12643
  latest_desired_state_synced_with_provider_at: {
12509
- description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
12644
+ description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.',
12510
12645
  format: 'date-time',
12511
12646
  nullable: true,
12512
12647
  type: 'string',
12513
12648
  },
12514
12649
  parent_acs_credential_id: {
12515
- description: 'ID of the parent credential.',
12650
+ description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12516
12651
  format: 'uuid',
12517
12652
  type: 'string',
12518
12653
  },
12519
12654
  starts_at: {
12520
- description: 'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
12655
+ description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
12521
12656
  type: 'string',
12522
12657
  },
12523
12658
  visionline_metadata: {
12524
- description: 'Visionline-specific metadata for the credential.',
12659
+ description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12525
12660
  properties: {
12526
12661
  auto_join: { type: 'boolean' },
12527
12662
  card_function_type: { enum: ['guest', 'staff'], type: 'string' },
@@ -12545,13 +12680,13 @@ export default {
12545
12680
  type: 'object',
12546
12681
  },
12547
12682
  warnings: {
12548
- description: 'Warnings associated with the `acs_credential`.',
12683
+ description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12549
12684
  items: {
12550
- description: 'Warning associated with the `acs_credential`.',
12685
+ description: 'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12551
12686
  discriminator: { propertyName: 'warning_code' },
12552
12687
  oneOf: [
12553
12688
  {
12554
- description: 'Indicates that the credential is waiting to be issued.',
12689
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
12555
12690
  properties: {
12556
12691
  created_at: {
12557
12692
  description: 'Date and time at which Seam created the warning.',
@@ -12572,7 +12707,7 @@ export default {
12572
12707
  type: 'object',
12573
12708
  },
12574
12709
  {
12575
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
12710
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
12576
12711
  properties: {
12577
12712
  created_at: {
12578
12713
  description: 'Date and time at which Seam created the warning.',
@@ -12593,7 +12728,7 @@ export default {
12593
12728
  type: 'object',
12594
12729
  },
12595
12730
  {
12596
- description: 'Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.',
12731
+ description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.',
12597
12732
  properties: {
12598
12733
  created_at: {
12599
12734
  description: 'Date and time at which Seam created the warning.',
@@ -12614,7 +12749,7 @@ export default {
12614
12749
  type: 'object',
12615
12750
  },
12616
12751
  {
12617
- description: 'Indicates that this credential is being deleted.',
12752
+ description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
12618
12753
  properties: {
12619
12754
  created_at: {
12620
12755
  description: 'Date and time at which Seam created the warning.',
@@ -12635,7 +12770,7 @@ export default {
12635
12770
  type: 'object',
12636
12771
  },
12637
12772
  {
12638
- description: 'An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.',
12773
+ description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.',
12639
12774
  properties: {
12640
12775
  created_at: {
12641
12776
  description: 'Date and time at which Seam created the warning.',
@@ -12656,7 +12791,7 @@ export default {
12656
12791
  type: 'object',
12657
12792
  },
12658
12793
  {
12659
- description: 'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
12794
+ description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.',
12660
12795
  properties: {
12661
12796
  created_at: {
12662
12797
  description: 'Date and time at which Seam created the warning.',
@@ -12681,7 +12816,7 @@ export default {
12681
12816
  type: 'array',
12682
12817
  },
12683
12818
  workspace_id: {
12684
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
12819
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
12685
12820
  format: 'uuid',
12686
12821
  type: 'string',
12687
12822
  },
@@ -12704,7 +12839,7 @@ export default {
12704
12839
  description: 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
12705
12840
  properties: {
12706
12841
  access_schedule: {
12707
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
12842
+ description: "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
12708
12843
  properties: {
12709
12844
  ends_at: {
12710
12845
  description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
@@ -12722,22 +12857,22 @@ export default {
12722
12857
  type: 'object',
12723
12858
  },
12724
12859
  acs_system_id: {
12725
- description: 'ID of the access control system that contains the `acs_user`.',
12860
+ description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12726
12861
  format: 'uuid',
12727
12862
  type: 'string',
12728
12863
  },
12729
12864
  acs_user_id: {
12730
- description: 'ID of the `acs_user`.',
12865
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12731
12866
  format: 'uuid',
12732
12867
  type: 'string',
12733
12868
  },
12734
12869
  created_at: {
12735
- description: 'Date and time at which the `acs_user` was created.',
12870
+ description: 'Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
12736
12871
  format: 'date-time',
12737
12872
  type: 'string',
12738
12873
  },
12739
12874
  display_name: {
12740
- description: 'Display name for the `acs_user`.',
12875
+ description: 'Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12741
12876
  type: 'string',
12742
12877
  },
12743
12878
  email: {
@@ -12747,18 +12882,18 @@ export default {
12747
12882
  'x-deprecated': 'use email_address.',
12748
12883
  },
12749
12884
  email_address: {
12750
- description: 'Email address of the `acs_user`.',
12885
+ description: 'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12751
12886
  format: 'email',
12752
12887
  type: 'string',
12753
12888
  },
12754
12889
  errors: {
12755
- description: 'Errors associated with the `acs_user`.',
12890
+ description: 'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12756
12891
  items: {
12757
- description: 'Error associated with the `acs_user`.',
12892
+ description: 'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12758
12893
  discriminator: { propertyName: 'error_code' },
12759
12894
  oneOf: [
12760
12895
  {
12761
- description: 'Indicates that the ACS user was deleted from the ACS system outside of Seam.',
12896
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.',
12762
12897
  properties: {
12763
12898
  created_at: {
12764
12899
  description: 'Date and time at which Seam created the error.',
@@ -12778,7 +12913,7 @@ export default {
12778
12913
  type: 'object',
12779
12914
  },
12780
12915
  {
12781
- description: 'Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.',
12916
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.',
12782
12917
  properties: {
12783
12918
  created_at: {
12784
12919
  description: 'Date and time at which Seam created the error.',
@@ -12798,7 +12933,7 @@ export default {
12798
12933
  type: 'object',
12799
12934
  },
12800
12935
  {
12801
- description: "Indicates that the user was not created on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
12936
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
12802
12937
  properties: {
12803
12938
  created_at: {
12804
12939
  description: 'Date and time at which Seam created the error.',
@@ -12818,7 +12953,7 @@ export default {
12818
12953
  type: 'object',
12819
12954
  },
12820
12955
  {
12821
- description: "Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
12956
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
12822
12957
  properties: {
12823
12958
  created_at: {
12824
12959
  description: 'Date and time at which Seam created the error.',
@@ -12838,7 +12973,7 @@ export default {
12838
12973
  type: 'object',
12839
12974
  },
12840
12975
  {
12841
- description: "Indicates that the user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
12976
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).',
12842
12977
  properties: {
12843
12978
  created_at: {
12844
12979
  description: 'Date and time at which Seam created the error.',
@@ -12862,7 +12997,7 @@ export default {
12862
12997
  type: 'array',
12863
12998
  },
12864
12999
  external_type: {
12865
- description: 'Brand-specific terminology for the `acs_user` type.',
13000
+ description: 'Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
12866
13001
  enum: [
12867
13002
  'pti_user',
12868
13003
  'brivo_user',
@@ -12875,11 +13010,11 @@ export default {
12875
13010
  type: 'string',
12876
13011
  },
12877
13012
  external_type_display_name: {
12878
- description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
13013
+ description: 'Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
12879
13014
  type: 'string',
12880
13015
  },
12881
13016
  full_name: {
12882
- description: 'Full name of the `acs_user`.',
13017
+ description: 'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12883
13018
  type: 'string',
12884
13019
  },
12885
13020
  hid_acs_system_id: { format: 'uuid', type: 'string' },
@@ -12890,7 +13025,7 @@ export default {
12890
13025
  },
12891
13026
  is_managed: { enum: [false], type: 'boolean' },
12892
13027
  is_suspended: {
12893
- description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
13028
+ description: 'Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
12894
13029
  type: 'boolean',
12895
13030
  },
12896
13031
  latest_desired_state_synced_with_provider_at: {
@@ -12900,49 +13035,63 @@ export default {
12900
13035
  'x-undocumented': 'Only used internally.',
12901
13036
  },
12902
13037
  phone_number: {
12903
- description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
13038
+ description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
12904
13039
  type: 'string',
12905
13040
  },
12906
13041
  user_identity_email_address: {
12907
- description: 'Email address of the user identity associated with the `acs_user`.',
13042
+ description: 'Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12908
13043
  nullable: true,
12909
13044
  type: 'string',
12910
13045
  },
12911
13046
  user_identity_full_name: {
12912
- description: 'Full name of the user identity associated with the `acs_user`.',
13047
+ description: 'Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12913
13048
  nullable: true,
12914
13049
  type: 'string',
12915
13050
  },
12916
13051
  user_identity_id: {
12917
- description: 'ID of the user identity associated with the `acs_user`.',
13052
+ description: 'ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12918
13053
  type: 'string',
12919
13054
  },
12920
13055
  user_identity_phone_number: {
12921
- description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
13056
+ description: 'Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
12922
13057
  nullable: true,
12923
13058
  type: 'string',
12924
13059
  },
12925
13060
  warnings: {
12926
- description: 'Warnings associated with the `acs_user`.',
13061
+ description: 'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12927
13062
  items: {
12928
- description: 'Warning associated with the `acs_user`.',
13063
+ description: 'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12929
13064
  discriminator: { propertyName: 'warning_code' },
12930
13065
  oneOf: [
12931
13066
  {
12932
- description: 'Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.',
13067
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.',
12933
13068
  properties: {
12934
- created_at: { format: 'date-time', type: 'string' },
12935
- message: { type: 'string' },
13069
+ created_at: {
13070
+ description: 'Date and time at which Seam created the warning.',
13071
+ format: 'date-time',
13072
+ type: 'string',
13073
+ },
13074
+ message: {
13075
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13076
+ type: 'string',
13077
+ },
12936
13078
  warning_code: { enum: ['being_deleted'], type: 'string' },
12937
13079
  },
12938
13080
  required: ['created_at', 'message', 'warning_code'],
12939
13081
  type: 'object',
12940
13082
  },
12941
13083
  {
12942
- description: 'Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn’t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.',
13084
+ description: 'Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.',
12943
13085
  properties: {
12944
- created_at: { format: 'date-time', type: 'string' },
12945
- message: { type: 'string' },
13086
+ created_at: {
13087
+ description: 'Date and time at which Seam created the warning.',
13088
+ format: 'date-time',
13089
+ type: 'string',
13090
+ },
13091
+ message: {
13092
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13093
+ type: 'string',
13094
+ },
12946
13095
  warning_code: {
12947
13096
  enum: ['salto_ks_user_not_subscribed'],
12948
13097
  type: 'string',
@@ -12952,10 +13101,17 @@ export default {
12952
13101
  type: 'object',
12953
13102
  },
12954
13103
  {
12955
- description: 'An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.',
13104
+ description: 'An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.',
12956
13105
  properties: {
12957
- created_at: { format: 'date-time', type: 'string' },
12958
- message: { type: 'string' },
13106
+ created_at: {
13107
+ description: 'Date and time at which Seam created the warning.',
13108
+ format: 'date-time',
13109
+ type: 'string',
13110
+ },
13111
+ message: {
13112
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13113
+ type: 'string',
13114
+ },
12959
13115
  warning_code: {
12960
13116
  enum: ['unknown_issue_with_acs_user'],
12961
13117
  type: 'string',
@@ -12969,7 +13125,7 @@ export default {
12969
13125
  type: 'array',
12970
13126
  },
12971
13127
  workspace_id: {
12972
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
13128
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
12973
13129
  format: 'uuid',
12974
13130
  type: 'string',
12975
13131
  },
@@ -17881,7 +18037,7 @@ export default {
17881
18037
  'x-deprecated': 'use email_address.',
17882
18038
  },
17883
18039
  email_address: {
17884
- description: 'Email address of the `acs_user`.',
18040
+ description: 'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
17885
18041
  format: 'email',
17886
18042
  type: 'string',
17887
18043
  },
@@ -17890,7 +18046,7 @@ export default {
17890
18046
  type: 'string',
17891
18047
  },
17892
18048
  phone_number: {
17893
- description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
18049
+ description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
17894
18050
  type: 'string',
17895
18051
  },
17896
18052
  user_identity_id: {
@@ -18520,7 +18676,7 @@ export default {
18520
18676
  type: 'object',
18521
18677
  },
18522
18678
  acs_user_id: {
18523
- description: 'ID of the `acs_user`.',
18679
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
18524
18680
  format: 'uuid',
18525
18681
  type: 'string',
18526
18682
  },
@@ -18531,17 +18687,17 @@ export default {
18531
18687
  'x-deprecated': 'use email_address.',
18532
18688
  },
18533
18689
  email_address: {
18534
- description: 'Email address of the `acs_user`.',
18690
+ description: 'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
18535
18691
  format: 'email',
18536
18692
  type: 'string',
18537
18693
  },
18538
18694
  full_name: {
18539
- description: 'Full name of the `acs_user`.',
18695
+ description: 'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
18540
18696
  type: 'string',
18541
18697
  },
18542
18698
  hid_acs_system_id: { format: 'uuid', type: 'string' },
18543
18699
  phone_number: {
18544
- description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
18700
+ description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
18545
18701
  type: 'string',
18546
18702
  },
18547
18703
  },
@@ -18597,7 +18753,7 @@ export default {
18597
18753
  type: 'object',
18598
18754
  },
18599
18755
  acs_user_id: {
18600
- description: 'ID of the `acs_user`.',
18756
+ description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
18601
18757
  format: 'uuid',
18602
18758
  type: 'string',
18603
18759
  },
@@ -18608,17 +18764,17 @@ export default {
18608
18764
  'x-deprecated': 'use email_address.',
18609
18765
  },
18610
18766
  email_address: {
18611
- description: 'Email address of the `acs_user`.',
18767
+ description: 'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
18612
18768
  format: 'email',
18613
18769
  type: 'string',
18614
18770
  },
18615
18771
  full_name: {
18616
- description: 'Full name of the `acs_user`.',
18772
+ description: 'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
18617
18773
  type: 'string',
18618
18774
  },
18619
18775
  hid_acs_system_id: { format: 'uuid', type: 'string' },
18620
18776
  phone_number: {
18621
- description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
18777
+ description: 'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
18622
18778
  type: 'string',
18623
18779
  },
18624
18780
  },
@@ -23306,7 +23462,7 @@ export default {
23306
23462
  schema: {
23307
23463
  properties: {
23308
23464
  climate_preset_key: {
23309
- description: 'Unique key to identify the climate preset.',
23465
+ description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
23310
23466
  type: 'string',
23311
23467
  },
23312
23468
  cooling_set_point_celsius: {
@@ -23315,7 +23471,7 @@ export default {
23315
23471
  type: 'number',
23316
23472
  },
23317
23473
  cooling_set_point_fahrenheit: {
23318
- description: 'Temperature to which the thermostat should cool (in °F).',
23474
+ description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
23319
23475
  format: 'float',
23320
23476
  type: 'number',
23321
23477
  },
@@ -23325,17 +23481,17 @@ export default {
23325
23481
  type: 'string',
23326
23482
  },
23327
23483
  fan_mode_setting: {
23328
- description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
23484
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
23329
23485
  enum: ['auto', 'on', 'circulate'],
23330
23486
  type: 'string',
23331
23487
  },
23332
23488
  heating_set_point_celsius: {
23333
- description: 'Temperature to which the thermostat should heat (in °C).',
23489
+ description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
23334
23490
  format: 'float',
23335
23491
  type: 'number',
23336
23492
  },
23337
23493
  heating_set_point_fahrenheit: {
23338
- description: 'Temperature to which the thermostat should heat (in °F).',
23494
+ description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
23339
23495
  format: 'float',
23340
23496
  type: 'number',
23341
23497
  },
@@ -23353,7 +23509,7 @@ export default {
23353
23509
  },
23354
23510
  name: {
23355
23511
  default: null,
23356
- description: 'User-friendly name to identify the climate preset.',
23512
+ description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
23357
23513
  nullable: true,
23358
23514
  type: 'string',
23359
23515
  },
@@ -25066,7 +25222,7 @@ export default {
25066
25222
  schema: {
25067
25223
  properties: {
25068
25224
  climate_preset_key: {
25069
- description: 'Unique key to identify the climate preset.',
25225
+ description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
25070
25226
  type: 'string',
25071
25227
  },
25072
25228
  cooling_set_point_celsius: {
@@ -25075,7 +25231,7 @@ export default {
25075
25231
  type: 'number',
25076
25232
  },
25077
25233
  cooling_set_point_fahrenheit: {
25078
- description: 'Temperature to which the thermostat should cool (in °F).',
25234
+ description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
25079
25235
  format: 'float',
25080
25236
  type: 'number',
25081
25237
  },
@@ -25085,17 +25241,17 @@ export default {
25085
25241
  type: 'string',
25086
25242
  },
25087
25243
  fan_mode_setting: {
25088
- description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
25244
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
25089
25245
  enum: ['auto', 'on', 'circulate'],
25090
25246
  type: 'string',
25091
25247
  },
25092
25248
  heating_set_point_celsius: {
25093
- description: 'Temperature to which the thermostat should heat (in °C).',
25249
+ description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
25094
25250
  format: 'float',
25095
25251
  type: 'number',
25096
25252
  },
25097
25253
  heating_set_point_fahrenheit: {
25098
- description: 'Temperature to which the thermostat should heat (in °F).',
25254
+ description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
25099
25255
  format: 'float',
25100
25256
  type: 'number',
25101
25257
  },
@@ -25106,13 +25262,13 @@ export default {
25106
25262
  },
25107
25263
  manual_override_allowed: {
25108
25264
  deprecated: true,
25109
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
25265
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
25110
25266
  type: 'boolean',
25111
25267
  'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
25112
25268
  },
25113
25269
  name: {
25114
25270
  default: null,
25115
- description: 'User-friendly name to identify the climate preset.',
25271
+ description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
25116
25272
  nullable: true,
25117
25273
  type: 'string',
25118
25274
  },
@@ -25163,7 +25319,7 @@ export default {
25163
25319
  schema: {
25164
25320
  properties: {
25165
25321
  climate_preset_key: {
25166
- description: 'Unique key to identify the climate preset.',
25322
+ description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
25167
25323
  type: 'string',
25168
25324
  },
25169
25325
  cooling_set_point_celsius: {
@@ -25172,7 +25328,7 @@ export default {
25172
25328
  type: 'number',
25173
25329
  },
25174
25330
  cooling_set_point_fahrenheit: {
25175
- description: 'Temperature to which the thermostat should cool (in °F).',
25331
+ description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
25176
25332
  format: 'float',
25177
25333
  type: 'number',
25178
25334
  },
@@ -25182,17 +25338,17 @@ export default {
25182
25338
  type: 'string',
25183
25339
  },
25184
25340
  fan_mode_setting: {
25185
- description: 'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
25341
+ description: 'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
25186
25342
  enum: ['auto', 'on', 'circulate'],
25187
25343
  type: 'string',
25188
25344
  },
25189
25345
  heating_set_point_celsius: {
25190
- description: 'Temperature to which the thermostat should heat (in °C).',
25346
+ description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
25191
25347
  format: 'float',
25192
25348
  type: 'number',
25193
25349
  },
25194
25350
  heating_set_point_fahrenheit: {
25195
- description: 'Temperature to which the thermostat should heat (in °F).',
25351
+ description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
25196
25352
  format: 'float',
25197
25353
  type: 'number',
25198
25354
  },
@@ -25203,13 +25359,13 @@ export default {
25203
25359
  },
25204
25360
  manual_override_allowed: {
25205
25361
  deprecated: true,
25206
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
25362
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
25207
25363
  type: 'boolean',
25208
25364
  'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
25209
25365
  },
25210
25366
  name: {
25211
25367
  default: null,
25212
- description: 'User-friendly name to identify the climate preset.',
25368
+ description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
25213
25369
  nullable: true,
25214
25370
  type: 'string',
25215
25371
  },