@seamapi/types 1.47.0 → 1.49.0

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

@@ -47,26 +47,49 @@ export interface Routes {
                 };
             };
             access_code: {
+                /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
+                /** Indicates whether the code is set on the device according to a preconfigured schedule. */
                 is_scheduled_on_device?: boolean | undefined;
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Indicates whether the access code is waiting for a code assignment. */
                 is_waiting_for_code_assignment?: boolean | undefined;
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
+                /** Indicates whether Seam manages the access code. */
                 is_managed: true;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
+                /**
+                    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+                   */
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
+                /** Indicates whether the access code is a backup code. */
                 is_backup?: boolean | undefined;
+                /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
                 pulled_backup_access_code_id?: (string | null) | undefined;
+                /** Indicates whether changes to the access code from external sources are permitted. */
                 is_external_modification_allowed: boolean;
+                /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
                 is_one_time_use: boolean;
+                /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
                 is_offline_access_code: boolean;
             };
         };
@@ -96,26 +119,49 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             access_codes: Array<{
+                /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
+                /** Indicates whether the code is set on the device according to a preconfigured schedule. */
                 is_scheduled_on_device?: boolean | undefined;
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Indicates whether the access code is waiting for a code assignment. */
                 is_waiting_for_code_assignment?: boolean | undefined;
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
+                /** Indicates whether Seam manages the access code. */
                 is_managed: true;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
+                /**
+                    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+                   */
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
+                /** Indicates whether the access code is a backup code. */
                 is_backup?: boolean | undefined;
+                /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
                 pulled_backup_access_code_id?: (string | null) | undefined;
+                /** Indicates whether changes to the access code from external sources are permitted. */
                 is_external_modification_allowed: boolean;
+                /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
                 is_one_time_use: boolean;
+                /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
                 is_offline_access_code: boolean;
             }>;
         };
@@ -185,26 +231,49 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             access_code: {
+                /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
+                /** Indicates whether the code is set on the device according to a preconfigured schedule. */
                 is_scheduled_on_device?: boolean | undefined;
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Indicates whether the access code is waiting for a code assignment. */
                 is_waiting_for_code_assignment?: boolean | undefined;
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
+                /** Indicates whether Seam manages the access code. */
                 is_managed: true;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
+                /**
+                    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+                   */
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
+                /** Indicates whether the access code is a backup code. */
                 is_backup?: boolean | undefined;
+                /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
                 pulled_backup_access_code_id?: (string | null) | undefined;
+                /** Indicates whether changes to the access code from external sources are permitted. */
                 is_external_modification_allowed: boolean;
+                /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
                 is_one_time_use: boolean;
+                /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
                 is_offline_access_code: boolean;
             };
         };
@@ -222,26 +291,49 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             access_codes: Array<{
+                /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
+                /** Indicates whether the code is set on the device according to a preconfigured schedule. */
                 is_scheduled_on_device?: boolean | undefined;
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Indicates whether the access code is waiting for a code assignment. */
                 is_waiting_for_code_assignment?: boolean | undefined;
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
+                /** Indicates whether Seam manages the access code. */
                 is_managed: true;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
+                /**
+                    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+                   */
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
+                /** Indicates whether the access code is a backup code. */
                 is_backup?: boolean | undefined;
+                /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
                 pulled_backup_access_code_id?: (string | null) | undefined;
+                /** Indicates whether changes to the access code from external sources are permitted. */
                 is_external_modification_allowed: boolean;
+                /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
                 is_one_time_use: boolean;
+                /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
                 is_offline_access_code: boolean;
             }>;
         };
@@ -257,26 +349,49 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             backup_access_code: {
+                /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
+                /** Indicates whether the code is set on the device according to a preconfigured schedule. */
                 is_scheduled_on_device?: boolean | undefined;
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Indicates whether the access code is waiting for a code assignment. */
                 is_waiting_for_code_assignment?: boolean | undefined;
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
+                /** Indicates whether Seam manages the access code. */
                 is_managed: true;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
+                /**
+                    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+                   */
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
+                /** Indicates whether the access code is a backup code. */
                 is_backup?: boolean | undefined;
+                /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
                 pulled_backup_access_code_id?: (string | null) | undefined;
+                /** Indicates whether changes to the access code from external sources are permitted. */
                 is_external_modification_allowed: boolean;
+                /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
                 is_one_time_use: boolean;
+                /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
                 is_offline_access_code: boolean;
             };
         };
@@ -294,16 +409,26 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             access_code: {
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
                 is_managed: false;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
                 status: 'set';
             };
@@ -372,16 +497,26 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             access_code: {
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
                 is_managed: false;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
                 status: 'set';
             };
@@ -399,16 +534,26 @@ export interface Routes {
         formData: {};
         jsonResponse: {
             access_codes: Array<{
+                /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
+                /** Unique identifier for the access code. */
                 access_code_id: string;
+                /** Unique identifier for the device associated with the access code. */
                 device_id: string;
+                /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
                 name: string | null;
+                /** Code used for access. Typically, a numeric or alphanumeric string. */
                 code: string | null;
+                /** Date and time at which the access code was created. */
                 created_at: string;
+                /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
                 errors?: any;
+                /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
                 warnings?: any;
                 is_managed: false;
+                /** Date and time at which the time-bound access code becomes active. */
                 starts_at?: (string | null) | undefined;
+                /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
                 status: 'set';
             }>;
@@ -582,6 +727,27 @@ export interface Routes {
         formData: {};
         jsonResponse: {};
     };
+    '/acs/credential_pools/list': {
+        route: '/acs/credential_pools/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            acs_system_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            acs_credential_pools: Array<{
+                acs_credential_pool_id: string;
+                acs_system_id: string;
+                display_name: string;
+                external_type: 'hid_part_number';
+                external_type_display_name: string;
+                created_at: string;
+                workspace_id: string;
+            }>;
+        };
+    };
     '/acs/credentials/assign': {
         route: '/acs/credentials/assign';
         method: 'PATCH' | 'POST';
@@ -592,7 +758,20 @@ export interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {};
+        jsonResponse: {
+            acs_credential: {
+                acs_credential_id: string;
+                acs_user_id?: string | undefined;
+                acs_credential_pool_id?: string | undefined;
+                acs_system_id: string;
+                display_name: string;
+                code: string | null;
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
+                external_type_display_name: string;
+                created_at: string;
+                workspace_id: string;
+            };
+        };
     };
     '/acs/credentials/create': {
         route: '/acs/credentials/create';
@@ -608,10 +787,11 @@ export interface Routes {
             acs_credential: {
                 acs_credential_id: string;
                 acs_user_id?: string | undefined;
+                acs_credential_pool_id?: string | undefined;
                 acs_system_id: string;
                 display_name: string;
                 code: string | null;
-                external_type: 'pti_card' | 'brivo_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -642,10 +822,11 @@ export interface Routes {
             acs_credential: {
                 acs_credential_id: string;
                 acs_user_id?: string | undefined;
+                acs_credential_pool_id?: string | undefined;
                 acs_system_id: string;
                 display_name: string;
                 code: string | null;
-                external_type: 'pti_card' | 'brivo_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -670,10 +851,11 @@ export interface Routes {
             acs_credentials: Array<{
                 acs_credential_id: string;
                 acs_user_id?: string | undefined;
+                acs_credential_pool_id?: string | undefined;
                 acs_system_id: string;
                 display_name: string;
                 code: string | null;
-                external_type: 'pti_card' | 'brivo_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -694,10 +876,11 @@ export interface Routes {
             acs_credential: {
                 acs_credential_id: string;
                 acs_user_id?: string | undefined;
+                acs_credential_pool_id?: string | undefined;
                 acs_system_id: string;
                 display_name: string;
                 code: string | null;
-                external_type: 'pti_card' | 'brivo_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -1390,7 +1573,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -1809,7 +1992,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -2483,7 +2666,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -2880,7 +3063,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -3299,7 +3482,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -3696,7 +3879,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -4513,7 +4696,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -4962,7 +5145,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;
@@ -5483,7 +5666,7 @@ export interface Routes {
                         display_name: string;
                         manufacturer_display_name: string;
                         offline_access_codes_supported?: boolean | undefined;
-                        access_codes_supported?: boolean | undefined;
+                        online_access_codes_supported?: boolean | undefined;
                         accessory_keypad_supported?: boolean | undefined;
                     };
                     has_direct_power?: boolean | undefined;

package/lib/seam/connect/unstable/model-types.d.ts

@@ -1 +1 @@
-export type { AccessCodeConstraint, AcsAccessGroup, AcsAccessGroupExternalType, AcsCredential, AcsCredentialExternalType, AcsSystem, AcsSystemExternalType, AcsUser, AcsUserExternalType, AnyDeviceType, BatteryStatus, Capabilities, ClimateSetting, DeviceMetadata, LockDeviceType, ManagedAccessCode, ManagedDevice, ManagedDeviceWithBackendMetadata, NoiseSensorDeviceType, ThermostatDeviceType, UnmanagedAccessCode, UnmanagedDevice, } from './models/index.js';
+export type { AccessCodeConstraint, AcsAccessGroup, AcsAccessGroupExternalType, AcsCredential, AcsCredentialExternalType, AcsCredentialPool, AcsCredentialPoolExternalType, AcsSystem, AcsSystemExternalType, AcsUser, AcsUserExternalType, AnyDeviceType, BatteryStatus, Capabilities, ClimateSetting, DeviceMetadata, LockDeviceType, ManagedAccessCode, ManagedDevice, ManagedDeviceWithBackendMetadata, NoiseSensorDeviceType, ThermostatDeviceType, UnmanagedAccessCode, UnmanagedDevice, } from './models/index.js';

package/lib/seam/connect/unstable/models/access-codes/managed-access-code.js

@@ -1,25 +1,85 @@
 import { z } from 'zod';
 export const managed_access_code = z.object({
-    common_code_key: z.string().nullable(),
-    is_scheduled_on_device: z.boolean().optional(),
-    type: z.enum(['time_bound', 'ongoing']),
-    is_waiting_for_code_assignment: z.boolean().optional(),
-    access_code_id: z.string().uuid(),
-    device_id: z.string().uuid(),
-    name: z.string().nullable(),
-    code: z.string().nullable(),
-    created_at: z.string().datetime(),
-    errors: z.any(),
-    warnings: z.any(),
-    is_managed: z.literal(true),
-    starts_at: z.string().datetime().nullable().optional(),
-    ends_at: z.string().datetime().nullable().optional(),
-    status: z.enum(['setting', 'set', 'unset', 'removing', 'unknown']),
-    is_backup_access_code_available: z.boolean(),
-    is_backup: z.boolean().optional(),
-    pulled_backup_access_code_id: z.string().uuid().nullable().optional(),
-    is_external_modification_allowed: z.boolean(),
-    is_one_time_use: z.boolean(),
-    is_offline_access_code: z.boolean(),
+    common_code_key: z
+        .string()
+        .nullable()
+        .describe('Unique identifier for a group of access codes that share the same code.'),
+    is_scheduled_on_device: z
+        .boolean()
+        .optional()
+        .describe('Indicates whether the code is set on the device according to a preconfigured schedule.'),
+    type: z
+        .enum(['time_bound', 'ongoing'])
+        .describe('Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.'),
+    is_waiting_for_code_assignment: z
+        .boolean()
+        .optional()
+        .describe('Indicates whether the access code is waiting for a code assignment.'),
+    access_code_id: z
+        .string()
+        .uuid()
+        .describe('Unique identifier for the access code.'),
+    device_id: z
+        .string()
+        .uuid()
+        .describe('Unique identifier for the device associated with the access code.'),
+    name: z
+        .string()
+        .nullable()
+        .describe('Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.'),
+    code: z
+        .string()
+        .nullable()
+        .describe('Code used for access. Typically, a numeric or alphanumeric string.'),
+    created_at: z
+        .string()
+        .datetime()
+        .describe('Date and time at which the access code was created.'),
+    errors: z
+        .any()
+        .describe('Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.'),
+    warnings: z
+        .any()
+        .describe('Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.'),
+    is_managed: z
+        .literal(true)
+        .describe('Indicates whether Seam manages the access code.'),
+    starts_at: z
+        .string()
+        .datetime()
+        .nullable()
+        .optional()
+        .describe('Date and time at which the time-bound access code becomes active.'),
+    ends_at: z
+        .string()
+        .datetime()
+        .nullable()
+        .optional()
+        .describe('Date and time after which the time-bound access code becomes inactive.'),
+    status: z.enum(['setting', 'set', 'unset', 'removing', 'unknown']).describe(`
+    Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
+  `),
+    is_backup_access_code_available: z
+        .boolean()
+        .describe('Indicates whether a backup access code is available for use if the primary access code is lost or compromised.'),
+    is_backup: z
+        .boolean()
+        .optional()
+        .describe('Indicates whether the access code is a backup code.'),
+    pulled_backup_access_code_id: z
+        .string()
+        .uuid()
+        .nullable()
+        .optional()
+        .describe('Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.'),
+    is_external_modification_allowed: z
+        .boolean()
+        .describe('Indicates whether changes to the access code from external sources are permitted.'),
+    is_one_time_use: z
+        .boolean()
+        .describe('Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.'),
+    is_offline_access_code: z
+        .boolean()
+        .describe('Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.'),
 });
 //# sourceMappingURL=managed-access-code.js.map