@seamapi/types 1.379.0 → 1.380.0

package/dist/connect.d.cts

@@ -10836,17 +10836,14 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
         schlage_metadata: z.ZodOptional<z.ZodObject<{
             device_id: z.ZodString;
             device_name: z.ZodString;
-            access_code_length: z.ZodNullable<z.ZodNumber>;
             model: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         }, {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         }>>;
         smartthings_metadata: z.ZodOptional<z.ZodObject<{
@@ -11559,7 +11556,6 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
         schlage_metadata?: {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         } | undefined;
         smartthings_metadata?: {
@@ -11792,7 +11788,6 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
         schlage_metadata?: {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         } | undefined;
         smartthings_metadata?: {
@@ -13273,7 +13268,6 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
         schlage_metadata?: {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         } | undefined;
         smartthings_metadata?: {
@@ -13849,7 +13843,6 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
         schlage_metadata?: {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         } | undefined;
         smartthings_metadata?: {
@@ -14545,17 +14538,14 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
         schlage_metadata: z.ZodOptional<z.ZodObject<{
             device_id: z.ZodString;
             device_name: z.ZodString;
-            access_code_length: z.ZodNullable<z.ZodNumber>;
             model: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         }, {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         }>>;
         smartthings_metadata: z.ZodOptional<z.ZodObject<{
@@ -15268,7 +15258,6 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
         schlage_metadata?: {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         } | undefined;
         smartthings_metadata?: {
@@ -15501,7 +15490,6 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
         schlage_metadata?: {
             device_id: string;
             device_name: string;
-            access_code_length: number | null;
             model?: string | undefined;
         } | undefined;
         smartthings_metadata?: {
@@ -23821,11 +23809,6 @@ declare const _default: {
                                     };
                                     schlage_metadata: {
                                         properties: {
-                                            access_code_length: {
-                                                format: string;
-                                                nullable: boolean;
-                                                type: string;
-                                            };
                                             device_id: {
                                                 type: string;
                                             };
@@ -44179,6 +44162,7 @@ declare const _default: {
                                             };
                                             user_identity?: never;
                                         };
+                                        required: string[];
                                         type: string;
                                     } | {
                                         properties: {
@@ -44203,10 +44187,10 @@ declare const _default: {
                                                     };
                                                 };
                                                 type: string;
-                                                'x-route-path': string;
                                             };
                                             user_identity_id?: never;
                                         };
+                                        required: string[];
                                         type: string;
                                     })[];
                                     properties?: never;
@@ -44292,14 +44276,27 @@ declare const _default: {
                                                     format: string;
                                                     type: string;
                                                 };
-                                                access_methods: {
+                                                created_at: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                display_name: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                                location_ids: {
+                                                    description: string;
+                                                    items: {
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    type: string;
+                                                };
+                                                requested_access_methods: {
                                                     description: string;
                                                     items: {
                                                         properties: {
-                                                            access_method_key: {
-                                                                description: string;
-                                                                type: string;
-                                                            };
                                                             created_at: {
                                                                 description: string;
                                                                 format: string;
@@ -44309,15 +44306,17 @@ declare const _default: {
                                                                 description: string;
                                                                 type: string;
                                                             };
-                                                            issued_at: {
+                                                            mode: {
                                                                 description: string;
-                                                                format: string;
-                                                                nullable: boolean;
+                                                                enum: string[];
                                                                 type: string;
                                                             };
-                                                            mode: {
+                                                            provisioned_access_method_ids: {
                                                                 description: string;
-                                                                enum: string[];
+                                                                items: {
+                                                                    format: string;
+                                                                    type: string;
+                                                                };
                                                                 type: string;
                                                             };
                                                         };
@@ -44327,6 +44326,96 @@ declare const _default: {
                                                     };
                                                     type: string;
                                                 };
+                                                user_identity_id: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                                workspace_id: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                            'x-undocumented': string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
+        '/unstable_access_grants/get': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_grant_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grant: {
+                                            properties: {
+                                                access_grant_id: {
+                                                    description: string;
+                                                    format: string;
+                                                    type: string;
+                                                };
                                                 created_at: {
                                                     description: string;
                                                     format: string;
@@ -44344,6 +44433,39 @@ declare const _default: {
                                                     };
                                                     type: string;
                                                 };
+                                                requested_access_methods: {
+                                                    description: string;
+                                                    items: {
+                                                        properties: {
+                                                            created_at: {
+                                                                description: string;
+                                                                format: string;
+                                                                type: string;
+                                                            };
+                                                            display_name: {
+                                                                description: string;
+                                                                type: string;
+                                                            };
+                                                            mode: {
+                                                                description: string;
+                                                                enum: string[];
+                                                                type: string;
+                                                            };
+                                                            provisioned_access_method_ids: {
+                                                                description: string;
+                                                                items: {
+                                                                    format: string;
+                                                                    type: string;
+                                                                };
+                                                                type: string;
+                                                            };
+                                                        };
+                                                        required: string[];
+                                                        type: string;
+                                                        'x-undocumented': string;
+                                                    };
+                                                    type: string;
+                                                };
                                                 user_identity_id: {
                                                     description: string;
                                                     format: string;
@@ -44400,6 +44522,271 @@ declare const _default: {
                 'x-undocumented': string;
             };
         };
+        '/unstable_access_grants/list': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    acs_entrance_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    acs_system_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    location_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                    user_identity_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_grants: {
+                                            items: {
+                                                properties: {
+                                                    access_grant_id: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    created_at: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    display_name: {
+                                                        description: string;
+                                                        type: string;
+                                                    };
+                                                    location_ids: {
+                                                        description: string;
+                                                        items: {
+                                                            format: string;
+                                                            type: string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    requested_access_methods: {
+                                                        description: string;
+                                                        items: {
+                                                            properties: {
+                                                                created_at: {
+                                                                    description: string;
+                                                                    format: string;
+                                                                    type: string;
+                                                                };
+                                                                display_name: {
+                                                                    description: string;
+                                                                    type: string;
+                                                                };
+                                                                mode: {
+                                                                    description: string;
+                                                                    enum: string[];
+                                                                    type: string;
+                                                                };
+                                                                provisioned_access_method_ids: {
+                                                                    description: string;
+                                                                    items: {
+                                                                        format: string;
+                                                                        type: string;
+                                                                    };
+                                                                    type: string;
+                                                                };
+                                                            };
+                                                            required: string[];
+                                                            type: string;
+                                                            'x-undocumented': string;
+                                                        };
+                                                        type: string;
+                                                    };
+                                                    user_identity_id: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    workspace_id: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                                'x-undocumented': string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
+        '/unstable_access_grants/list_access_methods': {
+            post: {
+                description: string;
+                operationId: string;
+                requestBody: {
+                    content: {
+                        'application/json': {
+                            schema: {
+                                properties: {
+                                    access_grant_id: {
+                                        description: string;
+                                        format: string;
+                                        type: string;
+                                    };
+                                };
+                                required: string[];
+                                type: string;
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    200: {
+                        content: {
+                            'application/json': {
+                                schema: {
+                                    properties: {
+                                        access_methods: {
+                                            items: {
+                                                properties: {
+                                                    access_method_id: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    created_at: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                    display_name: {
+                                                        description: string;
+                                                        type: string;
+                                                    };
+                                                    issued_at: {
+                                                        description: string;
+                                                        format: string;
+                                                        nullable: boolean;
+                                                        type: string;
+                                                    };
+                                                    mode: {
+                                                        description: string;
+                                                        enum: string[];
+                                                        type: string;
+                                                    };
+                                                    workspace_id: {
+                                                        description: string;
+                                                        format: string;
+                                                        type: string;
+                                                    };
+                                                };
+                                                required: string[];
+                                                type: string;
+                                                'x-undocumented': string;
+                                            };
+                                            type: string;
+                                        };
+                                        ok: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                    type: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    400: {
+                        description: string;
+                    };
+                    401: {
+                        description: string;
+                    };
+                };
+                security: ({
+                    pat_with_workspace: never[];
+                    console_session_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    console_session_with_workspace: never[];
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    pat_with_workspace?: never;
+                    console_session_with_workspace?: never;
+                })[];
+                summary: string;
+                tags: never[];
+                'x-fern-sdk-group-name': string[];
+                'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
+                'x-response-key': string;
+                'x-title': string;
+                'x-undocumented': string;
+            };
+        };
         '/unstable_locations/add_devices': {
             post: {
                 description: string;
@@ -64270,7 +64657,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -65012,7 +65398,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -68957,7 +69342,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -69661,7 +70045,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -70403,7 +70786,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -71106,7 +71488,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -73809,7 +74190,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -74512,7 +74892,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -80553,7 +80932,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -83237,7 +83615,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -83940,7 +84317,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -87757,16 +88133,16 @@ interface Routes {
         jsonBody: {};
         commonParams: ({
             /** ID of user identity for whom access is being granted. */
-            user_identity_id?: string | undefined;
+            user_identity_id: string;
         } | {
             /** When used, creates a new user identity with the given details, and grants them access. */
-            user_identity?: {
+            user_identity: {
                 /** Unique email address for the user identity. */
                 email_address?: (string | null) | undefined;
                 /** 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) | undefined;
                 full_name?: (string | null) | undefined;
-            } | undefined;
+            };
         }) & {
             /** Set of IDs of existing locations to which access is being granted. */
             location_ids?: string[] | undefined;
@@ -87798,18 +88174,55 @@ interface Routes {
                 user_identity_id: string;
                 /** IDs of the locations to which access is being given. */
                 location_ids: string[];
-                /** Access methods associated with this access grant. */
-                access_methods: Array<{
-                    /** Key for the access method - unique within an access grant. */
-                    access_method_key: string;
+                /** Access methods that the user requested for this access grant. */
+                requested_access_methods: Array<{
+                    /** 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 requested access method was added to this access grant. */
+                    created_at: string;
+                    /** IDs of the locations to which access is being given. */
+                    provisioned_access_method_ids: string[];
+                }>;
+                /** Display name of the access grant. */
+                display_name: string;
+                /** Date and time at which the access grant was created. */
+                created_at: string;
+            };
+        };
+    };
+    '/unstable_access_grants/get': {
+        route: '/unstable_access_grants/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of access grant to get. */
+            access_grant_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /**  */
+            access_grant: {
+                /** Unique identifier for 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 access is being granted. */
+                user_identity_id: string;
+                /** IDs of the locations to which access is being given. */
+                location_ids: string[];
+                /** Access methods that the user requested for this access grant. */
+                requested_access_methods: Array<{
                     /** 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. */
+                    /** Date and time at which the requested access method was added to this access grant. */
                     created_at: string;
-                    /** Date and time at which the access method was issued. */
-                    issued_at: string | null;
+                    /** IDs of the locations to which access is being given. */
+                    provisioned_access_method_ids: string[];
                 }>;
                 /** Display name of the access grant. */
                 display_name: string;
@@ -87818,6 +88231,77 @@ interface Routes {
             };
         };
     };
+    '/unstable_access_grants/list': {
+        route: '/unstable_access_grants/list';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of user identity to filter list of access grants by. */
+            user_identity_id?: string | undefined;
+            /** ID of system to filter list of access grants by. */
+            acs_system_id?: string | undefined;
+            /** ID of entrance to filter list of access grants by. */
+            acs_entrance_id?: string | undefined;
+            /** ID of location to filter list of access grants by. */
+            location_id?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            access_grants: Array<{
+                /** Unique identifier for 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 access is being granted. */
+                user_identity_id: string;
+                /** IDs of the locations to which access is being given. */
+                location_ids: string[];
+                /** Access methods that the user requested for this access grant. */
+                requested_access_methods: Array<{
+                    /** 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 requested access method was added to this access grant. */
+                    created_at: string;
+                    /** IDs of the locations to which access is being given. */
+                    provisioned_access_method_ids: string[];
+                }>;
+                /** Display name of the access grant. */
+                display_name: string;
+                /** Date and time at which the access grant was created. */
+                created_at: string;
+            }>;
+        };
+    };
+    '/unstable_access_grants/list_access_methods': {
+        route: '/unstable_access_grants/list_access_methods';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of access grant to list access methods for. */
+            access_grant_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            access_methods: Array<{
+                /** Unique identifier for the Seam workspace associated with the access grant. */
+                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;
+            }>;
+        };
+    };
     '/unstable_locations/add_devices': {
         route: '/unstable_locations/add_devices';
         method: 'POST' | 'PUT';
@@ -88344,7 +88828,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {
@@ -89049,7 +89532,6 @@ interface Routes {
                     schlage_metadata?: {
                         device_id: string;
                         device_name: string;
-                        access_code_length: number | null;
                         model?: string | undefined;
                     } | undefined;
                     smartthings_metadata?: {