@seamapi/types 1.185.0 → 1.187.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.
Files changed (50) hide show
  1. package/dist/connect.cjs +365 -30
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +726 -86
  4. package/lib/seam/connect/model-types.d.ts +1 -1
  5. package/lib/seam/connect/models/acs/acs-credential.d.ts +0 -17
  6. package/lib/seam/connect/models/acs/acs-credential.js +1 -6
  7. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.d.ts +36 -53
  9. package/lib/seam/connect/models/acs/acs-entrance.js +5 -31
  10. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  11. package/lib/seam/connect/models/acs/acs-system.d.ts +87 -24
  12. package/lib/seam/connect/models/acs/acs-system.js +33 -18
  13. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  14. package/lib/seam/connect/models/acs/index.d.ts +1 -0
  15. package/lib/seam/connect/models/acs/index.js +1 -0
  16. package/lib/seam/connect/models/acs/index.js.map +1 -1
  17. package/lib/seam/connect/models/acs/metadata/index.d.ts +2 -0
  18. package/lib/seam/connect/models/acs/metadata/index.js +3 -0
  19. package/lib/seam/connect/models/acs/metadata/index.js.map +1 -0
  20. package/lib/seam/connect/models/acs/metadata/latch.d.ts +18 -0
  21. package/lib/seam/connect/models/acs/metadata/latch.js +8 -0
  22. package/lib/seam/connect/models/acs/metadata/latch.js.map +1 -0
  23. package/lib/seam/connect/models/acs/metadata/visionline.d.ts +47 -0
  24. package/lib/seam/connect/models/acs/metadata/visionline.js +24 -0
  25. package/lib/seam/connect/models/acs/metadata/visionline.js.map +1 -0
  26. package/lib/seam/connect/models/devices/managed-device.d.ts +12 -0
  27. package/lib/seam/connect/models/devices/managed-device.js +2 -0
  28. package/lib/seam/connect/models/devices/managed-device.js.map +1 -1
  29. package/lib/seam/connect/models/devices/phone.d.ts +6 -0
  30. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +6 -0
  31. package/lib/seam/connect/openapi.d.ts +160 -20
  32. package/lib/seam/connect/openapi.js +137 -21
  33. package/lib/seam/connect/openapi.js.map +1 -1
  34. package/lib/seam/connect/route-types.d.ts +122 -64
  35. package/lib/seam/connect/schemas.d.ts +1 -1
  36. package/lib/seam/connect/schemas.js +1 -1
  37. package/lib/seam/connect/schemas.js.map +1 -1
  38. package/package.json +1 -1
  39. package/src/lib/seam/connect/model-types.ts +5 -0
  40. package/src/lib/seam/connect/models/acs/acs-credential.ts +2 -11
  41. package/src/lib/seam/connect/models/acs/acs-entrance.ts +8 -37
  42. package/src/lib/seam/connect/models/acs/acs-system.ts +45 -23
  43. package/src/lib/seam/connect/models/acs/index.ts +1 -0
  44. package/src/lib/seam/connect/models/acs/metadata/index.ts +2 -0
  45. package/src/lib/seam/connect/models/acs/metadata/latch.ts +12 -0
  46. package/src/lib/seam/connect/models/acs/metadata/visionline.ts +35 -0
  47. package/src/lib/seam/connect/models/devices/managed-device.ts +2 -0
  48. package/src/lib/seam/connect/openapi.ts +137 -21
  49. package/src/lib/seam/connect/route-types.ts +226 -124
  50. package/src/lib/seam/connect/schemas.ts +5 -0
@@ -0,0 +1,12 @@
1
+ import { z } from 'zod'
2
+
3
+ export const acs_entrance_latch_metadata = z.object({
4
+ accessibility_type: z.string(),
5
+ door_name: z.string(),
6
+ door_type: z.string(),
7
+ is_connected: z.boolean(),
8
+ })
9
+
10
+ export type AcsEntranceLatchMetadata = z.infer<
11
+ typeof acs_entrance_latch_metadata
12
+ >
@@ -0,0 +1,35 @@
1
+ import { z } from 'zod'
2
+
3
+ export const acs_entrance_visionline_metadata = z.object({
4
+ door_name: z.string(),
5
+ door_category: z.enum([
6
+ 'entrance',
7
+ 'guest',
8
+ 'elevator reader',
9
+ 'common',
10
+ 'common (PMS)',
11
+ ]),
12
+ profiles: z
13
+ .array(
14
+ z.object({
15
+ visionline_door_profile_id: z.string(),
16
+ visionline_door_profile_type: z.enum(['BLE', 'commonDoor', 'touch']),
17
+ }),
18
+ )
19
+ .optional(),
20
+ })
21
+
22
+ export const acs_credential_visionline_metadata = z.object({
23
+ card_function_type: z.enum(['guest', 'staff']),
24
+ joiner_acs_credential_ids: z.array(z.string().uuid()).optional(),
25
+ guest_acs_entrance_ids: z.array(z.string().uuid()).optional(),
26
+ common_acs_entrance_ids: z.array(z.string().uuid()).optional(),
27
+ })
28
+
29
+ export type AcsCredentialVisionlineMetadata = z.infer<
30
+ typeof acs_credential_visionline_metadata
31
+ >
32
+
33
+ export type AcsEntranceVisionlineMetadata = z.infer<
34
+ typeof acs_entrance_visionline_metadata
35
+ >
@@ -12,6 +12,8 @@ import { phone_specific_properties } from './phone-properties.js'
12
12
  export const device_capability_flags =
13
13
  devicedb_schemas.device_capability_flags.extend({
14
14
  can_simulate_removal: z.boolean().optional(),
15
+ can_simulate_connection: z.boolean().optional(),
16
+ can_simulate_disconnection: z.boolean().optional(),
15
17
  })
16
18
 
17
19
  export const battery_status = z.enum(['critical', 'low', 'good', 'full'])
@@ -332,7 +332,6 @@ export default {
332
332
  type: 'array',
333
333
  },
334
334
  latch_metadata: {
335
- nullable: true,
336
335
  properties: {
337
336
  accessibility_type: { type: 'string' },
338
337
  door_name: { type: 'string' },
@@ -348,7 +347,6 @@ export default {
348
347
  type: 'object',
349
348
  },
350
349
  visionline_metadata: {
351
- nullable: true,
352
350
  properties: {
353
351
  door_category: {
354
352
  enum: [
@@ -384,13 +382,11 @@ export default {
384
382
  },
385
383
  },
386
384
  required: [
387
- 'acs_entrance_id',
388
- 'display_name',
389
385
  'acs_system_id',
386
+ 'acs_entrance_id',
390
387
  'created_at',
391
- 'latch_metadata',
388
+ 'display_name',
392
389
  'errors',
393
- 'visionline_metadata',
394
390
  ],
395
391
  type: 'object',
396
392
  },
@@ -401,16 +397,39 @@ export default {
401
397
  can_automate_enrollment: { type: 'boolean' },
402
398
  can_create_acs_access_groups: { type: 'boolean' },
403
399
  can_remove_acs_users_from_acs_access_groups: { type: 'boolean' },
404
- connected_account_ids: { items: { type: 'string' }, type: 'array' },
400
+ connected_account_ids: {
401
+ items: { format: 'uuid', type: 'string' },
402
+ type: 'array',
403
+ },
405
404
  created_at: { format: 'date-time', type: 'string' },
406
405
  errors: {
407
406
  items: {
408
- properties: {
409
- error_code: { type: 'string' },
410
- message: { type: 'string' },
411
- },
412
- required: ['error_code', 'message'],
413
- type: 'object',
407
+ oneOf: [
408
+ {
409
+ properties: {
410
+ created_at: { format: 'date-time', type: 'string' },
411
+ error_code: {
412
+ enum: ['seam_bridge_disconnected'],
413
+ type: 'string',
414
+ },
415
+ message: { type: 'string' },
416
+ },
417
+ required: ['created_at', 'message', 'error_code'],
418
+ type: 'object',
419
+ },
420
+ {
421
+ properties: {
422
+ created_at: { format: 'date-time', type: 'string' },
423
+ error_code: {
424
+ enum: ['visionline_instance_unreachable'],
425
+ type: 'string',
426
+ },
427
+ message: { type: 'string' },
428
+ },
429
+ required: ['created_at', 'message', 'error_code'],
430
+ type: 'object',
431
+ },
432
+ ],
414
433
  },
415
434
  type: 'array',
416
435
  },
@@ -452,14 +471,7 @@ export default {
452
471
  type: 'string',
453
472
  },
454
473
  warnings: {
455
- items: {
456
- properties: {
457
- message: { type: 'string' },
458
- warning_code: { type: 'string' },
459
- },
460
- required: ['warning_code', 'message'],
461
- type: 'object',
462
- },
474
+ items: { properties: {}, type: 'object' },
463
475
  type: 'array',
464
476
  },
465
477
  workspace_id: { format: 'uuid', type: 'string' },
@@ -1806,6 +1818,8 @@ export default {
1806
1818
  can_program_online_access_codes: { type: 'boolean' },
1807
1819
  can_remotely_lock: { type: 'boolean' },
1808
1820
  can_remotely_unlock: { type: 'boolean' },
1821
+ can_simulate_connection: { type: 'boolean' },
1822
+ can_simulate_disconnection: { type: 'boolean' },
1809
1823
  can_simulate_removal: { type: 'boolean' },
1810
1824
  capabilities_supported: {
1811
1825
  description:
@@ -3231,6 +3245,8 @@ export default {
3231
3245
  can_program_online_access_codes: { type: 'boolean' },
3232
3246
  can_remotely_lock: { type: 'boolean' },
3233
3247
  can_remotely_unlock: { type: 'boolean' },
3248
+ can_simulate_connection: { type: 'boolean' },
3249
+ can_simulate_disconnection: { type: 'boolean' },
3234
3250
  can_simulate_removal: { type: 'boolean' },
3235
3251
  capabilities_supported: {
3236
3252
  description:
@@ -3458,6 +3474,8 @@ export default {
3458
3474
  can_program_online_access_codes: { type: 'boolean' },
3459
3475
  can_remotely_lock: { type: 'boolean' },
3460
3476
  can_remotely_unlock: { type: 'boolean' },
3477
+ can_simulate_connection: { type: 'boolean' },
3478
+ can_simulate_disconnection: { type: 'boolean' },
3461
3479
  can_simulate_removal: { type: 'boolean' },
3462
3480
  capabilities_supported: {
3463
3481
  description:
@@ -8300,6 +8318,8 @@ export default {
8300
8318
  'can_program_offline_access_codes',
8301
8319
  'can_program_online_access_codes',
8302
8320
  'can_simulate_removal',
8321
+ 'can_simulate_connection',
8322
+ 'can_simulate_disconnection',
8303
8323
  ],
8304
8324
  type: 'string',
8305
8325
  },
@@ -8313,6 +8333,8 @@ export default {
8313
8333
  'can_program_offline_access_codes',
8314
8334
  'can_program_online_access_codes',
8315
8335
  'can_simulate_removal',
8336
+ 'can_simulate_connection',
8337
+ 'can_simulate_disconnection',
8316
8338
  ],
8317
8339
  type: 'string',
8318
8340
  },
@@ -8459,6 +8481,88 @@ export default {
8459
8481
  'x-fern-sdk-return-value': 'device_providers',
8460
8482
  },
8461
8483
  },
8484
+ '/devices/simulate/connect': {
8485
+ post: {
8486
+ operationId: 'devicesSimulateConnectPost',
8487
+ requestBody: {
8488
+ content: {
8489
+ 'application/json': {
8490
+ schema: {
8491
+ properties: { device_id: { format: 'uuid', type: 'string' } },
8492
+ required: ['device_id'],
8493
+ type: 'object',
8494
+ },
8495
+ },
8496
+ },
8497
+ },
8498
+ responses: {
8499
+ 200: {
8500
+ content: {
8501
+ 'application/json': {
8502
+ schema: {
8503
+ properties: { ok: { type: 'boolean' } },
8504
+ required: ['ok'],
8505
+ type: 'object',
8506
+ },
8507
+ },
8508
+ },
8509
+ description: 'OK',
8510
+ },
8511
+ 400: { description: 'Bad Request' },
8512
+ 401: { description: 'Unauthorized' },
8513
+ },
8514
+ security: [
8515
+ { api_key: [] },
8516
+ { pat_with_workspace: [] },
8517
+ { console_session: [] },
8518
+ ],
8519
+ summary: '/devices/simulate/connect',
8520
+ tags: ['/devices'],
8521
+ 'x-fern-sdk-group-name': ['devices', 'simulate'],
8522
+ 'x-fern-sdk-method-name': 'connect',
8523
+ },
8524
+ },
8525
+ '/devices/simulate/disconnect': {
8526
+ post: {
8527
+ operationId: 'devicesSimulateDisconnectPost',
8528
+ requestBody: {
8529
+ content: {
8530
+ 'application/json': {
8531
+ schema: {
8532
+ properties: { device_id: { format: 'uuid', type: 'string' } },
8533
+ required: ['device_id'],
8534
+ type: 'object',
8535
+ },
8536
+ },
8537
+ },
8538
+ },
8539
+ responses: {
8540
+ 200: {
8541
+ content: {
8542
+ 'application/json': {
8543
+ schema: {
8544
+ properties: { ok: { type: 'boolean' } },
8545
+ required: ['ok'],
8546
+ type: 'object',
8547
+ },
8548
+ },
8549
+ },
8550
+ description: 'OK',
8551
+ },
8552
+ 400: { description: 'Bad Request' },
8553
+ 401: { description: 'Unauthorized' },
8554
+ },
8555
+ security: [
8556
+ { api_key: [] },
8557
+ { pat_with_workspace: [] },
8558
+ { console_session: [] },
8559
+ ],
8560
+ summary: '/devices/simulate/disconnect',
8561
+ tags: ['/devices'],
8562
+ 'x-fern-sdk-group-name': ['devices', 'simulate'],
8563
+ 'x-fern-sdk-method-name': 'disconnect',
8564
+ },
8565
+ },
8462
8566
  '/devices/simulate/remove': {
8463
8567
  post: {
8464
8568
  operationId: 'devicesSimulateRemovePost',
@@ -8692,6 +8796,8 @@ export default {
8692
8796
  'can_program_offline_access_codes',
8693
8797
  'can_program_online_access_codes',
8694
8798
  'can_simulate_removal',
8799
+ 'can_simulate_connection',
8800
+ 'can_simulate_disconnection',
8695
8801
  ],
8696
8802
  type: 'string',
8697
8803
  },
@@ -8705,6 +8811,8 @@ export default {
8705
8811
  'can_program_offline_access_codes',
8706
8812
  'can_program_online_access_codes',
8707
8813
  'can_simulate_removal',
8814
+ 'can_simulate_connection',
8815
+ 'can_simulate_disconnection',
8708
8816
  ],
8709
8817
  type: 'string',
8710
8818
  },
@@ -9438,6 +9546,8 @@ export default {
9438
9546
  'can_program_offline_access_codes',
9439
9547
  'can_program_online_access_codes',
9440
9548
  'can_simulate_removal',
9549
+ 'can_simulate_connection',
9550
+ 'can_simulate_disconnection',
9441
9551
  ],
9442
9552
  type: 'string',
9443
9553
  },
@@ -9451,6 +9561,8 @@ export default {
9451
9561
  'can_program_offline_access_codes',
9452
9562
  'can_program_online_access_codes',
9453
9563
  'can_simulate_removal',
9564
+ 'can_simulate_connection',
9565
+ 'can_simulate_disconnection',
9454
9566
  ],
9455
9567
  type: 'string',
9456
9568
  },
@@ -11142,6 +11254,8 @@ export default {
11142
11254
  'can_program_offline_access_codes',
11143
11255
  'can_program_online_access_codes',
11144
11256
  'can_simulate_removal',
11257
+ 'can_simulate_connection',
11258
+ 'can_simulate_disconnection',
11145
11259
  ],
11146
11260
  type: 'string',
11147
11261
  },
@@ -11155,6 +11269,8 @@ export default {
11155
11269
  'can_program_offline_access_codes',
11156
11270
  'can_program_online_access_codes',
11157
11271
  'can_simulate_removal',
11272
+ 'can_simulate_connection',
11273
+ 'can_simulate_disconnection',
11158
11274
  ],
11159
11275
  type: 'string',
11160
11276
  },