@seamapi/types 1.584.0 → 1.586.0

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

@@ -13547,6 +13547,131 @@ export type Routes = {
       }[]
     }
   }
+  '/access_grants/unmanaged/get': {
+    route: '/access_grants/unmanaged/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of unmanaged Access Grant to get. */
+      access_grant_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys. */
+      access_grant: {
+        /** ID of the Seam workspace associated with the Access Grant. */
+        workspace_id: string
+        /** ID of the Access Grant. */
+        access_grant_id: string
+        /** ID of user identity to which the Access Grant gives access. */
+        user_identity_id: string
+        /**
+         * @deprecated Use `space_ids`.*/
+        location_ids: string[]
+        /** IDs of the spaces to which the Access Grant gives access. */
+        space_ids: string[]
+        /** Access methods that the user requested for the Access Grant. */
+        requested_access_methods: {
+          /** Display name of the access method. */
+          display_name: string
+          /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+          mode: 'code' | 'card' | 'mobile_key'
+          /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+          code?: string | undefined
+          /** Date and time at which the requested access method was added to the Access Grant. */
+          created_at: string
+          /** IDs of the access methods created for the requested access method. */
+          created_access_method_ids: string[]
+        }[]
+        /** IDs of the access methods created for the Access Grant. */
+        access_method_ids: string[]
+        /** Name of the Access Grant. If not provided, the display name will be computed. */
+        name: string | null
+        /** Display name of the Access Grant. */
+        display_name: string
+        /** Date and time at which the Access Grant was created. */
+        created_at: string
+        /** Date and time at which the Access Grant starts. */
+        starts_at: string
+        /** Date and time at which the Access Grant ends. */
+        ends_at: string | null
+        /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+        warnings: {
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }[]
+      }
+    }
+  }
+  '/access_grants/unmanaged/list': {
+    route: '/access_grants/unmanaged/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of user identity by which you want to filter the list of unmanaged Access Grants. */
+      user_identity_id?: string | undefined
+      /** ID of the access system by which you want to filter the list of unmanaged Access Grants. */
+      acs_system_id?: string | undefined
+      /** ID of the entrance by which you want to filter the list of unmanaged Access Grants. */
+      acs_entrance_id?: string | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      access_grants: {
+        /** ID of the Seam workspace associated with the Access Grant. */
+        workspace_id: string
+        /** ID of the Access Grant. */
+        access_grant_id: string
+        /** ID of user identity to which the Access Grant gives access. */
+        user_identity_id: string
+        /**
+         * @deprecated Use `space_ids`.*/
+        location_ids: string[]
+        /** IDs of the spaces to which the Access Grant gives access. */
+        space_ids: string[]
+        /** Access methods that the user requested for the Access Grant. */
+        requested_access_methods: {
+          /** Display name of the access method. */
+          display_name: string
+          /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+          mode: 'code' | 'card' | 'mobile_key'
+          /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
+          code?: string | undefined
+          /** Date and time at which the requested access method was added to the Access Grant. */
+          created_at: string
+          /** IDs of the access methods created for the requested access method. */
+          created_access_method_ids: string[]
+        }[]
+        /** IDs of the access methods created for the Access Grant. */
+        access_method_ids: string[]
+        /** Name of the Access Grant. If not provided, the display name will be computed. */
+        name: string | null
+        /** Display name of the Access Grant. */
+        display_name: string
+        /** Date and time at which the Access Grant was created. */
+        created_at: string
+        /** Date and time at which the Access Grant starts. */
+        starts_at: string
+        /** Date and time at which the Access Grant ends. */
+        ends_at: string | null
+        /** Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). */
+        warnings: {
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }[]
+      }[]
+    }
+  }
   '/access_grants/update': {
     route: '/access_grants/update'
     method: 'POST' | 'PATCH'
@@ -23624,6 +23749,97 @@ export type Routes = {
       }[]
     }
   }
+  '/access_methods/unmanaged/get': {
+    route: '/access_methods/unmanaged/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of unmanaged access method to get. */
+      access_method_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys. */
+      access_method: {
+        /** ID of the Seam workspace associated with the access method. */
+        workspace_id: string
+        /** ID of the access method. */
+        access_method_id: string
+        /** Display name of the access method. */
+        display_name: string
+        /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+        mode: 'code' | 'card' | 'mobile_key'
+        /** Date and time at which the access method was created. */
+        created_at: string
+        /** Date and time at which the access method was issued. */
+        issued_at: string | null
+        /** Indicates whether the access method has been issued. */
+        is_issued: boolean
+        /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
+        is_encoding_required?: boolean | undefined
+        /** The actual PIN code for code access methods. */
+        code?: (string | null) | undefined
+        /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
+        warnings: {
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }[]
+      }
+    }
+  }
+  '/access_methods/unmanaged/list': {
+    route: '/access_methods/unmanaged/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of Access Grant to list unmanaged access methods for. */
+      access_grant_id: string
+      /** ID of the device for which you want to retrieve all unmanaged access methods. */
+      device_id?: string | undefined
+      /** ID of the entrance for which you want to retrieve all unmanaged access methods. */
+      acs_entrance_id?: string | undefined
+      /** ID of the space for which you want to retrieve all unmanaged access methods. */
+      space_id?: string | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      access_methods: {
+        /** ID of the Seam workspace associated with the access method. */
+        workspace_id: string
+        /** ID of the access method. */
+        access_method_id: string
+        /** Display name of the access method. */
+        display_name: string
+        /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+        mode: 'code' | 'card' | 'mobile_key'
+        /** Date and time at which the access method was created. */
+        created_at: string
+        /** Date and time at which the access method was issued. */
+        issued_at: string | null
+        /** Indicates whether the access method has been issued. */
+        is_issued: boolean
+        /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
+        is_encoding_required?: boolean | undefined
+        /** The actual PIN code for code access methods. */
+        code?: (string | null) | undefined
+        /** Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). */
+        warnings: {
+          /** Date and time at which Seam created the warning. */
+          created_at: string
+          /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+          warning_code: 'being_deleted'
+        }[]
+      }[]
+    }
+  }
   '/acs/access_groups/add_user': {
     route: '/acs/access_groups/add_user'
     method: 'PUT' | 'POST'
@@ -66860,6 +67076,12 @@ export type Routes = {
                   config?: {} | undefined
                 }
               | undefined
+            user_identity_name_updated?:
+              | {
+                  rule: 'user_identity_name_updated'
+                  config?: {} | undefined
+                }
+              | undefined
           }
         | undefined
     }
@@ -66902,6 +67124,12 @@ export type Routes = {
                   config?: {} | undefined
                 }
               | undefined
+            user_identity_name_updated?:
+              | {
+                  rule: 'user_identity_name_updated'
+                  config?: {} | undefined
+                }
+              | undefined
           }
         | undefined
     }
@@ -94860,6 +95088,129 @@ export type Routes = {
     formData: {}
     jsonResponse: {}
   }
+  '/user_identities/unmanaged/get': {
+    route: '/user_identities/unmanaged/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** ID of the unmanaged user identity that you want to get. */
+      user_identity_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      /** Represents an unmanaged user identity. Unmanaged user identities do not have keys. */
+      user_identity: {
+        /** ID of the user identity. */
+        user_identity_id: string
+        /** Unique email address for the user identity. */
+        email_address: string | null
+        /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
+        phone_number: string | null
+        display_name: string
+        full_name: string | null
+        /** Date and time at which the user identity was created. */
+        created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
+        workspace_id: string
+        /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+        errors: {
+          /** Date and time at which Seam created the error. */
+          created_at: string
+          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+          error_code: 'issue_with_acs_user'
+          /** ID of the access system user that has an issue. */
+          acs_user_id: string
+          /** ID of the access system that the user identity is associated with. */
+          acs_system_id: string
+        }[]
+        /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+        warnings: (
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'being_deleted'
+            }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'acs_user_profile_does_not_match_user_identity'
+            }
+        )[]
+        /** Array of access system user IDs associated with the user identity. */
+        acs_user_ids: string[]
+      }
+    }
+  }
+  '/user_identities/unmanaged/list': {
+    route: '/user_identities/unmanaged/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      /** String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`. */
+      search?: string | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      user_identities: {
+        /** ID of the user identity. */
+        user_identity_id: string
+        /** Unique email address for the user identity. */
+        email_address: string | null
+        /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
+        phone_number: string | null
+        display_name: string
+        full_name: string | null
+        /** Date and time at which the user identity was created. */
+        created_at: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
+        workspace_id: string
+        /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
+        errors: {
+          /** Date and time at which Seam created the error. */
+          created_at: string
+          /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+          message: string
+          /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+          error_code: 'issue_with_acs_user'
+          /** ID of the access system user that has an issue. */
+          acs_user_id: string
+          /** ID of the access system that the user identity is associated with. */
+          acs_system_id: string
+        }[]
+        /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
+        warnings: (
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'being_deleted'
+            }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'acs_user_profile_does_not_match_user_identity'
+            }
+        )[]
+        /** Array of access system user IDs associated with the user identity. */
+        acs_user_ids: string[]
+      }[]
+    }
+  }
   '/user_identities/update': {
     route: '/user_identities/update'
     method: 'PATCH' | 'POST'