@seamapi/types 1.128.0 → 1.130.0

package/dist/connect.d.cts

@@ -827,6 +827,16 @@ declare const _default: {
                             allOf: ({
                                 allOf: ({
                                     properties: {
+                                        appearance: {
+                                            properties: {
+                                                name: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                        };
                                         battery: {
                                             description: string;
                                             properties: {
@@ -896,6 +906,10 @@ declare const _default: {
                                             description: string;
                                             type: string;
                                         };
+                                        nickname: {
+                                            description: string;
+                                            type: string;
+                                        };
                                         offline_access_codes_enabled: {
                                             description: string;
                                             type: string;
@@ -950,6 +964,7 @@ declare const _default: {
                                             required: string[];
                                             type: string;
                                         };
+                                        appearance?: never;
                                         battery?: never;
                                         battery_level?: never;
                                         has_direct_power?: never;
@@ -958,6 +973,7 @@ declare const _default: {
                                         manufacturer?: never;
                                         model?: never;
                                         name?: never;
+                                        nickname?: never;
                                         offline_access_codes_enabled?: never;
                                         online?: never;
                                         online_access_codes_enabled?: never;
@@ -12055,20 +12071,25 @@ declare const _default: {
                     };
                 };
                 security: ({
-                    access_token: never[];
-                    seam_workspace: never[];
-                    seam_client_session_token?: never;
-                    client_session_token?: never;
+                    client_session: never[];
+                    pat_with_workspace?: never;
+                    console_session?: never;
+                    api_key?: never;
                 } | {
-                    seam_client_session_token: never[];
-                    access_token?: never;
-                    seam_workspace?: never;
-                    client_session_token?: never;
+                    pat_with_workspace: never[];
+                    client_session?: never;
+                    console_session?: never;
+                    api_key?: never;
                 } | {
-                    client_session_token: never[];
-                    access_token?: never;
-                    seam_workspace?: never;
-                    seam_client_session_token?: never;
+                    console_session: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    console_session?: never;
                 })[];
                 summary: string;
                 tags: string[];
@@ -13852,6 +13873,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -13890,6 +13914,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/get': {
@@ -13998,6 +14023,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -14036,6 +14064,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/heat_cool': {
@@ -14079,6 +14108,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -14117,6 +14149,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/list': {
@@ -14289,6 +14322,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -14327,6 +14363,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/set_fan_mode': {
@@ -14366,6 +14403,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -14404,6 +14444,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/update': {
@@ -18857,6 +18898,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -19347,6 +19394,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -20160,6 +20213,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -20627,6 +20686,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -21117,6 +21182,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -21584,6 +21655,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -22631,7 +22708,30 @@ interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {};
+        jsonResponse: {
+            action_attempt: {
+                status: 'success';
+                action_type: string;
+                action_attempt_id: string;
+                result?: any;
+                error: null;
+            } | {
+                status: 'pending';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: null;
+            } | {
+                status: 'error';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: {
+                    type: string;
+                    message: string;
+                };
+            };
+        };
     };
     '/thermostats/get': {
         route: '/thermostats/get';
@@ -22657,6 +22757,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -23125,7 +23231,30 @@ interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {};
+        jsonResponse: {
+            action_attempt: {
+                status: 'success';
+                action_type: string;
+                action_attempt_id: string;
+                result?: any;
+                error: null;
+            } | {
+                status: 'pending';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: null;
+            } | {
+                status: 'error';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: {
+                    type: string;
+                    message: string;
+                };
+            };
+        };
     };
     '/thermostats/heat_cool': {
         route: '/thermostats/heat_cool';
@@ -23141,7 +23270,30 @@ interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {};
+        jsonResponse: {
+            action_attempt: {
+                status: 'success';
+                action_type: string;
+                action_attempt_id: string;
+                result?: any;
+                error: null;
+            } | {
+                status: 'pending';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: null;
+            } | {
+                status: 'error';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: {
+                    type: string;
+                    message: string;
+                };
+            };
+        };
     };
     '/thermostats/list': {
         route: '/thermostats/list';
@@ -23177,6 +23329,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;
@@ -23643,7 +23801,30 @@ interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {};
+        jsonResponse: {
+            action_attempt: {
+                status: 'success';
+                action_type: string;
+                action_attempt_id: string;
+                result?: any;
+                error: null;
+            } | {
+                status: 'pending';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: null;
+            } | {
+                status: 'error';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: {
+                    type: string;
+                    message: string;
+                };
+            };
+        };
     };
     '/thermostats/set_fan_mode': {
         route: '/thermostats/set_fan_mode';
@@ -23657,7 +23838,30 @@ interface Routes {
         };
         commonParams: {};
         formData: {};
-        jsonResponse: {};
+        jsonResponse: {
+            action_attempt: {
+                status: 'success';
+                action_type: string;
+                action_attempt_id: string;
+                result?: any;
+                error: null;
+            } | {
+                status: 'pending';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: null;
+            } | {
+                status: 'error';
+                action_type: string;
+                action_attempt_id: string;
+                result: null;
+                error: {
+                    type: string;
+                    message: string;
+                };
+            };
+        };
     };
     '/thermostats/update': {
         route: '/thermostats/update';
@@ -23882,6 +24086,12 @@ interface Routes {
                     online: boolean;
                     /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
                     name: string;
+                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    nickname?: string | undefined;
+                    appearance: {
+                        /** Name of the device as seen from the provider API and application, not settable through Seam. */
+                        name: string;
+                    };
                     model: {
                         /** Display name of the device model. */
                         display_name: string;

package/lib/seam/connect/openapi.d.ts

@@ -753,6 +753,16 @@ declare const _default: {
                             allOf: ({
                                 allOf: ({
                                     properties: {
+                                        appearance: {
+                                            properties: {
+                                                name: {
+                                                    description: string;
+                                                    type: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            type: string;
+                                        };
                                         battery: {
                                             description: string;
                                             properties: {
@@ -822,6 +832,10 @@ declare const _default: {
                                             description: string;
                                             type: string;
                                         };
+                                        nickname: {
+                                            description: string;
+                                            type: string;
+                                        };
                                         offline_access_codes_enabled: {
                                             description: string;
                                             type: string;
@@ -876,6 +890,7 @@ declare const _default: {
                                             required: string[];
                                             type: string;
                                         };
+                                        appearance?: never;
                                         battery?: never;
                                         battery_level?: never;
                                         has_direct_power?: never;
@@ -884,6 +899,7 @@ declare const _default: {
                                         manufacturer?: never;
                                         model?: never;
                                         name?: never;
+                                        nickname?: never;
                                         offline_access_codes_enabled?: never;
                                         online?: never;
                                         online_access_codes_enabled?: never;
@@ -11981,20 +11997,25 @@ declare const _default: {
                     };
                 };
                 security: ({
-                    access_token: never[];
-                    seam_workspace: never[];
-                    seam_client_session_token?: never;
-                    client_session_token?: never;
+                    client_session: never[];
+                    pat_with_workspace?: never;
+                    console_session?: never;
+                    api_key?: never;
                 } | {
-                    seam_client_session_token: never[];
-                    access_token?: never;
-                    seam_workspace?: never;
-                    client_session_token?: never;
+                    pat_with_workspace: never[];
+                    client_session?: never;
+                    console_session?: never;
+                    api_key?: never;
                 } | {
-                    client_session_token: never[];
-                    access_token?: never;
-                    seam_workspace?: never;
-                    seam_client_session_token?: never;
+                    console_session: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    api_key?: never;
+                } | {
+                    api_key: never[];
+                    client_session?: never;
+                    pat_with_workspace?: never;
+                    console_session?: never;
                 })[];
                 summary: string;
                 tags: string[];
@@ -13778,6 +13799,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -13816,6 +13840,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/get': {
@@ -13924,6 +13949,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -13962,6 +13990,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/heat_cool': {
@@ -14005,6 +14034,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -14043,6 +14075,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/list': {
@@ -14215,6 +14248,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -14253,6 +14289,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/set_fan_mode': {
@@ -14292,6 +14329,9 @@ declare const _default: {
                             'application/json': {
                                 schema: {
                                     properties: {
+                                        action_attempt: {
+                                            $ref: string;
+                                        };
                                         ok: {
                                             type: string;
                                         };
@@ -14330,6 +14370,7 @@ declare const _default: {
                 tags: string[];
                 'x-fern-sdk-group-name': string[];
                 'x-fern-sdk-method-name': string;
+                'x-fern-sdk-return-value': string;
             };
         };
         '/thermostats/update': {