@seamapi/types 1.245.1 → 1.247.0

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

@@ -2569,12 +2569,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {
       acs_users: Array<{
+        /** ID of the `acs_user`. */
         acs_user_id: string
+        /** ID of the access control system that contains the `acs_user`. */
         acs_system_id: string
         hid_acs_system_id?: string | undefined
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
         workspace_id: string
+        /** Date and time at which the `acs_user` was created. */
         created_at: string
+        /** Display name for the `acs_user`. */
         display_name: string
+        /** Brand-specific terminology for the `acs_user` type. */
         external_type?:
           | (
               | 'pti_user'
@@ -2584,20 +2590,30 @@ export interface Routes {
               | 'latch_user'
             )
           | undefined
+        /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
         external_type_display_name?: string | undefined
+        /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
         is_suspended: boolean
+        /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
         access_schedule?:
           | {
               starts_at: string
               ends_at: string
             }
           | undefined
+        /** ID of the user identity associated with the `acs_user`. */
         user_identity_id?: string | undefined
+        /** Full name of the user identity associated with the `acs_user`. */
         user_identity_full_name?: (string | null) | undefined
+        /** Email address of the user identity associated with the `acs_user`. */
         user_identity_email_address?: (string | null) | undefined
+        /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
         user_identity_phone_number?: (string | null) | undefined
+        /**  */
         latest_desired_state_synced_with_provider_at?: string | undefined
+        /**  */
         is_latest_desired_state_synced_with_provider?: boolean | undefined
+        /** Warnings associated with the `acs_user`. */
         warnings: Array<
           | {
               created_at: string
@@ -2610,6 +2626,7 @@ export interface Routes {
               warning_code: 'salto_ks_user_not_subscribed'
             }
         >
+        /** Errors associated with the `acs_user`. */
         errors: Array<
           | {
               /** Date and time at which Seam created the error. */
@@ -2647,11 +2664,14 @@ export interface Routes {
               error_code: 'failed_to_delete_on_acs_system'
             }
         >
+        /** Full name of the `acs_user`. */
         full_name?: string | undefined
         /**
          * @deprecated use email_address. */
         email?: string | undefined
+        /** Email address of the `acs_user`. */
         email_address?: string | undefined
+        /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
         phone_number?: string | undefined
         is_managed: true
       }>
@@ -3937,7 +3957,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
+      /** ID of the desired access group. */
       acs_access_group_id: string
     }
     formData: {}
@@ -3948,32 +3970,45 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the `acs_system` to which to add the new `acs_user`. */
       acs_system_id: string
+      /** Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. */
       acs_access_group_ids?: string[]
+      /** ID of the user identity with which to associate the new `acs_user`. */
       user_identity_id?: string | undefined
+      /** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
       access_schedule?:
         | {
             starts_at: string
             ends_at: string
           }
         | undefined
+      /** Full name of the `acs_user`. */
       full_name?: string | undefined
       /**
        * @deprecated use email_address. */
       email?: string | undefined
+      /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
       phone_number?: string | undefined
+      /** Email address of the `acs_user`. */
       email_address?: string | undefined
     }
     commonParams: {}
     formData: {}
     jsonResponse: {
       acs_user: {
+        /** ID of the `acs_user`. */
         acs_user_id: string
+        /** ID of the access control system that contains the `acs_user`. */
         acs_system_id: string
         hid_acs_system_id?: string | undefined
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
         workspace_id: string
+        /** Date and time at which the `acs_user` was created. */
         created_at: string
+        /** Display name for the `acs_user`. */
         display_name: string
+        /** Brand-specific terminology for the `acs_user` type. */
         external_type?:
           | (
               | 'pti_user'
@@ -3983,20 +4018,30 @@ export interface Routes {
               | 'latch_user'
             )
           | undefined
+        /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
         external_type_display_name?: string | undefined
+        /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
         is_suspended: boolean
+        /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
         access_schedule?:
           | {
               starts_at: string
               ends_at: string
             }
           | undefined
+        /** ID of the user identity associated with the `acs_user`. */
         user_identity_id?: string | undefined
+        /** Full name of the user identity associated with the `acs_user`. */
         user_identity_full_name?: (string | null) | undefined
+        /** Email address of the user identity associated with the `acs_user`. */
         user_identity_email_address?: (string | null) | undefined
+        /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
         user_identity_phone_number?: (string | null) | undefined
+        /**  */
         latest_desired_state_synced_with_provider_at?: string | undefined
+        /**  */
         is_latest_desired_state_synced_with_provider?: boolean | undefined
+        /** Warnings associated with the `acs_user`. */
         warnings: Array<
           | {
               created_at: string
@@ -4009,6 +4054,7 @@ export interface Routes {
               warning_code: 'salto_ks_user_not_subscribed'
             }
         >
+        /** Errors associated with the `acs_user`. */
         errors: Array<
           | {
               /** Date and time at which Seam created the error. */
@@ -4046,11 +4092,14 @@ export interface Routes {
               error_code: 'failed_to_delete_on_acs_system'
             }
         >
+        /** Full name of the `acs_user`. */
         full_name?: string | undefined
         /**
          * @deprecated use email_address. */
         email?: string | undefined
+        /** Email address of the `acs_user`. */
         email_address?: string | undefined
+        /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
         phone_number?: string | undefined
         is_managed: true
       }
@@ -4062,6 +4111,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
     }
     formData: {}
@@ -4073,17 +4123,24 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
     }
     formData: {}
     jsonResponse: {
       acs_user: {
+        /** ID of the `acs_user`. */
         acs_user_id: string
+        /** ID of the access control system that contains the `acs_user`. */
         acs_system_id: string
         hid_acs_system_id?: string | undefined
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
         workspace_id: string
+        /** Date and time at which the `acs_user` was created. */
         created_at: string
+        /** Display name for the `acs_user`. */
         display_name: string
+        /** Brand-specific terminology for the `acs_user` type. */
         external_type?:
           | (
               | 'pti_user'
@@ -4093,20 +4150,30 @@ export interface Routes {
               | 'latch_user'
             )
           | undefined
+        /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
         external_type_display_name?: string | undefined
+        /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
         is_suspended: boolean
+        /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
         access_schedule?:
           | {
               starts_at: string
               ends_at: string
             }
           | undefined
+        /** ID of the user identity associated with the `acs_user`. */
         user_identity_id?: string | undefined
+        /** Full name of the user identity associated with the `acs_user`. */
         user_identity_full_name?: (string | null) | undefined
+        /** Email address of the user identity associated with the `acs_user`. */
         user_identity_email_address?: (string | null) | undefined
+        /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
         user_identity_phone_number?: (string | null) | undefined
+        /**  */
         latest_desired_state_synced_with_provider_at?: string | undefined
+        /**  */
         is_latest_desired_state_synced_with_provider?: boolean | undefined
+        /** Warnings associated with the `acs_user`. */
         warnings: Array<
           | {
               created_at: string
@@ -4119,6 +4186,7 @@ export interface Routes {
               warning_code: 'salto_ks_user_not_subscribed'
             }
         >
+        /** Errors associated with the `acs_user`. */
         errors: Array<
           | {
               /** Date and time at which Seam created the error. */
@@ -4156,11 +4224,14 @@ export interface Routes {
               error_code: 'failed_to_delete_on_acs_system'
             }
         >
+        /** Full name of the `acs_user`. */
         full_name?: string | undefined
         /**
          * @deprecated use email_address. */
         email?: string | undefined
+        /** Email address of the `acs_user`. */
         email_address?: string | undefined
+        /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
         phone_number?: string | undefined
         is_managed: true
       }
@@ -4172,9 +4243,13 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the user identity for which you want to retrieve all `acs_user`s. */
       user_identity_id?: string | undefined
+      /** Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
       user_identity_phone_number?: string | undefined
+      /** Email address of the user identity for which you want to retrieve all `acs_user`s. */
       user_identity_email_address?: string | undefined
+      /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
       acs_system_id?: string | undefined
       limit?: number
       created_before?: Date | undefined
@@ -4182,12 +4257,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {
       acs_users: Array<{
+        /** ID of the `acs_user`. */
         acs_user_id: string
+        /** ID of the access control system that contains the `acs_user`. */
         acs_system_id: string
         hid_acs_system_id?: string | undefined
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
         workspace_id: string
+        /** Date and time at which the `acs_user` was created. */
         created_at: string
+        /** Display name for the `acs_user`. */
         display_name: string
+        /** Brand-specific terminology for the `acs_user` type. */
         external_type?:
           | (
               | 'pti_user'
@@ -4197,20 +4278,30 @@ export interface Routes {
               | 'latch_user'
             )
           | undefined
+        /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
         external_type_display_name?: string | undefined
+        /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
         is_suspended: boolean
+        /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
         access_schedule?:
           | {
               starts_at: string
               ends_at: string
             }
           | undefined
+        /** ID of the user identity associated with the `acs_user`. */
         user_identity_id?: string | undefined
+        /** Full name of the user identity associated with the `acs_user`. */
         user_identity_full_name?: (string | null) | undefined
+        /** Email address of the user identity associated with the `acs_user`. */
         user_identity_email_address?: (string | null) | undefined
+        /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
         user_identity_phone_number?: (string | null) | undefined
+        /**  */
         latest_desired_state_synced_with_provider_at?: string | undefined
+        /**  */
         is_latest_desired_state_synced_with_provider?: boolean | undefined
+        /** Warnings associated with the `acs_user`. */
         warnings: Array<
           | {
               created_at: string
@@ -4223,6 +4314,7 @@ export interface Routes {
               warning_code: 'salto_ks_user_not_subscribed'
             }
         >
+        /** Errors associated with the `acs_user`. */
         errors: Array<
           | {
               /** Date and time at which Seam created the error. */
@@ -4260,11 +4352,14 @@ export interface Routes {
               error_code: 'failed_to_delete_on_acs_system'
             }
         >
+        /** Full name of the `acs_user`. */
         full_name?: string | undefined
         /**
          * @deprecated use email_address. */
         email?: string | undefined
+        /** Email address of the `acs_user`. */
         email_address?: string | undefined
+        /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
         phone_number?: string | undefined
         is_managed: true
       }>
@@ -4276,6 +4371,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
     }
     formData: {}
@@ -4323,7 +4419,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
+      /** ID of the desired access group. */
       acs_access_group_id: string
     }
     formData: {}
@@ -4334,6 +4432,7 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
     }
     commonParams: {}
@@ -4346,6 +4445,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
     }
     formData: {}
@@ -4362,12 +4462,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {
       acs_user: {
+        /** ID of the `acs_user`. */
         acs_user_id: string
+        /** ID of the access control system that contains the `acs_user`. */
         acs_system_id: string
         hid_acs_system_id?: string | undefined
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
         workspace_id: string
+        /** Date and time at which the `acs_user` was created. */
         created_at: string
+        /** Display name for the `acs_user`. */
         display_name: string
+        /** Brand-specific terminology for the `acs_user` type. */
         external_type?:
           | (
               | 'pti_user'
@@ -4377,20 +4483,30 @@ export interface Routes {
               | 'latch_user'
             )
           | undefined
+        /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
         external_type_display_name?: string | undefined
+        /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
         is_suspended: boolean
+        /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
         access_schedule?:
           | {
               starts_at: string
               ends_at: string
             }
           | undefined
+        /** ID of the user identity associated with the `acs_user`. */
         user_identity_id?: string | undefined
+        /** Full name of the user identity associated with the `acs_user`. */
         user_identity_full_name?: (string | null) | undefined
+        /** Email address of the user identity associated with the `acs_user`. */
         user_identity_email_address?: (string | null) | undefined
+        /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
         user_identity_phone_number?: (string | null) | undefined
+        /**  */
         latest_desired_state_synced_with_provider_at?: string | undefined
+        /**  */
         is_latest_desired_state_synced_with_provider?: boolean | undefined
+        /** Warnings associated with the `acs_user`. */
         warnings: Array<
           | {
               created_at: string
@@ -4403,6 +4519,7 @@ export interface Routes {
               warning_code: 'salto_ks_user_not_subscribed'
             }
         >
+        /** Errors associated with the `acs_user`. */
         errors: Array<
           | {
               /** Date and time at which Seam created the error. */
@@ -4440,11 +4557,14 @@ export interface Routes {
               error_code: 'failed_to_delete_on_acs_system'
             }
         >
+        /** Full name of the `acs_user`. */
         full_name?: string | undefined
         /**
          * @deprecated use email_address. */
         email?: string | undefined
+        /** Email address of the `acs_user`. */
         email_address?: string | undefined
+        /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
         phone_number?: string | undefined
         is_managed: false
       }
@@ -4465,12 +4585,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {
       acs_users: Array<{
+        /** ID of the `acs_user`. */
         acs_user_id: string
+        /** ID of the access control system that contains the `acs_user`. */
         acs_system_id: string
         hid_acs_system_id?: string | undefined
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
         workspace_id: string
+        /** Date and time at which the `acs_user` was created. */
         created_at: string
+        /** Display name for the `acs_user`. */
         display_name: string
+        /** Brand-specific terminology for the `acs_user` type. */
         external_type?:
           | (
               | 'pti_user'
@@ -4480,20 +4606,30 @@ export interface Routes {
               | 'latch_user'
             )
           | undefined
+        /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
         external_type_display_name?: string | undefined
+        /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
         is_suspended: boolean
+        /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
         access_schedule?:
           | {
               starts_at: string
               ends_at: string
             }
           | undefined
+        /** ID of the user identity associated with the `acs_user`. */
         user_identity_id?: string | undefined
+        /** Full name of the user identity associated with the `acs_user`. */
         user_identity_full_name?: (string | null) | undefined
+        /** Email address of the user identity associated with the `acs_user`. */
         user_identity_email_address?: (string | null) | undefined
+        /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
         user_identity_phone_number?: (string | null) | undefined
+        /**  */
         latest_desired_state_synced_with_provider_at?: string | undefined
+        /**  */
         is_latest_desired_state_synced_with_provider?: boolean | undefined
+        /** Warnings associated with the `acs_user`. */
         warnings: Array<
           | {
               created_at: string
@@ -4506,6 +4642,7 @@ export interface Routes {
               warning_code: 'salto_ks_user_not_subscribed'
             }
         >
+        /** Errors associated with the `acs_user`. */
         errors: Array<
           | {
               /** Date and time at which Seam created the error. */
@@ -4543,11 +4680,14 @@ export interface Routes {
               error_code: 'failed_to_delete_on_acs_system'
             }
         >
+        /** Full name of the `acs_user`. */
         full_name?: string | undefined
         /**
          * @deprecated use email_address. */
         email?: string | undefined
+        /** Email address of the `acs_user`. */
         email_address?: string | undefined
+        /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
         phone_number?: string | undefined
         is_managed: false
       }>
@@ -4559,6 +4699,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired `acs_user`. */
       acs_user_id: string
     }
     formData: {}
@@ -4569,18 +4710,23 @@ export interface Routes {
     method: 'PATCH' | 'POST'
     queryParams: {}
     jsonBody: {
+      /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
       access_schedule?:
         | ({
             starts_at: string
             ends_at: string
           } | null)
         | undefined
+      /** ID of the `acs_user`. */
       acs_user_id: string
+      /** Full name of the `acs_user`. */
       full_name?: string | undefined
       /**
        * @deprecated use email_address. */
       email?: string | undefined
+      /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
       phone_number?: string | undefined
+      /** Email address of the `acs_user`. */
       email_address?: string | undefined
       hid_acs_system_id?: string | undefined
     }
@@ -20373,12 +20519,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {
       acs_users: Array<{
+        /** ID of the `acs_user`. */
         acs_user_id: string
+        /** ID of the access control system that contains the `acs_user`. */
         acs_system_id: string
         hid_acs_system_id?: string | undefined
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`. */
         workspace_id: string
+        /** Date and time at which the `acs_user` was created. */
         created_at: string
+        /** Display name for the `acs_user`. */
         display_name: string
+        /** Brand-specific terminology for the `acs_user` type. */
         external_type?:
           | (
               | 'pti_user'
@@ -20388,20 +20540,30 @@ export interface Routes {
               | 'latch_user'
             )
           | undefined
+        /** Display name that corresponds to the brand-specific terminology for the `acs_user` type. */
         external_type_display_name?: string | undefined
+        /** Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
         is_suspended: boolean
+        /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
         access_schedule?:
           | {
               starts_at: string
               ends_at: string
             }
           | undefined
+        /** ID of the user identity associated with the `acs_user`. */
         user_identity_id?: string | undefined
+        /** Full name of the user identity associated with the `acs_user`. */
         user_identity_full_name?: (string | null) | undefined
+        /** Email address of the user identity associated with the `acs_user`. */
         user_identity_email_address?: (string | null) | undefined
+        /** Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`). */
         user_identity_phone_number?: (string | null) | undefined
+        /**  */
         latest_desired_state_synced_with_provider_at?: string | undefined
+        /**  */
         is_latest_desired_state_synced_with_provider?: boolean | undefined
+        /** Warnings associated with the `acs_user`. */
         warnings: Array<
           | {
               created_at: string
@@ -20414,6 +20576,7 @@ export interface Routes {
               warning_code: 'salto_ks_user_not_subscribed'
             }
         >
+        /** Errors associated with the `acs_user`. */
         errors: Array<
           | {
               /** Date and time at which Seam created the error. */
@@ -20451,11 +20614,14 @@ export interface Routes {
               error_code: 'failed_to_delete_on_acs_system'
             }
         >
+        /** Full name of the `acs_user`. */
         full_name?: string | undefined
         /**
          * @deprecated use email_address. */
         email?: string | undefined
+        /** Email address of the `acs_user`. */
         email_address?: string | undefined
+        /** Phone number of the `acs_user` in E.164 format (for example, `+15555550100`). */
         phone_number?: string | undefined
         is_managed: true
       }>