@seamapi/types 1.584.0 → 1.585.0

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

@@ -11819,6 +11819,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';
@@ -20298,6 +20423,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';
@@ -79625,6 +79841,123 @@ 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';

package/package.json

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

package/src/lib/seam/connect/internal/schemas.ts

@@ -80,7 +80,10 @@ export {
   thermostat_schedule,
   unit_resource,
   unmanaged_access_code,
+  unmanaged_access_grant,
+  unmanaged_access_method,
   unmanaged_device,
+  unmanaged_user_identity,
   user_identity,
   user_identity_resource,
   user_resource,

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -119,3 +119,19 @@ export const access_grant = z.object({
   `)
 
 export type AccessGrant = z.infer<typeof access_grant>
+
+// Unmanaged access grant schema - excludes client sessions, instant keys, customization profiles, and keys
+export const unmanaged_access_grant = access_grant.omit({
+  client_session_token: true,
+  instant_key_url: true,
+  customization_profile_id: true,
+  access_grant_key: true,
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /access_grants/unmanaged
+  ---
+  Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.
+  `)
+
+export type UnmanagedAccessGrant = z.infer<typeof unmanaged_access_grant>

package/src/lib/seam/connect/models/access-grants/access-method.ts

@@ -100,3 +100,18 @@ export const access_method = z.object({
   `)
 
 export type AccessMethod = z.infer<typeof access_method>
+
+// Unmanaged access method schema - excludes client sessions, instant keys, customization profiles, and keys
+export const unmanaged_access_method = access_method.omit({
+  instant_key_url: true,
+  client_session_token: true,
+  customization_profile_id: true,
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /access_methods/unmanaged
+  ---
+  Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.
+  `)
+
+export type UnmanagedAccessMethod = z.infer<typeof unmanaged_access_method>

package/src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -156,3 +156,16 @@ export const user_identity = z.object({
 `)
 
 export type UserIdentity = z.output<typeof user_identity>
+
+// Unmanaged user identity schema - excludes keys since unmanaged user identities cannot have keys
+export const unmanaged_user_identity = user_identity.omit({
+  user_identity_key: true,
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /user_identities/unmanaged
+  ---
+  Represents an unmanaged user identity. Unmanaged user identities do not have keys.
+  `)
+
+export type UnmanagedUserIdentity = z.output<typeof unmanaged_user_identity>