@seamapi/types 1.777.0 → 1.778.0

package/lib/seam/connect/route-types.d.ts

@@ -89576,6 +89576,151 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/user_identities/list_accessible_entrances': {
+        route: '/user_identities/list_accessible_entrances';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the user identity for which you want to retrieve all accessible entrances. */
+            user_identity_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            acs_entrances: {
+                /** 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). */
+                acs_system_id: string;
+                /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                acs_entrance_id: string;
+                /** IDs of the spaces that the entrance is in. */
+                space_ids: string[];
+                /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
+                created_at: string;
+                /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                display_name: string;
+                /** 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). */
+                connected_account_id: string;
+                /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                errors: {
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                }[];
+                /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                latch_metadata?: {
+                    /** Accessibility type in the Latch access system. */
+                    accessibility_type: string;
+                    /** Name of the door in the Latch access system. */
+                    door_name: string;
+                    /** Type of the door in the Latch access system. */
+                    door_type: string;
+                    /** Indicates whether the entrance is connected. */
+                    is_connected: boolean;
+                } | undefined;
+                /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                hotek_metadata?: {
+                    /** Room number of the entrance. */
+                    room_number?: string | undefined;
+                    /** Display name of the entrance. */
+                    common_area_number?: string | undefined;
+                    /** Display name of the entrance. */
+                    common_area_name?: string | undefined;
+                } | undefined;
+                /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                visionline_metadata?: {
+                    /** Name of the door in the Visionline access system. */
+                    door_name: string;
+                    /** Category of the door in the Visionline access system. */
+                    door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
+                    /** Profile for the door in the Visionline access system. */
+                    profiles?: {
+                        /** Door profile ID in the Visionline access system. */
+                        visionline_door_profile_id: string;
+                        /** Door profile type in the Visionline access system. */
+                        visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
+                    }[] | undefined;
+                } | undefined;
+                /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                salto_ks_metadata?: {
+                    /** Name of the door in the Salto KS access system. */
+                    door_name: string;
+                    /** Locked state of the door in the Salto KS access system. */
+                    locked_state: string;
+                    /** Type of the lock in the Salto KS access system. */
+                    lock_type: string;
+                    /** Indicates whether the door access device is online. */
+                    online?: boolean | undefined;
+                    /** Battery level of the door access device. */
+                    battery_level: string;
+                    /** Indicates whether the door is left open. */
+                    left_open_alarm?: boolean | undefined;
+                    /** Indicates whether an intrusion alarm is active on the door. */
+                    intrusion_alarm?: boolean | undefined;
+                    /** Indicates whether privacy mode is enabled for the lock. */
+                    privacy_mode?: boolean | undefined;
+                } | undefined;
+                /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                dormakaba_community_metadata?: {
+                    /** Type of access point profile in the dormakaba Community access system. */
+                    access_point_profile: string;
+                } | undefined;
+                /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                assa_abloy_vostio_metadata?: {
+                    /** Type of the door in the Vostio access system. */
+                    door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
+                    /** Name of the door in the Vostio access system. */
+                    door_name: string;
+                    /** Number of the door in the Vostio access system. */
+                    door_number?: number | undefined;
+                    /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
+                    stand_open?: boolean | undefined;
+                    /** PMS ID of the door in the Vostio access system. */
+                    pms_id?: string | undefined;
+                } | undefined;
+                /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                salto_space_metadata?: {
+                    /** Door ID in the Salto Space access system. */
+                    door_id?: string | undefined;
+                    /** Name of the door in the Salto Space access system. */
+                    door_name?: string | undefined;
+                    /** Description of the door in the Salto Space access system. */
+                    door_description?: string | undefined;
+                    /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
+                    audit_on_keys?: boolean | undefined;
+                    /** Name of the room in the Salto Space access system. */
+                    room_name?: string | undefined;
+                    /** Description of the room in the Salto Space access system. */
+                    room_description?: string | undefined;
+                } | undefined;
+                /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                dormakaba_ambiance_metadata?: {
+                    /** Name of the access point in the dormakaba Ambiance access system. */
+                    access_point_name: string;
+                } | undefined;
+                /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                brivo_metadata?: {
+                    /** ID of the access point in the Brivo access system. */
+                    access_point_id: string;
+                    /** ID of the site that the access point belongs to. */
+                    site_id: number;
+                    /** Name of the site that the access point belongs to. */
+                    site_name: string;
+                } | undefined;
+                /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
+                can_unlock_with_mobile_key?: boolean | undefined;
+                /** Indicates whether the ACS entrance can be unlocked with card credentials. */
+                can_unlock_with_card?: boolean | undefined;
+                /** Indicates whether the ACS entrance can be unlocked with pin codes. */
+                can_unlock_with_code?: boolean | undefined;
+                /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
+                can_unlock_with_cloud_key?: boolean | undefined;
+                /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+                can_belong_to_reservation?: boolean | undefined;
+            }[];
+        };
+        maxDuration: undefined;
+    };
     '/user_identities/list_acs_systems': {
         route: '/user_identities/list_acs_systems';
         method: 'GET' | 'POST';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.777.0",
+  "version": "1.778.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/openapi.ts

@@ -78421,6 +78421,119 @@ export default {
         'x-title': 'List Accessible Devices for a User Identity',
       },
     },
+    '/user_identities/list_accessible_entrances': {
+      get: {
+        description:
+          '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.',
+        operationId: 'userIdentitiesListAccessibleEntrancesGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'user_identity_id',
+            required: true,
+            schema: {
+              description:
+                'ID of the user identity for which you want to retrieve all accessible entrances.',
+              format: 'uuid',
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    acs_entrances: {
+                      items: { $ref: '#/components/schemas/acs_entrance' },
+                      type: 'array',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['acs_entrances', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/user_identities/list_accessible_entrances',
+        tags: ['/user_identities'],
+        'x-fern-sdk-group-name': ['user_identities'],
+        'x-fern-sdk-method-name': 'list_accessible_entrances',
+        'x-fern-sdk-return-value': 'acs_entrances',
+        'x-response-key': 'acs_entrances',
+        'x-title': 'List Accessible Entrances for a User Identity',
+      },
+      post: {
+        description:
+          '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.',
+        operationId: 'userIdentitiesListAccessibleEntrancesPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  user_identity_id: {
+                    description:
+                      'ID of the user identity for which you want to retrieve all accessible entrances.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['user_identity_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    acs_entrances: {
+                      items: { $ref: '#/components/schemas/acs_entrance' },
+                      type: 'array',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['acs_entrances', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/user_identities/list_accessible_entrances',
+        tags: ['/user_identities'],
+        'x-fern-sdk-group-name': ['user_identities'],
+        'x-fern-sdk-method-name': 'list_accessible_entrances',
+        'x-fern-sdk-return-value': 'acs_entrances',
+        'x-response-key': 'acs_entrances',
+        'x-title': 'List Accessible Entrances for a User Identity',
+      },
+    },
     '/user_identities/list_acs_systems': {
       get: {
         description:

package/src/lib/seam/connect/route-types.ts

@@ -106403,6 +106403,180 @@ export type Routes = {
     }
     maxDuration: undefined
   }
+  '/user_identities/list_accessible_entrances': {
+    route: '/user_identities/list_accessible_entrances'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of the user identity for which you want to retrieve all accessible entrances. */
+      user_identity_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      acs_entrances: {
+        /** 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). */
+        acs_system_id: string
+        /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        acs_entrance_id: string
+        /** IDs of the spaces that the entrance is in. */
+        space_ids: string[]
+        /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
+        created_at: string
+        /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        display_name: string
+        /** 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). */
+        connected_account_id: string
+        /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        errors: {
+          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+          error_code: string
+          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+        }[]
+        /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        latch_metadata?:
+          | {
+              /** Accessibility type in the Latch access system. */
+              accessibility_type: string
+              /** Name of the door in the Latch access system. */
+              door_name: string
+              /** Type of the door in the Latch access system. */
+              door_type: string
+              /** Indicates whether the entrance is connected. */
+              is_connected: boolean
+            }
+          | undefined
+        /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        hotek_metadata?:
+          | {
+              /** Room number of the entrance. */
+              room_number?: string | undefined
+              /** Display name of the entrance. */
+              common_area_number?: string | undefined
+              /** Display name of the entrance. */
+              common_area_name?: string | undefined
+            }
+          | undefined
+        /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        visionline_metadata?:
+          | {
+              /** Name of the door in the Visionline access system. */
+              door_name: string
+              /** Category of the door in the Visionline access system. */
+              door_category:
+                | 'entrance'
+                | 'guest'
+                | 'elevator reader'
+                | 'common'
+                | 'common (PMS)'
+              /** Profile for the door in the Visionline access system. */
+              profiles?:
+                | {
+                    /** Door profile ID in the Visionline access system. */
+                    visionline_door_profile_id: string
+                    /** Door profile type in the Visionline access system. */
+                    visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch'
+                  }[]
+                | undefined
+            }
+          | undefined
+        /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        salto_ks_metadata?:
+          | {
+              /** Name of the door in the Salto KS access system. */
+              door_name: string
+              /** Locked state of the door in the Salto KS access system. */
+              locked_state: string
+              /** Type of the lock in the Salto KS access system. */
+              lock_type: string
+              /** Indicates whether the door access device is online. */
+              online?: boolean | undefined
+              /** Battery level of the door access device. */
+              battery_level: string
+              /** Indicates whether the door is left open. */
+              left_open_alarm?: boolean | undefined
+              /** Indicates whether an intrusion alarm is active on the door. */
+              intrusion_alarm?: boolean | undefined
+              /** Indicates whether privacy mode is enabled for the lock. */
+              privacy_mode?: boolean | undefined
+            }
+          | undefined
+        /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        dormakaba_community_metadata?:
+          | {
+              /** Type of access point profile in the dormakaba Community access system. */
+              access_point_profile: string
+            }
+          | undefined
+        /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        assa_abloy_vostio_metadata?:
+          | {
+              /** Type of the door in the Vostio access system. */
+              door_type:
+                | 'CommonDoor'
+                | 'EntranceDoor'
+                | 'GuestDoor'
+                | 'Elevator'
+              /** Name of the door in the Vostio access system. */
+              door_name: string
+              /** Number of the door in the Vostio access system. */
+              door_number?: number | undefined
+              /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
+              stand_open?: boolean | undefined
+              /** PMS ID of the door in the Vostio access system. */
+              pms_id?: string | undefined
+            }
+          | undefined
+        /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        salto_space_metadata?:
+          | {
+              /** Door ID in the Salto Space access system. */
+              door_id?: string | undefined
+              /** Name of the door in the Salto Space access system. */
+              door_name?: string | undefined
+              /** Description of the door in the Salto Space access system. */
+              door_description?: string | undefined
+              /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
+              audit_on_keys?: boolean | undefined
+              /** Name of the room in the Salto Space access system. */
+              room_name?: string | undefined
+              /** Description of the room in the Salto Space access system. */
+              room_description?: string | undefined
+            }
+          | undefined
+        /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        dormakaba_ambiance_metadata?:
+          | {
+              /** Name of the access point in the dormakaba Ambiance access system. */
+              access_point_name: string
+            }
+          | undefined
+        /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        brivo_metadata?:
+          | {
+              /** ID of the access point in the Brivo access system. */
+              access_point_id: string
+              /** ID of the site that the access point belongs to. */
+              site_id: number
+              /** Name of the site that the access point belongs to. */
+              site_name: string
+            }
+          | undefined
+        /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
+        can_unlock_with_mobile_key?: boolean | undefined
+        /** Indicates whether the ACS entrance can be unlocked with card credentials. */
+        can_unlock_with_card?: boolean | undefined
+        /** Indicates whether the ACS entrance can be unlocked with pin codes. */
+        can_unlock_with_code?: boolean | undefined
+        /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
+        can_unlock_with_cloud_key?: boolean | undefined
+        /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
+        can_belong_to_reservation?: boolean | undefined
+      }[]
+    }
+    maxDuration: undefined
+  }
   '/user_identities/list_acs_systems': {
     route: '/user_identities/list_acs_systems'
     method: 'GET' | 'POST'