@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
@@ -1146,7 +1146,7 @@ export default {
1146
1146
  type: 'string',
1147
1147
  'x-title': 'Action Attempt ID',
1148
1148
  },
1149
- action_type: { enum: ['READ_CARD'], type: 'string' },
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: ['READ_CARD'], type: 'string' },
1172
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1173
1173
  error: { nullable: true },
1174
1174
  result: {
1175
1175
  properties: {
1176
- card_number: {
1177
- description: 'A number or string that physically identifies this card.',
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
- type: 'string',
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: ['card_number'],
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: ['READ_CARD'], type: 'string' },
1505
+ action_type: { enum: ['SCAN_CARD'], type: 'string' },
1206
1506
  error: {
1207
1507
  properties: {
1208
1508
  message: { type: 'string' },
@@ -1257,23 +1557,7 @@ export default {
1257
1557
  },
1258
1558
  action_type: { enum: ['ENCODE_CARD'], type: 'string' },
1259
1559
  error: { nullable: true },
1260
- result: {
1261
- properties: {
1262
- acs_credential_id: {
1263
- description: 'Matching acs_credential currently encoded on this card.',
1264
- format: 'uuid',
1265
- nullable: true,
1266
- type: 'string',
1267
- },
1268
- card_number: {
1269
- description: 'A number or string that physically identifies this card.',
1270
- nullable: true,
1271
- type: 'string',
1272
- },
1273
- },
1274
- required: ['acs_credential_id', 'card_number'],
1275
- type: 'object',
1276
- },
1560
+ result: { properties: {}, type: 'object' },
1277
1561
  status: { enum: ['success'], type: 'string' },
1278
1562
  },
1279
1563
  required: [
@@ -1897,10 +2181,16 @@ export default {
1897
2181
  },
1898
2182
  action_type: { enum: ['SYNC_ACCESS_CODES'], type: 'string' },
1899
2183
  error: { nullable: true },
1900
- result: {},
2184
+ result: { properties: {}, type: 'object' },
1901
2185
  status: { enum: ['success'], type: 'string' },
1902
2186
  },
1903
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2187
+ required: [
2188
+ 'action_attempt_id',
2189
+ 'status',
2190
+ 'error',
2191
+ 'action_type',
2192
+ 'result',
2193
+ ],
1904
2194
  type: 'object',
1905
2195
  },
1906
2196
  {
@@ -1964,10 +2254,16 @@ export default {
1964
2254
  },
1965
2255
  action_type: { enum: ['CREATE_ACCESS_CODE'], type: 'string' },
1966
2256
  error: { nullable: true },
1967
- result: {},
2257
+ result: { properties: { access_code: {} }, type: 'object' },
1968
2258
  status: { enum: ['success'], type: 'string' },
1969
2259
  },
1970
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2260
+ required: [
2261
+ 'action_attempt_id',
2262
+ 'status',
2263
+ 'error',
2264
+ 'action_type',
2265
+ 'result',
2266
+ ],
1971
2267
  type: 'object',
1972
2268
  },
1973
2269
  {
@@ -2031,10 +2327,16 @@ export default {
2031
2327
  },
2032
2328
  action_type: { enum: ['DELETE_ACCESS_CODE'], type: 'string' },
2033
2329
  error: { nullable: true },
2034
- result: {},
2330
+ result: { properties: {}, type: 'object' },
2035
2331
  status: { enum: ['success'], type: 'string' },
2036
2332
  },
2037
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2333
+ required: [
2334
+ 'action_attempt_id',
2335
+ 'status',
2336
+ 'error',
2337
+ 'action_type',
2338
+ 'result',
2339
+ ],
2038
2340
  type: 'object',
2039
2341
  },
2040
2342
  {
@@ -2098,10 +2400,16 @@ export default {
2098
2400
  },
2099
2401
  action_type: { enum: ['UPDATE_ACCESS_CODE'], type: 'string' },
2100
2402
  error: { nullable: true },
2101
- result: {},
2403
+ result: { properties: { access_code: {} }, type: 'object' },
2102
2404
  status: { enum: ['success'], type: 'string' },
2103
2405
  },
2104
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2406
+ required: [
2407
+ 'action_attempt_id',
2408
+ 'status',
2409
+ 'error',
2410
+ 'action_type',
2411
+ 'result',
2412
+ ],
2105
2413
  type: 'object',
2106
2414
  },
2107
2415
  {
@@ -2165,10 +2473,16 @@ export default {
2165
2473
  },
2166
2474
  action_type: { enum: ['CREATE_NOISE_THRESHOLD'], type: 'string' },
2167
2475
  error: { nullable: true },
2168
- result: {},
2476
+ result: { properties: { noise_threshold: {} }, type: 'object' },
2169
2477
  status: { enum: ['success'], type: 'string' },
2170
2478
  },
2171
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2479
+ required: [
2480
+ 'action_attempt_id',
2481
+ 'status',
2482
+ 'error',
2483
+ 'action_type',
2484
+ 'result',
2485
+ ],
2172
2486
  type: 'object',
2173
2487
  },
2174
2488
  {
@@ -2232,10 +2546,16 @@ export default {
2232
2546
  },
2233
2547
  action_type: { enum: ['DELETE_NOISE_THRESHOLD'], type: 'string' },
2234
2548
  error: { nullable: true },
2235
- result: {},
2549
+ result: { properties: {}, type: 'object' },
2236
2550
  status: { enum: ['success'], type: 'string' },
2237
2551
  },
2238
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2552
+ required: [
2553
+ 'action_attempt_id',
2554
+ 'status',
2555
+ 'error',
2556
+ 'action_type',
2557
+ 'result',
2558
+ ],
2239
2559
  type: 'object',
2240
2560
  },
2241
2561
  {
@@ -2299,10 +2619,16 @@ export default {
2299
2619
  },
2300
2620
  action_type: { enum: ['UPDATE_NOISE_THRESHOLD'], type: 'string' },
2301
2621
  error: { nullable: true },
2302
- result: {},
2622
+ result: { properties: { noise_threshold: {} }, type: 'object' },
2303
2623
  status: { enum: ['success'], type: 'string' },
2304
2624
  },
2305
- required: ['action_attempt_id', 'status', 'error', 'action_type'],
2625
+ required: [
2626
+ 'action_attempt_id',
2627
+ 'status',
2628
+ 'error',
2629
+ 'action_type',
2630
+ 'result',
2631
+ ],
2306
2632
  type: 'object',
2307
2633
  },
2308
2634
  {
@@ -7629,9 +7955,9 @@ export default {
7629
7955
  'x-undocumented': 'Encoders are in alpha.',
7630
7956
  },
7631
7957
  },
7632
- '/acs/encoders/read_card': {
7958
+ '/acs/encoders/scan_card': {
7633
7959
  post: {
7634
- operationId: 'acsEncodersReadCardPost',
7960
+ operationId: 'acsEncodersScanCardPost',
7635
7961
  requestBody: {
7636
7962
  content: {
7637
7963
  'application/json': {
@@ -7684,10 +8010,10 @@ export default {
7684
8010
  { console_session: [] },
7685
8011
  { api_key: [] },
7686
8012
  ],
7687
- summary: '/acs/encoders/read_card',
8013
+ summary: '/acs/encoders/scan_card',
7688
8014
  tags: ['/acs'],
7689
8015
  'x-fern-sdk-group-name': ['acs', 'encoders'],
7690
- 'x-fern-sdk-method-name': 'read_card',
8016
+ 'x-fern-sdk-method-name': 'scan_card',
7691
8017
  'x-fern-sdk-return-value': 'action_attempt',
7692
8018
  'x-response-key': 'action_attempt',
7693
8019
  'x-undocumented': 'Reading a card is currently unimplemented.',