@seamapi/types 1.287.1 → 1.287.3

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

@@ -265,8 +265,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -1149,8 +1148,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -2190,8 +2188,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -3061,8 +3058,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -3583,11 +3579,8 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
-            /**
-              Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
-              
-              The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-             */
+            /** Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+          The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
             acs_access_group: {
                 /** ID of the access group. */
                 acs_access_group_id: string;
@@ -3598,10 +3591,10 @@ export interface Routes {
                 /** Name of the access group. */
                 name: string;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 access_group_type_display_name: string;
                 display_name: string;
                 /** Brand-specific terminology for the access group type. */
@@ -3637,10 +3630,10 @@ export interface Routes {
                 /** Name of the access group. */
                 name: string;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 access_group_type_display_name: string;
                 display_name: string;
                 /** Brand-specific terminology for the access group type. */
@@ -3745,7 +3738,9 @@ export interface Routes {
                 is_suspended: boolean;
                 /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
+                    /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     starts_at: string;
+                    /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     ends_at: string;
                 } | undefined;
                 /** ID of the user identity associated with the `acs_user`. */
@@ -3850,10 +3845,10 @@ export interface Routes {
                 /** Name of the access group. */
                 name: string;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 access_group_type_display_name: string;
                 display_name: string;
                 /** Brand-specific terminology for the access group type. */
@@ -3889,10 +3884,10 @@ export interface Routes {
                 /** Name of the access group. */
                 name: string;
                 /**
-                 * @deprecated use external_type */
+                 * @deprecated Use `external_type`. */
                 access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 /**
-                 * @deprecated use external_type_display_name */
+                 * @deprecated Use `external_type_display_name`. */
                 access_group_type_display_name: string;
                 display_name: string;
                 /** Brand-specific terminology for the access group type. */
@@ -3963,8 +3958,7 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             /** Means by which a user gains access at an entrance.
-          
-                The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+          The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
             acs_credential: {
                 /** ID of the credential. */
                 acs_credential_id: string;
@@ -4064,8 +4058,7 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             /** Means by which a user gains access at an entrance.
-          
-                The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+          The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
             acs_credential: {
                 /** ID of the credential. */
                 acs_credential_id: string;
@@ -4150,8 +4143,7 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             /** Means by which a user gains access at an entrance.
-          
-                The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+          The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
             acs_credential: {
                 /** ID of the credential. */
                 acs_credential_id: string;
@@ -4376,8 +4368,7 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             /** Means by which a user gains access at an entrance.
-          
-                The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+          The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
             acs_credential: {
                 /** ID of the credential. */
                 acs_credential_id: string;
@@ -4450,8 +4441,7 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             /** Means by which a user gains access at an entrance.
-          
-                The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+          The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
             acs_credential: {
                 /** ID of the credential. */
                 acs_credential_id: string;
@@ -4610,8 +4600,7 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             /** Means by which a user gains access at an entrance.
-          
-                The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+          The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
             acs_credential: {
                 /** ID of the credential. */
                 acs_credential_id: string;
@@ -4925,8 +4914,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -5739,7 +5727,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -6144,8 +6132,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -6637,6 +6624,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
             acs_entrance: {
                 /** ID of the access control system that contains the entrance. */
                 acs_system_id: string;
@@ -7210,7 +7198,9 @@ export interface Routes {
                 is_suspended: boolean;
                 /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
+                    /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     starts_at: string;
+                    /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     ends_at: string;
                 } | undefined;
                 /** ID of the user identity associated with the `acs_user`. */
@@ -7323,7 +7313,9 @@ export interface Routes {
                 is_suspended: boolean;
                 /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
+                    /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     starts_at: string;
+                    /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     ends_at: string;
                 } | undefined;
                 /** ID of the user identity associated with the `acs_user`. */
@@ -7432,7 +7424,9 @@ export interface Routes {
                 is_suspended: boolean;
                 /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
+                    /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     starts_at: string;
+                    /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     ends_at: string;
                 } | undefined;
                 /** ID of the user identity associated with the `acs_user`. */
@@ -7631,7 +7625,9 @@ export interface Routes {
                 is_suspended: boolean;
                 /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
+                    /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     starts_at: string;
+                    /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     ends_at: string;
                 } | undefined;
                 /** ID of the user identity associated with the `acs_user`. */
@@ -7735,7 +7731,9 @@ export interface Routes {
                 is_suspended: boolean;
                 /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
+                    /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     starts_at: string;
+                    /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     ends_at: string;
                 } | undefined;
                 /** ID of the user identity associated with the `acs_user`. */
@@ -8094,8 +8092,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -8827,8 +8824,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -10059,7 +10055,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -10547,7 +10543,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -11438,7 +11434,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -11901,7 +11897,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -12389,7 +12385,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -12852,7 +12848,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -13255,8 +13251,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -13989,8 +13984,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -14842,7 +14836,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -15305,7 +15299,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -15713,8 +15707,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -16457,8 +16450,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -17240,8 +17232,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -18156,8 +18147,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -18892,8 +18882,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -19731,7 +19720,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -20136,8 +20125,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -20874,8 +20862,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -21693,7 +21680,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -22156,7 +22143,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -22559,8 +22546,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -23414,8 +23400,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;
@@ -24434,7 +24419,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -24899,7 +24884,7 @@ export interface Routes {
                         _member_group_id?: string | undefined;
                     } | undefined;
                     assa_abloy_vostio_metadata?: {
-                        encoder_id: string;
+                        encoder_name: string;
                     } | undefined;
                 }) & ({
                     _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
@@ -25185,7 +25170,9 @@ export interface Routes {
                 is_suspended: boolean;
                 /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
                 access_schedule?: {
+                    /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     starts_at: string;
+                    /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
                     ends_at: string;
                 } | undefined;
                 /** ID of the user identity associated with the `acs_user`. */
@@ -25685,8 +25672,7 @@ export interface Routes {
                 error: null;
                 action_type: 'ENCODE_CREDENTIAL';
                 /** Means by which a user gains access at an entrance.
-            
-                  The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
+            The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
                 result: {
                     /** ID of the credential. */
                     acs_credential_id: string;

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -29,12 +29,12 @@ const common_acs_access_group = z.object({
   name: z.string().describe('Name of the access group.'),
   access_group_type: acs_access_group_external_type.describe(`
     ---
-    deprecated: use external_type
+    deprecated: Use \`external_type\`.
     ---
   `),
   access_group_type_display_name: z.string().describe(`
     ---
-    deprecated: use external_type_display_name
+    deprecated: Use \`external_type_display_name\`.
     ---
     `),
   display_name: z.string(),
@@ -54,11 +54,9 @@ const common_acs_access_group = z.object({
 
 export const acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(true),
-}).describe(`
-    Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
-    
-    The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-  `)
+})
+  .describe(`Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).`)
 export const unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(false),
 })

package/src/lib/seam/connect/models/acs/acs-credential.ts

@@ -144,10 +144,8 @@ function getAcsCredentialDescription(is_managed = true): string {
     : 'unmanaged_acs_credential'
   const management_clause = is_managed ? '' : ', which is not managed by Seam,'
 
-  return `
-      Means by which a user gains access at an entrance.
-
-      The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim()
+  return `Means by which a user gains access at an entrance.
+The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim()
 }
 
 export const acs_credential_on_encoder = z.object({

package/src/lib/seam/connect/models/acs/acs-entrance.ts

@@ -8,30 +8,34 @@ import {
   acs_entrance_visionline_metadata,
 } from './metadata/index.js'
 
-export const acs_entrance = z.object({
-  acs_system_id: z
-    .string()
-    .uuid()
-    .describe('ID of the access control system that contains the entrance.'),
-  acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
-  created_at: z
-    .string()
-    .datetime()
-    .describe('Date and time at which the entrance was created.'),
-  display_name: z.string().describe('Display name for the entrance.'),
-  errors: z.array(
-    z.object({
-      error_code: z.string(),
-      message: z.string(),
-    }),
-  ),
-  latch_metadata: acs_entrance_latch_metadata.optional(),
-  visionline_metadata: acs_entrance_visionline_metadata.optional(),
-  salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
-  dormakaba_community_metadata:
-    acs_entrance_dormakaba_community_metadata.optional(),
-  assa_abloy_vostio_metadata:
-    acs_entrance_assa_abloy_vostio_metadata.optional(),
-})
+export const acs_entrance = z
+  .object({
+    acs_system_id: z
+      .string()
+      .uuid()
+      .describe('ID of the access control system that contains the entrance.'),
+    acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
+    created_at: z
+      .string()
+      .datetime()
+      .describe('Date and time at which the entrance was created.'),
+    display_name: z.string().describe('Display name for the entrance.'),
+    errors: z.array(
+      z.object({
+        error_code: z.string(),
+        message: z.string(),
+      }),
+    ),
+    latch_metadata: acs_entrance_latch_metadata.optional(),
+    visionline_metadata: acs_entrance_visionline_metadata.optional(),
+    salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
+    dormakaba_community_metadata:
+      acs_entrance_dormakaba_community_metadata.optional(),
+    assa_abloy_vostio_metadata:
+      acs_entrance_assa_abloy_vostio_metadata.optional(),
+  })
+  .describe(
+    'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+  )
 
 export type AcsEntrance = z.infer<typeof acs_entrance>