@seamapi/types 0.2.2 → 0.4.0

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

@@ -501,8 +501,8 @@ export interface Routes {
         route: '/client_sessions/create';
         method: 'POST' | 'PUT';
         queryParams: {};
-        jsonBody: any | {
-            user_identifier_key: string;
+        jsonBody: {
+            user_identifier_key?: string | undefined;
             connect_webview_ids?: string[] | undefined;
             connected_account_ids?: string[] | undefined;
         };
@@ -512,6 +512,7 @@ export interface Routes {
             client_session: {
                 token: string;
                 client_session_id: string;
+                user_identifier_key: string | null;
                 created_at: string;
             };
         };
@@ -532,7 +533,11 @@ export interface Routes {
         method: 'POST' | 'GET';
         queryParams: {};
         jsonBody: {};
-        commonParams: {};
+        commonParams: {
+            client_session_id?: string | undefined;
+            user_identifier_key?: string | undefined;
+            without_user_identifier_key?: boolean | undefined;
+        };
         formData: {};
         jsonResponse: {
             client_sessions: Array<{
@@ -553,7 +558,7 @@ export interface Routes {
             device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
             custom_redirect_url?: string | undefined;
             custom_redirect_failure_url?: string | undefined;
-            accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat'> | undefined;
+            accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'yale_access'> | undefined;
             provider_category?: ('stable' | 'internal_beta') | undefined;
             custom_metadata?: Record<string, string | number | null | boolean> | undefined;
         };
@@ -900,7 +905,7 @@ export interface Routes {
     };
     '/events/get': {
         route: '/events/get';
-        method: 'GET';
+        method: 'GET' | 'POST';
         queryParams: {};
         jsonBody: {};
         commonParams: {
@@ -915,8 +920,8 @@ export interface Routes {
                 device_id?: string | undefined;
                 event_type: string;
                 workspace_id: string;
-                created_at: Date;
-                occurred_at: Date;
+                created_at: string;
+                occurred_at: string;
             } | undefined;
             message?: string | undefined;
         };
@@ -944,8 +949,8 @@ export interface Routes {
                 device_id?: string | undefined;
                 event_type: string;
                 workspace_id: string;
-                created_at: Date;
-                occurred_at: Date;
+                created_at: string;
+                occurred_at: string;
             }> | undefined;
             message?: string | undefined;
         };
@@ -960,7 +965,7 @@ export interface Routes {
         jsonResponse: {
             ok: boolean;
             msg: 'I\u2019m one with the Force. The Force is with me.';
-            last_service_evaluation_at: string;
+            last_service_evaluation_at?: string | undefined;
             service_health_statuses: Array<{
                 service: string;
                 status: 'healthy' | 'degraded' | 'down';
@@ -978,7 +983,7 @@ export interface Routes {
         jsonResponse: {
             ok: boolean;
             msg: 'I\u2019m one with the Force. The Force is with me.';
-            last_service_evaluation_at: string;
+            last_service_evaluation_at?: string | undefined;
             service_health_statuses: Array<{
                 service: string;
                 status: 'healthy' | 'degraded' | 'down';
@@ -1532,35 +1537,6 @@ export interface Routes {
             }>;
         };
     };
-    '/thermostats/set_cooling_set_point': {
-        route: '/thermostats/set_cooling_set_point';
-        method: 'POST';
-        queryParams: {};
-        jsonBody: {
-            device_id: string;
-            cooling_set_point_celsius?: number | undefined;
-            cooling_set_point_fahrenheit?: number | undefined;
-            sync?: boolean;
-        };
-        commonParams: {};
-        formData: {};
-        jsonResponse: {};
-    };
-    '/thermostats/set_mode': {
-        route: '/thermostats/set_mode';
-        method: 'POST';
-        queryParams: {};
-        jsonBody: {
-            device_id: string;
-            automatic_heating_enabled?: boolean | undefined;
-            automatic_cooling_enabled?: boolean | undefined;
-            hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined;
-            sync?: boolean;
-        };
-        commonParams: {};
-        formData: {};
-        jsonResponse: {};
-    };
     '/thermostats/update': {
         route: '/thermostats/update';
         method: 'POST';

package/package.json

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

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

@@ -522,19 +522,18 @@ export interface Routes {
     route: '/client_sessions/create'
     method: 'POST' | 'PUT'
     queryParams: {}
-    jsonBody:
-      | any
-      | {
-          user_identifier_key: string
-          connect_webview_ids?: string[] | undefined
-          connected_account_ids?: string[] | undefined
-        }
+    jsonBody: {
+      user_identifier_key?: string | undefined
+      connect_webview_ids?: string[] | undefined
+      connected_account_ids?: string[] | undefined
+    }
     commonParams: {}
     formData: {}
     jsonResponse: {
       client_session: {
         token: string
         client_session_id: string
+        user_identifier_key: string | null
         created_at: string
       }
     }
@@ -555,7 +554,11 @@ export interface Routes {
     method: 'POST' | 'GET'
     queryParams: {}
     jsonBody: {}
-    commonParams: {}
+    commonParams: {
+      client_session_id?: string | undefined
+      user_identifier_key?: string | undefined
+      without_user_identifier_key?: boolean | undefined
+    }
     formData: {}
     jsonResponse: {
       client_sessions: Array<{
@@ -604,6 +607,7 @@ export interface Routes {
             | 'igloohome'
             | 'ecobee'
             | 'hubitat'
+            | 'yale_access'
           >
         | undefined
       provider_category?: ('stable' | 'internal_beta') | undefined
@@ -1211,7 +1215,7 @@ export interface Routes {
   }
   '/events/get': {
     route: '/events/get'
-    method: 'GET'
+    method: 'GET' | 'POST'
     queryParams: {}
     jsonBody: {}
     commonParams: {
@@ -1227,8 +1231,8 @@ export interface Routes {
             device_id?: string | undefined
             event_type: string
             workspace_id: string
-            created_at: Date
-            occurred_at: Date
+            created_at: string
+            occurred_at: string
           }
         | undefined
       message?: string | undefined
@@ -1326,8 +1330,8 @@ export interface Routes {
             device_id?: string | undefined
             event_type: string
             workspace_id: string
-            created_at: Date
-            occurred_at: Date
+            created_at: string
+            occurred_at: string
           }>
         | undefined
       message?: string | undefined
@@ -1343,7 +1347,7 @@ export interface Routes {
     jsonResponse: {
       ok: boolean
       msg: 'I\u2019m one with the Force. The Force is with me.'
-      last_service_evaluation_at: string
+      last_service_evaluation_at?: string | undefined
       service_health_statuses: Array<{
         service: string
         status: 'healthy' | 'degraded' | 'down'
@@ -1361,7 +1365,7 @@ export interface Routes {
     jsonResponse: {
       ok: boolean
       msg: 'I\u2019m one with the Force. The Force is with me.'
-      last_service_evaluation_at: string
+      last_service_evaluation_at?: string | undefined
       service_health_statuses: Array<{
         service: string
         status: 'healthy' | 'degraded' | 'down'
@@ -2150,35 +2154,6 @@ export interface Routes {
       }>
     }
   }
-  '/thermostats/set_cooling_set_point': {
-    route: '/thermostats/set_cooling_set_point'
-    method: 'POST'
-    queryParams: {}
-    jsonBody: {
-      device_id: string
-      cooling_set_point_celsius?: number | undefined
-      cooling_set_point_fahrenheit?: number | undefined
-      sync?: boolean
-    }
-    commonParams: {}
-    formData: {}
-    jsonResponse: {}
-  }
-  '/thermostats/set_mode': {
-    route: '/thermostats/set_mode'
-    method: 'POST'
-    queryParams: {}
-    jsonBody: {
-      device_id: string
-      automatic_heating_enabled?: boolean | undefined
-      automatic_cooling_enabled?: boolean | undefined
-      hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heatcool') | undefined
-      sync?: boolean
-    }
-    commonParams: {}
-    formData: {}
-    jsonResponse: {}
-  }
   '/thermostats/update': {
     route: '/thermostats/update'
     method: 'POST'