@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.
- package/dist/connect.cjs +899 -569
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +3626 -2951
- package/lib/seam/connect/models/acs/acs-credential.js +94 -51
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +12 -7
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.js +37 -14
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +48 -41
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-user.js +45 -32
- package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
- package/lib/seam/connect/models/thermostats/climate-preset.js +12 -10
- package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +19 -12
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +45 -23
- package/lib/seam/connect/openapi.js +557 -401
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3581 -2928
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential.ts +162 -51
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +22 -7
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +65 -18
- package/src/lib/seam/connect/models/acs/acs-system.ts +81 -52
- package/src/lib/seam/connect/models/acs/acs-user.ts +69 -32
- package/src/lib/seam/connect/models/thermostats/climate-preset.ts +28 -10
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +31 -12
- package/src/lib/seam/connect/openapi.ts +698 -401
- package/src/lib/seam/connect/route-types.ts +3581 -2928
|
@@ -1033,33 +1033,36 @@ export default {
|
|
|
1033
1033
|
},
|
|
1034
1034
|
acs_credential: {
|
|
1035
1035
|
description:
|
|
1036
|
-
'Means by which
|
|
1036
|
+
'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.',
|
|
1037
1037
|
properties: {
|
|
1038
1038
|
access_method: {
|
|
1039
1039
|
description:
|
|
1040
|
-
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
1040
|
+
'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
|
|
1041
1041
|
enum: ['code', 'card', 'mobile_key'],
|
|
1042
1042
|
type: 'string',
|
|
1043
1043
|
},
|
|
1044
1044
|
acs_credential_id: {
|
|
1045
|
-
description:
|
|
1045
|
+
description:
|
|
1046
|
+
'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1046
1047
|
format: 'uuid',
|
|
1047
1048
|
type: 'string',
|
|
1048
1049
|
},
|
|
1049
1050
|
acs_credential_pool_id: { format: 'uuid', type: 'string' },
|
|
1050
1051
|
acs_system_id: {
|
|
1051
1052
|
description:
|
|
1052
|
-
'ID of the access control system that contains the credential.',
|
|
1053
|
+
'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).',
|
|
1053
1054
|
format: 'uuid',
|
|
1054
1055
|
type: 'string',
|
|
1055
1056
|
},
|
|
1056
1057
|
acs_user_id: {
|
|
1057
|
-
description:
|
|
1058
|
+
description:
|
|
1059
|
+
'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.',
|
|
1058
1060
|
format: 'uuid',
|
|
1059
1061
|
type: 'string',
|
|
1060
1062
|
},
|
|
1061
1063
|
assa_abloy_vostio_metadata: {
|
|
1062
|
-
description:
|
|
1064
|
+
description:
|
|
1065
|
+
'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1063
1066
|
properties: {
|
|
1064
1067
|
door_names: { items: { type: 'string' }, type: 'array' },
|
|
1065
1068
|
endpoint_id: { type: 'string' },
|
|
@@ -1072,30 +1075,38 @@ export default {
|
|
|
1072
1075
|
},
|
|
1073
1076
|
type: 'object',
|
|
1074
1077
|
},
|
|
1075
|
-
card_number: {
|
|
1078
|
+
card_number: {
|
|
1079
|
+
description:
|
|
1080
|
+
'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1081
|
+
nullable: true,
|
|
1082
|
+
type: 'string',
|
|
1083
|
+
},
|
|
1076
1084
|
code: {
|
|
1077
|
-
description:
|
|
1085
|
+
description:
|
|
1086
|
+
'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1078
1087
|
nullable: true,
|
|
1079
1088
|
type: 'string',
|
|
1080
1089
|
},
|
|
1081
1090
|
created_at: {
|
|
1082
|
-
description:
|
|
1091
|
+
description:
|
|
1092
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
1083
1093
|
format: 'date-time',
|
|
1084
1094
|
type: 'string',
|
|
1085
1095
|
},
|
|
1086
1096
|
display_name: {
|
|
1087
1097
|
description:
|
|
1088
|
-
'Display name that corresponds to the credential type.',
|
|
1098
|
+
'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
1089
1099
|
minLength: 1,
|
|
1090
1100
|
type: 'string',
|
|
1091
1101
|
},
|
|
1092
1102
|
ends_at: {
|
|
1093
1103
|
description:
|
|
1094
|
-
'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`.',
|
|
1104
|
+
'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`.',
|
|
1095
1105
|
type: 'string',
|
|
1096
1106
|
},
|
|
1097
1107
|
errors: {
|
|
1098
|
-
description:
|
|
1108
|
+
description:
|
|
1109
|
+
'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1099
1110
|
items: {
|
|
1100
1111
|
properties: {
|
|
1101
1112
|
error_code: { type: 'string' },
|
|
@@ -1108,7 +1119,7 @@ export default {
|
|
|
1108
1119
|
},
|
|
1109
1120
|
external_type: {
|
|
1110
1121
|
description:
|
|
1111
|
-
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
1122
|
+
'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`.',
|
|
1112
1123
|
enum: [
|
|
1113
1124
|
'pti_card',
|
|
1114
1125
|
'brivo_credential',
|
|
@@ -1122,47 +1133,59 @@ export default {
|
|
|
1122
1133
|
},
|
|
1123
1134
|
external_type_display_name: {
|
|
1124
1135
|
description:
|
|
1125
|
-
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
1136
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
1126
1137
|
type: 'string',
|
|
1127
1138
|
},
|
|
1128
|
-
is_issued: {
|
|
1139
|
+
is_issued: {
|
|
1140
|
+
description:
|
|
1141
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
1142
|
+
type: 'boolean',
|
|
1143
|
+
},
|
|
1129
1144
|
is_latest_desired_state_synced_with_provider: {
|
|
1130
1145
|
description:
|
|
1131
|
-
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
1146
|
+
'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.',
|
|
1132
1147
|
nullable: true,
|
|
1133
1148
|
type: 'boolean',
|
|
1134
1149
|
},
|
|
1135
1150
|
is_managed: { enum: [true], type: 'boolean' },
|
|
1136
1151
|
is_multi_phone_sync_credential: {
|
|
1137
1152
|
description:
|
|
1138
|
-
'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).',
|
|
1153
|
+
'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).',
|
|
1139
1154
|
type: 'boolean',
|
|
1140
1155
|
},
|
|
1141
1156
|
is_one_time_use: {
|
|
1142
1157
|
description:
|
|
1143
|
-
'Indicates whether the credential can only be used once. If
|
|
1158
|
+
'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.',
|
|
1144
1159
|
type: 'boolean',
|
|
1145
1160
|
},
|
|
1146
|
-
issued_at: {
|
|
1161
|
+
issued_at: {
|
|
1162
|
+
description:
|
|
1163
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
1164
|
+
format: 'date-time',
|
|
1165
|
+
nullable: true,
|
|
1166
|
+
type: 'string',
|
|
1167
|
+
},
|
|
1147
1168
|
latest_desired_state_synced_with_provider_at: {
|
|
1148
1169
|
description:
|
|
1149
|
-
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
1170
|
+
'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.',
|
|
1150
1171
|
format: 'date-time',
|
|
1151
1172
|
nullable: true,
|
|
1152
1173
|
type: 'string',
|
|
1153
1174
|
},
|
|
1154
1175
|
parent_acs_credential_id: {
|
|
1155
|
-
description:
|
|
1176
|
+
description:
|
|
1177
|
+
'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1156
1178
|
format: 'uuid',
|
|
1157
1179
|
type: 'string',
|
|
1158
1180
|
},
|
|
1159
1181
|
starts_at: {
|
|
1160
1182
|
description:
|
|
1161
|
-
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
1183
|
+
'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.',
|
|
1162
1184
|
type: 'string',
|
|
1163
1185
|
},
|
|
1164
1186
|
visionline_metadata: {
|
|
1165
|
-
description:
|
|
1187
|
+
description:
|
|
1188
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1166
1189
|
properties: {
|
|
1167
1190
|
auto_join: { type: 'boolean' },
|
|
1168
1191
|
card_function_type: { enum: ['guest', 'staff'], type: 'string' },
|
|
@@ -1186,14 +1209,16 @@ export default {
|
|
|
1186
1209
|
type: 'object',
|
|
1187
1210
|
},
|
|
1188
1211
|
warnings: {
|
|
1189
|
-
description:
|
|
1212
|
+
description:
|
|
1213
|
+
'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1190
1214
|
items: {
|
|
1191
|
-
description:
|
|
1215
|
+
description:
|
|
1216
|
+
'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1192
1217
|
discriminator: { propertyName: 'warning_code' },
|
|
1193
1218
|
oneOf: [
|
|
1194
1219
|
{
|
|
1195
1220
|
description:
|
|
1196
|
-
'Indicates that the credential is waiting to be issued.',
|
|
1221
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
1197
1222
|
properties: {
|
|
1198
1223
|
created_at: {
|
|
1199
1224
|
description:
|
|
@@ -1218,7 +1243,7 @@ export default {
|
|
|
1218
1243
|
},
|
|
1219
1244
|
{
|
|
1220
1245
|
description:
|
|
1221
|
-
"Indicates that the schedule of one of the credential's children was modified externally.",
|
|
1246
|
+
"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.",
|
|
1222
1247
|
properties: {
|
|
1223
1248
|
created_at: {
|
|
1224
1249
|
description:
|
|
@@ -1243,7 +1268,7 @@ export default {
|
|
|
1243
1268
|
},
|
|
1244
1269
|
{
|
|
1245
1270
|
description:
|
|
1246
|
-
'Indicates that the schedule of
|
|
1271
|
+
'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.',
|
|
1247
1272
|
properties: {
|
|
1248
1273
|
created_at: {
|
|
1249
1274
|
description:
|
|
@@ -1268,7 +1293,7 @@ export default {
|
|
|
1268
1293
|
},
|
|
1269
1294
|
{
|
|
1270
1295
|
description:
|
|
1271
|
-
'Indicates that
|
|
1296
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
1272
1297
|
properties: {
|
|
1273
1298
|
created_at: {
|
|
1274
1299
|
description:
|
|
@@ -1293,7 +1318,7 @@ export default {
|
|
|
1293
1318
|
},
|
|
1294
1319
|
{
|
|
1295
1320
|
description:
|
|
1296
|
-
'An unknown issue occurred while syncing the state of
|
|
1321
|
+
'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.',
|
|
1297
1322
|
properties: {
|
|
1298
1323
|
created_at: {
|
|
1299
1324
|
description:
|
|
@@ -1318,7 +1343,7 @@ export default {
|
|
|
1318
1343
|
},
|
|
1319
1344
|
{
|
|
1320
1345
|
description:
|
|
1321
|
-
'Access permissions for
|
|
1346
|
+
'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.',
|
|
1322
1347
|
properties: {
|
|
1323
1348
|
created_at: {
|
|
1324
1349
|
description:
|
|
@@ -1347,7 +1372,7 @@ export default {
|
|
|
1347
1372
|
},
|
|
1348
1373
|
workspace_id: {
|
|
1349
1374
|
description:
|
|
1350
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
1375
|
+
'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).',
|
|
1351
1376
|
format: 'uuid',
|
|
1352
1377
|
type: 'string',
|
|
1353
1378
|
},
|
|
@@ -1414,30 +1439,34 @@ export default {
|
|
|
1414
1439
|
'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).',
|
|
1415
1440
|
properties: {
|
|
1416
1441
|
acs_encoder_id: {
|
|
1417
|
-
description:
|
|
1442
|
+
description:
|
|
1443
|
+
'ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.',
|
|
1418
1444
|
format: 'uuid',
|
|
1419
1445
|
type: 'string',
|
|
1420
1446
|
},
|
|
1421
1447
|
acs_system_id: {
|
|
1422
1448
|
description:
|
|
1423
|
-
'ID of the access control system that contains the
|
|
1449
|
+
'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).',
|
|
1424
1450
|
format: 'uuid',
|
|
1425
1451
|
type: 'string',
|
|
1426
1452
|
},
|
|
1427
1453
|
created_at: {
|
|
1428
1454
|
description:
|
|
1429
|
-
'Date and time at which the
|
|
1455
|
+
'Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.',
|
|
1430
1456
|
format: 'date-time',
|
|
1431
1457
|
type: 'string',
|
|
1432
1458
|
},
|
|
1433
1459
|
display_name: {
|
|
1434
|
-
description:
|
|
1460
|
+
description:
|
|
1461
|
+
'Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
|
|
1435
1462
|
type: 'string',
|
|
1436
1463
|
},
|
|
1437
1464
|
errors: {
|
|
1438
|
-
description:
|
|
1465
|
+
description:
|
|
1466
|
+
'Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
|
|
1439
1467
|
items: {
|
|
1440
|
-
description:
|
|
1468
|
+
description:
|
|
1469
|
+
'Error associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
|
|
1441
1470
|
properties: {
|
|
1442
1471
|
created_at: {
|
|
1443
1472
|
description: 'Date and time at which Seam created the error.',
|
|
@@ -1463,7 +1492,7 @@ export default {
|
|
|
1463
1492
|
},
|
|
1464
1493
|
workspace_id: {
|
|
1465
1494
|
description:
|
|
1466
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
1495
|
+
'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).',
|
|
1467
1496
|
format: 'uuid',
|
|
1468
1497
|
type: 'string',
|
|
1469
1498
|
},
|
|
@@ -1484,17 +1513,20 @@ export default {
|
|
|
1484
1513
|
'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).',
|
|
1485
1514
|
properties: {
|
|
1486
1515
|
acs_entrance_id: {
|
|
1487
|
-
description:
|
|
1516
|
+
description:
|
|
1517
|
+
'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1488
1518
|
format: 'uuid',
|
|
1489
1519
|
type: 'string',
|
|
1490
1520
|
},
|
|
1491
1521
|
acs_system_id: {
|
|
1492
1522
|
description:
|
|
1493
|
-
'ID of the access control system that contains the entrance.',
|
|
1523
|
+
'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).',
|
|
1494
1524
|
format: 'uuid',
|
|
1495
1525
|
type: 'string',
|
|
1496
1526
|
},
|
|
1497
1527
|
assa_abloy_vostio_metadata: {
|
|
1528
|
+
description:
|
|
1529
|
+
'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1498
1530
|
properties: {
|
|
1499
1531
|
door_name: { type: 'string' },
|
|
1500
1532
|
door_number: { format: 'float', type: 'number' },
|
|
@@ -1509,24 +1541,38 @@ export default {
|
|
|
1509
1541
|
type: 'object',
|
|
1510
1542
|
},
|
|
1511
1543
|
created_at: {
|
|
1512
|
-
description:
|
|
1544
|
+
description:
|
|
1545
|
+
'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
|
|
1513
1546
|
format: 'date-time',
|
|
1514
1547
|
type: 'string',
|
|
1515
1548
|
},
|
|
1516
1549
|
display_name: {
|
|
1517
|
-
description:
|
|
1550
|
+
description:
|
|
1551
|
+
'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1518
1552
|
type: 'string',
|
|
1519
1553
|
},
|
|
1520
1554
|
dormakaba_community_metadata: {
|
|
1555
|
+
description:
|
|
1556
|
+
'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1521
1557
|
properties: { access_point_name: { type: 'string' } },
|
|
1522
1558
|
required: ['access_point_name'],
|
|
1523
1559
|
type: 'object',
|
|
1524
1560
|
},
|
|
1525
1561
|
errors: {
|
|
1562
|
+
description:
|
|
1563
|
+
'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1526
1564
|
items: {
|
|
1527
1565
|
properties: {
|
|
1528
|
-
error_code: {
|
|
1529
|
-
|
|
1566
|
+
error_code: {
|
|
1567
|
+
description:
|
|
1568
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
1569
|
+
type: 'string',
|
|
1570
|
+
},
|
|
1571
|
+
message: {
|
|
1572
|
+
description:
|
|
1573
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
1574
|
+
type: 'string',
|
|
1575
|
+
},
|
|
1530
1576
|
},
|
|
1531
1577
|
required: ['error_code', 'message'],
|
|
1532
1578
|
type: 'object',
|
|
@@ -1534,6 +1580,8 @@ export default {
|
|
|
1534
1580
|
type: 'array',
|
|
1535
1581
|
},
|
|
1536
1582
|
latch_metadata: {
|
|
1583
|
+
description:
|
|
1584
|
+
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1537
1585
|
properties: {
|
|
1538
1586
|
accessibility_type: { type: 'string' },
|
|
1539
1587
|
door_name: { type: 'string' },
|
|
@@ -1549,6 +1597,8 @@ export default {
|
|
|
1549
1597
|
type: 'object',
|
|
1550
1598
|
},
|
|
1551
1599
|
salto_ks_metadata: {
|
|
1600
|
+
description:
|
|
1601
|
+
'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1552
1602
|
properties: {
|
|
1553
1603
|
battery_level: { type: 'string' },
|
|
1554
1604
|
door_name: { type: 'string' },
|
|
@@ -1568,6 +1618,8 @@ export default {
|
|
|
1568
1618
|
type: 'object',
|
|
1569
1619
|
},
|
|
1570
1620
|
salto_space_metadata: {
|
|
1621
|
+
description:
|
|
1622
|
+
'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1571
1623
|
properties: {
|
|
1572
1624
|
door_description: { type: 'string' },
|
|
1573
1625
|
door_name: { type: 'string' },
|
|
@@ -1577,6 +1629,8 @@ export default {
|
|
|
1577
1629
|
type: 'object',
|
|
1578
1630
|
},
|
|
1579
1631
|
visionline_metadata: {
|
|
1632
|
+
description:
|
|
1633
|
+
'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
1580
1634
|
properties: {
|
|
1581
1635
|
door_category: {
|
|
1582
1636
|
enum: [
|
|
@@ -1626,66 +1680,69 @@ export default {
|
|
|
1626
1680
|
'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1627
1681
|
properties: {
|
|
1628
1682
|
acs_system_id: {
|
|
1629
|
-
description:
|
|
1683
|
+
description:
|
|
1684
|
+
'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1630
1685
|
format: 'uuid',
|
|
1631
1686
|
type: 'string',
|
|
1632
1687
|
},
|
|
1633
1688
|
can_add_acs_users_to_acs_access_groups: {
|
|
1634
1689
|
description:
|
|
1635
|
-
'Indicates whether the
|
|
1690
|
+
'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).',
|
|
1636
1691
|
type: 'boolean',
|
|
1637
1692
|
},
|
|
1638
1693
|
can_automate_enrollment: {
|
|
1639
1694
|
description:
|
|
1640
|
-
'Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
1695
|
+
'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).',
|
|
1641
1696
|
type: 'boolean',
|
|
1642
1697
|
},
|
|
1643
1698
|
can_create_acs_access_groups: {
|
|
1644
1699
|
description:
|
|
1645
|
-
'Indicates whether the
|
|
1700
|
+
'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).',
|
|
1646
1701
|
type: 'boolean',
|
|
1647
1702
|
},
|
|
1648
1703
|
can_remove_acs_users_from_acs_access_groups: {
|
|
1649
1704
|
description:
|
|
1650
|
-
'Indicates whether the
|
|
1705
|
+
'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).',
|
|
1651
1706
|
type: 'boolean',
|
|
1652
1707
|
},
|
|
1653
1708
|
connected_account_id: {
|
|
1654
1709
|
description:
|
|
1655
|
-
'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the
|
|
1710
|
+
'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).',
|
|
1656
1711
|
format: 'uuid',
|
|
1657
1712
|
type: 'string',
|
|
1658
1713
|
},
|
|
1659
1714
|
connected_account_ids: {
|
|
1660
1715
|
deprecated: true,
|
|
1661
1716
|
description:
|
|
1662
|
-
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the
|
|
1717
|
+
'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).',
|
|
1663
1718
|
items: { format: 'uuid', type: 'string' },
|
|
1664
1719
|
type: 'array',
|
|
1665
1720
|
'x-deprecated': 'Use `connected_account_id`.',
|
|
1666
1721
|
},
|
|
1667
1722
|
created_at: {
|
|
1668
|
-
description:
|
|
1723
|
+
description:
|
|
1724
|
+
'Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.',
|
|
1669
1725
|
format: 'date-time',
|
|
1670
1726
|
type: 'string',
|
|
1671
1727
|
},
|
|
1672
1728
|
default_credential_manager_acs_system_id: {
|
|
1673
1729
|
description:
|
|
1674
|
-
'ID of the default credential manager acs_system for this access control system.',
|
|
1730
|
+
'ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1675
1731
|
format: 'uuid',
|
|
1676
1732
|
nullable: true,
|
|
1677
1733
|
type: 'string',
|
|
1678
|
-
'x-draft': 'Needs review',
|
|
1679
1734
|
},
|
|
1680
1735
|
errors: {
|
|
1681
|
-
description:
|
|
1736
|
+
description:
|
|
1737
|
+
'Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1682
1738
|
items: {
|
|
1683
|
-
description:
|
|
1739
|
+
description:
|
|
1740
|
+
'Error associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1684
1741
|
discriminator: { propertyName: 'error_code' },
|
|
1685
1742
|
oneOf: [
|
|
1686
1743
|
{
|
|
1687
1744
|
description:
|
|
1688
|
-
'Indicates that the Seam API cannot communicate with
|
|
1745
|
+
'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).',
|
|
1689
1746
|
properties: {
|
|
1690
1747
|
created_at: {
|
|
1691
1748
|
description:
|
|
@@ -1710,7 +1767,7 @@ export default {
|
|
|
1710
1767
|
},
|
|
1711
1768
|
{
|
|
1712
1769
|
description:
|
|
1713
|
-
'Indicates that
|
|
1770
|
+
'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).',
|
|
1714
1771
|
properties: {
|
|
1715
1772
|
created_at: {
|
|
1716
1773
|
description:
|
|
@@ -1760,7 +1817,7 @@ export default {
|
|
|
1760
1817
|
},
|
|
1761
1818
|
{
|
|
1762
1819
|
description:
|
|
1763
|
-
'Indicates that the access system has been disconnected. See [
|
|
1820
|
+
'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.',
|
|
1764
1821
|
properties: {
|
|
1765
1822
|
created_at: {
|
|
1766
1823
|
description:
|
|
@@ -1785,7 +1842,7 @@ export default {
|
|
|
1785
1842
|
},
|
|
1786
1843
|
{
|
|
1787
1844
|
description:
|
|
1788
|
-
'Indicates that the login credentials are invalid. Reconnect the account using
|
|
1845
|
+
'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.',
|
|
1789
1846
|
properties: {
|
|
1790
1847
|
created_at: {
|
|
1791
1848
|
description:
|
|
@@ -1809,6 +1866,8 @@ export default {
|
|
|
1809
1866
|
type: 'object',
|
|
1810
1867
|
},
|
|
1811
1868
|
{
|
|
1869
|
+
description:
|
|
1870
|
+
'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.',
|
|
1812
1871
|
properties: {
|
|
1813
1872
|
created_at: {
|
|
1814
1873
|
description:
|
|
@@ -1818,7 +1877,7 @@ export default {
|
|
|
1818
1877
|
},
|
|
1819
1878
|
error_code: {
|
|
1820
1879
|
description:
|
|
1821
|
-
'
|
|
1880
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
1822
1881
|
enum: ['salto_ks_certification_expired'],
|
|
1823
1882
|
type: 'string',
|
|
1824
1883
|
},
|
|
@@ -1837,7 +1896,7 @@ export default {
|
|
|
1837
1896
|
},
|
|
1838
1897
|
external_type: {
|
|
1839
1898
|
description:
|
|
1840
|
-
'Brand-specific terminology for the
|
|
1899
|
+
'Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.',
|
|
1841
1900
|
enum: [
|
|
1842
1901
|
'pti_site',
|
|
1843
1902
|
'alta_org',
|
|
@@ -1857,26 +1916,29 @@ export default {
|
|
|
1857
1916
|
},
|
|
1858
1917
|
external_type_display_name: {
|
|
1859
1918
|
description:
|
|
1860
|
-
'Display name that corresponds to the brand-specific terminology for the
|
|
1919
|
+
'Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.',
|
|
1861
1920
|
type: 'string',
|
|
1862
1921
|
},
|
|
1863
1922
|
image_alt_text: {
|
|
1864
|
-
description:
|
|
1923
|
+
description:
|
|
1924
|
+
'Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.',
|
|
1865
1925
|
type: 'string',
|
|
1866
1926
|
},
|
|
1867
1927
|
image_url: {
|
|
1868
|
-
description:
|
|
1928
|
+
description:
|
|
1929
|
+
'URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1869
1930
|
type: 'string',
|
|
1870
1931
|
},
|
|
1871
1932
|
is_credential_manager: {
|
|
1872
1933
|
description:
|
|
1873
|
-
'Indicates
|
|
1934
|
+
'Indicates whether the `acs_system` is a credential manager.',
|
|
1874
1935
|
type: 'boolean',
|
|
1875
1936
|
},
|
|
1876
1937
|
location: {
|
|
1877
1938
|
properties: {
|
|
1878
1939
|
time_zone: {
|
|
1879
|
-
description:
|
|
1940
|
+
description:
|
|
1941
|
+
'Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.',
|
|
1880
1942
|
nullable: true,
|
|
1881
1943
|
type: 'string',
|
|
1882
1944
|
},
|
|
@@ -1884,7 +1946,11 @@ export default {
|
|
|
1884
1946
|
required: ['time_zone'],
|
|
1885
1947
|
type: 'object',
|
|
1886
1948
|
},
|
|
1887
|
-
name: {
|
|
1949
|
+
name: {
|
|
1950
|
+
description:
|
|
1951
|
+
'Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1952
|
+
type: 'string',
|
|
1953
|
+
},
|
|
1888
1954
|
system_type: {
|
|
1889
1955
|
deprecated: true,
|
|
1890
1956
|
enum: [
|
|
@@ -1914,7 +1980,7 @@ export default {
|
|
|
1914
1980
|
properties: {
|
|
1915
1981
|
lan_address: {
|
|
1916
1982
|
description:
|
|
1917
|
-
'IP address or hostname of the main Visionline server relative to
|
|
1983
|
+
'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.',
|
|
1918
1984
|
type: 'string',
|
|
1919
1985
|
},
|
|
1920
1986
|
mobile_access_uuid: {
|
|
@@ -1932,12 +1998,16 @@ export default {
|
|
|
1932
1998
|
type: 'object',
|
|
1933
1999
|
},
|
|
1934
2000
|
warnings: {
|
|
1935
|
-
description:
|
|
2001
|
+
description:
|
|
2002
|
+
'Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1936
2003
|
items: {
|
|
1937
|
-
description:
|
|
2004
|
+
description:
|
|
2005
|
+
'Warning associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
1938
2006
|
discriminator: { propertyName: 'warning_code' },
|
|
1939
2007
|
oneOf: [
|
|
1940
2008
|
{
|
|
2009
|
+
description:
|
|
2010
|
+
'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.',
|
|
1941
2011
|
properties: {
|
|
1942
2012
|
created_at: {
|
|
1943
2013
|
description:
|
|
@@ -1952,7 +2022,7 @@ export default {
|
|
|
1952
2022
|
},
|
|
1953
2023
|
warning_code: {
|
|
1954
2024
|
description:
|
|
1955
|
-
'
|
|
2025
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1956
2026
|
enum: ['salto_ks_subscription_limit_almost_reached'],
|
|
1957
2027
|
type: 'string',
|
|
1958
2028
|
},
|
|
@@ -1961,6 +2031,8 @@ export default {
|
|
|
1961
2031
|
type: 'object',
|
|
1962
2032
|
},
|
|
1963
2033
|
{
|
|
2034
|
+
description:
|
|
2035
|
+
'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).',
|
|
1964
2036
|
properties: {
|
|
1965
2037
|
created_at: {
|
|
1966
2038
|
description:
|
|
@@ -1979,7 +2051,7 @@ export default {
|
|
|
1979
2051
|
},
|
|
1980
2052
|
warning_code: {
|
|
1981
2053
|
description:
|
|
1982
|
-
'
|
|
2054
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1983
2055
|
enum: ['time_zone_does_not_match_location'],
|
|
1984
2056
|
type: 'string',
|
|
1985
2057
|
},
|
|
@@ -1993,7 +2065,7 @@ export default {
|
|
|
1993
2065
|
},
|
|
1994
2066
|
workspace_id: {
|
|
1995
2067
|
description:
|
|
1996
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
2068
|
+
'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).',
|
|
1997
2069
|
format: 'uuid',
|
|
1998
2070
|
type: 'string',
|
|
1999
2071
|
},
|
|
@@ -2021,7 +2093,7 @@ export default {
|
|
|
2021
2093
|
properties: {
|
|
2022
2094
|
access_schedule: {
|
|
2023
2095
|
description:
|
|
2024
|
-
"`starts_at` and `ends_at` timestamps for the
|
|
2096
|
+
"`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
|
|
2025
2097
|
properties: {
|
|
2026
2098
|
ends_at: {
|
|
2027
2099
|
description:
|
|
@@ -2042,22 +2114,25 @@ export default {
|
|
|
2042
2114
|
},
|
|
2043
2115
|
acs_system_id: {
|
|
2044
2116
|
description:
|
|
2045
|
-
'ID of the access control system that contains the
|
|
2117
|
+
'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).',
|
|
2046
2118
|
format: 'uuid',
|
|
2047
2119
|
type: 'string',
|
|
2048
2120
|
},
|
|
2049
2121
|
acs_user_id: {
|
|
2050
|
-
description:
|
|
2122
|
+
description:
|
|
2123
|
+
'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2051
2124
|
format: 'uuid',
|
|
2052
2125
|
type: 'string',
|
|
2053
2126
|
},
|
|
2054
2127
|
created_at: {
|
|
2055
|
-
description:
|
|
2128
|
+
description:
|
|
2129
|
+
'Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
|
|
2056
2130
|
format: 'date-time',
|
|
2057
2131
|
type: 'string',
|
|
2058
2132
|
},
|
|
2059
2133
|
display_name: {
|
|
2060
|
-
description:
|
|
2134
|
+
description:
|
|
2135
|
+
'Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2061
2136
|
type: 'string',
|
|
2062
2137
|
},
|
|
2063
2138
|
email: {
|
|
@@ -2067,19 +2142,22 @@ export default {
|
|
|
2067
2142
|
'x-deprecated': 'use email_address.',
|
|
2068
2143
|
},
|
|
2069
2144
|
email_address: {
|
|
2070
|
-
description:
|
|
2145
|
+
description:
|
|
2146
|
+
'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2071
2147
|
format: 'email',
|
|
2072
2148
|
type: 'string',
|
|
2073
2149
|
},
|
|
2074
2150
|
errors: {
|
|
2075
|
-
description:
|
|
2151
|
+
description:
|
|
2152
|
+
'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2076
2153
|
items: {
|
|
2077
|
-
description:
|
|
2154
|
+
description:
|
|
2155
|
+
'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2078
2156
|
discriminator: { propertyName: 'error_code' },
|
|
2079
2157
|
oneOf: [
|
|
2080
2158
|
{
|
|
2081
2159
|
description:
|
|
2082
|
-
'Indicates that the ACS user was deleted from the
|
|
2160
|
+
'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.',
|
|
2083
2161
|
properties: {
|
|
2084
2162
|
created_at: {
|
|
2085
2163
|
description:
|
|
@@ -2102,7 +2180,7 @@ export default {
|
|
|
2102
2180
|
},
|
|
2103
2181
|
{
|
|
2104
2182
|
description:
|
|
2105
|
-
'Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.',
|
|
2183
|
+
'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.',
|
|
2106
2184
|
properties: {
|
|
2107
2185
|
created_at: {
|
|
2108
2186
|
description:
|
|
@@ -2125,7 +2203,7 @@ export default {
|
|
|
2125
2203
|
},
|
|
2126
2204
|
{
|
|
2127
2205
|
description:
|
|
2128
|
-
|
|
2206
|
+
'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).',
|
|
2129
2207
|
properties: {
|
|
2130
2208
|
created_at: {
|
|
2131
2209
|
description:
|
|
@@ -2148,7 +2226,7 @@ export default {
|
|
|
2148
2226
|
},
|
|
2149
2227
|
{
|
|
2150
2228
|
description:
|
|
2151
|
-
|
|
2229
|
+
'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).',
|
|
2152
2230
|
properties: {
|
|
2153
2231
|
created_at: {
|
|
2154
2232
|
description:
|
|
@@ -2171,7 +2249,7 @@ export default {
|
|
|
2171
2249
|
},
|
|
2172
2250
|
{
|
|
2173
2251
|
description:
|
|
2174
|
-
|
|
2252
|
+
'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).',
|
|
2175
2253
|
properties: {
|
|
2176
2254
|
created_at: {
|
|
2177
2255
|
description:
|
|
@@ -2197,7 +2275,8 @@ export default {
|
|
|
2197
2275
|
type: 'array',
|
|
2198
2276
|
},
|
|
2199
2277
|
external_type: {
|
|
2200
|
-
description:
|
|
2278
|
+
description:
|
|
2279
|
+
'Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
|
|
2201
2280
|
enum: [
|
|
2202
2281
|
'pti_user',
|
|
2203
2282
|
'brivo_user',
|
|
@@ -2211,11 +2290,12 @@ export default {
|
|
|
2211
2290
|
},
|
|
2212
2291
|
external_type_display_name: {
|
|
2213
2292
|
description:
|
|
2214
|
-
'Display name that corresponds to the brand-specific terminology for the
|
|
2293
|
+
'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.',
|
|
2215
2294
|
type: 'string',
|
|
2216
2295
|
},
|
|
2217
2296
|
full_name: {
|
|
2218
|
-
description:
|
|
2297
|
+
description:
|
|
2298
|
+
'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2219
2299
|
type: 'string',
|
|
2220
2300
|
},
|
|
2221
2301
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
@@ -2227,7 +2307,7 @@ export default {
|
|
|
2227
2307
|
is_managed: { enum: [true], type: 'boolean' },
|
|
2228
2308
|
is_suspended: {
|
|
2229
2309
|
description:
|
|
2230
|
-
'Indicates whether the
|
|
2310
|
+
'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).',
|
|
2231
2311
|
type: 'boolean',
|
|
2232
2312
|
},
|
|
2233
2313
|
latest_desired_state_synced_with_provider_at: {
|
|
@@ -2238,44 +2318,55 @@ export default {
|
|
|
2238
2318
|
},
|
|
2239
2319
|
phone_number: {
|
|
2240
2320
|
description:
|
|
2241
|
-
'Phone number of the
|
|
2321
|
+
'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
2242
2322
|
type: 'string',
|
|
2243
2323
|
},
|
|
2244
2324
|
user_identity_email_address: {
|
|
2245
2325
|
description:
|
|
2246
|
-
'Email address of the user identity associated with the
|
|
2326
|
+
'Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2247
2327
|
nullable: true,
|
|
2248
2328
|
type: 'string',
|
|
2249
2329
|
},
|
|
2250
2330
|
user_identity_full_name: {
|
|
2251
2331
|
description:
|
|
2252
|
-
'Full name of the user identity associated with the
|
|
2332
|
+
'Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2253
2333
|
nullable: true,
|
|
2254
2334
|
type: 'string',
|
|
2255
2335
|
},
|
|
2256
2336
|
user_identity_id: {
|
|
2257
2337
|
description:
|
|
2258
|
-
'ID of the user identity associated with the
|
|
2338
|
+
'ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2259
2339
|
type: 'string',
|
|
2260
2340
|
},
|
|
2261
2341
|
user_identity_phone_number: {
|
|
2262
2342
|
description:
|
|
2263
|
-
'Phone number of the user identity associated with the
|
|
2343
|
+
'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`).',
|
|
2264
2344
|
nullable: true,
|
|
2265
2345
|
type: 'string',
|
|
2266
2346
|
},
|
|
2267
2347
|
warnings: {
|
|
2268
|
-
description:
|
|
2348
|
+
description:
|
|
2349
|
+
'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2269
2350
|
items: {
|
|
2270
|
-
description:
|
|
2351
|
+
description:
|
|
2352
|
+
'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
2271
2353
|
discriminator: { propertyName: 'warning_code' },
|
|
2272
2354
|
oneOf: [
|
|
2273
2355
|
{
|
|
2274
2356
|
description:
|
|
2275
|
-
'Indicates that the user is being deleted from the
|
|
2357
|
+
'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.',
|
|
2276
2358
|
properties: {
|
|
2277
|
-
created_at: {
|
|
2278
|
-
|
|
2359
|
+
created_at: {
|
|
2360
|
+
description:
|
|
2361
|
+
'Date and time at which Seam created the warning.',
|
|
2362
|
+
format: 'date-time',
|
|
2363
|
+
type: 'string',
|
|
2364
|
+
},
|
|
2365
|
+
message: {
|
|
2366
|
+
description:
|
|
2367
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2368
|
+
type: 'string',
|
|
2369
|
+
},
|
|
2279
2370
|
warning_code: { enum: ['being_deleted'], type: 'string' },
|
|
2280
2371
|
},
|
|
2281
2372
|
required: ['created_at', 'message', 'warning_code'],
|
|
@@ -2283,10 +2374,19 @@ export default {
|
|
|
2283
2374
|
},
|
|
2284
2375
|
{
|
|
2285
2376
|
description:
|
|
2286
|
-
'Indicates that the user is not subscribed on
|
|
2377
|
+
'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.',
|
|
2287
2378
|
properties: {
|
|
2288
|
-
created_at: {
|
|
2289
|
-
|
|
2379
|
+
created_at: {
|
|
2380
|
+
description:
|
|
2381
|
+
'Date and time at which Seam created the warning.',
|
|
2382
|
+
format: 'date-time',
|
|
2383
|
+
type: 'string',
|
|
2384
|
+
},
|
|
2385
|
+
message: {
|
|
2386
|
+
description:
|
|
2387
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2388
|
+
type: 'string',
|
|
2389
|
+
},
|
|
2290
2390
|
warning_code: {
|
|
2291
2391
|
enum: ['salto_ks_user_not_subscribed'],
|
|
2292
2392
|
type: 'string',
|
|
@@ -2297,10 +2397,19 @@ export default {
|
|
|
2297
2397
|
},
|
|
2298
2398
|
{
|
|
2299
2399
|
description:
|
|
2300
|
-
'An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.',
|
|
2400
|
+
'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.',
|
|
2301
2401
|
properties: {
|
|
2302
|
-
created_at: {
|
|
2303
|
-
|
|
2402
|
+
created_at: {
|
|
2403
|
+
description:
|
|
2404
|
+
'Date and time at which Seam created the warning.',
|
|
2405
|
+
format: 'date-time',
|
|
2406
|
+
type: 'string',
|
|
2407
|
+
},
|
|
2408
|
+
message: {
|
|
2409
|
+
description:
|
|
2410
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
2411
|
+
type: 'string',
|
|
2412
|
+
},
|
|
2304
2413
|
warning_code: {
|
|
2305
2414
|
enum: ['unknown_issue_with_acs_user'],
|
|
2306
2415
|
type: 'string',
|
|
@@ -2315,7 +2424,7 @@ export default {
|
|
|
2315
2424
|
},
|
|
2316
2425
|
workspace_id: {
|
|
2317
2426
|
description:
|
|
2318
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
2427
|
+
'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).',
|
|
2319
2428
|
format: 'uuid',
|
|
2320
2429
|
type: 'string',
|
|
2321
2430
|
},
|
|
@@ -2531,20 +2640,20 @@ export default {
|
|
|
2531
2640
|
properties: {
|
|
2532
2641
|
card_number: {
|
|
2533
2642
|
description:
|
|
2534
|
-
'A number or string that physically identifies
|
|
2643
|
+
'A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2535
2644
|
nullable: true,
|
|
2536
2645
|
type: 'string',
|
|
2537
2646
|
},
|
|
2538
2647
|
created_at: {
|
|
2539
2648
|
description:
|
|
2540
|
-
'Date and time the credential was created.',
|
|
2649
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
2541
2650
|
format: 'date-time',
|
|
2542
2651
|
nullable: true,
|
|
2543
2652
|
type: 'string',
|
|
2544
2653
|
},
|
|
2545
2654
|
ends_at: {
|
|
2546
2655
|
description:
|
|
2547
|
-
'Date and time the credential will stop being
|
|
2656
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable.',
|
|
2548
2657
|
format: 'date-time',
|
|
2549
2658
|
nullable: true,
|
|
2550
2659
|
type: 'string',
|
|
@@ -2552,39 +2661,79 @@ export default {
|
|
|
2552
2661
|
is_issued: { nullable: true, type: 'boolean' },
|
|
2553
2662
|
starts_at: {
|
|
2554
2663
|
description:
|
|
2555
|
-
'Date and time the credential
|
|
2664
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable.',
|
|
2556
2665
|
format: 'date-time',
|
|
2557
2666
|
nullable: true,
|
|
2558
2667
|
type: 'string',
|
|
2559
2668
|
},
|
|
2560
2669
|
visionline_metadata: {
|
|
2561
2670
|
description:
|
|
2562
|
-
'Visionline-specific metadata for the credential.',
|
|
2671
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2563
2672
|
properties: {
|
|
2564
|
-
cancelled: {
|
|
2673
|
+
cancelled: {
|
|
2674
|
+
description:
|
|
2675
|
+
'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled.',
|
|
2676
|
+
type: 'boolean',
|
|
2677
|
+
},
|
|
2565
2678
|
card_format: {
|
|
2679
|
+
description:
|
|
2680
|
+
'Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2566
2681
|
enum: ['TLCode', 'rfid48'],
|
|
2567
2682
|
type: 'string',
|
|
2568
2683
|
},
|
|
2569
|
-
card_holder: {
|
|
2570
|
-
|
|
2684
|
+
card_holder: {
|
|
2685
|
+
description:
|
|
2686
|
+
'Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2687
|
+
type: 'string',
|
|
2688
|
+
},
|
|
2689
|
+
card_id: {
|
|
2690
|
+
description:
|
|
2691
|
+
'Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2692
|
+
type: 'string',
|
|
2693
|
+
},
|
|
2571
2694
|
common_acs_entrance_ids: {
|
|
2695
|
+
description:
|
|
2696
|
+
'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).',
|
|
2572
2697
|
items: { format: 'uuid', type: 'string' },
|
|
2573
2698
|
type: 'array',
|
|
2574
2699
|
},
|
|
2575
|
-
discarded: {
|
|
2576
|
-
|
|
2700
|
+
discarded: {
|
|
2701
|
+
description:
|
|
2702
|
+
'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded.',
|
|
2703
|
+
type: 'boolean',
|
|
2704
|
+
},
|
|
2705
|
+
expired: {
|
|
2706
|
+
description:
|
|
2707
|
+
'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired.',
|
|
2708
|
+
type: 'boolean',
|
|
2709
|
+
},
|
|
2577
2710
|
guest_acs_entrance_ids: {
|
|
2711
|
+
description:
|
|
2712
|
+
'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).',
|
|
2578
2713
|
items: { format: 'uuid', type: 'string' },
|
|
2579
2714
|
type: 'array',
|
|
2580
2715
|
},
|
|
2581
2716
|
number_of_issued_cards: {
|
|
2717
|
+
description:
|
|
2718
|
+
'Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2582
2719
|
format: 'float',
|
|
2583
2720
|
type: 'number',
|
|
2584
2721
|
},
|
|
2585
|
-
overridden: {
|
|
2586
|
-
|
|
2587
|
-
|
|
2722
|
+
overridden: {
|
|
2723
|
+
description:
|
|
2724
|
+
'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden.',
|
|
2725
|
+
type: 'boolean',
|
|
2726
|
+
},
|
|
2727
|
+
overwritten: {
|
|
2728
|
+
description:
|
|
2729
|
+
'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten.',
|
|
2730
|
+
type: 'boolean',
|
|
2731
|
+
},
|
|
2732
|
+
pending_auto_update: {
|
|
2733
|
+
description:
|
|
2734
|
+
'Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update.',
|
|
2735
|
+
type: 'boolean',
|
|
2736
|
+
},
|
|
2588
2737
|
},
|
|
2589
2738
|
required: [
|
|
2590
2739
|
'card_id',
|
|
@@ -2615,16 +2764,17 @@ export default {
|
|
|
2615
2764
|
oneOf: [
|
|
2616
2765
|
{
|
|
2617
2766
|
description:
|
|
2618
|
-
'Means by which
|
|
2767
|
+
'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.',
|
|
2619
2768
|
properties: {
|
|
2620
2769
|
access_method: {
|
|
2621
2770
|
description:
|
|
2622
|
-
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
2771
|
+
'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
|
|
2623
2772
|
enum: ['code', 'card', 'mobile_key'],
|
|
2624
2773
|
type: 'string',
|
|
2625
2774
|
},
|
|
2626
2775
|
acs_credential_id: {
|
|
2627
|
-
description:
|
|
2776
|
+
description:
|
|
2777
|
+
'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2628
2778
|
format: 'uuid',
|
|
2629
2779
|
type: 'string',
|
|
2630
2780
|
},
|
|
@@ -2634,19 +2784,19 @@ export default {
|
|
|
2634
2784
|
},
|
|
2635
2785
|
acs_system_id: {
|
|
2636
2786
|
description:
|
|
2637
|
-
'ID of the access control system that contains the credential.',
|
|
2787
|
+
'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).',
|
|
2638
2788
|
format: 'uuid',
|
|
2639
2789
|
type: 'string',
|
|
2640
2790
|
},
|
|
2641
2791
|
acs_user_id: {
|
|
2642
2792
|
description:
|
|
2643
|
-
'ID of the ACS user to whom the credential belongs.',
|
|
2793
|
+
'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.',
|
|
2644
2794
|
format: 'uuid',
|
|
2645
2795
|
type: 'string',
|
|
2646
2796
|
},
|
|
2647
2797
|
assa_abloy_vostio_metadata: {
|
|
2648
2798
|
description:
|
|
2649
|
-
'Vostio-specific metadata for the credential.',
|
|
2799
|
+
'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2650
2800
|
properties: {
|
|
2651
2801
|
door_names: {
|
|
2652
2802
|
items: { type: 'string' },
|
|
@@ -2662,33 +2812,38 @@ export default {
|
|
|
2662
2812
|
},
|
|
2663
2813
|
type: 'object',
|
|
2664
2814
|
},
|
|
2665
|
-
card_number: {
|
|
2815
|
+
card_number: {
|
|
2816
|
+
description:
|
|
2817
|
+
'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2818
|
+
nullable: true,
|
|
2819
|
+
type: 'string',
|
|
2820
|
+
},
|
|
2666
2821
|
code: {
|
|
2667
2822
|
description:
|
|
2668
|
-
'Access (PIN) code for the credential.',
|
|
2823
|
+
'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2669
2824
|
nullable: true,
|
|
2670
2825
|
type: 'string',
|
|
2671
2826
|
},
|
|
2672
2827
|
created_at: {
|
|
2673
2828
|
description:
|
|
2674
|
-
'Date and time at which the credential was created.',
|
|
2829
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
2675
2830
|
format: 'date-time',
|
|
2676
2831
|
type: 'string',
|
|
2677
2832
|
},
|
|
2678
2833
|
display_name: {
|
|
2679
2834
|
description:
|
|
2680
|
-
'Display name that corresponds to the credential type.',
|
|
2835
|
+
'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
2681
2836
|
minLength: 1,
|
|
2682
2837
|
type: 'string',
|
|
2683
2838
|
},
|
|
2684
2839
|
ends_at: {
|
|
2685
2840
|
description:
|
|
2686
|
-
'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`.',
|
|
2841
|
+
'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`.',
|
|
2687
2842
|
type: 'string',
|
|
2688
2843
|
},
|
|
2689
2844
|
errors: {
|
|
2690
2845
|
description:
|
|
2691
|
-
'Errors associated with the
|
|
2846
|
+
'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2692
2847
|
items: {
|
|
2693
2848
|
properties: {
|
|
2694
2849
|
error_code: { type: 'string' },
|
|
@@ -2701,7 +2856,7 @@ export default {
|
|
|
2701
2856
|
},
|
|
2702
2857
|
external_type: {
|
|
2703
2858
|
description:
|
|
2704
|
-
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
2859
|
+
'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`.',
|
|
2705
2860
|
enum: [
|
|
2706
2861
|
'pti_card',
|
|
2707
2862
|
'brivo_credential',
|
|
@@ -2715,52 +2870,59 @@ export default {
|
|
|
2715
2870
|
},
|
|
2716
2871
|
external_type_display_name: {
|
|
2717
2872
|
description:
|
|
2718
|
-
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
2873
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
2719
2874
|
type: 'string',
|
|
2720
2875
|
},
|
|
2721
|
-
is_issued: {
|
|
2876
|
+
is_issued: {
|
|
2877
|
+
description:
|
|
2878
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
2879
|
+
type: 'boolean',
|
|
2880
|
+
},
|
|
2722
2881
|
is_latest_desired_state_synced_with_provider: {
|
|
2723
2882
|
description:
|
|
2724
|
-
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
2883
|
+
'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.',
|
|
2725
2884
|
nullable: true,
|
|
2726
2885
|
type: 'boolean',
|
|
2727
2886
|
},
|
|
2728
2887
|
is_managed: { enum: [true], type: 'boolean' },
|
|
2729
2888
|
is_multi_phone_sync_credential: {
|
|
2730
2889
|
description:
|
|
2731
|
-
'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).',
|
|
2890
|
+
'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).',
|
|
2732
2891
|
type: 'boolean',
|
|
2733
2892
|
},
|
|
2734
2893
|
is_one_time_use: {
|
|
2735
2894
|
description:
|
|
2736
|
-
'Indicates whether the credential can only be used once. If
|
|
2895
|
+
'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.',
|
|
2737
2896
|
type: 'boolean',
|
|
2738
2897
|
},
|
|
2739
2898
|
issued_at: {
|
|
2899
|
+
description:
|
|
2900
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
2740
2901
|
format: 'date-time',
|
|
2741
2902
|
nullable: true,
|
|
2742
2903
|
type: 'string',
|
|
2743
2904
|
},
|
|
2744
2905
|
latest_desired_state_synced_with_provider_at: {
|
|
2745
2906
|
description:
|
|
2746
|
-
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
2907
|
+
'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.',
|
|
2747
2908
|
format: 'date-time',
|
|
2748
2909
|
nullable: true,
|
|
2749
2910
|
type: 'string',
|
|
2750
2911
|
},
|
|
2751
2912
|
parent_acs_credential_id: {
|
|
2752
|
-
description:
|
|
2913
|
+
description:
|
|
2914
|
+
'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2753
2915
|
format: 'uuid',
|
|
2754
2916
|
type: 'string',
|
|
2755
2917
|
},
|
|
2756
2918
|
starts_at: {
|
|
2757
2919
|
description:
|
|
2758
|
-
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
2920
|
+
'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.',
|
|
2759
2921
|
type: 'string',
|
|
2760
2922
|
},
|
|
2761
2923
|
visionline_metadata: {
|
|
2762
2924
|
description:
|
|
2763
|
-
'Visionline-specific metadata for the credential.',
|
|
2925
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2764
2926
|
properties: {
|
|
2765
2927
|
auto_join: { type: 'boolean' },
|
|
2766
2928
|
card_function_type: {
|
|
@@ -2788,15 +2950,15 @@ export default {
|
|
|
2788
2950
|
},
|
|
2789
2951
|
warnings: {
|
|
2790
2952
|
description:
|
|
2791
|
-
'Warnings associated with the
|
|
2953
|
+
'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2792
2954
|
items: {
|
|
2793
2955
|
description:
|
|
2794
|
-
'Warning associated with the
|
|
2956
|
+
'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
2795
2957
|
discriminator: { propertyName: 'warning_code' },
|
|
2796
2958
|
oneOf: [
|
|
2797
2959
|
{
|
|
2798
2960
|
description:
|
|
2799
|
-
'Indicates that the credential is waiting to be issued.',
|
|
2961
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
2800
2962
|
properties: {
|
|
2801
2963
|
created_at: {
|
|
2802
2964
|
description:
|
|
@@ -2825,7 +2987,7 @@ export default {
|
|
|
2825
2987
|
},
|
|
2826
2988
|
{
|
|
2827
2989
|
description:
|
|
2828
|
-
"Indicates that the schedule of one of the credential's children was modified externally.",
|
|
2990
|
+
"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.",
|
|
2829
2991
|
properties: {
|
|
2830
2992
|
created_at: {
|
|
2831
2993
|
description:
|
|
@@ -2854,7 +3016,7 @@ export default {
|
|
|
2854
3016
|
},
|
|
2855
3017
|
{
|
|
2856
3018
|
description:
|
|
2857
|
-
'Indicates that the schedule of
|
|
3019
|
+
'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.',
|
|
2858
3020
|
properties: {
|
|
2859
3021
|
created_at: {
|
|
2860
3022
|
description:
|
|
@@ -2883,7 +3045,7 @@ export default {
|
|
|
2883
3045
|
},
|
|
2884
3046
|
{
|
|
2885
3047
|
description:
|
|
2886
|
-
'Indicates that
|
|
3048
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
2887
3049
|
properties: {
|
|
2888
3050
|
created_at: {
|
|
2889
3051
|
description:
|
|
@@ -2912,7 +3074,7 @@ export default {
|
|
|
2912
3074
|
},
|
|
2913
3075
|
{
|
|
2914
3076
|
description:
|
|
2915
|
-
'An unknown issue occurred while syncing the state of
|
|
3077
|
+
'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.',
|
|
2916
3078
|
properties: {
|
|
2917
3079
|
created_at: {
|
|
2918
3080
|
description:
|
|
@@ -2943,7 +3105,7 @@ export default {
|
|
|
2943
3105
|
},
|
|
2944
3106
|
{
|
|
2945
3107
|
description:
|
|
2946
|
-
'Access permissions for
|
|
3108
|
+
'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.',
|
|
2947
3109
|
properties: {
|
|
2948
3110
|
created_at: {
|
|
2949
3111
|
description:
|
|
@@ -2976,7 +3138,7 @@ export default {
|
|
|
2976
3138
|
},
|
|
2977
3139
|
workspace_id: {
|
|
2978
3140
|
description:
|
|
2979
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
3141
|
+
'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).',
|
|
2980
3142
|
format: 'uuid',
|
|
2981
3143
|
type: 'string',
|
|
2982
3144
|
},
|
|
@@ -2997,16 +3159,17 @@ export default {
|
|
|
2997
3159
|
},
|
|
2998
3160
|
{
|
|
2999
3161
|
description:
|
|
3000
|
-
'Means by which
|
|
3162
|
+
'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.',
|
|
3001
3163
|
properties: {
|
|
3002
3164
|
access_method: {
|
|
3003
3165
|
description:
|
|
3004
|
-
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
3166
|
+
'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
|
|
3005
3167
|
enum: ['code', 'card', 'mobile_key'],
|
|
3006
3168
|
type: 'string',
|
|
3007
3169
|
},
|
|
3008
3170
|
acs_credential_id: {
|
|
3009
|
-
description:
|
|
3171
|
+
description:
|
|
3172
|
+
'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3010
3173
|
format: 'uuid',
|
|
3011
3174
|
type: 'string',
|
|
3012
3175
|
},
|
|
@@ -3016,19 +3179,19 @@ export default {
|
|
|
3016
3179
|
},
|
|
3017
3180
|
acs_system_id: {
|
|
3018
3181
|
description:
|
|
3019
|
-
'ID of the access control system that contains the credential.',
|
|
3182
|
+
'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).',
|
|
3020
3183
|
format: 'uuid',
|
|
3021
3184
|
type: 'string',
|
|
3022
3185
|
},
|
|
3023
3186
|
acs_user_id: {
|
|
3024
3187
|
description:
|
|
3025
|
-
'ID of the ACS user to whom the credential belongs.',
|
|
3188
|
+
'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.',
|
|
3026
3189
|
format: 'uuid',
|
|
3027
3190
|
type: 'string',
|
|
3028
3191
|
},
|
|
3029
3192
|
assa_abloy_vostio_metadata: {
|
|
3030
3193
|
description:
|
|
3031
|
-
'Vostio-specific metadata for the credential.',
|
|
3194
|
+
'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3032
3195
|
properties: {
|
|
3033
3196
|
door_names: {
|
|
3034
3197
|
items: { type: 'string' },
|
|
@@ -3044,33 +3207,38 @@ export default {
|
|
|
3044
3207
|
},
|
|
3045
3208
|
type: 'object',
|
|
3046
3209
|
},
|
|
3047
|
-
card_number: {
|
|
3210
|
+
card_number: {
|
|
3211
|
+
description:
|
|
3212
|
+
'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3213
|
+
nullable: true,
|
|
3214
|
+
type: 'string',
|
|
3215
|
+
},
|
|
3048
3216
|
code: {
|
|
3049
3217
|
description:
|
|
3050
|
-
'Access (PIN) code for the credential.',
|
|
3218
|
+
'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3051
3219
|
nullable: true,
|
|
3052
3220
|
type: 'string',
|
|
3053
3221
|
},
|
|
3054
3222
|
created_at: {
|
|
3055
3223
|
description:
|
|
3056
|
-
'Date and time at which the credential was created.',
|
|
3224
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
3057
3225
|
format: 'date-time',
|
|
3058
3226
|
type: 'string',
|
|
3059
3227
|
},
|
|
3060
3228
|
display_name: {
|
|
3061
3229
|
description:
|
|
3062
|
-
'Display name that corresponds to the credential type.',
|
|
3230
|
+
'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
3063
3231
|
minLength: 1,
|
|
3064
3232
|
type: 'string',
|
|
3065
3233
|
},
|
|
3066
3234
|
ends_at: {
|
|
3067
3235
|
description:
|
|
3068
|
-
'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`.',
|
|
3236
|
+
'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`.',
|
|
3069
3237
|
type: 'string',
|
|
3070
3238
|
},
|
|
3071
3239
|
errors: {
|
|
3072
3240
|
description:
|
|
3073
|
-
'Errors associated with the
|
|
3241
|
+
'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3074
3242
|
items: {
|
|
3075
3243
|
properties: {
|
|
3076
3244
|
error_code: { type: 'string' },
|
|
@@ -3083,7 +3251,7 @@ export default {
|
|
|
3083
3251
|
},
|
|
3084
3252
|
external_type: {
|
|
3085
3253
|
description:
|
|
3086
|
-
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
3254
|
+
'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`.',
|
|
3087
3255
|
enum: [
|
|
3088
3256
|
'pti_card',
|
|
3089
3257
|
'brivo_credential',
|
|
@@ -3097,52 +3265,59 @@ export default {
|
|
|
3097
3265
|
},
|
|
3098
3266
|
external_type_display_name: {
|
|
3099
3267
|
description:
|
|
3100
|
-
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
3268
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
3101
3269
|
type: 'string',
|
|
3102
3270
|
},
|
|
3103
|
-
is_issued: {
|
|
3271
|
+
is_issued: {
|
|
3272
|
+
description:
|
|
3273
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
3274
|
+
type: 'boolean',
|
|
3275
|
+
},
|
|
3104
3276
|
is_latest_desired_state_synced_with_provider: {
|
|
3105
3277
|
description:
|
|
3106
|
-
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
3278
|
+
'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.',
|
|
3107
3279
|
nullable: true,
|
|
3108
3280
|
type: 'boolean',
|
|
3109
3281
|
},
|
|
3110
3282
|
is_managed: { enum: [false], type: 'boolean' },
|
|
3111
3283
|
is_multi_phone_sync_credential: {
|
|
3112
3284
|
description:
|
|
3113
|
-
'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).',
|
|
3285
|
+
'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).',
|
|
3114
3286
|
type: 'boolean',
|
|
3115
3287
|
},
|
|
3116
3288
|
is_one_time_use: {
|
|
3117
3289
|
description:
|
|
3118
|
-
'Indicates whether the credential can only be used once. If
|
|
3290
|
+
'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.',
|
|
3119
3291
|
type: 'boolean',
|
|
3120
3292
|
},
|
|
3121
3293
|
issued_at: {
|
|
3294
|
+
description:
|
|
3295
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
3122
3296
|
format: 'date-time',
|
|
3123
3297
|
nullable: true,
|
|
3124
3298
|
type: 'string',
|
|
3125
3299
|
},
|
|
3126
3300
|
latest_desired_state_synced_with_provider_at: {
|
|
3127
3301
|
description:
|
|
3128
|
-
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
3302
|
+
'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.',
|
|
3129
3303
|
format: 'date-time',
|
|
3130
3304
|
nullable: true,
|
|
3131
3305
|
type: 'string',
|
|
3132
3306
|
},
|
|
3133
3307
|
parent_acs_credential_id: {
|
|
3134
|
-
description:
|
|
3308
|
+
description:
|
|
3309
|
+
'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3135
3310
|
format: 'uuid',
|
|
3136
3311
|
type: 'string',
|
|
3137
3312
|
},
|
|
3138
3313
|
starts_at: {
|
|
3139
3314
|
description:
|
|
3140
|
-
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
3315
|
+
'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.',
|
|
3141
3316
|
type: 'string',
|
|
3142
3317
|
},
|
|
3143
3318
|
visionline_metadata: {
|
|
3144
3319
|
description:
|
|
3145
|
-
'Visionline-specific metadata for the credential.',
|
|
3320
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3146
3321
|
properties: {
|
|
3147
3322
|
auto_join: { type: 'boolean' },
|
|
3148
3323
|
card_function_type: {
|
|
@@ -3170,15 +3345,15 @@ export default {
|
|
|
3170
3345
|
},
|
|
3171
3346
|
warnings: {
|
|
3172
3347
|
description:
|
|
3173
|
-
'Warnings associated with the
|
|
3348
|
+
'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3174
3349
|
items: {
|
|
3175
3350
|
description:
|
|
3176
|
-
'Warning associated with the
|
|
3351
|
+
'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3177
3352
|
discriminator: { propertyName: 'warning_code' },
|
|
3178
3353
|
oneOf: [
|
|
3179
3354
|
{
|
|
3180
3355
|
description:
|
|
3181
|
-
'Indicates that the credential is waiting to be issued.',
|
|
3356
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
3182
3357
|
properties: {
|
|
3183
3358
|
created_at: {
|
|
3184
3359
|
description:
|
|
@@ -3207,7 +3382,7 @@ export default {
|
|
|
3207
3382
|
},
|
|
3208
3383
|
{
|
|
3209
3384
|
description:
|
|
3210
|
-
"Indicates that the schedule of one of the credential's children was modified externally.",
|
|
3385
|
+
"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.",
|
|
3211
3386
|
properties: {
|
|
3212
3387
|
created_at: {
|
|
3213
3388
|
description:
|
|
@@ -3236,7 +3411,7 @@ export default {
|
|
|
3236
3411
|
},
|
|
3237
3412
|
{
|
|
3238
3413
|
description:
|
|
3239
|
-
'Indicates that the schedule of
|
|
3414
|
+
'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.',
|
|
3240
3415
|
properties: {
|
|
3241
3416
|
created_at: {
|
|
3242
3417
|
description:
|
|
@@ -3265,7 +3440,7 @@ export default {
|
|
|
3265
3440
|
},
|
|
3266
3441
|
{
|
|
3267
3442
|
description:
|
|
3268
|
-
'Indicates that
|
|
3443
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
3269
3444
|
properties: {
|
|
3270
3445
|
created_at: {
|
|
3271
3446
|
description:
|
|
@@ -3294,7 +3469,7 @@ export default {
|
|
|
3294
3469
|
},
|
|
3295
3470
|
{
|
|
3296
3471
|
description:
|
|
3297
|
-
'An unknown issue occurred while syncing the state of
|
|
3472
|
+
'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.',
|
|
3298
3473
|
properties: {
|
|
3299
3474
|
created_at: {
|
|
3300
3475
|
description:
|
|
@@ -3325,7 +3500,7 @@ export default {
|
|
|
3325
3500
|
},
|
|
3326
3501
|
{
|
|
3327
3502
|
description:
|
|
3328
|
-
'Access permissions for
|
|
3503
|
+
'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.',
|
|
3329
3504
|
properties: {
|
|
3330
3505
|
created_at: {
|
|
3331
3506
|
description:
|
|
@@ -3358,7 +3533,7 @@ export default {
|
|
|
3358
3533
|
},
|
|
3359
3534
|
workspace_id: {
|
|
3360
3535
|
description:
|
|
3361
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
3536
|
+
'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).',
|
|
3362
3537
|
format: 'uuid',
|
|
3363
3538
|
type: 'string',
|
|
3364
3539
|
},
|
|
@@ -3510,20 +3685,21 @@ export default {
|
|
|
3510
3685
|
error: { nullable: true },
|
|
3511
3686
|
result: {
|
|
3512
3687
|
description:
|
|
3513
|
-
'Means by which
|
|
3688
|
+
'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.',
|
|
3514
3689
|
oneOf: [
|
|
3515
3690
|
{
|
|
3516
3691
|
description:
|
|
3517
|
-
'Means by which
|
|
3692
|
+
'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.',
|
|
3518
3693
|
properties: {
|
|
3519
3694
|
access_method: {
|
|
3520
3695
|
description:
|
|
3521
|
-
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
3696
|
+
'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
|
|
3522
3697
|
enum: ['code', 'card', 'mobile_key'],
|
|
3523
3698
|
type: 'string',
|
|
3524
3699
|
},
|
|
3525
3700
|
acs_credential_id: {
|
|
3526
|
-
description:
|
|
3701
|
+
description:
|
|
3702
|
+
'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3527
3703
|
format: 'uuid',
|
|
3528
3704
|
type: 'string',
|
|
3529
3705
|
},
|
|
@@ -3533,19 +3709,19 @@ export default {
|
|
|
3533
3709
|
},
|
|
3534
3710
|
acs_system_id: {
|
|
3535
3711
|
description:
|
|
3536
|
-
'ID of the access control system that contains the credential.',
|
|
3712
|
+
'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).',
|
|
3537
3713
|
format: 'uuid',
|
|
3538
3714
|
type: 'string',
|
|
3539
3715
|
},
|
|
3540
3716
|
acs_user_id: {
|
|
3541
3717
|
description:
|
|
3542
|
-
'ID of the ACS user to whom the credential belongs.',
|
|
3718
|
+
'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.',
|
|
3543
3719
|
format: 'uuid',
|
|
3544
3720
|
type: 'string',
|
|
3545
3721
|
},
|
|
3546
3722
|
assa_abloy_vostio_metadata: {
|
|
3547
3723
|
description:
|
|
3548
|
-
'Vostio-specific metadata for the credential.',
|
|
3724
|
+
'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3549
3725
|
properties: {
|
|
3550
3726
|
door_names: {
|
|
3551
3727
|
items: { type: 'string' },
|
|
@@ -3561,32 +3737,38 @@ export default {
|
|
|
3561
3737
|
},
|
|
3562
3738
|
type: 'object',
|
|
3563
3739
|
},
|
|
3564
|
-
card_number: {
|
|
3740
|
+
card_number: {
|
|
3741
|
+
description:
|
|
3742
|
+
'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3743
|
+
nullable: true,
|
|
3744
|
+
type: 'string',
|
|
3745
|
+
},
|
|
3565
3746
|
code: {
|
|
3566
|
-
description:
|
|
3747
|
+
description:
|
|
3748
|
+
'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3567
3749
|
nullable: true,
|
|
3568
3750
|
type: 'string',
|
|
3569
3751
|
},
|
|
3570
3752
|
created_at: {
|
|
3571
3753
|
description:
|
|
3572
|
-
'Date and time at which the credential was created.',
|
|
3754
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
3573
3755
|
format: 'date-time',
|
|
3574
3756
|
type: 'string',
|
|
3575
3757
|
},
|
|
3576
3758
|
display_name: {
|
|
3577
3759
|
description:
|
|
3578
|
-
'Display name that corresponds to the credential type.',
|
|
3760
|
+
'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
3579
3761
|
minLength: 1,
|
|
3580
3762
|
type: 'string',
|
|
3581
3763
|
},
|
|
3582
3764
|
ends_at: {
|
|
3583
3765
|
description:
|
|
3584
|
-
'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`.',
|
|
3766
|
+
'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`.',
|
|
3585
3767
|
type: 'string',
|
|
3586
3768
|
},
|
|
3587
3769
|
errors: {
|
|
3588
3770
|
description:
|
|
3589
|
-
'Errors associated with the
|
|
3771
|
+
'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3590
3772
|
items: {
|
|
3591
3773
|
properties: {
|
|
3592
3774
|
error_code: { type: 'string' },
|
|
@@ -3599,7 +3781,7 @@ export default {
|
|
|
3599
3781
|
},
|
|
3600
3782
|
external_type: {
|
|
3601
3783
|
description:
|
|
3602
|
-
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
3784
|
+
'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`.',
|
|
3603
3785
|
enum: [
|
|
3604
3786
|
'pti_card',
|
|
3605
3787
|
'brivo_credential',
|
|
@@ -3613,52 +3795,59 @@ export default {
|
|
|
3613
3795
|
},
|
|
3614
3796
|
external_type_display_name: {
|
|
3615
3797
|
description:
|
|
3616
|
-
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
3798
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
3617
3799
|
type: 'string',
|
|
3618
3800
|
},
|
|
3619
|
-
is_issued: {
|
|
3801
|
+
is_issued: {
|
|
3802
|
+
description:
|
|
3803
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
3804
|
+
type: 'boolean',
|
|
3805
|
+
},
|
|
3620
3806
|
is_latest_desired_state_synced_with_provider: {
|
|
3621
3807
|
description:
|
|
3622
|
-
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
3808
|
+
'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.',
|
|
3623
3809
|
nullable: true,
|
|
3624
3810
|
type: 'boolean',
|
|
3625
3811
|
},
|
|
3626
3812
|
is_managed: { enum: [true], type: 'boolean' },
|
|
3627
3813
|
is_multi_phone_sync_credential: {
|
|
3628
3814
|
description:
|
|
3629
|
-
'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).',
|
|
3815
|
+
'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).',
|
|
3630
3816
|
type: 'boolean',
|
|
3631
3817
|
},
|
|
3632
3818
|
is_one_time_use: {
|
|
3633
3819
|
description:
|
|
3634
|
-
'Indicates whether the credential can only be used once. If
|
|
3820
|
+
'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.',
|
|
3635
3821
|
type: 'boolean',
|
|
3636
3822
|
},
|
|
3637
3823
|
issued_at: {
|
|
3824
|
+
description:
|
|
3825
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
3638
3826
|
format: 'date-time',
|
|
3639
3827
|
nullable: true,
|
|
3640
3828
|
type: 'string',
|
|
3641
3829
|
},
|
|
3642
3830
|
latest_desired_state_synced_with_provider_at: {
|
|
3643
3831
|
description:
|
|
3644
|
-
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
3832
|
+
'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.',
|
|
3645
3833
|
format: 'date-time',
|
|
3646
3834
|
nullable: true,
|
|
3647
3835
|
type: 'string',
|
|
3648
3836
|
},
|
|
3649
3837
|
parent_acs_credential_id: {
|
|
3650
|
-
description:
|
|
3838
|
+
description:
|
|
3839
|
+
'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3651
3840
|
format: 'uuid',
|
|
3652
3841
|
type: 'string',
|
|
3653
3842
|
},
|
|
3654
3843
|
starts_at: {
|
|
3655
3844
|
description:
|
|
3656
|
-
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
3845
|
+
'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.',
|
|
3657
3846
|
type: 'string',
|
|
3658
3847
|
},
|
|
3659
3848
|
visionline_metadata: {
|
|
3660
3849
|
description:
|
|
3661
|
-
'Visionline-specific metadata for the credential.',
|
|
3850
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3662
3851
|
properties: {
|
|
3663
3852
|
auto_join: { type: 'boolean' },
|
|
3664
3853
|
card_function_type: {
|
|
@@ -3686,15 +3875,15 @@ export default {
|
|
|
3686
3875
|
},
|
|
3687
3876
|
warnings: {
|
|
3688
3877
|
description:
|
|
3689
|
-
'Warnings associated with the
|
|
3878
|
+
'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3690
3879
|
items: {
|
|
3691
3880
|
description:
|
|
3692
|
-
'Warning associated with the
|
|
3881
|
+
'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3693
3882
|
discriminator: { propertyName: 'warning_code' },
|
|
3694
3883
|
oneOf: [
|
|
3695
3884
|
{
|
|
3696
3885
|
description:
|
|
3697
|
-
'Indicates that the credential is waiting to be issued.',
|
|
3886
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
3698
3887
|
properties: {
|
|
3699
3888
|
created_at: {
|
|
3700
3889
|
description:
|
|
@@ -3723,7 +3912,7 @@ export default {
|
|
|
3723
3912
|
},
|
|
3724
3913
|
{
|
|
3725
3914
|
description:
|
|
3726
|
-
"Indicates that the schedule of one of the credential's children was modified externally.",
|
|
3915
|
+
"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.",
|
|
3727
3916
|
properties: {
|
|
3728
3917
|
created_at: {
|
|
3729
3918
|
description:
|
|
@@ -3752,7 +3941,7 @@ export default {
|
|
|
3752
3941
|
},
|
|
3753
3942
|
{
|
|
3754
3943
|
description:
|
|
3755
|
-
'Indicates that the schedule of
|
|
3944
|
+
'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.',
|
|
3756
3945
|
properties: {
|
|
3757
3946
|
created_at: {
|
|
3758
3947
|
description:
|
|
@@ -3781,7 +3970,7 @@ export default {
|
|
|
3781
3970
|
},
|
|
3782
3971
|
{
|
|
3783
3972
|
description:
|
|
3784
|
-
'Indicates that
|
|
3973
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
3785
3974
|
properties: {
|
|
3786
3975
|
created_at: {
|
|
3787
3976
|
description:
|
|
@@ -3810,7 +3999,7 @@ export default {
|
|
|
3810
3999
|
},
|
|
3811
4000
|
{
|
|
3812
4001
|
description:
|
|
3813
|
-
'An unknown issue occurred while syncing the state of
|
|
4002
|
+
'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.',
|
|
3814
4003
|
properties: {
|
|
3815
4004
|
created_at: {
|
|
3816
4005
|
description:
|
|
@@ -3839,7 +4028,7 @@ export default {
|
|
|
3839
4028
|
},
|
|
3840
4029
|
{
|
|
3841
4030
|
description:
|
|
3842
|
-
'Access permissions for
|
|
4031
|
+
'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.',
|
|
3843
4032
|
properties: {
|
|
3844
4033
|
created_at: {
|
|
3845
4034
|
description:
|
|
@@ -3872,7 +4061,7 @@ export default {
|
|
|
3872
4061
|
},
|
|
3873
4062
|
workspace_id: {
|
|
3874
4063
|
description:
|
|
3875
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
4064
|
+
'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).',
|
|
3876
4065
|
format: 'uuid',
|
|
3877
4066
|
type: 'string',
|
|
3878
4067
|
},
|
|
@@ -3893,16 +4082,17 @@ export default {
|
|
|
3893
4082
|
},
|
|
3894
4083
|
{
|
|
3895
4084
|
description:
|
|
3896
|
-
'Means by which
|
|
4085
|
+
'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.',
|
|
3897
4086
|
properties: {
|
|
3898
4087
|
access_method: {
|
|
3899
4088
|
description:
|
|
3900
|
-
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
4089
|
+
'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
|
|
3901
4090
|
enum: ['code', 'card', 'mobile_key'],
|
|
3902
4091
|
type: 'string',
|
|
3903
4092
|
},
|
|
3904
4093
|
acs_credential_id: {
|
|
3905
|
-
description:
|
|
4094
|
+
description:
|
|
4095
|
+
'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3906
4096
|
format: 'uuid',
|
|
3907
4097
|
type: 'string',
|
|
3908
4098
|
},
|
|
@@ -3912,19 +4102,19 @@ export default {
|
|
|
3912
4102
|
},
|
|
3913
4103
|
acs_system_id: {
|
|
3914
4104
|
description:
|
|
3915
|
-
'ID of the access control system that contains the credential.',
|
|
4105
|
+
'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).',
|
|
3916
4106
|
format: 'uuid',
|
|
3917
4107
|
type: 'string',
|
|
3918
4108
|
},
|
|
3919
4109
|
acs_user_id: {
|
|
3920
4110
|
description:
|
|
3921
|
-
'ID of the ACS user to whom the credential belongs.',
|
|
4111
|
+
'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.',
|
|
3922
4112
|
format: 'uuid',
|
|
3923
4113
|
type: 'string',
|
|
3924
4114
|
},
|
|
3925
4115
|
assa_abloy_vostio_metadata: {
|
|
3926
4116
|
description:
|
|
3927
|
-
'Vostio-specific metadata for the credential.',
|
|
4117
|
+
'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3928
4118
|
properties: {
|
|
3929
4119
|
door_names: {
|
|
3930
4120
|
items: { type: 'string' },
|
|
@@ -3940,32 +4130,38 @@ export default {
|
|
|
3940
4130
|
},
|
|
3941
4131
|
type: 'object',
|
|
3942
4132
|
},
|
|
3943
|
-
card_number: {
|
|
4133
|
+
card_number: {
|
|
4134
|
+
description:
|
|
4135
|
+
'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4136
|
+
nullable: true,
|
|
4137
|
+
type: 'string',
|
|
4138
|
+
},
|
|
3944
4139
|
code: {
|
|
3945
|
-
description:
|
|
4140
|
+
description:
|
|
4141
|
+
'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3946
4142
|
nullable: true,
|
|
3947
4143
|
type: 'string',
|
|
3948
4144
|
},
|
|
3949
4145
|
created_at: {
|
|
3950
4146
|
description:
|
|
3951
|
-
'Date and time at which the credential was created.',
|
|
4147
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
3952
4148
|
format: 'date-time',
|
|
3953
4149
|
type: 'string',
|
|
3954
4150
|
},
|
|
3955
4151
|
display_name: {
|
|
3956
4152
|
description:
|
|
3957
|
-
'Display name that corresponds to the credential type.',
|
|
4153
|
+
'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
3958
4154
|
minLength: 1,
|
|
3959
4155
|
type: 'string',
|
|
3960
4156
|
},
|
|
3961
4157
|
ends_at: {
|
|
3962
4158
|
description:
|
|
3963
|
-
'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`.',
|
|
4159
|
+
'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`.',
|
|
3964
4160
|
type: 'string',
|
|
3965
4161
|
},
|
|
3966
4162
|
errors: {
|
|
3967
4163
|
description:
|
|
3968
|
-
'Errors associated with the
|
|
4164
|
+
'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3969
4165
|
items: {
|
|
3970
4166
|
properties: {
|
|
3971
4167
|
error_code: { type: 'string' },
|
|
@@ -3978,7 +4174,7 @@ export default {
|
|
|
3978
4174
|
},
|
|
3979
4175
|
external_type: {
|
|
3980
4176
|
description:
|
|
3981
|
-
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
4177
|
+
'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`.',
|
|
3982
4178
|
enum: [
|
|
3983
4179
|
'pti_card',
|
|
3984
4180
|
'brivo_credential',
|
|
@@ -3992,52 +4188,59 @@ export default {
|
|
|
3992
4188
|
},
|
|
3993
4189
|
external_type_display_name: {
|
|
3994
4190
|
description:
|
|
3995
|
-
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
4191
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
3996
4192
|
type: 'string',
|
|
3997
4193
|
},
|
|
3998
|
-
is_issued: {
|
|
4194
|
+
is_issued: {
|
|
4195
|
+
description:
|
|
4196
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
4197
|
+
type: 'boolean',
|
|
4198
|
+
},
|
|
3999
4199
|
is_latest_desired_state_synced_with_provider: {
|
|
4000
4200
|
description:
|
|
4001
|
-
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
4201
|
+
'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.',
|
|
4002
4202
|
nullable: true,
|
|
4003
4203
|
type: 'boolean',
|
|
4004
4204
|
},
|
|
4005
4205
|
is_managed: { enum: [false], type: 'boolean' },
|
|
4006
4206
|
is_multi_phone_sync_credential: {
|
|
4007
4207
|
description:
|
|
4008
|
-
'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).',
|
|
4208
|
+
'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).',
|
|
4009
4209
|
type: 'boolean',
|
|
4010
4210
|
},
|
|
4011
4211
|
is_one_time_use: {
|
|
4012
4212
|
description:
|
|
4013
|
-
'Indicates whether the credential can only be used once. If
|
|
4213
|
+
'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.',
|
|
4014
4214
|
type: 'boolean',
|
|
4015
4215
|
},
|
|
4016
4216
|
issued_at: {
|
|
4217
|
+
description:
|
|
4218
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
4017
4219
|
format: 'date-time',
|
|
4018
4220
|
nullable: true,
|
|
4019
4221
|
type: 'string',
|
|
4020
4222
|
},
|
|
4021
4223
|
latest_desired_state_synced_with_provider_at: {
|
|
4022
4224
|
description:
|
|
4023
|
-
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
4225
|
+
'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.',
|
|
4024
4226
|
format: 'date-time',
|
|
4025
4227
|
nullable: true,
|
|
4026
4228
|
type: 'string',
|
|
4027
4229
|
},
|
|
4028
4230
|
parent_acs_credential_id: {
|
|
4029
|
-
description:
|
|
4231
|
+
description:
|
|
4232
|
+
'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4030
4233
|
format: 'uuid',
|
|
4031
4234
|
type: 'string',
|
|
4032
4235
|
},
|
|
4033
4236
|
starts_at: {
|
|
4034
4237
|
description:
|
|
4035
|
-
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
4238
|
+
'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.',
|
|
4036
4239
|
type: 'string',
|
|
4037
4240
|
},
|
|
4038
4241
|
visionline_metadata: {
|
|
4039
4242
|
description:
|
|
4040
|
-
'Visionline-specific metadata for the credential.',
|
|
4243
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4041
4244
|
properties: {
|
|
4042
4245
|
auto_join: { type: 'boolean' },
|
|
4043
4246
|
card_function_type: {
|
|
@@ -4065,15 +4268,15 @@ export default {
|
|
|
4065
4268
|
},
|
|
4066
4269
|
warnings: {
|
|
4067
4270
|
description:
|
|
4068
|
-
'Warnings associated with the
|
|
4271
|
+
'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4069
4272
|
items: {
|
|
4070
4273
|
description:
|
|
4071
|
-
'Warning associated with the
|
|
4274
|
+
'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4072
4275
|
discriminator: { propertyName: 'warning_code' },
|
|
4073
4276
|
oneOf: [
|
|
4074
4277
|
{
|
|
4075
4278
|
description:
|
|
4076
|
-
'Indicates that the credential is waiting to be issued.',
|
|
4279
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
4077
4280
|
properties: {
|
|
4078
4281
|
created_at: {
|
|
4079
4282
|
description:
|
|
@@ -4102,7 +4305,7 @@ export default {
|
|
|
4102
4305
|
},
|
|
4103
4306
|
{
|
|
4104
4307
|
description:
|
|
4105
|
-
"Indicates that the schedule of one of the credential's children was modified externally.",
|
|
4308
|
+
"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.",
|
|
4106
4309
|
properties: {
|
|
4107
4310
|
created_at: {
|
|
4108
4311
|
description:
|
|
@@ -4131,7 +4334,7 @@ export default {
|
|
|
4131
4334
|
},
|
|
4132
4335
|
{
|
|
4133
4336
|
description:
|
|
4134
|
-
'Indicates that the schedule of
|
|
4337
|
+
'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.',
|
|
4135
4338
|
properties: {
|
|
4136
4339
|
created_at: {
|
|
4137
4340
|
description:
|
|
@@ -4160,7 +4363,7 @@ export default {
|
|
|
4160
4363
|
},
|
|
4161
4364
|
{
|
|
4162
4365
|
description:
|
|
4163
|
-
'Indicates that
|
|
4366
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
4164
4367
|
properties: {
|
|
4165
4368
|
created_at: {
|
|
4166
4369
|
description:
|
|
@@ -4189,7 +4392,7 @@ export default {
|
|
|
4189
4392
|
},
|
|
4190
4393
|
{
|
|
4191
4394
|
description:
|
|
4192
|
-
'An unknown issue occurred while syncing the state of
|
|
4395
|
+
'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.',
|
|
4193
4396
|
properties: {
|
|
4194
4397
|
created_at: {
|
|
4195
4398
|
description:
|
|
@@ -4218,7 +4421,7 @@ export default {
|
|
|
4218
4421
|
},
|
|
4219
4422
|
{
|
|
4220
4423
|
description:
|
|
4221
|
-
'Access permissions for
|
|
4424
|
+
'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.',
|
|
4222
4425
|
properties: {
|
|
4223
4426
|
created_at: {
|
|
4224
4427
|
description:
|
|
@@ -4251,7 +4454,7 @@ export default {
|
|
|
4251
4454
|
},
|
|
4252
4455
|
workspace_id: {
|
|
4253
4456
|
description:
|
|
4254
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
4457
|
+
'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).',
|
|
4255
4458
|
format: 'uuid',
|
|
4256
4459
|
type: 'string',
|
|
4257
4460
|
},
|
|
@@ -6886,33 +7089,42 @@ export default {
|
|
|
6886
7089
|
properties: {
|
|
6887
7090
|
climate_preset_key: {
|
|
6888
7091
|
description:
|
|
6889
|
-
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
7092
|
+
'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).',
|
|
6890
7093
|
type: 'string',
|
|
6891
7094
|
},
|
|
6892
7095
|
created_at: {
|
|
6893
7096
|
description:
|
|
6894
|
-
'Date and time at which the thermostat schedule was created.',
|
|
7097
|
+
'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.',
|
|
6895
7098
|
format: 'date-time',
|
|
6896
7099
|
type: 'string',
|
|
6897
7100
|
},
|
|
6898
7101
|
device_id: {
|
|
6899
|
-
description:
|
|
7102
|
+
description:
|
|
7103
|
+
'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.',
|
|
6900
7104
|
format: 'uuid',
|
|
6901
7105
|
type: 'string',
|
|
6902
7106
|
},
|
|
6903
7107
|
ends_at: {
|
|
6904
7108
|
description:
|
|
6905
|
-
'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
7109
|
+
'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.',
|
|
6906
7110
|
format: 'date-time',
|
|
6907
7111
|
type: 'string',
|
|
6908
7112
|
},
|
|
6909
7113
|
errors: {
|
|
6910
7114
|
description:
|
|
6911
|
-
'
|
|
7115
|
+
'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
6912
7116
|
items: {
|
|
6913
7117
|
properties: {
|
|
6914
|
-
error_code: {
|
|
6915
|
-
|
|
7118
|
+
error_code: {
|
|
7119
|
+
description:
|
|
7120
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
7121
|
+
type: 'string',
|
|
7122
|
+
},
|
|
7123
|
+
message: {
|
|
7124
|
+
description:
|
|
7125
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
7126
|
+
type: 'string',
|
|
7127
|
+
},
|
|
6916
7128
|
},
|
|
6917
7129
|
required: ['error_code', 'message'],
|
|
6918
7130
|
type: 'object',
|
|
@@ -6921,29 +7133,30 @@ export default {
|
|
|
6921
7133
|
},
|
|
6922
7134
|
max_override_period_minutes: {
|
|
6923
7135
|
description:
|
|
6924
|
-
"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).",
|
|
7136
|
+
"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).",
|
|
6925
7137
|
minimum: 0,
|
|
6926
7138
|
type: 'integer',
|
|
6927
7139
|
},
|
|
6928
7140
|
name: {
|
|
6929
7141
|
description:
|
|
6930
|
-
'User-friendly name to identify the thermostat schedule.',
|
|
7142
|
+
'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
6931
7143
|
type: 'string',
|
|
6932
7144
|
},
|
|
6933
7145
|
starts_at: {
|
|
6934
7146
|
description:
|
|
6935
|
-
'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
7147
|
+
'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.',
|
|
6936
7148
|
format: 'date-time',
|
|
6937
7149
|
type: 'string',
|
|
6938
7150
|
},
|
|
6939
7151
|
thermostat_schedule_id: {
|
|
6940
|
-
description:
|
|
7152
|
+
description:
|
|
7153
|
+
'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
6941
7154
|
format: 'uuid',
|
|
6942
7155
|
type: 'string',
|
|
6943
7156
|
},
|
|
6944
7157
|
unstable_is_override_allowed: {
|
|
6945
7158
|
description:
|
|
6946
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
7159
|
+
"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.",
|
|
6947
7160
|
type: 'boolean',
|
|
6948
7161
|
'x-undocumented': 'Unstable',
|
|
6949
7162
|
},
|
|
@@ -6966,17 +7179,17 @@ export default {
|
|
|
6966
7179
|
properties: {
|
|
6967
7180
|
can_delete: {
|
|
6968
7181
|
description:
|
|
6969
|
-
'Indicates whether
|
|
7182
|
+
'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
|
|
6970
7183
|
type: 'boolean',
|
|
6971
7184
|
},
|
|
6972
7185
|
can_edit: {
|
|
6973
7186
|
description:
|
|
6974
|
-
'Indicates whether
|
|
7187
|
+
'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
|
|
6975
7188
|
type: 'boolean',
|
|
6976
7189
|
},
|
|
6977
7190
|
climate_preset_key: {
|
|
6978
7191
|
description:
|
|
6979
|
-
'Unique key to identify the climate preset.',
|
|
7192
|
+
'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
6980
7193
|
type: 'string',
|
|
6981
7194
|
},
|
|
6982
7195
|
cooling_set_point_celsius: {
|
|
@@ -6987,30 +7200,30 @@ export default {
|
|
|
6987
7200
|
},
|
|
6988
7201
|
cooling_set_point_fahrenheit: {
|
|
6989
7202
|
description:
|
|
6990
|
-
'Temperature to which the thermostat should cool (in °F).',
|
|
7203
|
+
'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).',
|
|
6991
7204
|
format: 'float',
|
|
6992
7205
|
type: 'number',
|
|
6993
7206
|
},
|
|
6994
7207
|
display_name: {
|
|
6995
7208
|
description:
|
|
6996
|
-
'Display name for the climate preset.',
|
|
7209
|
+
'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
6997
7210
|
type: 'string',
|
|
6998
7211
|
},
|
|
6999
7212
|
fan_mode_setting: {
|
|
7000
7213
|
description:
|
|
7001
|
-
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
7214
|
+
'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`.',
|
|
7002
7215
|
enum: ['auto', 'on', 'circulate'],
|
|
7003
7216
|
type: 'string',
|
|
7004
7217
|
},
|
|
7005
7218
|
heating_set_point_celsius: {
|
|
7006
7219
|
description:
|
|
7007
|
-
'Temperature to which the thermostat should heat (in °C).',
|
|
7220
|
+
'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).',
|
|
7008
7221
|
format: 'float',
|
|
7009
7222
|
type: 'number',
|
|
7010
7223
|
},
|
|
7011
7224
|
heating_set_point_fahrenheit: {
|
|
7012
7225
|
description:
|
|
7013
|
-
'Temperature to which the thermostat should heat (in °F).',
|
|
7226
|
+
'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).',
|
|
7014
7227
|
format: 'float',
|
|
7015
7228
|
type: 'number',
|
|
7016
7229
|
},
|
|
@@ -7023,7 +7236,7 @@ export default {
|
|
|
7023
7236
|
manual_override_allowed: {
|
|
7024
7237
|
deprecated: true,
|
|
7025
7238
|
description:
|
|
7026
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
7239
|
+
"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).",
|
|
7027
7240
|
type: 'boolean',
|
|
7028
7241
|
'x-deprecated':
|
|
7029
7242
|
"Use 'thermostat_schedule.is_override_allowed'",
|
|
@@ -7031,7 +7244,7 @@ export default {
|
|
|
7031
7244
|
name: {
|
|
7032
7245
|
default: null,
|
|
7033
7246
|
description:
|
|
7034
|
-
'User-friendly name to identify the climate preset.',
|
|
7247
|
+
'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
7035
7248
|
nullable: true,
|
|
7036
7249
|
type: 'string',
|
|
7037
7250
|
},
|
|
@@ -7065,17 +7278,17 @@ export default {
|
|
|
7065
7278
|
properties: {
|
|
7066
7279
|
can_delete: {
|
|
7067
7280
|
description:
|
|
7068
|
-
'Indicates whether
|
|
7281
|
+
'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
|
|
7069
7282
|
type: 'boolean',
|
|
7070
7283
|
},
|
|
7071
7284
|
can_edit: {
|
|
7072
7285
|
description:
|
|
7073
|
-
'Indicates whether
|
|
7286
|
+
'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
|
|
7074
7287
|
type: 'boolean',
|
|
7075
7288
|
},
|
|
7076
7289
|
climate_preset_key: {
|
|
7077
7290
|
description:
|
|
7078
|
-
'Unique key to identify the climate preset.',
|
|
7291
|
+
'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
7079
7292
|
type: 'string',
|
|
7080
7293
|
},
|
|
7081
7294
|
cooling_set_point_celsius: {
|
|
@@ -7086,29 +7299,30 @@ export default {
|
|
|
7086
7299
|
},
|
|
7087
7300
|
cooling_set_point_fahrenheit: {
|
|
7088
7301
|
description:
|
|
7089
|
-
'Temperature to which the thermostat should cool (in °F).',
|
|
7302
|
+
'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).',
|
|
7090
7303
|
format: 'float',
|
|
7091
7304
|
type: 'number',
|
|
7092
7305
|
},
|
|
7093
7306
|
display_name: {
|
|
7094
|
-
description:
|
|
7307
|
+
description:
|
|
7308
|
+
'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
7095
7309
|
type: 'string',
|
|
7096
7310
|
},
|
|
7097
7311
|
fan_mode_setting: {
|
|
7098
7312
|
description:
|
|
7099
|
-
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
7313
|
+
'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`.',
|
|
7100
7314
|
enum: ['auto', 'on', 'circulate'],
|
|
7101
7315
|
type: 'string',
|
|
7102
7316
|
},
|
|
7103
7317
|
heating_set_point_celsius: {
|
|
7104
7318
|
description:
|
|
7105
|
-
'Temperature to which the thermostat should heat (in °C).',
|
|
7319
|
+
'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).',
|
|
7106
7320
|
format: 'float',
|
|
7107
7321
|
type: 'number',
|
|
7108
7322
|
},
|
|
7109
7323
|
heating_set_point_fahrenheit: {
|
|
7110
7324
|
description:
|
|
7111
|
-
'Temperature to which the thermostat should heat (in °F).',
|
|
7325
|
+
'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).',
|
|
7112
7326
|
format: 'float',
|
|
7113
7327
|
type: 'number',
|
|
7114
7328
|
},
|
|
@@ -7121,7 +7335,7 @@ export default {
|
|
|
7121
7335
|
manual_override_allowed: {
|
|
7122
7336
|
deprecated: true,
|
|
7123
7337
|
description:
|
|
7124
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
7338
|
+
"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).",
|
|
7125
7339
|
type: 'boolean',
|
|
7126
7340
|
'x-deprecated':
|
|
7127
7341
|
"Use 'thermostat_schedule.is_override_allowed'",
|
|
@@ -7129,7 +7343,7 @@ export default {
|
|
|
7129
7343
|
name: {
|
|
7130
7344
|
default: null,
|
|
7131
7345
|
description:
|
|
7132
|
-
'User-friendly name to identify the climate preset.',
|
|
7346
|
+
'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
7133
7347
|
nullable: true,
|
|
7134
7348
|
type: 'string',
|
|
7135
7349
|
},
|
|
@@ -7141,17 +7355,17 @@ export default {
|
|
|
7141
7355
|
properties: {
|
|
7142
7356
|
can_delete: {
|
|
7143
7357
|
description:
|
|
7144
|
-
'Indicates whether
|
|
7358
|
+
'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
|
|
7145
7359
|
type: 'boolean',
|
|
7146
7360
|
},
|
|
7147
7361
|
can_edit: {
|
|
7148
7362
|
description:
|
|
7149
|
-
'Indicates whether
|
|
7363
|
+
'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
|
|
7150
7364
|
type: 'boolean',
|
|
7151
7365
|
},
|
|
7152
7366
|
climate_preset_key: {
|
|
7153
7367
|
description:
|
|
7154
|
-
'Unique key to identify the climate preset.',
|
|
7368
|
+
'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
7155
7369
|
type: 'string',
|
|
7156
7370
|
},
|
|
7157
7371
|
cooling_set_point_celsius: {
|
|
@@ -7162,29 +7376,30 @@ export default {
|
|
|
7162
7376
|
},
|
|
7163
7377
|
cooling_set_point_fahrenheit: {
|
|
7164
7378
|
description:
|
|
7165
|
-
'Temperature to which the thermostat should cool (in °F).',
|
|
7379
|
+
'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).',
|
|
7166
7380
|
format: 'float',
|
|
7167
7381
|
type: 'number',
|
|
7168
7382
|
},
|
|
7169
7383
|
display_name: {
|
|
7170
|
-
description:
|
|
7384
|
+
description:
|
|
7385
|
+
'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
7171
7386
|
type: 'string',
|
|
7172
7387
|
},
|
|
7173
7388
|
fan_mode_setting: {
|
|
7174
7389
|
description:
|
|
7175
|
-
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
7390
|
+
'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`.',
|
|
7176
7391
|
enum: ['auto', 'on', 'circulate'],
|
|
7177
7392
|
type: 'string',
|
|
7178
7393
|
},
|
|
7179
7394
|
heating_set_point_celsius: {
|
|
7180
7395
|
description:
|
|
7181
|
-
'Temperature to which the thermostat should heat (in °C).',
|
|
7396
|
+
'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).',
|
|
7182
7397
|
format: 'float',
|
|
7183
7398
|
type: 'number',
|
|
7184
7399
|
},
|
|
7185
7400
|
heating_set_point_fahrenheit: {
|
|
7186
7401
|
description:
|
|
7187
|
-
'Temperature to which the thermostat should heat (in °F).',
|
|
7402
|
+
'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).',
|
|
7188
7403
|
format: 'float',
|
|
7189
7404
|
type: 'number',
|
|
7190
7405
|
},
|
|
@@ -7197,7 +7412,7 @@ export default {
|
|
|
7197
7412
|
manual_override_allowed: {
|
|
7198
7413
|
deprecated: true,
|
|
7199
7414
|
description:
|
|
7200
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
7415
|
+
"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).",
|
|
7201
7416
|
type: 'boolean',
|
|
7202
7417
|
'x-deprecated':
|
|
7203
7418
|
"Use 'thermostat_schedule.is_override_allowed'",
|
|
@@ -7205,7 +7420,7 @@ export default {
|
|
|
7205
7420
|
name: {
|
|
7206
7421
|
default: null,
|
|
7207
7422
|
description:
|
|
7208
|
-
'User-friendly name to identify the climate preset.',
|
|
7423
|
+
'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
7209
7424
|
nullable: true,
|
|
7210
7425
|
type: 'string',
|
|
7211
7426
|
},
|
|
@@ -11560,7 +11775,7 @@ export default {
|
|
|
11560
11775
|
},
|
|
11561
11776
|
cooling_set_point_fahrenheit: {
|
|
11562
11777
|
description:
|
|
11563
|
-
'Temperature to which the thermostat should cool (in °F).',
|
|
11778
|
+
'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).',
|
|
11564
11779
|
format: 'float',
|
|
11565
11780
|
type: 'number',
|
|
11566
11781
|
},
|
|
@@ -11585,19 +11800,19 @@ export default {
|
|
|
11585
11800
|
},
|
|
11586
11801
|
fan_mode_setting: {
|
|
11587
11802
|
description:
|
|
11588
|
-
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
11803
|
+
'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`.',
|
|
11589
11804
|
enum: ['auto', 'on', 'circulate'],
|
|
11590
11805
|
type: 'string',
|
|
11591
11806
|
},
|
|
11592
11807
|
heating_set_point_celsius: {
|
|
11593
11808
|
description:
|
|
11594
|
-
'Temperature to which the thermostat should heat (in °C).',
|
|
11809
|
+
'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).',
|
|
11595
11810
|
format: 'float',
|
|
11596
11811
|
type: 'number',
|
|
11597
11812
|
},
|
|
11598
11813
|
heating_set_point_fahrenheit: {
|
|
11599
11814
|
description:
|
|
11600
|
-
'Temperature to which the thermostat should heat (in °F).',
|
|
11815
|
+
'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).',
|
|
11601
11816
|
format: 'float',
|
|
11602
11817
|
type: 'number',
|
|
11603
11818
|
},
|
|
@@ -12324,33 +12539,42 @@ export default {
|
|
|
12324
12539
|
properties: {
|
|
12325
12540
|
climate_preset_key: {
|
|
12326
12541
|
description:
|
|
12327
|
-
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
12542
|
+
'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).',
|
|
12328
12543
|
type: 'string',
|
|
12329
12544
|
},
|
|
12330
12545
|
created_at: {
|
|
12331
12546
|
description:
|
|
12332
|
-
'Date and time at which the thermostat schedule was created.',
|
|
12547
|
+
'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.',
|
|
12333
12548
|
format: 'date-time',
|
|
12334
12549
|
type: 'string',
|
|
12335
12550
|
},
|
|
12336
12551
|
device_id: {
|
|
12337
|
-
description:
|
|
12552
|
+
description:
|
|
12553
|
+
'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.',
|
|
12338
12554
|
format: 'uuid',
|
|
12339
12555
|
type: 'string',
|
|
12340
12556
|
},
|
|
12341
12557
|
ends_at: {
|
|
12342
12558
|
description:
|
|
12343
|
-
'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
12559
|
+
'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.',
|
|
12344
12560
|
format: 'date-time',
|
|
12345
12561
|
type: 'string',
|
|
12346
12562
|
},
|
|
12347
12563
|
errors: {
|
|
12348
12564
|
description:
|
|
12349
|
-
'
|
|
12565
|
+
'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
12350
12566
|
items: {
|
|
12351
12567
|
properties: {
|
|
12352
|
-
error_code: {
|
|
12353
|
-
|
|
12568
|
+
error_code: {
|
|
12569
|
+
description:
|
|
12570
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12571
|
+
type: 'string',
|
|
12572
|
+
},
|
|
12573
|
+
message: {
|
|
12574
|
+
description:
|
|
12575
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12576
|
+
type: 'string',
|
|
12577
|
+
},
|
|
12354
12578
|
},
|
|
12355
12579
|
required: ['error_code', 'message'],
|
|
12356
12580
|
type: 'object',
|
|
@@ -12359,29 +12583,30 @@ export default {
|
|
|
12359
12583
|
},
|
|
12360
12584
|
max_override_period_minutes: {
|
|
12361
12585
|
description:
|
|
12362
|
-
"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).",
|
|
12586
|
+
"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).",
|
|
12363
12587
|
minimum: 0,
|
|
12364
12588
|
type: 'integer',
|
|
12365
12589
|
},
|
|
12366
12590
|
name: {
|
|
12367
12591
|
description:
|
|
12368
|
-
'User-friendly name to identify the thermostat schedule.',
|
|
12592
|
+
'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
12369
12593
|
type: 'string',
|
|
12370
12594
|
},
|
|
12371
12595
|
starts_at: {
|
|
12372
12596
|
description:
|
|
12373
|
-
'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
12597
|
+
'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.',
|
|
12374
12598
|
format: 'date-time',
|
|
12375
12599
|
type: 'string',
|
|
12376
12600
|
},
|
|
12377
12601
|
thermostat_schedule_id: {
|
|
12378
|
-
description:
|
|
12602
|
+
description:
|
|
12603
|
+
'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
12379
12604
|
format: 'uuid',
|
|
12380
12605
|
type: 'string',
|
|
12381
12606
|
},
|
|
12382
12607
|
unstable_is_override_allowed: {
|
|
12383
12608
|
description:
|
|
12384
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
12609
|
+
"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.",
|
|
12385
12610
|
type: 'boolean',
|
|
12386
12611
|
'x-undocumented': 'Unstable',
|
|
12387
12612
|
},
|
|
@@ -13368,33 +13593,36 @@ export default {
|
|
|
13368
13593
|
},
|
|
13369
13594
|
unmanaged_acs_credential: {
|
|
13370
13595
|
description:
|
|
13371
|
-
'Means by which
|
|
13596
|
+
'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.',
|
|
13372
13597
|
properties: {
|
|
13373
13598
|
access_method: {
|
|
13374
13599
|
description:
|
|
13375
|
-
'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
13600
|
+
'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.',
|
|
13376
13601
|
enum: ['code', 'card', 'mobile_key'],
|
|
13377
13602
|
type: 'string',
|
|
13378
13603
|
},
|
|
13379
13604
|
acs_credential_id: {
|
|
13380
|
-
description:
|
|
13605
|
+
description:
|
|
13606
|
+
'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13381
13607
|
format: 'uuid',
|
|
13382
13608
|
type: 'string',
|
|
13383
13609
|
},
|
|
13384
13610
|
acs_credential_pool_id: { format: 'uuid', type: 'string' },
|
|
13385
13611
|
acs_system_id: {
|
|
13386
13612
|
description:
|
|
13387
|
-
'ID of the access control system that contains the credential.',
|
|
13613
|
+
'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).',
|
|
13388
13614
|
format: 'uuid',
|
|
13389
13615
|
type: 'string',
|
|
13390
13616
|
},
|
|
13391
13617
|
acs_user_id: {
|
|
13392
|
-
description:
|
|
13618
|
+
description:
|
|
13619
|
+
'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.',
|
|
13393
13620
|
format: 'uuid',
|
|
13394
13621
|
type: 'string',
|
|
13395
13622
|
},
|
|
13396
13623
|
assa_abloy_vostio_metadata: {
|
|
13397
|
-
description:
|
|
13624
|
+
description:
|
|
13625
|
+
'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13398
13626
|
properties: {
|
|
13399
13627
|
door_names: { items: { type: 'string' }, type: 'array' },
|
|
13400
13628
|
endpoint_id: { type: 'string' },
|
|
@@ -13407,30 +13635,38 @@ export default {
|
|
|
13407
13635
|
},
|
|
13408
13636
|
type: 'object',
|
|
13409
13637
|
},
|
|
13410
|
-
card_number: {
|
|
13638
|
+
card_number: {
|
|
13639
|
+
description:
|
|
13640
|
+
'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13641
|
+
nullable: true,
|
|
13642
|
+
type: 'string',
|
|
13643
|
+
},
|
|
13411
13644
|
code: {
|
|
13412
|
-
description:
|
|
13645
|
+
description:
|
|
13646
|
+
'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13413
13647
|
nullable: true,
|
|
13414
13648
|
type: 'string',
|
|
13415
13649
|
},
|
|
13416
13650
|
created_at: {
|
|
13417
|
-
description:
|
|
13651
|
+
description:
|
|
13652
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
|
|
13418
13653
|
format: 'date-time',
|
|
13419
13654
|
type: 'string',
|
|
13420
13655
|
},
|
|
13421
13656
|
display_name: {
|
|
13422
13657
|
description:
|
|
13423
|
-
'Display name that corresponds to the credential type.',
|
|
13658
|
+
'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
13424
13659
|
minLength: 1,
|
|
13425
13660
|
type: 'string',
|
|
13426
13661
|
},
|
|
13427
13662
|
ends_at: {
|
|
13428
13663
|
description:
|
|
13429
|
-
'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`.',
|
|
13664
|
+
'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`.',
|
|
13430
13665
|
type: 'string',
|
|
13431
13666
|
},
|
|
13432
13667
|
errors: {
|
|
13433
|
-
description:
|
|
13668
|
+
description:
|
|
13669
|
+
'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13434
13670
|
items: {
|
|
13435
13671
|
properties: {
|
|
13436
13672
|
error_code: { type: 'string' },
|
|
@@ -13443,7 +13679,7 @@ export default {
|
|
|
13443
13679
|
},
|
|
13444
13680
|
external_type: {
|
|
13445
13681
|
description:
|
|
13446
|
-
'Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.',
|
|
13682
|
+
'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`.',
|
|
13447
13683
|
enum: [
|
|
13448
13684
|
'pti_card',
|
|
13449
13685
|
'brivo_credential',
|
|
@@ -13457,47 +13693,59 @@ export default {
|
|
|
13457
13693
|
},
|
|
13458
13694
|
external_type_display_name: {
|
|
13459
13695
|
description:
|
|
13460
|
-
'Display name that corresponds to the brand-specific terminology for the credential type.',
|
|
13696
|
+
'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.',
|
|
13461
13697
|
type: 'string',
|
|
13462
13698
|
},
|
|
13463
|
-
is_issued: {
|
|
13699
|
+
is_issued: {
|
|
13700
|
+
description:
|
|
13701
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.',
|
|
13702
|
+
type: 'boolean',
|
|
13703
|
+
},
|
|
13464
13704
|
is_latest_desired_state_synced_with_provider: {
|
|
13465
13705
|
description:
|
|
13466
|
-
'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
|
|
13706
|
+
'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.',
|
|
13467
13707
|
nullable: true,
|
|
13468
13708
|
type: 'boolean',
|
|
13469
13709
|
},
|
|
13470
13710
|
is_managed: { enum: [false], type: 'boolean' },
|
|
13471
13711
|
is_multi_phone_sync_credential: {
|
|
13472
13712
|
description:
|
|
13473
|
-
'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).',
|
|
13713
|
+
'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).',
|
|
13474
13714
|
type: 'boolean',
|
|
13475
13715
|
},
|
|
13476
13716
|
is_one_time_use: {
|
|
13477
13717
|
description:
|
|
13478
|
-
'Indicates whether the credential can only be used once. If
|
|
13718
|
+
'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.',
|
|
13479
13719
|
type: 'boolean',
|
|
13480
13720
|
},
|
|
13481
|
-
issued_at: {
|
|
13721
|
+
issued_at: {
|
|
13722
|
+
description:
|
|
13723
|
+
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.',
|
|
13724
|
+
format: 'date-time',
|
|
13725
|
+
nullable: true,
|
|
13726
|
+
type: 'string',
|
|
13727
|
+
},
|
|
13482
13728
|
latest_desired_state_synced_with_provider_at: {
|
|
13483
13729
|
description:
|
|
13484
|
-
'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
|
|
13730
|
+
'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.',
|
|
13485
13731
|
format: 'date-time',
|
|
13486
13732
|
nullable: true,
|
|
13487
13733
|
type: 'string',
|
|
13488
13734
|
},
|
|
13489
13735
|
parent_acs_credential_id: {
|
|
13490
|
-
description:
|
|
13736
|
+
description:
|
|
13737
|
+
'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13491
13738
|
format: 'uuid',
|
|
13492
13739
|
type: 'string',
|
|
13493
13740
|
},
|
|
13494
13741
|
starts_at: {
|
|
13495
13742
|
description:
|
|
13496
|
-
'Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
13743
|
+
'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.',
|
|
13497
13744
|
type: 'string',
|
|
13498
13745
|
},
|
|
13499
13746
|
visionline_metadata: {
|
|
13500
|
-
description:
|
|
13747
|
+
description:
|
|
13748
|
+
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13501
13749
|
properties: {
|
|
13502
13750
|
auto_join: { type: 'boolean' },
|
|
13503
13751
|
card_function_type: { enum: ['guest', 'staff'], type: 'string' },
|
|
@@ -13521,14 +13769,16 @@ export default {
|
|
|
13521
13769
|
type: 'object',
|
|
13522
13770
|
},
|
|
13523
13771
|
warnings: {
|
|
13524
|
-
description:
|
|
13772
|
+
description:
|
|
13773
|
+
'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13525
13774
|
items: {
|
|
13526
|
-
description:
|
|
13775
|
+
description:
|
|
13776
|
+
'Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
13527
13777
|
discriminator: { propertyName: 'warning_code' },
|
|
13528
13778
|
oneOf: [
|
|
13529
13779
|
{
|
|
13530
13780
|
description:
|
|
13531
|
-
'Indicates that the credential is waiting to be issued.',
|
|
13781
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.',
|
|
13532
13782
|
properties: {
|
|
13533
13783
|
created_at: {
|
|
13534
13784
|
description:
|
|
@@ -13553,7 +13803,7 @@ export default {
|
|
|
13553
13803
|
},
|
|
13554
13804
|
{
|
|
13555
13805
|
description:
|
|
13556
|
-
"Indicates that the schedule of one of the credential's children was modified externally.",
|
|
13806
|
+
"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.",
|
|
13557
13807
|
properties: {
|
|
13558
13808
|
created_at: {
|
|
13559
13809
|
description:
|
|
@@ -13578,7 +13828,7 @@ export default {
|
|
|
13578
13828
|
},
|
|
13579
13829
|
{
|
|
13580
13830
|
description:
|
|
13581
|
-
'Indicates that the schedule of
|
|
13831
|
+
'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.',
|
|
13582
13832
|
properties: {
|
|
13583
13833
|
created_at: {
|
|
13584
13834
|
description:
|
|
@@ -13603,7 +13853,7 @@ export default {
|
|
|
13603
13853
|
},
|
|
13604
13854
|
{
|
|
13605
13855
|
description:
|
|
13606
|
-
'Indicates that
|
|
13856
|
+
'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.',
|
|
13607
13857
|
properties: {
|
|
13608
13858
|
created_at: {
|
|
13609
13859
|
description:
|
|
@@ -13628,7 +13878,7 @@ export default {
|
|
|
13628
13878
|
},
|
|
13629
13879
|
{
|
|
13630
13880
|
description:
|
|
13631
|
-
'An unknown issue occurred while syncing the state of
|
|
13881
|
+
'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.',
|
|
13632
13882
|
properties: {
|
|
13633
13883
|
created_at: {
|
|
13634
13884
|
description:
|
|
@@ -13653,7 +13903,7 @@ export default {
|
|
|
13653
13903
|
},
|
|
13654
13904
|
{
|
|
13655
13905
|
description:
|
|
13656
|
-
'Access permissions for
|
|
13906
|
+
'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.',
|
|
13657
13907
|
properties: {
|
|
13658
13908
|
created_at: {
|
|
13659
13909
|
description:
|
|
@@ -13682,7 +13932,7 @@ export default {
|
|
|
13682
13932
|
},
|
|
13683
13933
|
workspace_id: {
|
|
13684
13934
|
description:
|
|
13685
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.',
|
|
13935
|
+
'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).',
|
|
13686
13936
|
format: 'uuid',
|
|
13687
13937
|
type: 'string',
|
|
13688
13938
|
},
|
|
@@ -13707,7 +13957,7 @@ export default {
|
|
|
13707
13957
|
properties: {
|
|
13708
13958
|
access_schedule: {
|
|
13709
13959
|
description:
|
|
13710
|
-
"`starts_at` and `ends_at` timestamps for the
|
|
13960
|
+
"`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
|
|
13711
13961
|
properties: {
|
|
13712
13962
|
ends_at: {
|
|
13713
13963
|
description:
|
|
@@ -13728,22 +13978,25 @@ export default {
|
|
|
13728
13978
|
},
|
|
13729
13979
|
acs_system_id: {
|
|
13730
13980
|
description:
|
|
13731
|
-
'ID of the access control system that contains the
|
|
13981
|
+
'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).',
|
|
13732
13982
|
format: 'uuid',
|
|
13733
13983
|
type: 'string',
|
|
13734
13984
|
},
|
|
13735
13985
|
acs_user_id: {
|
|
13736
|
-
description:
|
|
13986
|
+
description:
|
|
13987
|
+
'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13737
13988
|
format: 'uuid',
|
|
13738
13989
|
type: 'string',
|
|
13739
13990
|
},
|
|
13740
13991
|
created_at: {
|
|
13741
|
-
description:
|
|
13992
|
+
description:
|
|
13993
|
+
'Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.',
|
|
13742
13994
|
format: 'date-time',
|
|
13743
13995
|
type: 'string',
|
|
13744
13996
|
},
|
|
13745
13997
|
display_name: {
|
|
13746
|
-
description:
|
|
13998
|
+
description:
|
|
13999
|
+
'Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13747
14000
|
type: 'string',
|
|
13748
14001
|
},
|
|
13749
14002
|
email: {
|
|
@@ -13753,19 +14006,22 @@ export default {
|
|
|
13753
14006
|
'x-deprecated': 'use email_address.',
|
|
13754
14007
|
},
|
|
13755
14008
|
email_address: {
|
|
13756
|
-
description:
|
|
14009
|
+
description:
|
|
14010
|
+
'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13757
14011
|
format: 'email',
|
|
13758
14012
|
type: 'string',
|
|
13759
14013
|
},
|
|
13760
14014
|
errors: {
|
|
13761
|
-
description:
|
|
14015
|
+
description:
|
|
14016
|
+
'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13762
14017
|
items: {
|
|
13763
|
-
description:
|
|
14018
|
+
description:
|
|
14019
|
+
'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13764
14020
|
discriminator: { propertyName: 'error_code' },
|
|
13765
14021
|
oneOf: [
|
|
13766
14022
|
{
|
|
13767
14023
|
description:
|
|
13768
|
-
'Indicates that the ACS user was deleted from the
|
|
14024
|
+
'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.',
|
|
13769
14025
|
properties: {
|
|
13770
14026
|
created_at: {
|
|
13771
14027
|
description:
|
|
@@ -13788,7 +14044,7 @@ export default {
|
|
|
13788
14044
|
},
|
|
13789
14045
|
{
|
|
13790
14046
|
description:
|
|
13791
|
-
'Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.',
|
|
14047
|
+
'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.',
|
|
13792
14048
|
properties: {
|
|
13793
14049
|
created_at: {
|
|
13794
14050
|
description:
|
|
@@ -13811,7 +14067,7 @@ export default {
|
|
|
13811
14067
|
},
|
|
13812
14068
|
{
|
|
13813
14069
|
description:
|
|
13814
|
-
|
|
14070
|
+
'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).',
|
|
13815
14071
|
properties: {
|
|
13816
14072
|
created_at: {
|
|
13817
14073
|
description:
|
|
@@ -13834,7 +14090,7 @@ export default {
|
|
|
13834
14090
|
},
|
|
13835
14091
|
{
|
|
13836
14092
|
description:
|
|
13837
|
-
|
|
14093
|
+
'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).',
|
|
13838
14094
|
properties: {
|
|
13839
14095
|
created_at: {
|
|
13840
14096
|
description:
|
|
@@ -13857,7 +14113,7 @@ export default {
|
|
|
13857
14113
|
},
|
|
13858
14114
|
{
|
|
13859
14115
|
description:
|
|
13860
|
-
|
|
14116
|
+
'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).',
|
|
13861
14117
|
properties: {
|
|
13862
14118
|
created_at: {
|
|
13863
14119
|
description:
|
|
@@ -13883,7 +14139,8 @@ export default {
|
|
|
13883
14139
|
type: 'array',
|
|
13884
14140
|
},
|
|
13885
14141
|
external_type: {
|
|
13886
|
-
description:
|
|
14142
|
+
description:
|
|
14143
|
+
'Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.',
|
|
13887
14144
|
enum: [
|
|
13888
14145
|
'pti_user',
|
|
13889
14146
|
'brivo_user',
|
|
@@ -13897,11 +14154,12 @@ export default {
|
|
|
13897
14154
|
},
|
|
13898
14155
|
external_type_display_name: {
|
|
13899
14156
|
description:
|
|
13900
|
-
'Display name that corresponds to the brand-specific terminology for the
|
|
14157
|
+
'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.',
|
|
13901
14158
|
type: 'string',
|
|
13902
14159
|
},
|
|
13903
14160
|
full_name: {
|
|
13904
|
-
description:
|
|
14161
|
+
description:
|
|
14162
|
+
'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13905
14163
|
type: 'string',
|
|
13906
14164
|
},
|
|
13907
14165
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
@@ -13913,7 +14171,7 @@ export default {
|
|
|
13913
14171
|
is_managed: { enum: [false], type: 'boolean' },
|
|
13914
14172
|
is_suspended: {
|
|
13915
14173
|
description:
|
|
13916
|
-
'Indicates whether the
|
|
14174
|
+
'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).',
|
|
13917
14175
|
type: 'boolean',
|
|
13918
14176
|
},
|
|
13919
14177
|
latest_desired_state_synced_with_provider_at: {
|
|
@@ -13924,44 +14182,55 @@ export default {
|
|
|
13924
14182
|
},
|
|
13925
14183
|
phone_number: {
|
|
13926
14184
|
description:
|
|
13927
|
-
'Phone number of the
|
|
14185
|
+
'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
13928
14186
|
type: 'string',
|
|
13929
14187
|
},
|
|
13930
14188
|
user_identity_email_address: {
|
|
13931
14189
|
description:
|
|
13932
|
-
'Email address of the user identity associated with the
|
|
14190
|
+
'Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13933
14191
|
nullable: true,
|
|
13934
14192
|
type: 'string',
|
|
13935
14193
|
},
|
|
13936
14194
|
user_identity_full_name: {
|
|
13937
14195
|
description:
|
|
13938
|
-
'Full name of the user identity associated with the
|
|
14196
|
+
'Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13939
14197
|
nullable: true,
|
|
13940
14198
|
type: 'string',
|
|
13941
14199
|
},
|
|
13942
14200
|
user_identity_id: {
|
|
13943
14201
|
description:
|
|
13944
|
-
'ID of the user identity associated with the
|
|
14202
|
+
'ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13945
14203
|
type: 'string',
|
|
13946
14204
|
},
|
|
13947
14205
|
user_identity_phone_number: {
|
|
13948
14206
|
description:
|
|
13949
|
-
'Phone number of the user identity associated with the
|
|
14207
|
+
'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`).',
|
|
13950
14208
|
nullable: true,
|
|
13951
14209
|
type: 'string',
|
|
13952
14210
|
},
|
|
13953
14211
|
warnings: {
|
|
13954
|
-
description:
|
|
14212
|
+
description:
|
|
14213
|
+
'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13955
14214
|
items: {
|
|
13956
|
-
description:
|
|
14215
|
+
description:
|
|
14216
|
+
'Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
13957
14217
|
discriminator: { propertyName: 'warning_code' },
|
|
13958
14218
|
oneOf: [
|
|
13959
14219
|
{
|
|
13960
14220
|
description:
|
|
13961
|
-
'Indicates that the user is being deleted from the
|
|
14221
|
+
'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.',
|
|
13962
14222
|
properties: {
|
|
13963
|
-
created_at: {
|
|
13964
|
-
|
|
14223
|
+
created_at: {
|
|
14224
|
+
description:
|
|
14225
|
+
'Date and time at which Seam created the warning.',
|
|
14226
|
+
format: 'date-time',
|
|
14227
|
+
type: 'string',
|
|
14228
|
+
},
|
|
14229
|
+
message: {
|
|
14230
|
+
description:
|
|
14231
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
14232
|
+
type: 'string',
|
|
14233
|
+
},
|
|
13965
14234
|
warning_code: { enum: ['being_deleted'], type: 'string' },
|
|
13966
14235
|
},
|
|
13967
14236
|
required: ['created_at', 'message', 'warning_code'],
|
|
@@ -13969,10 +14238,19 @@ export default {
|
|
|
13969
14238
|
},
|
|
13970
14239
|
{
|
|
13971
14240
|
description:
|
|
13972
|
-
'Indicates that the user is not subscribed on
|
|
14241
|
+
'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.',
|
|
13973
14242
|
properties: {
|
|
13974
|
-
created_at: {
|
|
13975
|
-
|
|
14243
|
+
created_at: {
|
|
14244
|
+
description:
|
|
14245
|
+
'Date and time at which Seam created the warning.',
|
|
14246
|
+
format: 'date-time',
|
|
14247
|
+
type: 'string',
|
|
14248
|
+
},
|
|
14249
|
+
message: {
|
|
14250
|
+
description:
|
|
14251
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
14252
|
+
type: 'string',
|
|
14253
|
+
},
|
|
13976
14254
|
warning_code: {
|
|
13977
14255
|
enum: ['salto_ks_user_not_subscribed'],
|
|
13978
14256
|
type: 'string',
|
|
@@ -13983,10 +14261,19 @@ export default {
|
|
|
13983
14261
|
},
|
|
13984
14262
|
{
|
|
13985
14263
|
description:
|
|
13986
|
-
'An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.',
|
|
14264
|
+
'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.',
|
|
13987
14265
|
properties: {
|
|
13988
|
-
created_at: {
|
|
13989
|
-
|
|
14266
|
+
created_at: {
|
|
14267
|
+
description:
|
|
14268
|
+
'Date and time at which Seam created the warning.',
|
|
14269
|
+
format: 'date-time',
|
|
14270
|
+
type: 'string',
|
|
14271
|
+
},
|
|
14272
|
+
message: {
|
|
14273
|
+
description:
|
|
14274
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
14275
|
+
type: 'string',
|
|
14276
|
+
},
|
|
13990
14277
|
warning_code: {
|
|
13991
14278
|
enum: ['unknown_issue_with_acs_user'],
|
|
13992
14279
|
type: 'string',
|
|
@@ -14001,7 +14288,7 @@ export default {
|
|
|
14001
14288
|
},
|
|
14002
14289
|
workspace_id: {
|
|
14003
14290
|
description:
|
|
14004
|
-
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
14291
|
+
'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).',
|
|
14005
14292
|
format: 'uuid',
|
|
14006
14293
|
type: 'string',
|
|
14007
14294
|
},
|
|
@@ -19081,7 +19368,8 @@ export default {
|
|
|
19081
19368
|
'x-deprecated': 'use email_address.',
|
|
19082
19369
|
},
|
|
19083
19370
|
email_address: {
|
|
19084
|
-
description:
|
|
19371
|
+
description:
|
|
19372
|
+
'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
19085
19373
|
format: 'email',
|
|
19086
19374
|
type: 'string',
|
|
19087
19375
|
},
|
|
@@ -19091,7 +19379,7 @@ export default {
|
|
|
19091
19379
|
},
|
|
19092
19380
|
phone_number: {
|
|
19093
19381
|
description:
|
|
19094
|
-
'Phone number of the
|
|
19382
|
+
'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
19095
19383
|
type: 'string',
|
|
19096
19384
|
},
|
|
19097
19385
|
user_identity_id: {
|
|
@@ -19739,7 +20027,8 @@ export default {
|
|
|
19739
20027
|
type: 'object',
|
|
19740
20028
|
},
|
|
19741
20029
|
acs_user_id: {
|
|
19742
|
-
description:
|
|
20030
|
+
description:
|
|
20031
|
+
'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
19743
20032
|
format: 'uuid',
|
|
19744
20033
|
type: 'string',
|
|
19745
20034
|
},
|
|
@@ -19750,18 +20039,20 @@ export default {
|
|
|
19750
20039
|
'x-deprecated': 'use email_address.',
|
|
19751
20040
|
},
|
|
19752
20041
|
email_address: {
|
|
19753
|
-
description:
|
|
20042
|
+
description:
|
|
20043
|
+
'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
19754
20044
|
format: 'email',
|
|
19755
20045
|
type: 'string',
|
|
19756
20046
|
},
|
|
19757
20047
|
full_name: {
|
|
19758
|
-
description:
|
|
20048
|
+
description:
|
|
20049
|
+
'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
19759
20050
|
type: 'string',
|
|
19760
20051
|
},
|
|
19761
20052
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
19762
20053
|
phone_number: {
|
|
19763
20054
|
description:
|
|
19764
|
-
'Phone number of the
|
|
20055
|
+
'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
19765
20056
|
type: 'string',
|
|
19766
20057
|
},
|
|
19767
20058
|
},
|
|
@@ -19819,7 +20110,8 @@ export default {
|
|
|
19819
20110
|
type: 'object',
|
|
19820
20111
|
},
|
|
19821
20112
|
acs_user_id: {
|
|
19822
|
-
description:
|
|
20113
|
+
description:
|
|
20114
|
+
'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
19823
20115
|
format: 'uuid',
|
|
19824
20116
|
type: 'string',
|
|
19825
20117
|
},
|
|
@@ -19830,18 +20122,20 @@ export default {
|
|
|
19830
20122
|
'x-deprecated': 'use email_address.',
|
|
19831
20123
|
},
|
|
19832
20124
|
email_address: {
|
|
19833
|
-
description:
|
|
20125
|
+
description:
|
|
20126
|
+
'Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
19834
20127
|
format: 'email',
|
|
19835
20128
|
type: 'string',
|
|
19836
20129
|
},
|
|
19837
20130
|
full_name: {
|
|
19838
|
-
description:
|
|
20131
|
+
description:
|
|
20132
|
+
'Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
19839
20133
|
type: 'string',
|
|
19840
20134
|
},
|
|
19841
20135
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
19842
20136
|
phone_number: {
|
|
19843
20137
|
description:
|
|
19844
|
-
'Phone number of the
|
|
20138
|
+
'Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).',
|
|
19845
20139
|
type: 'string',
|
|
19846
20140
|
},
|
|
19847
20141
|
},
|
|
@@ -24603,7 +24897,8 @@ export default {
|
|
|
24603
24897
|
schema: {
|
|
24604
24898
|
properties: {
|
|
24605
24899
|
climate_preset_key: {
|
|
24606
|
-
description:
|
|
24900
|
+
description:
|
|
24901
|
+
'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
24607
24902
|
type: 'string',
|
|
24608
24903
|
},
|
|
24609
24904
|
cooling_set_point_celsius: {
|
|
@@ -24614,7 +24909,7 @@ export default {
|
|
|
24614
24909
|
},
|
|
24615
24910
|
cooling_set_point_fahrenheit: {
|
|
24616
24911
|
description:
|
|
24617
|
-
'Temperature to which the thermostat should cool (in °F).',
|
|
24912
|
+
'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).',
|
|
24618
24913
|
format: 'float',
|
|
24619
24914
|
type: 'number',
|
|
24620
24915
|
},
|
|
@@ -24625,19 +24920,19 @@ export default {
|
|
|
24625
24920
|
},
|
|
24626
24921
|
fan_mode_setting: {
|
|
24627
24922
|
description:
|
|
24628
|
-
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
24923
|
+
'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`.',
|
|
24629
24924
|
enum: ['auto', 'on', 'circulate'],
|
|
24630
24925
|
type: 'string',
|
|
24631
24926
|
},
|
|
24632
24927
|
heating_set_point_celsius: {
|
|
24633
24928
|
description:
|
|
24634
|
-
'Temperature to which the thermostat should heat (in °C).',
|
|
24929
|
+
'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).',
|
|
24635
24930
|
format: 'float',
|
|
24636
24931
|
type: 'number',
|
|
24637
24932
|
},
|
|
24638
24933
|
heating_set_point_fahrenheit: {
|
|
24639
24934
|
description:
|
|
24640
|
-
'Temperature to which the thermostat should heat (in °F).',
|
|
24935
|
+
'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).',
|
|
24641
24936
|
format: 'float',
|
|
24642
24937
|
type: 'number',
|
|
24643
24938
|
},
|
|
@@ -24659,7 +24954,7 @@ export default {
|
|
|
24659
24954
|
name: {
|
|
24660
24955
|
default: null,
|
|
24661
24956
|
description:
|
|
24662
|
-
'User-friendly name to identify the climate preset.',
|
|
24957
|
+
'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
24663
24958
|
nullable: true,
|
|
24664
24959
|
type: 'string',
|
|
24665
24960
|
},
|
|
@@ -26460,7 +26755,8 @@ export default {
|
|
|
26460
26755
|
schema: {
|
|
26461
26756
|
properties: {
|
|
26462
26757
|
climate_preset_key: {
|
|
26463
|
-
description:
|
|
26758
|
+
description:
|
|
26759
|
+
'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
26464
26760
|
type: 'string',
|
|
26465
26761
|
},
|
|
26466
26762
|
cooling_set_point_celsius: {
|
|
@@ -26471,7 +26767,7 @@ export default {
|
|
|
26471
26767
|
},
|
|
26472
26768
|
cooling_set_point_fahrenheit: {
|
|
26473
26769
|
description:
|
|
26474
|
-
'Temperature to which the thermostat should cool (in °F).',
|
|
26770
|
+
'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).',
|
|
26475
26771
|
format: 'float',
|
|
26476
26772
|
type: 'number',
|
|
26477
26773
|
},
|
|
@@ -26482,19 +26778,19 @@ export default {
|
|
|
26482
26778
|
},
|
|
26483
26779
|
fan_mode_setting: {
|
|
26484
26780
|
description:
|
|
26485
|
-
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
26781
|
+
'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`.',
|
|
26486
26782
|
enum: ['auto', 'on', 'circulate'],
|
|
26487
26783
|
type: 'string',
|
|
26488
26784
|
},
|
|
26489
26785
|
heating_set_point_celsius: {
|
|
26490
26786
|
description:
|
|
26491
|
-
'Temperature to which the thermostat should heat (in °C).',
|
|
26787
|
+
'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).',
|
|
26492
26788
|
format: 'float',
|
|
26493
26789
|
type: 'number',
|
|
26494
26790
|
},
|
|
26495
26791
|
heating_set_point_fahrenheit: {
|
|
26496
26792
|
description:
|
|
26497
|
-
'Temperature to which the thermostat should heat (in °F).',
|
|
26793
|
+
'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).',
|
|
26498
26794
|
format: 'float',
|
|
26499
26795
|
type: 'number',
|
|
26500
26796
|
},
|
|
@@ -26507,7 +26803,7 @@ export default {
|
|
|
26507
26803
|
manual_override_allowed: {
|
|
26508
26804
|
deprecated: true,
|
|
26509
26805
|
description:
|
|
26510
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
26806
|
+
"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).",
|
|
26511
26807
|
type: 'boolean',
|
|
26512
26808
|
'x-deprecated':
|
|
26513
26809
|
"Use 'thermostat_schedule.is_override_allowed'",
|
|
@@ -26515,7 +26811,7 @@ export default {
|
|
|
26515
26811
|
name: {
|
|
26516
26812
|
default: null,
|
|
26517
26813
|
description:
|
|
26518
|
-
'User-friendly name to identify the climate preset.',
|
|
26814
|
+
'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
26519
26815
|
nullable: true,
|
|
26520
26816
|
type: 'string',
|
|
26521
26817
|
},
|
|
@@ -26567,7 +26863,8 @@ export default {
|
|
|
26567
26863
|
schema: {
|
|
26568
26864
|
properties: {
|
|
26569
26865
|
climate_preset_key: {
|
|
26570
|
-
description:
|
|
26866
|
+
description:
|
|
26867
|
+
'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
26571
26868
|
type: 'string',
|
|
26572
26869
|
},
|
|
26573
26870
|
cooling_set_point_celsius: {
|
|
@@ -26578,7 +26875,7 @@ export default {
|
|
|
26578
26875
|
},
|
|
26579
26876
|
cooling_set_point_fahrenheit: {
|
|
26580
26877
|
description:
|
|
26581
|
-
'Temperature to which the thermostat should cool (in °F).',
|
|
26878
|
+
'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).',
|
|
26582
26879
|
format: 'float',
|
|
26583
26880
|
type: 'number',
|
|
26584
26881
|
},
|
|
@@ -26589,19 +26886,19 @@ export default {
|
|
|
26589
26886
|
},
|
|
26590
26887
|
fan_mode_setting: {
|
|
26591
26888
|
description:
|
|
26592
|
-
'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
|
|
26889
|
+
'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`.',
|
|
26593
26890
|
enum: ['auto', 'on', 'circulate'],
|
|
26594
26891
|
type: 'string',
|
|
26595
26892
|
},
|
|
26596
26893
|
heating_set_point_celsius: {
|
|
26597
26894
|
description:
|
|
26598
|
-
'Temperature to which the thermostat should heat (in °C).',
|
|
26895
|
+
'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).',
|
|
26599
26896
|
format: 'float',
|
|
26600
26897
|
type: 'number',
|
|
26601
26898
|
},
|
|
26602
26899
|
heating_set_point_fahrenheit: {
|
|
26603
26900
|
description:
|
|
26604
|
-
'Temperature to which the thermostat should heat (in °F).',
|
|
26901
|
+
'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).',
|
|
26605
26902
|
format: 'float',
|
|
26606
26903
|
type: 'number',
|
|
26607
26904
|
},
|
|
@@ -26614,7 +26911,7 @@ export default {
|
|
|
26614
26911
|
manual_override_allowed: {
|
|
26615
26912
|
deprecated: true,
|
|
26616
26913
|
description:
|
|
26617
|
-
"Indicates whether a person at the thermostat can change the thermostat's settings.",
|
|
26914
|
+
"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).",
|
|
26618
26915
|
type: 'boolean',
|
|
26619
26916
|
'x-deprecated':
|
|
26620
26917
|
"Use 'thermostat_schedule.is_override_allowed'",
|
|
@@ -26622,7 +26919,7 @@ export default {
|
|
|
26622
26919
|
name: {
|
|
26623
26920
|
default: null,
|
|
26624
26921
|
description:
|
|
26625
|
-
'User-friendly name to identify the climate preset.',
|
|
26922
|
+
'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
|
|
26626
26923
|
nullable: true,
|
|
26627
26924
|
type: 'string',
|
|
26628
26925
|
},
|