@seamapi/types 1.263.1 → 1.264.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +364 -43
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +3241 -120
- package/lib/seam/connect/models/acs/acs-credential.d.ts +83 -0
- package/lib/seam/connect/models/acs/acs-credential.js +38 -0
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +798 -14
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -2
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/scan-card.d.ts +875 -0
- package/lib/seam/connect/models/action-attempts/{read-card.js → scan-card.js} +8 -12
- package/lib/seam/connect/models/action-attempts/scan-card.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +241 -4
- package/lib/seam/connect/openapi.js +311 -11
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2202 -102
- package/package.json +2 -2
- package/src/lib/seam/connect/models/acs/acs-credential.ts +48 -0
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -2
- package/src/lib/seam/connect/models/action-attempts/{read-card.ts → scan-card.ts} +15 -12
- package/src/lib/seam/connect/openapi.ts +316 -11
- package/src/lib/seam/connect/route-types.ts +3042 -242
- package/lib/seam/connect/models/action-attempts/read-card.d.ts +0 -91
- package/lib/seam/connect/models/action-attempts/read-card.js.map +0 -1
|
@@ -1146,7 +1146,7 @@ export default {
|
|
|
1146
1146
|
type: 'string',
|
|
1147
1147
|
'x-title': 'Action Attempt ID',
|
|
1148
1148
|
},
|
|
1149
|
-
action_type: { enum: ['
|
|
1149
|
+
action_type: { enum: ['SCAN_CARD'], type: 'string' },
|
|
1150
1150
|
error: { nullable: true },
|
|
1151
1151
|
result: { nullable: true },
|
|
1152
1152
|
status: { enum: ['pending'], type: 'string' },
|
|
@@ -1169,17 +1169,317 @@ export default {
|
|
|
1169
1169
|
type: 'string',
|
|
1170
1170
|
'x-title': 'Action Attempt ID',
|
|
1171
1171
|
},
|
|
1172
|
-
action_type: { enum: ['
|
|
1172
|
+
action_type: { enum: ['SCAN_CARD'], type: 'string' },
|
|
1173
1173
|
error: { nullable: true },
|
|
1174
1174
|
result: {
|
|
1175
1175
|
properties: {
|
|
1176
|
-
|
|
1177
|
-
description: '
|
|
1176
|
+
acs_credential_on_encoder: {
|
|
1177
|
+
description: 'Snapshot of the card data read from the physical encoder.',
|
|
1178
|
+
properties: {
|
|
1179
|
+
card_number: {
|
|
1180
|
+
description: 'A number or string that physically identifies this card.',
|
|
1181
|
+
nullable: true,
|
|
1182
|
+
type: 'string',
|
|
1183
|
+
},
|
|
1184
|
+
created_at: {
|
|
1185
|
+
description: 'Date and time the credential was created.',
|
|
1186
|
+
format: 'date-time',
|
|
1187
|
+
type: 'string',
|
|
1188
|
+
},
|
|
1189
|
+
ends_at: {
|
|
1190
|
+
description: 'Date and time the credential will stop being useable.',
|
|
1191
|
+
format: 'date-time',
|
|
1192
|
+
nullable: true,
|
|
1193
|
+
type: 'string',
|
|
1194
|
+
},
|
|
1195
|
+
is_issued: { nullable: true, type: 'boolean' },
|
|
1196
|
+
starts_at: {
|
|
1197
|
+
description: 'Date and time the credential will become useable.',
|
|
1198
|
+
format: 'date-time',
|
|
1199
|
+
nullable: true,
|
|
1200
|
+
type: 'string',
|
|
1201
|
+
},
|
|
1202
|
+
visionline_metadata: {
|
|
1203
|
+
properties: {
|
|
1204
|
+
cancelled: { type: 'boolean' },
|
|
1205
|
+
card_format: {
|
|
1206
|
+
enum: ['TLCode', 'rfid48'],
|
|
1207
|
+
type: 'string',
|
|
1208
|
+
},
|
|
1209
|
+
card_function_type: {
|
|
1210
|
+
enum: ['guest', 'staff'],
|
|
1211
|
+
type: 'string',
|
|
1212
|
+
},
|
|
1213
|
+
card_holder: { type: 'string' },
|
|
1214
|
+
card_id: { type: 'string' },
|
|
1215
|
+
discarded: { type: 'boolean' },
|
|
1216
|
+
expired: { type: 'boolean' },
|
|
1217
|
+
number_of_issued_cards: {
|
|
1218
|
+
format: 'float',
|
|
1219
|
+
type: 'number',
|
|
1220
|
+
},
|
|
1221
|
+
overridden: { type: 'boolean' },
|
|
1222
|
+
overwritten: { type: 'boolean' },
|
|
1223
|
+
pending_auto_update: { type: 'boolean' },
|
|
1224
|
+
},
|
|
1225
|
+
required: [
|
|
1226
|
+
'card_id',
|
|
1227
|
+
'card_function_type',
|
|
1228
|
+
'cancelled',
|
|
1229
|
+
'discarded',
|
|
1230
|
+
'expired',
|
|
1231
|
+
'overwritten',
|
|
1232
|
+
'pending_auto_update',
|
|
1233
|
+
'card_format',
|
|
1234
|
+
'number_of_issued_cards',
|
|
1235
|
+
],
|
|
1236
|
+
type: 'object',
|
|
1237
|
+
},
|
|
1238
|
+
},
|
|
1239
|
+
required: [
|
|
1240
|
+
'created_at',
|
|
1241
|
+
'is_issued',
|
|
1242
|
+
'starts_at',
|
|
1243
|
+
'ends_at',
|
|
1244
|
+
'card_number',
|
|
1245
|
+
],
|
|
1246
|
+
type: 'object',
|
|
1247
|
+
},
|
|
1248
|
+
acs_credential_on_seam: {
|
|
1249
|
+
description: 'Matching acs_credential currently encoded on this card.',
|
|
1178
1250
|
nullable: true,
|
|
1179
|
-
|
|
1251
|
+
oneOf: [
|
|
1252
|
+
{
|
|
1253
|
+
properties: {
|
|
1254
|
+
access_method: {
|
|
1255
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
1256
|
+
type: 'string',
|
|
1257
|
+
},
|
|
1258
|
+
acs_credential_id: { format: 'uuid', type: 'string' },
|
|
1259
|
+
acs_credential_pool_id: {
|
|
1260
|
+
format: 'uuid',
|
|
1261
|
+
type: 'string',
|
|
1262
|
+
},
|
|
1263
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
1264
|
+
acs_user_id: { format: 'uuid', type: 'string' },
|
|
1265
|
+
card_number: { nullable: true, type: 'string' },
|
|
1266
|
+
code: { nullable: true, type: 'string' },
|
|
1267
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
1268
|
+
display_name: { minLength: 1, type: 'string' },
|
|
1269
|
+
ends_at: { type: 'string' },
|
|
1270
|
+
errors: {
|
|
1271
|
+
items: {
|
|
1272
|
+
properties: {
|
|
1273
|
+
error_code: { type: 'string' },
|
|
1274
|
+
message: { type: 'string' },
|
|
1275
|
+
},
|
|
1276
|
+
required: ['error_code', 'message'],
|
|
1277
|
+
type: 'object',
|
|
1278
|
+
},
|
|
1279
|
+
type: 'array',
|
|
1280
|
+
},
|
|
1281
|
+
external_type: {
|
|
1282
|
+
enum: [
|
|
1283
|
+
'pti_card',
|
|
1284
|
+
'brivo_credential',
|
|
1285
|
+
'hid_credential',
|
|
1286
|
+
'visionline_card',
|
|
1287
|
+
'salto_ks_credential',
|
|
1288
|
+
],
|
|
1289
|
+
type: 'string',
|
|
1290
|
+
},
|
|
1291
|
+
external_type_display_name: { type: 'string' },
|
|
1292
|
+
is_issued: { type: 'boolean' },
|
|
1293
|
+
is_latest_desired_state_synced_with_provider: {
|
|
1294
|
+
type: 'boolean',
|
|
1295
|
+
},
|
|
1296
|
+
is_managed: { enum: [true], type: 'boolean' },
|
|
1297
|
+
is_multi_phone_sync_credential: { type: 'boolean' },
|
|
1298
|
+
issued_at: {
|
|
1299
|
+
format: 'date-time',
|
|
1300
|
+
nullable: true,
|
|
1301
|
+
type: 'string',
|
|
1302
|
+
},
|
|
1303
|
+
latest_desired_state_synced_with_provider_at: {
|
|
1304
|
+
format: 'date-time',
|
|
1305
|
+
type: 'string',
|
|
1306
|
+
},
|
|
1307
|
+
parent_acs_credential_id: {
|
|
1308
|
+
format: 'uuid',
|
|
1309
|
+
type: 'string',
|
|
1310
|
+
},
|
|
1311
|
+
starts_at: { type: 'string' },
|
|
1312
|
+
visionline_metadata: {
|
|
1313
|
+
properties: {
|
|
1314
|
+
auto_join: { type: 'boolean' },
|
|
1315
|
+
card_function_type: {
|
|
1316
|
+
enum: ['guest', 'staff'],
|
|
1317
|
+
type: 'string',
|
|
1318
|
+
},
|
|
1319
|
+
card_id: { type: 'string' },
|
|
1320
|
+
common_acs_entrance_ids: {
|
|
1321
|
+
items: { format: 'uuid', type: 'string' },
|
|
1322
|
+
type: 'array',
|
|
1323
|
+
},
|
|
1324
|
+
credential_id: { type: 'string' },
|
|
1325
|
+
guest_acs_entrance_ids: {
|
|
1326
|
+
items: { format: 'uuid', type: 'string' },
|
|
1327
|
+
type: 'array',
|
|
1328
|
+
},
|
|
1329
|
+
is_valid: { type: 'boolean' },
|
|
1330
|
+
joiner_acs_credential_ids: {
|
|
1331
|
+
items: { format: 'uuid', type: 'string' },
|
|
1332
|
+
type: 'array',
|
|
1333
|
+
},
|
|
1334
|
+
},
|
|
1335
|
+
required: ['card_function_type'],
|
|
1336
|
+
type: 'object',
|
|
1337
|
+
},
|
|
1338
|
+
warnings: {
|
|
1339
|
+
items: {
|
|
1340
|
+
properties: {
|
|
1341
|
+
message: { type: 'string' },
|
|
1342
|
+
warning_code: { type: 'string' },
|
|
1343
|
+
},
|
|
1344
|
+
required: ['warning_code', 'message'],
|
|
1345
|
+
type: 'object',
|
|
1346
|
+
},
|
|
1347
|
+
type: 'array',
|
|
1348
|
+
},
|
|
1349
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
1350
|
+
},
|
|
1351
|
+
required: [
|
|
1352
|
+
'acs_credential_id',
|
|
1353
|
+
'acs_system_id',
|
|
1354
|
+
'display_name',
|
|
1355
|
+
'access_method',
|
|
1356
|
+
'created_at',
|
|
1357
|
+
'workspace_id',
|
|
1358
|
+
'errors',
|
|
1359
|
+
'warnings',
|
|
1360
|
+
'is_managed',
|
|
1361
|
+
],
|
|
1362
|
+
type: 'object',
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
properties: {
|
|
1366
|
+
access_method: {
|
|
1367
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
1368
|
+
type: 'string',
|
|
1369
|
+
},
|
|
1370
|
+
acs_credential_id: { format: 'uuid', type: 'string' },
|
|
1371
|
+
acs_credential_pool_id: {
|
|
1372
|
+
format: 'uuid',
|
|
1373
|
+
type: 'string',
|
|
1374
|
+
},
|
|
1375
|
+
acs_system_id: { format: 'uuid', type: 'string' },
|
|
1376
|
+
acs_user_id: { format: 'uuid', type: 'string' },
|
|
1377
|
+
card_number: { nullable: true, type: 'string' },
|
|
1378
|
+
code: { nullable: true, type: 'string' },
|
|
1379
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
1380
|
+
display_name: { minLength: 1, type: 'string' },
|
|
1381
|
+
ends_at: { type: 'string' },
|
|
1382
|
+
errors: {
|
|
1383
|
+
items: {
|
|
1384
|
+
properties: {
|
|
1385
|
+
error_code: { type: 'string' },
|
|
1386
|
+
message: { type: 'string' },
|
|
1387
|
+
},
|
|
1388
|
+
required: ['error_code', 'message'],
|
|
1389
|
+
type: 'object',
|
|
1390
|
+
},
|
|
1391
|
+
type: 'array',
|
|
1392
|
+
},
|
|
1393
|
+
external_type: {
|
|
1394
|
+
enum: [
|
|
1395
|
+
'pti_card',
|
|
1396
|
+
'brivo_credential',
|
|
1397
|
+
'hid_credential',
|
|
1398
|
+
'visionline_card',
|
|
1399
|
+
'salto_ks_credential',
|
|
1400
|
+
],
|
|
1401
|
+
type: 'string',
|
|
1402
|
+
},
|
|
1403
|
+
external_type_display_name: { type: 'string' },
|
|
1404
|
+
is_issued: { type: 'boolean' },
|
|
1405
|
+
is_latest_desired_state_synced_with_provider: {
|
|
1406
|
+
type: 'boolean',
|
|
1407
|
+
},
|
|
1408
|
+
is_managed: { enum: [false], type: 'boolean' },
|
|
1409
|
+
is_multi_phone_sync_credential: { type: 'boolean' },
|
|
1410
|
+
issued_at: {
|
|
1411
|
+
format: 'date-time',
|
|
1412
|
+
nullable: true,
|
|
1413
|
+
type: 'string',
|
|
1414
|
+
},
|
|
1415
|
+
latest_desired_state_synced_with_provider_at: {
|
|
1416
|
+
format: 'date-time',
|
|
1417
|
+
type: 'string',
|
|
1418
|
+
},
|
|
1419
|
+
parent_acs_credential_id: {
|
|
1420
|
+
format: 'uuid',
|
|
1421
|
+
type: 'string',
|
|
1422
|
+
},
|
|
1423
|
+
starts_at: { type: 'string' },
|
|
1424
|
+
visionline_metadata: {
|
|
1425
|
+
properties: {
|
|
1426
|
+
auto_join: { type: 'boolean' },
|
|
1427
|
+
card_function_type: {
|
|
1428
|
+
enum: ['guest', 'staff'],
|
|
1429
|
+
type: 'string',
|
|
1430
|
+
},
|
|
1431
|
+
card_id: { type: 'string' },
|
|
1432
|
+
common_acs_entrance_ids: {
|
|
1433
|
+
items: { format: 'uuid', type: 'string' },
|
|
1434
|
+
type: 'array',
|
|
1435
|
+
},
|
|
1436
|
+
credential_id: { type: 'string' },
|
|
1437
|
+
guest_acs_entrance_ids: {
|
|
1438
|
+
items: { format: 'uuid', type: 'string' },
|
|
1439
|
+
type: 'array',
|
|
1440
|
+
},
|
|
1441
|
+
is_valid: { type: 'boolean' },
|
|
1442
|
+
joiner_acs_credential_ids: {
|
|
1443
|
+
items: { format: 'uuid', type: 'string' },
|
|
1444
|
+
type: 'array',
|
|
1445
|
+
},
|
|
1446
|
+
},
|
|
1447
|
+
required: ['card_function_type'],
|
|
1448
|
+
type: 'object',
|
|
1449
|
+
},
|
|
1450
|
+
warnings: {
|
|
1451
|
+
items: {
|
|
1452
|
+
properties: {
|
|
1453
|
+
message: { type: 'string' },
|
|
1454
|
+
warning_code: { type: 'string' },
|
|
1455
|
+
},
|
|
1456
|
+
required: ['warning_code', 'message'],
|
|
1457
|
+
type: 'object',
|
|
1458
|
+
},
|
|
1459
|
+
type: 'array',
|
|
1460
|
+
},
|
|
1461
|
+
workspace_id: { format: 'uuid', type: 'string' },
|
|
1462
|
+
},
|
|
1463
|
+
required: [
|
|
1464
|
+
'acs_credential_id',
|
|
1465
|
+
'acs_system_id',
|
|
1466
|
+
'display_name',
|
|
1467
|
+
'access_method',
|
|
1468
|
+
'created_at',
|
|
1469
|
+
'workspace_id',
|
|
1470
|
+
'errors',
|
|
1471
|
+
'warnings',
|
|
1472
|
+
'is_managed',
|
|
1473
|
+
],
|
|
1474
|
+
type: 'object',
|
|
1475
|
+
},
|
|
1476
|
+
],
|
|
1180
1477
|
},
|
|
1181
1478
|
},
|
|
1182
|
-
required: [
|
|
1479
|
+
required: [
|
|
1480
|
+
'acs_credential_on_encoder',
|
|
1481
|
+
'acs_credential_on_seam',
|
|
1482
|
+
],
|
|
1183
1483
|
type: 'object',
|
|
1184
1484
|
},
|
|
1185
1485
|
status: { enum: ['success'], type: 'string' },
|
|
@@ -1202,7 +1502,7 @@ export default {
|
|
|
1202
1502
|
type: 'string',
|
|
1203
1503
|
'x-title': 'Action Attempt ID',
|
|
1204
1504
|
},
|
|
1205
|
-
action_type: { enum: ['
|
|
1505
|
+
action_type: { enum: ['SCAN_CARD'], type: 'string' },
|
|
1206
1506
|
error: {
|
|
1207
1507
|
properties: {
|
|
1208
1508
|
message: { type: 'string' },
|
|
@@ -7629,9 +7929,9 @@ export default {
|
|
|
7629
7929
|
'x-undocumented': 'Encoders are in alpha.',
|
|
7630
7930
|
},
|
|
7631
7931
|
},
|
|
7632
|
-
'/acs/encoders/
|
|
7932
|
+
'/acs/encoders/scan_card': {
|
|
7633
7933
|
post: {
|
|
7634
|
-
operationId: '
|
|
7934
|
+
operationId: 'acsEncodersScanCardPost',
|
|
7635
7935
|
requestBody: {
|
|
7636
7936
|
content: {
|
|
7637
7937
|
'application/json': {
|
|
@@ -7684,10 +7984,10 @@ export default {
|
|
|
7684
7984
|
{ console_session: [] },
|
|
7685
7985
|
{ api_key: [] },
|
|
7686
7986
|
],
|
|
7687
|
-
summary: '/acs/encoders/
|
|
7987
|
+
summary: '/acs/encoders/scan_card',
|
|
7688
7988
|
tags: ['/acs'],
|
|
7689
7989
|
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
7690
|
-
'x-fern-sdk-method-name': '
|
|
7990
|
+
'x-fern-sdk-method-name': 'scan_card',
|
|
7691
7991
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
7692
7992
|
'x-response-key': 'action_attempt',
|
|
7693
7993
|
'x-undocumented': 'Reading a card is currently unimplemented.',
|