@seamapi/types 1.263.1 → 1.264.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/connect.cjs +438 -84
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3745 -454
  4. package/lib/seam/connect/models/acs/acs-credential.d.ts +83 -0
  5. package/lib/seam/connect/models/acs/acs-credential.js +38 -0
  6. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +862 -53
  8. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -2
  9. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/deprecated.d.ts +61 -21
  11. package/lib/seam/connect/models/action-attempts/deprecated.js +13 -5
  12. package/lib/seam/connect/models/action-attempts/deprecated.js.map +1 -1
  13. package/lib/seam/connect/models/action-attempts/encode-card.d.ts +3 -18
  14. package/lib/seam/connect/models/action-attempts/encode-card.js +1 -12
  15. package/lib/seam/connect/models/action-attempts/encode-card.js.map +1 -1
  16. package/lib/seam/connect/models/action-attempts/index.d.ts +1 -0
  17. package/lib/seam/connect/models/action-attempts/index.js +1 -0
  18. package/lib/seam/connect/models/action-attempts/index.js.map +1 -1
  19. package/lib/seam/connect/models/action-attempts/scan-card.d.ts +875 -0
  20. package/lib/seam/connect/models/action-attempts/{read-card.js → scan-card.js} +8 -12
  21. package/lib/seam/connect/models/action-attempts/scan-card.js.map +1 -0
  22. package/lib/seam/connect/openapi.d.ts +308 -38
  23. package/lib/seam/connect/openapi.js +368 -42
  24. package/lib/seam/connect/openapi.js.map +1 -1
  25. package/lib/seam/connect/route-types.d.ts +2522 -362
  26. package/lib/seam/connect/schemas.d.ts +1 -1
  27. package/lib/seam/connect/schemas.js +1 -1
  28. package/lib/seam/connect/schemas.js.map +1 -1
  29. package/package.json +2 -2
  30. package/src/lib/seam/connect/models/acs/acs-credential.ts +48 -0
  31. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -2
  32. package/src/lib/seam/connect/models/action-attempts/deprecated.ts +13 -5
  33. package/src/lib/seam/connect/models/action-attempts/encode-card.ts +1 -12
  34. package/src/lib/seam/connect/models/action-attempts/index.ts +1 -0
  35. package/src/lib/seam/connect/models/action-attempts/{read-card.ts → scan-card.ts} +15 -12
  36. package/src/lib/seam/connect/openapi.ts +373 -44
  37. package/src/lib/seam/connect/route-types.ts +3362 -502
  38. package/src/lib/seam/connect/schemas.ts +3 -0
  39. package/lib/seam/connect/models/action-attempts/read-card.d.ts +0 -91
  40. package/lib/seam/connect/models/action-attempts/read-card.js.map +0 -1
@@ -1223,7 +1223,7 @@ export default {
1223
1223
  type: 'string',
1224
1224
  'x-title': 'Action Attempt ID',
1225
1225
  },
1226
- action_type: { enum: ['READ_CARD'], type: 'string' },
1226
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1227
1227
  error: { nullable: true },
1228
1228
  result: { nullable: true },
1229
1229
  status: { enum: ['pending'], type: 'string' },
@@ -1246,18 +1246,323 @@ export default {
1246
1246
  type: 'string',
1247
1247
  'x-title': 'Action Attempt ID',
1248
1248
  },
1249
- action_type: { enum: ['READ_CARD'], type: 'string' },
1249
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1250
1250
  error: { nullable: true },
1251
1251
  result: {
1252
1252
  properties: {
1253
- card_number: {
1253
+ acs_credential_on_encoder: {
1254
1254
  description:
1255
- 'A number or string that physically identifies this card.',
1255
+ 'Snapshot of the card data read from the physical encoder.',
1256
+ properties: {
1257
+ card_number: {
1258
+ description:
1259
+ 'A number or string that physically identifies this card.',
1260
+ nullable: true,
1261
+ type: 'string',
1262
+ },
1263
+ created_at: {
1264
+ description:
1265
+ 'Date and time the credential was created.',
1266
+ format: 'date-time',
1267
+ type: 'string',
1268
+ },
1269
+ ends_at: {
1270
+ description:
1271
+ 'Date and time the credential will stop being useable.',
1272
+ format: 'date-time',
1273
+ nullable: true,
1274
+ type: 'string',
1275
+ },
1276
+ is_issued: { nullable: true, type: 'boolean' },
1277
+ starts_at: {
1278
+ description:
1279
+ 'Date and time the credential will become useable.',
1280
+ format: 'date-time',
1281
+ nullable: true,
1282
+ type: 'string',
1283
+ },
1284
+ visionline_metadata: {
1285
+ properties: {
1286
+ cancelled: { type: 'boolean' },
1287
+ card_format: {
1288
+ enum: ['TLCode', 'rfid48'],
1289
+ type: 'string',
1290
+ },
1291
+ card_function_type: {
1292
+ enum: ['guest', 'staff'],
1293
+ type: 'string',
1294
+ },
1295
+ card_holder: { type: 'string' },
1296
+ card_id: { type: 'string' },
1297
+ discarded: { type: 'boolean' },
1298
+ expired: { type: 'boolean' },
1299
+ number_of_issued_cards: {
1300
+ format: 'float',
1301
+ type: 'number',
1302
+ },
1303
+ overridden: { type: 'boolean' },
1304
+ overwritten: { type: 'boolean' },
1305
+ pending_auto_update: { type: 'boolean' },
1306
+ },
1307
+ required: [
1308
+ 'card_id',
1309
+ 'card_function_type',
1310
+ 'cancelled',
1311
+ 'discarded',
1312
+ 'expired',
1313
+ 'overwritten',
1314
+ 'pending_auto_update',
1315
+ 'card_format',
1316
+ 'number_of_issued_cards',
1317
+ ],
1318
+ type: 'object',
1319
+ },
1320
+ },
1321
+ required: [
1322
+ 'created_at',
1323
+ 'is_issued',
1324
+ 'starts_at',
1325
+ 'ends_at',
1326
+ 'card_number',
1327
+ ],
1328
+ type: 'object',
1329
+ },
1330
+ acs_credential_on_seam: {
1331
+ description:
1332
+ 'Matching acs_credential currently encoded on this card.',
1256
1333
  nullable: true,
1257
- type: 'string',
1334
+ oneOf: [
1335
+ {
1336
+ properties: {
1337
+ access_method: {
1338
+ enum: ['code', 'card', 'mobile_key'],
1339
+ type: 'string',
1340
+ },
1341
+ acs_credential_id: { format: 'uuid', type: 'string' },
1342
+ acs_credential_pool_id: {
1343
+ format: 'uuid',
1344
+ type: 'string',
1345
+ },
1346
+ acs_system_id: { format: 'uuid', type: 'string' },
1347
+ acs_user_id: { format: 'uuid', type: 'string' },
1348
+ card_number: { nullable: true, type: 'string' },
1349
+ code: { nullable: true, type: 'string' },
1350
+ created_at: { format: 'date-time', type: 'string' },
1351
+ display_name: { minLength: 1, type: 'string' },
1352
+ ends_at: { type: 'string' },
1353
+ errors: {
1354
+ items: {
1355
+ properties: {
1356
+ error_code: { type: 'string' },
1357
+ message: { type: 'string' },
1358
+ },
1359
+ required: ['error_code', 'message'],
1360
+ type: 'object',
1361
+ },
1362
+ type: 'array',
1363
+ },
1364
+ external_type: {
1365
+ enum: [
1366
+ 'pti_card',
1367
+ 'brivo_credential',
1368
+ 'hid_credential',
1369
+ 'visionline_card',
1370
+ 'salto_ks_credential',
1371
+ ],
1372
+ type: 'string',
1373
+ },
1374
+ external_type_display_name: { type: 'string' },
1375
+ is_issued: { type: 'boolean' },
1376
+ is_latest_desired_state_synced_with_provider: {
1377
+ type: 'boolean',
1378
+ },
1379
+ is_managed: { enum: [true], type: 'boolean' },
1380
+ is_multi_phone_sync_credential: { type: 'boolean' },
1381
+ issued_at: {
1382
+ format: 'date-time',
1383
+ nullable: true,
1384
+ type: 'string',
1385
+ },
1386
+ latest_desired_state_synced_with_provider_at: {
1387
+ format: 'date-time',
1388
+ type: 'string',
1389
+ },
1390
+ parent_acs_credential_id: {
1391
+ format: 'uuid',
1392
+ type: 'string',
1393
+ },
1394
+ starts_at: { type: 'string' },
1395
+ visionline_metadata: {
1396
+ properties: {
1397
+ auto_join: { type: 'boolean' },
1398
+ card_function_type: {
1399
+ enum: ['guest', 'staff'],
1400
+ type: 'string',
1401
+ },
1402
+ card_id: { type: 'string' },
1403
+ common_acs_entrance_ids: {
1404
+ items: { format: 'uuid', type: 'string' },
1405
+ type: 'array',
1406
+ },
1407
+ credential_id: { type: 'string' },
1408
+ guest_acs_entrance_ids: {
1409
+ items: { format: 'uuid', type: 'string' },
1410
+ type: 'array',
1411
+ },
1412
+ is_valid: { type: 'boolean' },
1413
+ joiner_acs_credential_ids: {
1414
+ items: { format: 'uuid', type: 'string' },
1415
+ type: 'array',
1416
+ },
1417
+ },
1418
+ required: ['card_function_type'],
1419
+ type: 'object',
1420
+ },
1421
+ warnings: {
1422
+ items: {
1423
+ properties: {
1424
+ message: { type: 'string' },
1425
+ warning_code: { type: 'string' },
1426
+ },
1427
+ required: ['warning_code', 'message'],
1428
+ type: 'object',
1429
+ },
1430
+ type: 'array',
1431
+ },
1432
+ workspace_id: { format: 'uuid', type: 'string' },
1433
+ },
1434
+ required: [
1435
+ 'acs_credential_id',
1436
+ 'acs_system_id',
1437
+ 'display_name',
1438
+ 'access_method',
1439
+ 'created_at',
1440
+ 'workspace_id',
1441
+ 'errors',
1442
+ 'warnings',
1443
+ 'is_managed',
1444
+ ],
1445
+ type: 'object',
1446
+ },
1447
+ {
1448
+ properties: {
1449
+ access_method: {
1450
+ enum: ['code', 'card', 'mobile_key'],
1451
+ type: 'string',
1452
+ },
1453
+ acs_credential_id: { format: 'uuid', type: 'string' },
1454
+ acs_credential_pool_id: {
1455
+ format: 'uuid',
1456
+ type: 'string',
1457
+ },
1458
+ acs_system_id: { format: 'uuid', type: 'string' },
1459
+ acs_user_id: { format: 'uuid', type: 'string' },
1460
+ card_number: { nullable: true, type: 'string' },
1461
+ code: { nullable: true, type: 'string' },
1462
+ created_at: { format: 'date-time', type: 'string' },
1463
+ display_name: { minLength: 1, type: 'string' },
1464
+ ends_at: { type: 'string' },
1465
+ errors: {
1466
+ items: {
1467
+ properties: {
1468
+ error_code: { type: 'string' },
1469
+ message: { type: 'string' },
1470
+ },
1471
+ required: ['error_code', 'message'],
1472
+ type: 'object',
1473
+ },
1474
+ type: 'array',
1475
+ },
1476
+ external_type: {
1477
+ enum: [
1478
+ 'pti_card',
1479
+ 'brivo_credential',
1480
+ 'hid_credential',
1481
+ 'visionline_card',
1482
+ 'salto_ks_credential',
1483
+ ],
1484
+ type: 'string',
1485
+ },
1486
+ external_type_display_name: { type: 'string' },
1487
+ is_issued: { type: 'boolean' },
1488
+ is_latest_desired_state_synced_with_provider: {
1489
+ type: 'boolean',
1490
+ },
1491
+ is_managed: { enum: [false], type: 'boolean' },
1492
+ is_multi_phone_sync_credential: { type: 'boolean' },
1493
+ issued_at: {
1494
+ format: 'date-time',
1495
+ nullable: true,
1496
+ type: 'string',
1497
+ },
1498
+ latest_desired_state_synced_with_provider_at: {
1499
+ format: 'date-time',
1500
+ type: 'string',
1501
+ },
1502
+ parent_acs_credential_id: {
1503
+ format: 'uuid',
1504
+ type: 'string',
1505
+ },
1506
+ starts_at: { type: 'string' },
1507
+ visionline_metadata: {
1508
+ properties: {
1509
+ auto_join: { type: 'boolean' },
1510
+ card_function_type: {
1511
+ enum: ['guest', 'staff'],
1512
+ type: 'string',
1513
+ },
1514
+ card_id: { type: 'string' },
1515
+ common_acs_entrance_ids: {
1516
+ items: { format: 'uuid', type: 'string' },
1517
+ type: 'array',
1518
+ },
1519
+ credential_id: { type: 'string' },
1520
+ guest_acs_entrance_ids: {
1521
+ items: { format: 'uuid', type: 'string' },
1522
+ type: 'array',
1523
+ },
1524
+ is_valid: { type: 'boolean' },
1525
+ joiner_acs_credential_ids: {
1526
+ items: { format: 'uuid', type: 'string' },
1527
+ type: 'array',
1528
+ },
1529
+ },
1530
+ required: ['card_function_type'],
1531
+ type: 'object',
1532
+ },
1533
+ warnings: {
1534
+ items: {
1535
+ properties: {
1536
+ message: { type: 'string' },
1537
+ warning_code: { type: 'string' },
1538
+ },
1539
+ required: ['warning_code', 'message'],
1540
+ type: 'object',
1541
+ },
1542
+ type: 'array',
1543
+ },
1544
+ workspace_id: { format: 'uuid', type: 'string' },
1545
+ },
1546
+ required: [
1547
+ 'acs_credential_id',
1548
+ 'acs_system_id',
1549
+ 'display_name',
1550
+ 'access_method',
1551
+ 'created_at',
1552
+ 'workspace_id',
1553
+ 'errors',
1554
+ 'warnings',
1555
+ 'is_managed',
1556
+ ],
1557
+ type: 'object',
1558
+ },
1559
+ ],
1258
1560
  },
1259
1561
  },
1260
- required: ['card_number'],
1562
+ required: [
1563
+ 'acs_credential_on_encoder',
1564
+ 'acs_credential_on_seam',
1565
+ ],
1261
1566
  type: 'object',
1262
1567
  },
1263
1568
  status: { enum: ['success'], type: 'string' },
@@ -1280,7 +1585,7 @@ export default {
1280
1585
  type: 'string',
1281
1586
  'x-title': 'Action Attempt ID',
1282
1587
  },
1283
- action_type: { enum: ['READ_CARD'], type: 'string' },
1588
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1284
1589
  error: {
1285
1590
  properties: {
1286
1591
  message: { type: 'string' },
@@ -1335,25 +1640,7 @@ export default {
1335
1640
  },
1336
1641
  action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1337
1642
  error: { nullable: true },
1338
- result: {
1339
- properties: {
1340
- acs_credential_id: {
1341
- description:
1342
- 'Matching acs_credential currently encoded on this card.',
1343
- format: 'uuid',
1344
- nullable: true,
1345
- type: 'string',
1346
- },
1347
- card_number: {
1348
- description:
1349
- 'A number or string that physically identifies this card.',
1350
- nullable: true,
1351
- type: 'string',
1352
- },
1353
- },
1354
- required: ['acs_credential_id', 'card_number'],
1355
- type: 'object',
1356
- },
1643
+ result: { properties: {}, type: 'object' },
1357
1644
  status: { enum: ['success'], type: 'string' },
1358
1645
  },
1359
1646
  required: [
@@ -1977,10 +2264,16 @@ export default {
1977
2264
  },
1978
2265
  action_type: { enum: ['SYNC_ACCESS_CODES'], type: 'string' },
1979
2266
  error: { nullable: true },
1980
- result: {},
2267
+ result: { properties: {}, type: 'object' },
1981
2268
  status: { enum: ['success'], type: 'string' },
1982
2269
  },
1983
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2270
+ required: [
2271
+ 'action_attempt_id',
2272
+ 'status',
2273
+ 'error',
2274
+ 'action_type',
2275
+ 'result',
2276
+ ],
1984
2277
  type: 'object',
1985
2278
  },
1986
2279
  {
@@ -2044,10 +2337,16 @@ export default {
2044
2337
  },
2045
2338
  action_type: { enum: ['CREATE_ACCESS_CODE'], type: 'string' },
2046
2339
  error: { nullable: true },
2047
- result: {},
2340
+ result: { properties: { access_code: {} }, type: 'object' },
2048
2341
  status: { enum: ['success'], type: 'string' },
2049
2342
  },
2050
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2343
+ required: [
2344
+ 'action_attempt_id',
2345
+ 'status',
2346
+ 'error',
2347
+ 'action_type',
2348
+ 'result',
2349
+ ],
2051
2350
  type: 'object',
2052
2351
  },
2053
2352
  {
@@ -2111,10 +2410,16 @@ export default {
2111
2410
  },
2112
2411
  action_type: { enum: ['DELETE_ACCESS_CODE'], type: 'string' },
2113
2412
  error: { nullable: true },
2114
- result: {},
2413
+ result: { properties: {}, type: 'object' },
2115
2414
  status: { enum: ['success'], type: 'string' },
2116
2415
  },
2117
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2416
+ required: [
2417
+ 'action_attempt_id',
2418
+ 'status',
2419
+ 'error',
2420
+ 'action_type',
2421
+ 'result',
2422
+ ],
2118
2423
  type: 'object',
2119
2424
  },
2120
2425
  {
@@ -2178,10 +2483,16 @@ export default {
2178
2483
  },
2179
2484
  action_type: { enum: ['UPDATE_ACCESS_CODE'], type: 'string' },
2180
2485
  error: { nullable: true },
2181
- result: {},
2486
+ result: { properties: { access_code: {} }, type: 'object' },
2182
2487
  status: { enum: ['success'], type: 'string' },
2183
2488
  },
2184
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2489
+ required: [
2490
+ 'action_attempt_id',
2491
+ 'status',
2492
+ 'error',
2493
+ 'action_type',
2494
+ 'result',
2495
+ ],
2185
2496
  type: 'object',
2186
2497
  },
2187
2498
  {
@@ -2245,10 +2556,16 @@ export default {
2245
2556
  },
2246
2557
  action_type: { enum: ['CREATE_NOISE_THRESHOLD'], type: 'string' },
2247
2558
  error: { nullable: true },
2248
- result: {},
2559
+ result: { properties: { noise_threshold: {} }, type: 'object' },
2249
2560
  status: { enum: ['success'], type: 'string' },
2250
2561
  },
2251
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2562
+ required: [
2563
+ 'action_attempt_id',
2564
+ 'status',
2565
+ 'error',
2566
+ 'action_type',
2567
+ 'result',
2568
+ ],
2252
2569
  type: 'object',
2253
2570
  },
2254
2571
  {
@@ -2312,10 +2629,16 @@ export default {
2312
2629
  },
2313
2630
  action_type: { enum: ['DELETE_NOISE_THRESHOLD'], type: 'string' },
2314
2631
  error: { nullable: true },
2315
- result: {},
2632
+ result: { properties: {}, type: 'object' },
2316
2633
  status: { enum: ['success'], type: 'string' },
2317
2634
  },
2318
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2635
+ required: [
2636
+ 'action_attempt_id',
2637
+ 'status',
2638
+ 'error',
2639
+ 'action_type',
2640
+ 'result',
2641
+ ],
2319
2642
  type: 'object',
2320
2643
  },
2321
2644
  {
@@ -2379,10 +2702,16 @@ export default {
2379
2702
  },
2380
2703
  action_type: { enum: ['UPDATE_NOISE_THRESHOLD'], type: 'string' },
2381
2704
  error: { nullable: true },
2382
- result: {},
2705
+ result: { properties: { noise_threshold: {} }, type: 'object' },
2383
2706
  status: { enum: ['success'], type: 'string' },
2384
2707
  },
2385
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2708
+ required: [
2709
+ 'action_attempt_id',
2710
+ 'status',
2711
+ 'error',
2712
+ 'action_type',
2713
+ 'result',
2714
+ ],
2386
2715
  type: 'object',
2387
2716
  },
2388
2717
  {
@@ -7773,9 +8102,9 @@ export default {
7773
8102
  'x-undocumented': 'Encoders are in alpha.',
7774
8103
  },
7775
8104
  },
7776
- '/acs/encoders/read_card': {
8105
+ '/acs/encoders/scan_card': {
7777
8106
  post: {
7778
- operationId: 'acsEncodersReadCardPost',
8107
+ operationId: 'acsEncodersScanCardPost',
7779
8108
  requestBody: {
7780
8109
  content: {
7781
8110
  'application/json': {
@@ -7828,10 +8157,10 @@ export default {
7828
8157
  { console_session: [] },
7829
8158
  { api_key: [] },
7830
8159
  ],
7831
- summary: '/acs/encoders/read_card',
8160
+ summary: '/acs/encoders/scan_card',
7832
8161
  tags: ['/acs'],
7833
8162
  'x-fern-sdk-group-name': ['acs', 'encoders'],
7834
- 'x-fern-sdk-method-name': 'read_card',
8163
+ 'x-fern-sdk-method-name': 'scan_card',
7835
8164
  'x-fern-sdk-return-value': 'action_attempt',
7836
8165
  'x-response-key': 'action_attempt',
7837
8166
  'x-undocumented': 'Reading a card is currently unimplemented.',