npm - @seamapi/types - Versions diffs - 1.48.0 → 1.49.0 - Mend

@seamapi/types 1.48.0 → 1.49.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

package/dist/connect.d.cts CHANGED Viewed

@@ -81,81 +81,102 @@ declare const _default: {
             access_code: {
                 properties: {
                     access_code_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     code: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     common_code_key: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     created_at: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     device_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     ends_at: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
                     };
                     errors: {
+                        description: string;
                         nullable: boolean;
                     };
                     is_backup: {
+                        description: string;
                         type: string;
                     };
                     is_backup_access_code_available: {
+                        description: string;
                         type: string;
                     };
                     is_external_modification_allowed: {
+                        description: string;
                         type: string;
                     };
                     is_managed: {
+                        description: string;
                         enum: boolean[];
                         type: string;
                     };
                     is_offline_access_code: {
+                        description: string;
                         type: string;
                     };
                     is_one_time_use: {
+                        description: string;
                         type: string;
                     };
                     is_scheduled_on_device: {
+                        description: string;
                         type: string;
                     };
                     is_waiting_for_code_assignment: {
+                        description: string;
                         type: string;
                     };
                     name: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     pulled_backup_access_code_id: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
                     };
                     starts_at: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
                     };
                     status: {
+                        description: string;
                         enum: string[];
                         type: string;
                     };
                     type: {
+                        description: string;
                         enum: string[];
                         type: string;
                     };
                     warnings: {
+                        description: string;
                         nullable: boolean;
                     };
                 };
@@ -754,9 +775,6 @@ declare const _default: {
                                     };
                                     model: {
                                         properties: {
-                                            access_codes_supported: {
-                                                type: string;
-                                            };
                                             accessory_keypad_supported: {
                                                 type: string;
                                             };
@@ -769,6 +787,9 @@ declare const _default: {
                                             offline_access_codes_supported: {
                                                 type: string;
                                             };
+                                            online_access_codes_supported: {
+                                                type: string;
+                                            };
                                         };
                                         required: string[];
                                         type: string;
@@ -2092,27 +2113,33 @@ declare const _default: {
             unmanaged_access_code: {
                 properties: {
                     access_code_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     code: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     created_at: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     device_id: {
+                        description: string;
                         format: string;
                         type: string;
                     };
                     ends_at: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
                     };
                     errors: {
+                        description: string;
                         nullable: boolean;
                     };
                     is_managed: {
@@ -2120,10 +2147,12 @@ declare const _default: {
                         type: string;
                     };
                     name: {
+                        description: string;
                         nullable: boolean;
                         type: string;
                     };
                     starts_at: {
+                        description: string;
                         format: string;
                         nullable: boolean;
                         type: string;
@@ -2133,10 +2162,12 @@ declare const _default: {
                         type: string;
                     };
                     type: {
+                        description: string;
                         enum: string[];
                         type: string;
                     };
                     warnings: {
+                        description: string;
                         nullable: boolean;
                     };
                 };
@@ -4472,6 +4503,107 @@ declare const _default: {
                 'x-fern-sdk-method-name': string;
             };
         };
+        '/acs/credential_pools/list': {
+            post: {
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_system_id: {
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        acs_credential_pools: {
+                                            items: {
+                                                properties: {
+                                                    acs_credential_pool_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    acs_system_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    created_at: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    display_name: {
+                                                        minLength: number;
+                                                        type: string;
+                                                    };
+                                                    external_type: {
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                    external_type_display_name: {
+                                                        type: string;
+                                                    };
+                                                    workspace_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    access_token: never[];
+                    seam_workspace: never[];
+                    seam_client_session_token?: never;
+                    client_session_token?: never;
+                } | {
+                    seam_client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    client_session_token?: never;
+                } | {
+                    client_session_token: never[];
+                    access_token?: never;
+                    seam_workspace?: never;
+                    seam_client_session_token?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+            };
+        };
         '/acs/credentials/assign': {
             patch: {
                 operationId: string;
@@ -4507,6 +4639,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                acs_credential_pool_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 acs_system_id: {
                                                     format: string;
                                                     type: string;
@@ -4614,6 +4750,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                acs_credential_pool_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 acs_system_id: {
                                                     format: string;
                                                     type: string;
@@ -4724,6 +4864,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                acs_credential_pool_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 acs_system_id: {
                                                     format: string;
                                                     type: string;
@@ -4895,6 +5039,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                acs_credential_pool_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 acs_system_id: {
                                                     format: string;
                                                     type: string;
@@ -5028,6 +5176,10 @@ declare const _default: {
                                                         format: string;
                                                         type: string;
                                                     };
+                                                    acs_credential_pool_id: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
                                                     acs_system_id: {
                                                         format: string;
                                                         type: string;
@@ -5140,6 +5292,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                acs_credential_pool_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 acs_system_id: {
                                                     format: string;
                                                     type: string;
@@ -5247,6 +5403,10 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
+                                                acs_credential_pool_id: {
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 acs_system_id: {
                                                     format: string;
                                                     type: string;
@@ -12949,26 +13109,49 @@ 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;
             };
         };
@@ -12998,26 +13181,49 @@ 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;
             }>;
         };
@@ -13087,26 +13293,49 @@ 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;
             };
         };
@@ -13124,26 +13353,49 @@ 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;
             }>;
         };
@@ -13159,26 +13411,49 @@ 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;
             };
         };
@@ -13196,16 +13471,26 @@ 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';
             };
@@ -13274,16 +13559,26 @@ 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';
             };
@@ -13301,16 +13596,26 @@ 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';
             }>;
@@ -13484,6 +13789,27 @@ 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';
@@ -13498,10 +13824,11 @@ 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' | 'hid_cm_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -13522,10 +13849,11 @@ 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' | 'hid_cm_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -13556,10 +13884,11 @@ 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' | 'hid_cm_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -13584,10 +13913,11 @@ 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' | 'hid_cm_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -13608,10 +13938,11 @@ 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' | 'hid_cm_credential';
+                external_type: 'pti_card' | 'brivo_credential' | 'hid_credential';
                 external_type_display_name: string;
                 created_at: string;
                 workspace_id: string;
@@ -14304,7 +14635,7 @@ 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;
@@ -14723,7 +15054,7 @@ 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;
@@ -15397,7 +15728,7 @@ 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;
@@ -15794,7 +16125,7 @@ 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;
@@ -16213,7 +16544,7 @@ 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;
@@ -16610,7 +16941,7 @@ 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;
@@ -17427,7 +17758,7 @@ 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;
@@ -17876,7 +18207,7 @@ 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;
@@ -18397,7 +18728,7 @@ 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;