@seamapi/types 1.777.0 → 1.779.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.
@@ -30857,6 +30857,8 @@ export type Routes = {
30857
30857
  name: string;
30858
30858
  /** Your unique identifier for the space. */
30859
30859
  space_key: string;
30860
+ /** Your unique identifier for the site. */
30861
+ parent_site_key?: string | undefined;
30860
30862
  }[] | undefined;
30861
30863
  /** List of general sites or areas. */
30862
30864
  sites?: {
@@ -31225,6 +31227,8 @@ export type Routes = {
31225
31227
  name: string;
31226
31228
  /** Your unique identifier for the space. */
31227
31229
  space_key: string;
31230
+ /** Your unique identifier for the site. */
31231
+ parent_site_key?: string | undefined;
31228
31232
  }[] | undefined;
31229
31233
  /** List of general sites or areas. */
31230
31234
  sites?: {
@@ -86416,6 +86420,8 @@ export type Routes = {
86416
86420
  name: string;
86417
86421
  /** Your unique identifier for the space. */
86418
86422
  space_key: string;
86423
+ /** Your unique identifier for the site. */
86424
+ parent_site_key?: string | undefined;
86419
86425
  }[] | undefined;
86420
86426
  };
86421
86427
  formData: {};
@@ -86485,6 +86491,8 @@ export type Routes = {
86485
86491
  name: string;
86486
86492
  /** Your unique identifier for the space. */
86487
86493
  space_key: string;
86494
+ /** Your unique identifier for the site. */
86495
+ parent_site_key?: string | undefined;
86488
86496
  }[] | undefined;
86489
86497
  };
86490
86498
  formData: {};
@@ -89576,6 +89584,151 @@ export type Routes = {
89576
89584
  };
89577
89585
  maxDuration: undefined;
89578
89586
  };
89587
+ '/user_identities/list_accessible_entrances': {
89588
+ route: '/user_identities/list_accessible_entrances';
89589
+ method: 'GET' | 'POST';
89590
+ queryParams: {};
89591
+ jsonBody: {};
89592
+ commonParams: {
89593
+ /** ID of the user identity for which you want to retrieve all accessible entrances. */
89594
+ user_identity_id: string;
89595
+ };
89596
+ formData: {};
89597
+ jsonResponse: {
89598
+ acs_entrances: {
89599
+ /** 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). */
89600
+ acs_system_id: string;
89601
+ /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89602
+ acs_entrance_id: string;
89603
+ /** IDs of the spaces that the entrance is in. */
89604
+ space_ids: string[];
89605
+ /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
89606
+ created_at: string;
89607
+ /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89608
+ display_name: string;
89609
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89610
+ connected_account_id: string;
89611
+ /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89612
+ errors: {
89613
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
89614
+ error_code: string;
89615
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
89616
+ message: string;
89617
+ }[];
89618
+ /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89619
+ latch_metadata?: {
89620
+ /** Accessibility type in the Latch access system. */
89621
+ accessibility_type: string;
89622
+ /** Name of the door in the Latch access system. */
89623
+ door_name: string;
89624
+ /** Type of the door in the Latch access system. */
89625
+ door_type: string;
89626
+ /** Indicates whether the entrance is connected. */
89627
+ is_connected: boolean;
89628
+ } | undefined;
89629
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89630
+ hotek_metadata?: {
89631
+ /** Room number of the entrance. */
89632
+ room_number?: string | undefined;
89633
+ /** Display name of the entrance. */
89634
+ common_area_number?: string | undefined;
89635
+ /** Display name of the entrance. */
89636
+ common_area_name?: string | undefined;
89637
+ } | undefined;
89638
+ /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89639
+ visionline_metadata?: {
89640
+ /** Name of the door in the Visionline access system. */
89641
+ door_name: string;
89642
+ /** Category of the door in the Visionline access system. */
89643
+ door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
89644
+ /** Profile for the door in the Visionline access system. */
89645
+ profiles?: {
89646
+ /** Door profile ID in the Visionline access system. */
89647
+ visionline_door_profile_id: string;
89648
+ /** Door profile type in the Visionline access system. */
89649
+ visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
89650
+ }[] | undefined;
89651
+ } | undefined;
89652
+ /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89653
+ salto_ks_metadata?: {
89654
+ /** Name of the door in the Salto KS access system. */
89655
+ door_name: string;
89656
+ /** Locked state of the door in the Salto KS access system. */
89657
+ locked_state: string;
89658
+ /** Type of the lock in the Salto KS access system. */
89659
+ lock_type: string;
89660
+ /** Indicates whether the door access device is online. */
89661
+ online?: boolean | undefined;
89662
+ /** Battery level of the door access device. */
89663
+ battery_level: string;
89664
+ /** Indicates whether the door is left open. */
89665
+ left_open_alarm?: boolean | undefined;
89666
+ /** Indicates whether an intrusion alarm is active on the door. */
89667
+ intrusion_alarm?: boolean | undefined;
89668
+ /** Indicates whether privacy mode is enabled for the lock. */
89669
+ privacy_mode?: boolean | undefined;
89670
+ } | undefined;
89671
+ /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89672
+ dormakaba_community_metadata?: {
89673
+ /** Type of access point profile in the dormakaba Community access system. */
89674
+ access_point_profile: string;
89675
+ } | undefined;
89676
+ /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89677
+ assa_abloy_vostio_metadata?: {
89678
+ /** Type of the door in the Vostio access system. */
89679
+ door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
89680
+ /** Name of the door in the Vostio access system. */
89681
+ door_name: string;
89682
+ /** Number of the door in the Vostio access system. */
89683
+ door_number?: number | undefined;
89684
+ /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
89685
+ stand_open?: boolean | undefined;
89686
+ /** PMS ID of the door in the Vostio access system. */
89687
+ pms_id?: string | undefined;
89688
+ } | undefined;
89689
+ /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89690
+ salto_space_metadata?: {
89691
+ /** Door ID in the Salto Space access system. */
89692
+ door_id?: string | undefined;
89693
+ /** Name of the door in the Salto Space access system. */
89694
+ door_name?: string | undefined;
89695
+ /** Description of the door in the Salto Space access system. */
89696
+ door_description?: string | undefined;
89697
+ /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
89698
+ audit_on_keys?: boolean | undefined;
89699
+ /** Name of the room in the Salto Space access system. */
89700
+ room_name?: string | undefined;
89701
+ /** Description of the room in the Salto Space access system. */
89702
+ room_description?: string | undefined;
89703
+ } | undefined;
89704
+ /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89705
+ dormakaba_ambiance_metadata?: {
89706
+ /** Name of the access point in the dormakaba Ambiance access system. */
89707
+ access_point_name: string;
89708
+ } | undefined;
89709
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
89710
+ brivo_metadata?: {
89711
+ /** ID of the access point in the Brivo access system. */
89712
+ access_point_id: string;
89713
+ /** ID of the site that the access point belongs to. */
89714
+ site_id: number;
89715
+ /** Name of the site that the access point belongs to. */
89716
+ site_name: string;
89717
+ } | undefined;
89718
+ /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
89719
+ can_unlock_with_mobile_key?: boolean | undefined;
89720
+ /** Indicates whether the ACS entrance can be unlocked with card credentials. */
89721
+ can_unlock_with_card?: boolean | undefined;
89722
+ /** Indicates whether the ACS entrance can be unlocked with pin codes. */
89723
+ can_unlock_with_code?: boolean | undefined;
89724
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
89725
+ can_unlock_with_cloud_key?: boolean | undefined;
89726
+ /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
89727
+ can_belong_to_reservation?: boolean | undefined;
89728
+ }[];
89729
+ };
89730
+ maxDuration: undefined;
89731
+ };
89579
89732
  '/user_identities/list_acs_systems': {
89580
89733
  route: '/user_identities/list_acs_systems';
89581
89734
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.777.0",
3
+ "version": "1.779.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -26,15 +26,7 @@ import {
26
26
  user_resource,
27
27
  } from './user-identity-resources.js'
28
28
 
29
- export const customer_data = z.object({
30
- customer_key: z
31
- .string()
32
- .min(1)
33
- .refine((val) => val === val.trim(), {
34
- message: 'Must not have leading or trailing whitespace',
35
- })
36
- .describe('Your unique identifier for the customer.'),
37
-
29
+ export const external_resources = z.object({
38
30
  // Location resources
39
31
  spaces: z
40
32
  .array(neutral_resource)
@@ -106,6 +98,20 @@ export const customer_data = z.object({
106
98
  .describe('List of access grants.'),
107
99
  })
108
100
 
101
+ export type ExternalResources = z.infer<typeof external_resources>
102
+
103
+ export const customer_data = z
104
+ .object({
105
+ customer_key: z
106
+ .string()
107
+ .min(1)
108
+ .refine((val) => val === val.trim(), {
109
+ message: 'Must not have leading or trailing whitespace',
110
+ })
111
+ .describe('Your unique identifier for the customer.'),
112
+ })
113
+ .merge(external_resources)
114
+
109
115
  export type CustomerData = z.infer<typeof customer_data>
110
116
 
111
117
  // Re-export all resource types for convenience
@@ -16,6 +16,14 @@ export const neutral_resource = base_location_resource.extend({
16
16
  message: 'Must not have leading or trailing whitespace',
17
17
  })
18
18
  .describe('Your unique identifier for the space.'),
19
+ parent_site_key: z
20
+ .string()
21
+ .min(1)
22
+ .refine((val) => val === val.trim(), {
23
+ message: 'Must not have leading or trailing whitespace',
24
+ })
25
+ .describe('Your unique identifier for the site.')
26
+ .optional(),
19
27
  })
20
28
 
21
29
  export const property_resource = base_location_resource.extend({
@@ -50691,6 +50691,12 @@ export default {
50691
50691
  'Your display name for this location resource.',
50692
50692
  type: 'string',
50693
50693
  },
50694
+ parent_site_key: {
50695
+ description:
50696
+ 'Your unique identifier for the site.',
50697
+ minLength: 1,
50698
+ type: 'string',
50699
+ },
50694
50700
  space_key: {
50695
50701
  description:
50696
50702
  'Your unique identifier for the space.',
@@ -51928,6 +51934,11 @@ export default {
51928
51934
  'Your display name for this location resource.',
51929
51935
  type: 'string',
51930
51936
  },
51937
+ parent_site_key: {
51938
+ description: 'Your unique identifier for the site.',
51939
+ minLength: 1,
51940
+ type: 'string',
51941
+ },
51931
51942
  space_key: {
51932
51943
  description: 'Your unique identifier for the space.',
51933
51944
  minLength: 1,
@@ -76832,6 +76843,11 @@ export default {
76832
76843
  'Your display name for this location resource.',
76833
76844
  type: 'string',
76834
76845
  },
76846
+ parent_site_key: {
76847
+ description: 'Your unique identifier for the site.',
76848
+ minLength: 1,
76849
+ type: 'string',
76850
+ },
76835
76851
  space_key: {
76836
76852
  description: 'Your unique identifier for the space.',
76837
76853
  minLength: 1,
@@ -76913,6 +76929,11 @@ export default {
76913
76929
  'Your display name for this location resource.',
76914
76930
  type: 'string',
76915
76931
  },
76932
+ parent_site_key: {
76933
+ description: 'Your unique identifier for the site.',
76934
+ minLength: 1,
76935
+ type: 'string',
76936
+ },
76916
76937
  space_key: {
76917
76938
  description: 'Your unique identifier for the space.',
76918
76939
  minLength: 1,
@@ -77048,6 +77069,11 @@ export default {
77048
77069
  'Your display name for this location resource.',
77049
77070
  type: 'string',
77050
77071
  },
77072
+ parent_site_key: {
77073
+ description: 'Your unique identifier for the site.',
77074
+ minLength: 1,
77075
+ type: 'string',
77076
+ },
77051
77077
  space_key: {
77052
77078
  description: 'Your unique identifier for the space.',
77053
77079
  minLength: 1,
@@ -78421,6 +78447,119 @@ export default {
78421
78447
  'x-title': 'List Accessible Devices for a User Identity',
78422
78448
  },
78423
78449
  },
78450
+ '/user_identities/list_accessible_entrances': {
78451
+ get: {
78452
+ description:
78453
+ 'Returns a list of all [ACS entrances](https://docs.seam.co/latest/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.',
78454
+ operationId: 'userIdentitiesListAccessibleEntrancesGet',
78455
+ parameters: [
78456
+ {
78457
+ in: 'query',
78458
+ name: 'user_identity_id',
78459
+ required: true,
78460
+ schema: {
78461
+ description:
78462
+ 'ID of the user identity for which you want to retrieve all accessible entrances.',
78463
+ format: 'uuid',
78464
+ type: 'string',
78465
+ },
78466
+ },
78467
+ ],
78468
+ responses: {
78469
+ 200: {
78470
+ content: {
78471
+ 'application/json': {
78472
+ schema: {
78473
+ properties: {
78474
+ acs_entrances: {
78475
+ items: { $ref: '#/components/schemas/acs_entrance' },
78476
+ type: 'array',
78477
+ },
78478
+ ok: { type: 'boolean' },
78479
+ },
78480
+ required: ['acs_entrances', 'ok'],
78481
+ type: 'object',
78482
+ },
78483
+ },
78484
+ },
78485
+ description: 'OK',
78486
+ },
78487
+ 400: { description: 'Bad Request' },
78488
+ 401: { description: 'Unauthorized' },
78489
+ },
78490
+ security: [
78491
+ { client_session: [] },
78492
+ { pat_with_workspace: [] },
78493
+ { console_session_with_workspace: [] },
78494
+ { api_key: [] },
78495
+ ],
78496
+ summary: '/user_identities/list_accessible_entrances',
78497
+ tags: ['/user_identities'],
78498
+ 'x-fern-sdk-group-name': ['user_identities'],
78499
+ 'x-fern-sdk-method-name': 'list_accessible_entrances',
78500
+ 'x-fern-sdk-return-value': 'acs_entrances',
78501
+ 'x-response-key': 'acs_entrances',
78502
+ 'x-title': 'List Accessible Entrances for a User Identity',
78503
+ },
78504
+ post: {
78505
+ description:
78506
+ 'Returns a list of all [ACS entrances](https://docs.seam.co/latest/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.',
78507
+ operationId: 'userIdentitiesListAccessibleEntrancesPost',
78508
+ requestBody: {
78509
+ content: {
78510
+ 'application/json': {
78511
+ schema: {
78512
+ properties: {
78513
+ user_identity_id: {
78514
+ description:
78515
+ 'ID of the user identity for which you want to retrieve all accessible entrances.',
78516
+ format: 'uuid',
78517
+ type: 'string',
78518
+ },
78519
+ },
78520
+ required: ['user_identity_id'],
78521
+ type: 'object',
78522
+ },
78523
+ },
78524
+ },
78525
+ },
78526
+ responses: {
78527
+ 200: {
78528
+ content: {
78529
+ 'application/json': {
78530
+ schema: {
78531
+ properties: {
78532
+ acs_entrances: {
78533
+ items: { $ref: '#/components/schemas/acs_entrance' },
78534
+ type: 'array',
78535
+ },
78536
+ ok: { type: 'boolean' },
78537
+ },
78538
+ required: ['acs_entrances', 'ok'],
78539
+ type: 'object',
78540
+ },
78541
+ },
78542
+ },
78543
+ description: 'OK',
78544
+ },
78545
+ 400: { description: 'Bad Request' },
78546
+ 401: { description: 'Unauthorized' },
78547
+ },
78548
+ security: [
78549
+ { client_session: [] },
78550
+ { pat_with_workspace: [] },
78551
+ { console_session_with_workspace: [] },
78552
+ { api_key: [] },
78553
+ ],
78554
+ summary: '/user_identities/list_accessible_entrances',
78555
+ tags: ['/user_identities'],
78556
+ 'x-fern-sdk-group-name': ['user_identities'],
78557
+ 'x-fern-sdk-method-name': 'list_accessible_entrances',
78558
+ 'x-fern-sdk-return-value': 'acs_entrances',
78559
+ 'x-response-key': 'acs_entrances',
78560
+ 'x-title': 'List Accessible Entrances for a User Identity',
78561
+ },
78562
+ },
78424
78563
  '/user_identities/list_acs_systems': {
78425
78564
  get: {
78426
78565
  description:
@@ -35762,6 +35762,8 @@ export type Routes = {
35762
35762
  name: string
35763
35763
  /** Your unique identifier for the space. */
35764
35764
  space_key: string
35765
+ /** Your unique identifier for the site. */
35766
+ parent_site_key?: string | undefined
35765
35767
  }[]
35766
35768
  | undefined
35767
35769
  /** List of general sites or areas. */
@@ -36173,6 +36175,8 @@ export type Routes = {
36173
36175
  name: string
36174
36176
  /** Your unique identifier for the space. */
36175
36177
  space_key: string
36178
+ /** Your unique identifier for the site. */
36179
+ parent_site_key?: string | undefined
36176
36180
  }[]
36177
36181
  | undefined
36178
36182
  /** List of general sites or areas. */
@@ -102577,6 +102581,8 @@ export type Routes = {
102577
102581
  name: string
102578
102582
  /** Your unique identifier for the space. */
102579
102583
  space_key: string
102584
+ /** Your unique identifier for the site. */
102585
+ parent_site_key?: string | undefined
102580
102586
  }[]
102581
102587
  | undefined
102582
102588
  }
@@ -102648,6 +102654,8 @@ export type Routes = {
102648
102654
  name: string
102649
102655
  /** Your unique identifier for the space. */
102650
102656
  space_key: string
102657
+ /** Your unique identifier for the site. */
102658
+ parent_site_key?: string | undefined
102651
102659
  }[]
102652
102660
  | undefined
102653
102661
  }
@@ -106403,6 +106411,180 @@ export type Routes = {
106403
106411
  }
106404
106412
  maxDuration: undefined
106405
106413
  }
106414
+ '/user_identities/list_accessible_entrances': {
106415
+ route: '/user_identities/list_accessible_entrances'
106416
+ method: 'GET' | 'POST'
106417
+ queryParams: {}
106418
+ jsonBody: {}
106419
+ commonParams: {
106420
+ /** ID of the user identity for which you want to retrieve all accessible entrances. */
106421
+ user_identity_id: string
106422
+ }
106423
+ formData: {}
106424
+ jsonResponse: {
106425
+ acs_entrances: {
106426
+ /** 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). */
106427
+ acs_system_id: string
106428
+ /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106429
+ acs_entrance_id: string
106430
+ /** IDs of the spaces that the entrance is in. */
106431
+ space_ids: string[]
106432
+ /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
106433
+ created_at: string
106434
+ /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106435
+ display_name: string
106436
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106437
+ connected_account_id: string
106438
+ /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106439
+ errors: {
106440
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
106441
+ error_code: string
106442
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
106443
+ message: string
106444
+ }[]
106445
+ /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106446
+ latch_metadata?:
106447
+ | {
106448
+ /** Accessibility type in the Latch access system. */
106449
+ accessibility_type: string
106450
+ /** Name of the door in the Latch access system. */
106451
+ door_name: string
106452
+ /** Type of the door in the Latch access system. */
106453
+ door_type: string
106454
+ /** Indicates whether the entrance is connected. */
106455
+ is_connected: boolean
106456
+ }
106457
+ | undefined
106458
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106459
+ hotek_metadata?:
106460
+ | {
106461
+ /** Room number of the entrance. */
106462
+ room_number?: string | undefined
106463
+ /** Display name of the entrance. */
106464
+ common_area_number?: string | undefined
106465
+ /** Display name of the entrance. */
106466
+ common_area_name?: string | undefined
106467
+ }
106468
+ | undefined
106469
+ /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106470
+ visionline_metadata?:
106471
+ | {
106472
+ /** Name of the door in the Visionline access system. */
106473
+ door_name: string
106474
+ /** Category of the door in the Visionline access system. */
106475
+ door_category:
106476
+ | 'entrance'
106477
+ | 'guest'
106478
+ | 'elevator reader'
106479
+ | 'common'
106480
+ | 'common (PMS)'
106481
+ /** Profile for the door in the Visionline access system. */
106482
+ profiles?:
106483
+ | {
106484
+ /** Door profile ID in the Visionline access system. */
106485
+ visionline_door_profile_id: string
106486
+ /** Door profile type in the Visionline access system. */
106487
+ visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch'
106488
+ }[]
106489
+ | undefined
106490
+ }
106491
+ | undefined
106492
+ /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106493
+ salto_ks_metadata?:
106494
+ | {
106495
+ /** Name of the door in the Salto KS access system. */
106496
+ door_name: string
106497
+ /** Locked state of the door in the Salto KS access system. */
106498
+ locked_state: string
106499
+ /** Type of the lock in the Salto KS access system. */
106500
+ lock_type: string
106501
+ /** Indicates whether the door access device is online. */
106502
+ online?: boolean | undefined
106503
+ /** Battery level of the door access device. */
106504
+ battery_level: string
106505
+ /** Indicates whether the door is left open. */
106506
+ left_open_alarm?: boolean | undefined
106507
+ /** Indicates whether an intrusion alarm is active on the door. */
106508
+ intrusion_alarm?: boolean | undefined
106509
+ /** Indicates whether privacy mode is enabled for the lock. */
106510
+ privacy_mode?: boolean | undefined
106511
+ }
106512
+ | undefined
106513
+ /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106514
+ dormakaba_community_metadata?:
106515
+ | {
106516
+ /** Type of access point profile in the dormakaba Community access system. */
106517
+ access_point_profile: string
106518
+ }
106519
+ | undefined
106520
+ /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106521
+ assa_abloy_vostio_metadata?:
106522
+ | {
106523
+ /** Type of the door in the Vostio access system. */
106524
+ door_type:
106525
+ | 'CommonDoor'
106526
+ | 'EntranceDoor'
106527
+ | 'GuestDoor'
106528
+ | 'Elevator'
106529
+ /** Name of the door in the Vostio access system. */
106530
+ door_name: string
106531
+ /** Number of the door in the Vostio access system. */
106532
+ door_number?: number | undefined
106533
+ /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
106534
+ stand_open?: boolean | undefined
106535
+ /** PMS ID of the door in the Vostio access system. */
106536
+ pms_id?: string | undefined
106537
+ }
106538
+ | undefined
106539
+ /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106540
+ salto_space_metadata?:
106541
+ | {
106542
+ /** Door ID in the Salto Space access system. */
106543
+ door_id?: string | undefined
106544
+ /** Name of the door in the Salto Space access system. */
106545
+ door_name?: string | undefined
106546
+ /** Description of the door in the Salto Space access system. */
106547
+ door_description?: string | undefined
106548
+ /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
106549
+ audit_on_keys?: boolean | undefined
106550
+ /** Name of the room in the Salto Space access system. */
106551
+ room_name?: string | undefined
106552
+ /** Description of the room in the Salto Space access system. */
106553
+ room_description?: string | undefined
106554
+ }
106555
+ | undefined
106556
+ /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106557
+ dormakaba_ambiance_metadata?:
106558
+ | {
106559
+ /** Name of the access point in the dormakaba Ambiance access system. */
106560
+ access_point_name: string
106561
+ }
106562
+ | undefined
106563
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
106564
+ brivo_metadata?:
106565
+ | {
106566
+ /** ID of the access point in the Brivo access system. */
106567
+ access_point_id: string
106568
+ /** ID of the site that the access point belongs to. */
106569
+ site_id: number
106570
+ /** Name of the site that the access point belongs to. */
106571
+ site_name: string
106572
+ }
106573
+ | undefined
106574
+ /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
106575
+ can_unlock_with_mobile_key?: boolean | undefined
106576
+ /** Indicates whether the ACS entrance can be unlocked with card credentials. */
106577
+ can_unlock_with_card?: boolean | undefined
106578
+ /** Indicates whether the ACS entrance can be unlocked with pin codes. */
106579
+ can_unlock_with_code?: boolean | undefined
106580
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
106581
+ can_unlock_with_cloud_key?: boolean | undefined
106582
+ /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
106583
+ can_belong_to_reservation?: boolean | undefined
106584
+ }[]
106585
+ }
106586
+ maxDuration: undefined
106587
+ }
106406
106588
  '/user_identities/list_acs_systems': {
106407
106589
  route: '/user_identities/list_acs_systems'
106408
106590
  method: 'GET' | 'POST'